teaspoon 0.8.0 → 0.9.0

data/lib/generators/teaspoon/install/templates/qunit/{env_comments.rb → env_comments.rb.tt}

@@ -41,7 +41,7 @@ Teaspoon.configure do |config|
     # directives.
     # Note: If no version is specified, the latest is assumed.
     #
-    # Available: jasmine[1.3.1, 2.0.0], mocha[1.10.0, 1.17.1] qunit[1.12.0, 1.14.0]
+    # Available: jasmine[1.3.1], mocha[1.10.0, 1.17.1] qunit[1.12.0, 1.14.0]
     suite.use_framework :qunit
 
     # Specify a file matcher as a regular expression and all matching files will be loaded when the suite is run. These
@@ -80,6 +80,11 @@ Teaspoon.configure do |config|
     # synchronous Ajax request to the server that will call all of the blocks you've defined for that hook name.
     #suite.hook :fixtures, proc{ }
 
+    # Determine whether specs loaded into the test harness should be embedded as individual script tags or concatenated
+    # into a single file. Similar to Rails' asset `debug: true` and `config.assets.debug = true` options. By default, 
+    # Teaspoon expands all assets to provide more valuable stack traces that reference individual source files.
+    #suite.expand_assets = false
+
   end
 
   # Example suite. Since we're just filtering to files already within the root test/javascripts, these files will also
@@ -134,8 +139,8 @@ Teaspoon.configure do |config|
   # Specify the formatters to use when outputting the results.
   # Note: Output files can be specified by using `"junit>/path/to/output.xml"`.
   #
-  # Available: dot, documentation, clean, json, junit, pride, snowday, swayze_or_oprah, tap, tap_y, teamcity
-  #config.formatters = ["dot"]
+  # Available: <%= Teaspoon::Formatters.known_formatters.map(&:name).join ", " %>
+  #config.formatters = ["<%= Teaspoon::Formatters.known_formatters.select(&:default?).first.name %>"]
 
   # Specify if you want color output from the formatters.
   #config.color = true
@@ -161,14 +166,14 @@ Teaspoon.configure do |config|
 
   config.coverage do |coverage|
 
-    # Which coverage reports Instanbul should generate. Correlates directly to what Istanbul supports.
+    # Which coverage reports Istanbul should generate. Correlates directly to what Istanbul supports.
     #
     # Available: text-summary, text, html, lcov, lcovonly, cobertura, teamcity
     #coverage.reports = ["text-summary", "html"]
 
     # The path that the coverage should be written to - when there's an artifact to write to disk.
     # Note: Relative to `config.root`.
-    #coverage.output_dir = "coverage"
+    #coverage.output_path = "coverage"
 
     # Various thresholds requirements can be defined, and those thresholds will be checked at the end of a run. If any
     # aren't met the run will fail with a message. Thresholds can be defined as a percentage (0-100), or nil.

data/lib/generators/teaspoon/install/templates/qunit/test_helper.coffee

@@ -6,6 +6,10 @@
 # Use this polyfill to avoid the confusion.
 #= require support/bind-poly
 #
+# You can require your own javascript files here. By default this will include everything in application, however you
+# may get better load performance if you require the specific files that are being used in the test that tests them.
+#= require application
+#
 # Deferring execution
 # If you're using CommonJS, RequireJS or some other asynchronous library you can defer execution. Call
 # Teaspoon.execute() after everything has been loaded. Simple example of a timeout:
@@ -16,14 +20,10 @@
 # Matching files
 # By default Teaspoon will look for files that match _test.{js,js.coffee,.coffee}. Add a filename_test.js file in your
 # test path and it'll be included in the default suite automatically. If you want to customize suites, check out the
-# configuration in config/initializers/teaspoon.rb
+# configuration in teaspoon_env.rb
 #
 # Manifest
 # If you'd rather require your test files manually (to control order for instance) you can disable the suite matcher in
 # the configuration and use this file as a manifest.
 #
 # For more information: http://github.com/modeset/teaspoon
-#
-# You can require your own javascript files here. By default this will include everything in application, however you
-# may get better load performance if you require the specific files that are being used in the test that tests them.
-#= require application

data/lib/generators/teaspoon/install/templates/qunit/test_helper.js

@@ -6,6 +6,10 @@
 // Use this polyfill to avoid the confusion.
 //= require support/bind-poly
 //
+// You can require your own javascript files here. By default this will include everything in application, however you
+// may get better load performance if you require the specific files that are being used in the test that tests them.
+//= require application
+//
 // Deferring execution
 // If you're using CommonJS, RequireJS or some other asynchronous library you can defer execution. Call
 // Teaspoon.execute() after everything has been loaded. Simple example of a timeout:
@@ -16,15 +20,11 @@
 // Matching files
 // By default Teaspoon will look for files that match _test.{js,js.coffee,.coffee}. Add a filename_test.js file in your
 // test path and it'll be included in the default suite automatically. If you want to customize suites, check out the
-// configuration in config/initializers/teaspoon.rb
+// configuration in teaspoon_env.rb
 //
 // Manifest
 // If you'd rather require your test files manually (to control order for instance) you can disable the suite matcher in
 // the configuration and use this file as a manifest.
 //
 // For more information: http://github.com/modeset/teaspoon
-//
-// You can require your own javascript files here. By default this will include everything in application, however you
-// may get better load performance if you require the specific files that are being used in the test that tests them.
-//= require application
 

data/lib/tasks/teaspoon.rake

@@ -1,5 +1,5 @@
 desc "Run the javascript specs"
-task :teaspoon => :environment do |t, args|
+task teaspoon: :environment do
   require "teaspoon/console"
 
   options = {

data/lib/teaspoon/command_line.rb

@@ -1,10 +1,10 @@
 require "optparse"
 require "teaspoon/version"
 require "teaspoon/exceptions"
+require "teaspoon/formatters/base"
 
 module Teaspoon
   class CommandLine
-
     def initialize
       @options = {}
       @options[:files] = opt_parser.parse!
@@ -31,90 +31,87 @@ module Teaspoon
     protected
 
     def opts_for_general
-      opt :environment,
-        "-r", "--require FILE",
-        "Require Teaspoon environment file."
+      opt :environment, "-r", "--require FILE",
+          "Require Teaspoon environment file."
 
-      #opt :custom_options_file,
-      #  "-O", "--options PATH",
-      #  "Specify the path to a custom options file."
+      # opt :custom_options_file,
+      #     "-O", "--options PATH",
+      #     "Specify the path to a custom options file."
 
       opt :driver, "-d", "--driver DRIVER",
-        "Specify driver:",
-        "  phantomjs (default)",
-        "  selenium"
+          "Specify driver:",
+          "  phantomjs (default)",
+          "  selenium",
+          "  capybara_webkit"
 
       opt :driver_options, "--driver-options OPTIONS",
-        "Specify driver-specific options to pass into the driver.",
-        "  e.g. \"--ssl-protocol=any --ssl-certificates-path=/path/to/certs\".",
-        "  Driver options are only supported with phantomjs."
+          "Specify driver-specific options to pass into the driver.",
+          "  e.g. \"--ssl-protocol=any --ssl-certificates-path=/path/to/certs\".",
+          "  Driver options are only supported with phantomjs."
 
       opt :driver_timeout, "--driver-timeout SECONDS",
-        "Sets the timeout for the driver to wait before exiting."
+          "Sets the timeout for the driver to wait before exiting."
 
       opt :server, "--server SERVER",
-        "Sets server to use with Rack.",
-        "  e.g. webrick, thin"
+          "Sets server to use with Rack.",
+          "  e.g. webrick, thin"
 
       opt :server_port, "--server-port PORT",
-        "Sets the server to use a specific port."
+          "Sets the server to use a specific port."
 
       opt :server_timeout, "--server-timeout SECONDS",
-        "Sets the timeout that the server must start within."
+          "Sets the timeout that the server must start within."
 
       opt :fail_fast, "-F", "--[no-]fail-fast",
-        "Abort after the first failing suite."
+          "Abort after the first failing suite."
     end
 
     def opts_for_filtering
       separator("Filtering")
 
       opt :suite, "-s", "--suite SUITE",
-        "Focus to a specific suite."
+          "Focus to a specific suite."
 
       opt :filter, "-g", "--filter FILTER",
-        "Filter tests matching a specific filter."
+          "Filter tests matching a specific filter."
     end
 
     def opts_for_output
       separator("Output")
 
       opt :suppress_log, "-q", "--[no-]suppress-log",
-        "Suppress logs coming from console[log/debug/error]."
+          "Suppress logs coming from console[log/debug/error]."
 
       opt :color, "-c", "--[no-]color",
-        "Enable/Disable color output."
+          "Enable/Disable color output."
 
       opt :export, "-e", "--export [OUTPUT_PATH]",
-        "Exports the test suite as the full HTML (requires wget)."
+          "Exports the test suite as the full HTML (requires wget)."
 
       opt :formatters, "-f", "--format FORMATTERS",
-        "Specify formatters (comma separated)",
-        "  dot (default) - dots",
-        "  documentation - descriptive documentation",
-        "  clean - like dots but doesn't log re-run commands",
-        "  json - json formatter (raw teaspoon)",
-        "  junit - junit compatible formatter",
-        "  pride - yay rainbows!",
-        "  snowday - makes you feel warm inside",
-        "  swayze_or_oprah - quote from either Patrick Swayze or Oprah Winfrey",
-        "  tap - test anything protocol formatter",
-        "  tap_y - tap_yaml, format used by tapout",
-        "  teamcity - teamcity compatible formatter"
+          "Specify formatters (comma separated)",
+          *Teaspoon::Formatters.known_formatters.map(&:cli_help)
     end
 
     def opts_for_coverage
       separator("Coverage")
 
       opt :use_coverage, "-C", "--coverage CONFIG_NAME",
-        "Generate coverage reports using a pre-defined coverage configuration."
+          "Generate coverage reports using a pre-defined coverage configuration."
     end
 
     def opts_for_utility
       separator("Utility")
 
-      @parser.on "-v", "--version", "Display the version.", proc{ STDOUT.print("#{Teaspoon::VERSION}\n"); exit }
-      @parser.on "-h", "--help", "You're looking at it.", proc { STDOUT.print("#{@parser}\n"); exit }
+      @parser.on "-v", "--version", "Display the version." do
+        STDOUT.print("#{Teaspoon::VERSION}\n")
+        exit
+      end
+
+      @parser.on "-h", "--help", "You're looking at it." do
+        STDOUT.print("#{@parser}\n")
+        exit
+      end
     end
 
     private
@@ -124,7 +121,7 @@ module Teaspoon
     end
 
     def opt(config, *args)
-      @parser.on(*args, proc{ |value| @options[config] = value })
+      @parser.on(*args, proc { |value| @options[config] = value })
     end
 
     def require_console

data/lib/teaspoon/configuration.rb

@@ -1,7 +1,6 @@
 require "singleton"
 
 module Teaspoon
-
   autoload :Formatters, "teaspoon/formatters/base"
   autoload :Drivers,    "teaspoon/drivers/base"
 
@@ -17,7 +16,7 @@ module Teaspoon
     # - add it to ENV_OVERRIDES if it can be overridden from ENV
     # - add it to the initializers in /lib/generators/install/templates so it's documented there as well
 
-    cattr_accessor   :mount_at, :root, :asset_paths, :fixture_paths
+    cattr_accessor :mount_at, :root, :asset_paths, :fixture_paths
     @@mount_at       = "/teaspoon"
     @@root           = nil # will default to Rails.root
     @@asset_paths    = ["spec/javascripts", "spec/javascripts/stylesheets", "test/javascripts", "test/javascripts/stylesheets"]
@@ -25,9 +24,9 @@ module Teaspoon
 
     # console runner specific
 
-    cattr_accessor   :driver, :driver_options, :driver_timeout, :server, :server_port, :server_timeout, :fail_fast,
-                     :formatters, :color, :suppress_log,
-                     :use_coverage
+    cattr_accessor :driver, :driver_options, :driver_timeout, :server, :server_port, :server_timeout, :fail_fast,
+                   :formatters, :color, :suppress_log,
+                   :use_coverage
     @@driver         = "phantomjs"
     @@driver_options = nil
     @@driver_timeout = 180
@@ -53,41 +52,38 @@ module Teaspoon
     # suite configurations
 
     cattr_accessor :suite_configs
-    @@suite_configs = {"default" => {block: proc{}}}
+    @@suite_configs = { "default" => { block: proc {} } }
 
     def self.suite(name = :default, &block)
-      @@suite_configs[name.to_s] = {block: block, instance: Suite.new(&block)}
+      @@suite_configs[name.to_s] = { block: block, instance: Suite.new(&block) }
     end
 
     class Suite
-
       FRAMEWORKS = {
         jasmine: ["1.3.1", "2.0.0"],
         mocha: ["1.10.0", "1.17.1"],
         qunit: ["1.12.0", "1.14.0"],
-        angular: ["1.0.5"],
       }
 
-      attr_accessor   :matcher, :helper, :javascripts, :stylesheets,
-                      :boot_partial, :body_partial,
-                      :no_coverage,
-                      :hooks
+      attr_accessor :matcher, :helper, :javascripts, :stylesheets,
+                    :boot_partial, :body_partial,
+                    :no_coverage, :hooks, :expand_assets
 
       def initialize
-        @matcher      = "{spec/javascripts,app/assets}/**/*_spec.{js,js.coffee,coffee}"
-        @helper       = "spec_helper"
-        @javascripts  = ["jasmine/1.3.1", "teaspoon-jasmine"]
-        @stylesheets  = ["teaspoon"]
-
-        @boot_partial = "boot"
-        @body_partial = "body"
+        @matcher       = "{spec/javascripts,app/assets}/**/*_spec.{js,js.coffee,coffee}"
+        @helper        = "spec_helper"
+        @javascripts   = ["jasmine/1.3.1", "teaspoon-jasmine"]
+        @stylesheets   = ["teaspoon"]
 
-        @no_coverage  = [%r{/lib/ruby/gems/}, %r{/vendor/assets/}, %r{/support/}, %r{/(.+)_helper.}]
+        @boot_partial  = "boot"
+        @body_partial  = "body"
 
-        @hooks        = Hash.new{ |h, k| h[k] = [] }
+        @no_coverage   = [%r{/lib/ruby/gems/}, %r{/vendor/assets/}, %r{/support/}, %r{/(.+)_helper.}]
+        @hooks         = Hash.new { |h, k| h[k] = [] }
+        @expand_assets = true
 
         default = Teaspoon.configuration.suite_configs["default"]
-        self.instance_eval(&default[:block]) if default
+        instance_eval(&default[:block]) if default
         yield self if block_given?
       end
 
@@ -96,7 +92,9 @@ module Teaspoon
         version ||= FRAMEWORKS[name].last if FRAMEWORKS[name]
         unless FRAMEWORKS[name] && FRAMEWORKS[name].include?(version)
           message = "Unknown framework \"#{name}\""
-          message += " with version #{version} -- available versions #{FRAMEWORKS[name].join(", ")}" if FRAMEWORKS[name] && version
+          if FRAMEWORKS[name] && version
+            message += " with version #{version} -- available versions #{FRAMEWORKS[name].join(', ')}"
+          end
           raise Teaspoon::UnknownFramework, message
         end
 
@@ -105,7 +103,6 @@ module Teaspoon
         when :qunit
           @matcher = "{test/javascripts,app/assets}/**/*_test.{js,js.coffee,coffee}"
           @helper  = "test_helper"
-        else
         end
       end
       alias_method :use_framework=, :use_framework
@@ -118,15 +115,15 @@ module Teaspoon
     # coverage configurations
 
     cattr_accessor :coverage_configs
-    @@coverage_configs = {"default" => {block: proc{}}}
+    @@coverage_configs = { "default" => { block: proc {} } }
 
     def self.coverage(name = :default, &block)
-      @@coverage_configs[name.to_s] = {block: block, instance: Coverage.new(&block)}
+      @@coverage_configs[name.to_s] = { block: block, instance: Coverage.new(&block) }
     end
 
     class Coverage
-      attr_accessor   :reports, :output_path,
-                      :statements, :functions, :branches, :lines
+      attr_accessor :reports, :output_path,
+                    :statements, :functions, :branches, :lines
 
       def initialize
         @reports      = ["text-summary"]
@@ -138,7 +135,7 @@ module Teaspoon
         @lines        = nil
 
         default = Teaspoon.configuration.coverage_configs["default"]
-        self.instance_eval(&default[:block]) if default
+        instance_eval(&default[:block]) if default
         yield self if block_given?
       end
     end

data/lib/teaspoon/configuration.rb.orig

@@ -0,0 +1,187 @@
+require "singleton"
+
+module Teaspoon
+  autoload :Formatters, "teaspoon/formatters/base"
+  autoload :Drivers,    "teaspoon/drivers/base"
+
+  class Configuration
+    include Singleton
+
+    # CONTRIBUTORS:
+    # If you add a configuration option you should do the following before it will be considered for merging.
+    # - think about if it should be a suite, coverage, or global configuration
+    # - write specs for it, and add it to existing specs in spec/teaspoon/configuration_spec.rb
+    # - add it to the readme so it's documented
+    # - add it to the command_line.rb if appropriate (_only_ if it's appropriate)
+    # - add it to ENV_OVERRIDES if it can be overridden from ENV
+    # - add it to the initializers in /lib/generators/install/templates so it's documented there as well
+
+    cattr_accessor :mount_at, :root, :asset_paths, :fixture_paths
+    @@mount_at       = "/teaspoon"
+    @@root           = nil # will default to Rails.root
+    @@asset_paths    = ["spec/javascripts", "spec/javascripts/stylesheets", "test/javascripts", "test/javascripts/stylesheets"]
+    @@fixture_paths  = ["spec/javascripts/fixtures", "test/javascripts/fixtures"]
+
+    # console runner specific
+
+    cattr_accessor :driver, :driver_options, :driver_timeout, :server, :server_port, :server_timeout, :fail_fast,
+                   :formatters, :color, :suppress_log,
+                   :use_coverage
+    @@driver         = "phantomjs"
+    @@driver_options = nil
+    @@driver_timeout = 180
+    @@server         = nil
+    @@server_port    = nil
+    @@server_timeout = 20
+    @@fail_fast      = true
+
+    @@formatters     = ["dot"]
+    @@color          = true
+    @@suppress_log   = false
+
+    @@use_coverage   = nil
+
+    # options that can be specified in the ENV
+
+    ENV_OVERRIDES = {
+      boolean: %w(FAIL_FAST SUPPRESS_LOG COLOR),
+      integer: %w(DRIVER_TIMEOUT SERVER_TIMEOUT),
+      string:  %w(DRIVER DRIVER_OPTIONS SERVER SERVER_PORT FORMATTERS USE_COVERAGE)
+    }
+
+    # suite configurations
+
+    cattr_accessor :suite_configs
+    @@suite_configs = { "default" => { block: proc {} } }
+
+    def self.suite(name = :default, &block)
+      @@suite_configs[name.to_s] = { block: block, instance: Suite.new(&block) }
+    end
+
+    class Suite
+      FRAMEWORKS = {
+        jasmine: ["1.3.1", "2.0.0"],
+        mocha: ["1.10.0", "1.17.1"],
+        qunit: ["1.12.0", "1.14.0"],
+      }
+
+      attr_accessor   :matcher, :helper, :javascripts, :stylesheets,
+                      :boot_partial, :body_partial, :no_coverage, :hooks,
+                      :expand_assets
+
+      def initialize
+        @matcher       = "{spec/javascripts,app/assets}/**/*_spec.{js,js.coffee,coffee}"
+        @helper        = "spec_helper"
+        @javascripts   = ["jasmine/1.3.1", "teaspoon-jasmine"]
+        @stylesheets   = ["teaspoon"]
+
+        @boot_partial  = "boot"
+        @body_partial  = "body"
+
+        @no_coverage   = [%r{/lib/ruby/gems/}, %r{/vendor/assets/}, %r{/support/}, %r{/(.+)_helper.}]
+
+<<<<<<< Updated upstream
+        @hooks        = Hash.new { |h, k| h[k] = [] }
+=======
+        @hooks         = Hash.new{ |h, k| h[k] = [] }
+        @expand_assets = true
+>>>>>>> Stashed changes
+
+        default = Teaspoon.configuration.suite_configs["default"]
+        instance_eval(&default[:block]) if default
+        yield self if block_given?
+      end
+
+      def use_framework(name, version = nil)
+        name = name.to_sym
+        version ||= FRAMEWORKS[name].last if FRAMEWORKS[name]
+        unless FRAMEWORKS[name] && FRAMEWORKS[name].include?(version)
+          message = "Unknown framework \"#{name}\""
+          if FRAMEWORKS[name] && version
+            message += " with version #{version} -- available versions #{FRAMEWORKS[name].join(', ')}"
+          end
+          raise Teaspoon::UnknownFramework, message
+        end
+
+        @javascripts = [[name, version].join("/"), "teaspoon-#{name}"]
+        case name.to_sym
+        when :qunit
+          @matcher = "{test/javascripts,app/assets}/**/*_test.{js,js.coffee,coffee}"
+          @helper  = "test_helper"
+        end
+      end
+      alias_method :use_framework=, :use_framework
+
+      def hook(group = :default, &block)
+        @hooks[group.to_s] << block
+      end
+    end
+
+    # coverage configurations
+
+    cattr_accessor :coverage_configs
+    @@coverage_configs = { "default" => { block: proc {} } }
+
+    def self.coverage(name = :default, &block)
+      @@coverage_configs[name.to_s] = { block: block, instance: Coverage.new(&block) }
+    end
+
+    class Coverage
+      attr_accessor :reports, :output_path,
+                    :statements, :functions, :branches, :lines
+
+      def initialize
+        @reports      = ["text-summary"]
+        @output_path  = "coverage"
+
+        @statements   = nil
+        @functions    = nil
+        @branches     = nil
+        @lines        = nil
+
+        default = Teaspoon.configuration.coverage_configs["default"]
+        instance_eval(&default[:block]) if default
+        yield self if block_given?
+      end
+    end
+
+    # custom getters / setters
+
+    def self.root=(path)
+      @@root = Pathname.new(path.to_s) if path.present?
+    end
+
+    def self.formatters
+      return ["dot"] if @@formatters.blank?
+      return @@formatters if @@formatters.is_a?(Array)
+      @@formatters.to_s.split(/,\s?/)
+    end
+
+    # override from env or options
+
+    def self.override_from_options(options)
+      options.each { |k, v| override(k, v) }
+    end
+
+    def self.override_from_env(env)
+      ENV_OVERRIDES[:boolean].each { |o| override(o, env[o] == "true") if env[o].present? }
+      ENV_OVERRIDES[:integer].each { |o| override(o, env[o].to_i) if env[o].present? }
+      ENV_OVERRIDES[:string].each  { |o| override(o, env[o]) if env[o].present? }
+    end
+
+    def self.override(config, value)
+      setter = "#{config.to_s.downcase}="
+      send(setter, value) if respond_to?(setter)
+    end
+  end
+
+  mattr_accessor :configured, :configuration
+  @@configured = false
+  @@configuration = Configuration
+
+  def self.configure
+    yield @@configuration
+    @@configured = true
+    @@configuration.override_from_env(ENV)
+  end
+end