spectacular/src/spectacular_bin.coffee

Advanced BDD framework for CoffeeScript and JavaScript

fs = require 'fs'
vm = require 'vm'
path = require 'path'
exists = fs.exists or path.exists
require 'colors'

SPECTACULAR = path.resolve __dirname, '..'
ROOT = path.resolve '.'

[node, binPath, args...] = process.argv

existsSync = fs.existsSync or path.existsSync

SPECTACULAR_CONFIG = path.resolve ROOT, '.spectacular'

if args.length is 0 or not args.some((e) -> e in ['test','server','phantomjs', 'slimerjs'])
  args.push '-h'

if existsSync SPECTACULAR_CONFIG
  args = fs.readFileSync(SPECTACULAR_CONFIG).toString()
  .replace(/^\s+|\s+$/g, '')
  .split(/\s+/g)
  .concat(args)


deprecated = (message) -> console.log "DEPRECATION WARNING: #{message}"

options =
  coffee: false
  verbose: false
  profile: false
  resume: true
  trace: true
  format: 'progress'
  longTrace: false
  showSource: true
  requires: []
  fixturesRoot: './specs/support/fixtures'
  phantomjsExecutable: 'phantomjs'
  slimerjsExecutable: 'slimerjs'
  noMatchers: false
  noHelpers: false
  colors: true
  cli: false
  server: false
  phantomjs: false
  slimerjs: false
  random: true
  sourceMap: false
  seed: null
  globs: []
  sources: []

while args.length
  option = args.shift()

  switch option
    # Commands
    when 'test'
      options.cli = true
      options.server = false
      options.phantomjs = false
      options.slimerjs = false
    when 'server', 's'
      options.cli = false
      options.server = true
    when 'phantomjs'
      options.cli = false
      options.server = true
      options.phantomjs = true
      options.slimerjs = false
    when 'slimerjs'
      options.cli = false
      options.server = true
      options.slimerjs = true
      options.phantomjs = false

    # Options
    when '--coffee', '-c'
      options.coffee = true
      require 'coffee-script'

    when '--no-matchers'
      deprecated '--no-matchers is deprecated and may be removed in future release, use --require PATH instead'

    when '--no-helpers'
      deprecated '--no-helpers is deprecated and may be removed in future release, use --require PATH instead'

    when '--matchers', '-m'
      deprecated '--matchers and -m are deprecated and may be removed in future release, use --require PATH instead'
      options.requires.push args.shift()

    when '--helpers'
      deprecated '--helpers is deprecated and may be removed in future release, use --require PATH instead'
      options.requires.push args.shift()

    when '--require', '-r' then options.requires.push args.shift()
    when '--colors' then options.colors = true
    when '--no-colors' then options.colors = false

    when '--fixtures' then options.fixturesRoot = args.shift()
    when '--trace', '-t' then options.trace = true
    when '--no-trace' then options.trace = false
    when '--long-trace' then options.longTrace = true
    when '--documentation', '-d'
      deprecated '--documentation is deprecated and may be removed in future release, use `--format documentation` instead.'
      options.format = 'documentation'
    when '--format', '-f' then options.format = args.shift()
    when '--verbose', '-v' then options.verbose = true
    when '--profile', '-p' then options.profile = true
    when '--map', '--source-map' then options.sourceMap = true
    when '--random' then options.random = true
    when '--no-random' then options.random = false
    when '--seed' then options.seed = parseInt args.shift()
    when '--phantomjs-bin' then options.phantomjsExecutable = args.shift()
    when '--slimerjs-bin' then options.slimerjsExecutable = args.shift()
    when '--server', '-s'
      deprecated '--server and -s options are deprecated and may be removed in future release, use `spectacular server` or `spectacular s` instead.'
      options.cli = false
      options.server = true
    when '--phantomjs'
      deprecated '--phantomjs option is deprecated and may be removed in future release, use `spectacular phantomjs` instead.'
      options.cli = false
      options.server = true
      options.phantomjs = true
      options.slimerjs = false
    when '--source' then options.sources.push args.shift()
    when '--version'
      options.cli = false
      console.log require("#{ROOT}/package.json").version
    when '-h', '--help'
      options.cli = false
      console.log '''

# Spectacular Help

  Usage:

    spectacular [command] [options] [globs...]

  Commands:

    test        Run tests on NodeJS.
    server      Start the Spectacular server.
    phantomjs   Stats the Spectacular server and run tests in phantomjs.

  Options:

    -c, --coffee          Add support for CoffeeScript files.
    -f, --format          Select the console output format (progress|documentation)
    -h, --help            Display this message.
    -p, --profile         Add a report with the 10 slowest examples.
    -t, --trace           Enable stack trace report for failures.
    -v, --verbose         Enable verbose output.
    -r, --require PATH    Append the passed-in path to the array of paths to require
    --phantomjs-bin PATH  Sets the path to the PhantomJS binary.
    --slimerjs-bin PATH   Sets the path to the SlimerJS binary.
    --fixtures PATH       Specify the path where project fixtures can be found.
    --long-trace          Display the full stack trace.
    --colors              Enable coloring from the output.
    --no-colors           Disable coloring from the output.
    --seed                Set the seed of the test ranomizer.
    --random              Enable the randomness of test execution
    --no-random           Disable the randomness of test execution.
    --no-trace            Remove stack trace from failures reports.
    --source GLOB         Source files for the server.
    --version             Display the Spectacular version.

'''
    else options.globs.push option

#### Lookup for the spectacular lib.
#
# When a project owns a version of Spectacular, that version is used
# instead of the global one.
exists path.resolve(ROOT, 'node_modules/spectacular'), (exist) ->
  if exist
    spectacularPath = path.resolve(ROOT, 'node_modules/spectacular')
  else
    spectacularPath = SPECTACULAR

  if options.cli
    spectacular = require("#{spectacularPath}/lib/cli")
  else if options.server
    spectacular = require("#{spectacularPath}/lib/server")

  if spectacular?
    spectacular.run(options).then (status) -> process.exit status