teaspoon 0.9.1 → 1.0.0

data/lib/generators/teaspoon/install/templates/MISSING_FRAMEWORK

@@ -0,0 +1,14 @@
+******************************************************************************
+Error: There don't seem to be any frameworks registered within Teaspoon yet.
+
+Teaspoon has been split into separate gems so you can now include only the
+javascript frameworks you want.
+
+Add one or more of the following to your gemfile:
+
+  gem "teaspoon-jasmine"
+  gem "teaspoon-mocha"
+  gem "teaspoon-qunit"
+
+More information can be found at: https://github.com/modeset/teaspoon
+

data/lib/generators/teaspoon/install/templates/env.rb.tt

@@ -0,0 +1,14 @@
+Teaspoon.configure do |config|
+  config.mount_at = "/teaspoon"
+  config.root = nil
+  config.asset_paths = ["<%= framework.install_path %>/javascripts", "<%= framework.install_path %>/javascripts/stylesheets"]
+  config.fixture_paths = ["<%= framework.install_path %>/javascripts/fixtures"]
+
+  config.suite do |suite|
+    suite.use_framework :<%= framework.name %>, <%= version.inspect %> # <%= framework.versions.join(', ') %>
+    suite.matcher = <%= suite.matcher.inspect %>
+    suite.helper = <%= suite.helper.inspect %>
+    suite.boot_partial = <%= suite.boot_partial.inspect %>
+    suite.body_partial = <%= suite.body_partial.inspect %>
+  end
+end

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

@@ -1,27 +1,20 @@
-# Set RAILS_ROOT and load the environment if it's not already loaded.
-unless defined?(Rails)
-  ENV["RAILS_ROOT"] = File.expand_path("../../", __FILE__)
-  require File.expand_path("../../config/environment", __FILE__)
-end
-
 Teaspoon.configure do |config|
-
   # Determines where the Teaspoon routes will be mounted. Changing this to "/jasmine" would allow you to browse to
   # `http://localhost:3000/jasmine` to run your tests.
-  #config.mount_at = "/teaspoon"
+  config.mount_at = "/teaspoon"
 
   # Specifies the root where Teaspoon will look for files. If you're testing an engine using a dummy application it can
   # be useful to set this to your engines root (e.g. `Teaspoon::Engine.root`).
   # Note: Defaults to `Rails.root` if nil.
-  #config.root = nil
+  config.root = nil
 
   # Paths that will be appended to the Rails assets paths
   # Note: Relative to `config.root`.
-  #config.asset_paths = ["spec/javascripts", "spec/javascripts/stylesheets"]
+  config.asset_paths = ["<%= framework.install_path %>/javascripts", "<%= framework.install_path %>/javascripts/stylesheets"]
 
   # Fixtures are rendered through a controller, which allows using HAML, RABL/JBuilder, etc. Files in these paths will
   # be rendered as fixtures.
-  #config.fixture_paths = ["spec/javascripts/fixtures"]
+  config.fixture_paths = ["<%= framework.install_path %>/javascripts/fixtures"]
 
   # SUITES
   #
@@ -35,62 +28,52 @@ Teaspoon.configure do |config|
   # - with the rake task: rake teaspoon suite=[suite_name]
   # - with the cli: teaspoon --suite=[suite_name]
   config.suite do |suite|
-
     # Specify the framework you would like to use. This allows you to select versions, and will do some basic setup for
     # you -- which you can override with the directives below. This should be specified first, as it can override other
     # directives.
     # Note: If no version is specified, the latest is assumed.
     #
-    # Available: jasmine[1.3.1], mocha[1.10.0, 1.17.1] qunit[1.12.0, 1.14.0]
-    suite.use_framework :jasmine, "1.3.1"
+    # Versions: <%= framework.versions.join(', ') %>
+    suite.use_framework :<%= framework.name %>, <%= version.inspect %>
 
     # Specify a file matcher as a regular expression and all matching files will be loaded when the suite is run. These
     # files need to be within an asset path. You can add asset paths using the `config.asset_paths`.
-    #suite.matcher = "{spec/javascripts,app/assets}/**/*_spec.{js,js.coffee,coffee}"
-
-    # This suites spec helper, which can require additional support files. This file is loaded before any of your test
-    # files are loaded.
-    #suite.helper = "spec_helper"
+    suite.matcher = <%= suite.matcher.inspect %>
 
-    # The core Teaspoon javascripts. It's recommended to include only the base files here, as you can require support
-    # libraries from your spec helper.
-    # Note: For CoffeeScript files use `"teaspoon/jasmine"` etc.
-    #
-    # Available: teaspoon-jasmine, teaspoon-mocha, teaspoon-qunit
-    #suite.javascripts = ["jasmine/1.3.1", "teaspoon-jasmine"]
+    # Load additional JS files, but requiring them in your spec helper is the preferred way to do this.
+    #suite.javascripts = []
 
     # You can include your own stylesheets if you want to change how Teaspoon looks.
     # Note: Spec related CSS can and should be loaded using fixtures.
     #suite.stylesheets = ["teaspoon"]
 
+    # This suites spec helper, which can require additional support files. This file is loaded before any of your test
+    # files are loaded.
+    suite.helper = <%= suite.helper.inspect %>
+
     # Partial to be rendered in the head tag of the runner. You can use the provided ones or define your own by creating
     # a `_boot.html.erb` in your fixtures path, and adjust the config to `"/boot"` for instance.
     #
     # Available: boot, boot_require_js
-    #suite.boot_partial = "boot"
+    suite.boot_partial = <%= suite.boot_partial.inspect %>
 
     # Partial to be rendered in the body tag of the runner. You can define your own to create a custom body structure.
-    #suite.body_partial = "body"
-
-    # Assets to be ignored when generating coverage reports. Accepts an array of filenames or regular expressions. The
-    # default excludes assets from vendor, gems and support libraries.<br/><br/>
-    #suite.no_coverage = [%r{/lib/ruby/gems/}, %r{/vendor/assets/}, %r{/support/}, %r{/(.+)_helper.}]
+    suite.body_partial = <%= suite.body_partial.inspect %>
 
     # Hooks allow you to use `Teaspoon.hook("fixtures")` before, after, or during your spec run. This will make a
     # synchronous Ajax request to the server that will call all of the blocks you've defined for that hook name.
-    #suite.hook :fixtures, proc{ }
+    #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
-
+    #suite.expand_assets = true
   end
 
   # Example suite. Since we're just filtering to files already within the root test/javascripts, these files will also
   # be run in the default suite -- but can be focused into a more specific suite.
   #config.suite :targeted do |suite|
-  #  suite.matcher = "test/javascripts/targeted/*_test.{js,js.coffee,coffee}"
+  #  suite.matcher = "<%= framework.install_path %>/javascripts/targeted/*_spec.{js,js.coffee,coffee}"
   #end
 
   # CONSOLE RUNNER SPECIFIC
@@ -107,15 +90,17 @@ Teaspoon.configure do |config|
 
   # Specify which headless driver to use. Supports PhantomJS and Selenium Webdriver.
   #
-  # Available: phantomjs, selenium
+  # Available: <%= Teaspoon::Driver.available.keys.map{|f| ":#{f}"}.join(", ") %>
   # PhantomJS: https://github.com/modeset/teaspoon/wiki/Using-PhantomJS
   # Selenium Webdriver: https://github.com/modeset/teaspoon/wiki/Using-Selenium-WebDriver
-  #config.driver = "phantomjs"
+  # Capybara Webkit: https://github.com/modeset/teaspoon/wiki/Using-Capybara-Webkit
+  #config.driver = :<%= Teaspoon::Driver.default %>
 
   # Specify additional options for the driver.
   #
   # PhantomJS: https://github.com/modeset/teaspoon/wiki/Using-PhantomJS
   # Selenium Webdriver: https://github.com/modeset/teaspoon/wiki/Using-Selenium-WebDriver
+  # Capybara Webkit: https://github.com/modeset/teaspoon/wiki/Using-Capybara-Webkit
   #config.driver_options = nil
 
   # Specify the timeout for the driver. Specs are expected to complete within this time frame or the run will be
@@ -139,8 +124,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: <%= Teaspoon::Formatters.known_formatters.map(&:name).join ", " %>
-  #config.formatters = ["<%= Teaspoon::Formatters.known_formatters.select(&:default?).first.name %>"]
+  # Available: <%= Teaspoon::Formatter.available.keys.map{|f| ":#{f}"}.join(", ") %>
+  #config.formatters = [:<%= Teaspoon::Formatter.default %>]
 
   # Specify if you want color output from the formatters.
   #config.color = true
@@ -161,11 +146,15 @@ Teaspoon.configure do |config|
   # - with the rake task: rake teaspoon USE_COVERAGE=[coverage_name]
   # - with the cli: teaspoon --coverage=[coverage_name]
 
-  # Specify that you always want a coverage configuration to be used.
+  # Specify that you always want a coverage configuration to be used. Otherwise, specify that you want coverage
+  # on the CLI.
+  # Set this to "true" or the name of your coverage config.
   #config.use_coverage = nil
 
+  # You can have multiple coverage configs by passing a name to config.coverage.
+  # e.g. config.coverage :ci do |coverage|
+  # The default coverage config name is :default.
   config.coverage do |coverage|
-
     # Which coverage reports Istanbul should generate. Correlates directly to what Istanbul supports.
     #
     # Available: text-summary, text, html, lcov, lcovonly, cobertura, teamcity
@@ -175,13 +164,15 @@ Teaspoon.configure do |config|
     # Note: Relative to `config.root`.
     #coverage.output_path = "coverage"
 
+    # Assets to be ignored when generating coverage reports. Accepts an array of filenames or regular expressions. The
+    # default excludes assets from vendor, gems and support libraries.
+    #coverage.ignore = [%r{/lib/ruby/gems/}, %r{/vendor/assets/}, %r{/support/}, %r{/(.+)_helper.}]
+
     # 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.
     #coverage.statements = nil
     #coverage.functions = nil
     #coverage.branches = nil
     #coverage.lines = nil
-
   end
-
 end

data/lib/tasks/teaspoon/info.rake

@@ -0,0 +1,17 @@
+namespace :teaspoon do
+  desc "Print teaspoon and framework information"
+  task info: :environment do
+    STDOUT.print("Teaspoon: #{Teaspoon::VERSION}\n\n")
+
+    STDOUT.print("Frameworks:\n")
+
+    Teaspoon::Framework.available.each do |framework, _|
+      STDOUT.print("  #{framework}\n")
+
+      versions = Teaspoon::Framework.fetch(framework).versions
+      versions.each { |version| STDOUT.print("    #{version}\n") }
+
+      STDOUT.print("\n")
+    end
+  end
+end

data/lib/teaspoon-devkit.rb

@@ -0,0 +1,61 @@
+module Teaspoon
+  DEV_PATH = File.expand_path("../../", __FILE__)
+  SPEC_HELPER = File.join(DEV_PATH, "spec", "spec_helper")
+  FIXTURE_PATH = File.join(DEV_PATH, "spec", "javascripts", "fixtures")
+  RAKEFILE = File.join(DEV_PATH, "Rakefile")
+
+  def self.require_dummy!
+    unless defined?(Rails)
+      ENV["RAILS_ROOT"] = File.join(DEV_PATH, "spec", "dummy")
+      require File.join(ENV["RAILS_ROOT"], "config", "environment")
+    end
+  end
+
+  def self.loaded_from_teaspoon_root?
+    Dir.pwd == DEV_PATH
+  end
+
+  def self.load_teaspoon_tasks
+    if !loaded_from_teaspoon_root?
+      load File.join(RAKEFILE)
+    end
+  end
+
+  def self.setup_framework_tasks(framework:, framework_name:, framework_const:, framework_root:, compile_assets:)
+    extend Rake::DSL
+
+    namespace :teaspoon do
+      namespace framework do
+        desc "Run the #{framework_name} code examples"
+        RSpec::Core::RakeTask.new(:spec) do |t|
+          t.pattern = File.expand_path("spec/**/*_spec.rb", framework_root)
+        end
+      end
+
+      namespace framework do
+        desc "Builds Teaspoon #{framework_name} into the distribution ready bundle"
+        task build: "#{framework}:build:javascripts"
+
+        namespace :build do
+          desc "Compile Teaspoon #{framework_name} coffeescripts into javacripts"
+          task javascripts: :environment do
+            env = Rails.application.assets
+
+            Array(compile_assets).each do |filename|
+              asset = env.find_asset("teaspoon/#{filename}")
+              base_destination = framework_const.asset_paths.first
+              asset.write_to(File.expand_path("teaspoon-#{filename}", base_destination))
+            end
+          end
+        end
+      end
+    end
+
+    if !loaded_from_teaspoon_root?
+      Rake::Task["default"].prerequisites.clear
+      Rake::Task["default"].clear
+
+      task default: "teaspoon:#{framework}:spec"
+    end
+  end
+end

data/lib/teaspoon.rb

@@ -2,6 +2,8 @@ require "teaspoon/version"
 require "teaspoon/exceptions"
 require "teaspoon/utility"
 require "teaspoon/configuration"
+require "teaspoon/formatter"
+require "teaspoon/framework"
 
 require "teaspoon/engine" if defined?(Rails)
 

data/lib/teaspoon/command_line.rb

@@ -1,7 +1,9 @@
 require "optparse"
 require "teaspoon/version"
 require "teaspoon/exceptions"
-require "teaspoon/formatters/base"
+require "teaspoon/utility"
+require "teaspoon/driver"
+require "teaspoon/formatter"
 
 module Teaspoon
   class CommandLine
@@ -10,9 +12,9 @@ module Teaspoon
       @options[:files] = opt_parser.parse!
 
       require_console
-      abort if Teaspoon::Console.new(@options).failures?
+      Teaspoon.abort(nil, 1) if Teaspoon::Console.new(@options).failures?
     rescue Teaspoon::EnvironmentNotFound => e
-      abort("#{e.message}\nConsider using -r path/to/teaspoon_env\n")
+      Teaspoon.abort("#{e.message} Consider using --require=path/to/teaspoon_env.rb")
     end
 
     def opt_parser
@@ -40,9 +42,7 @@ module Teaspoon
 
       opt :driver, "-d", "--driver DRIVER",
           "Specify driver:",
-          "  phantomjs (default)",
-          "  selenium",
-          "  capybara_webkit"
+          *driver_details
 
       opt :driver_options, "--driver-options OPTIONS",
           "Specify driver-specific options to pass into the driver.",
@@ -90,7 +90,7 @@ module Teaspoon
 
       opt :formatters, "-f", "--format FORMATTERS",
           "Specify formatters (comma separated)",
-          *Teaspoon::Formatters.known_formatters.map(&:cli_help)
+          *formatter_details
     end
 
     def opts_for_coverage
@@ -104,13 +104,11 @@ module Teaspoon
       separator("Utility")
 
       @parser.on "-v", "--version", "Display the version." do
-        STDOUT.print("#{Teaspoon::VERSION}\n")
-        exit
+        Teaspoon.abort(Teaspoon::VERSION, 0)
       end
 
       @parser.on "-h", "--help", "You're looking at it." do
-        STDOUT.print("#{@parser}\n")
-        exit
+        Teaspoon.abort(@parser, 0)
       end
     end
 
@@ -128,9 +126,16 @@ module Teaspoon
       require "teaspoon/console"
     end
 
-    def abort(message = nil)
-      STDOUT.print(message) if message
-      exit(1)
+    def formatter_details
+      Teaspoon::Formatter.available.map do |name, options|
+        "  #{name}#{' (default)' if options[:default]} - #{options[:description]}"
+      end
+    end
+
+    def driver_details
+      Teaspoon::Driver.available.map do |name, options|
+        "  #{name}#{' (default)' if options[:default]}"
+      end
     end
   end
 end

data/lib/teaspoon/configuration.rb

@@ -1,9 +1,8 @@
 require "singleton"
+require "teaspoon/driver"
+require "teaspoon/formatter"
 
 module Teaspoon
-  autoload :Formatters, "teaspoon/formatters/base"
-  autoload :Drivers,    "teaspoon/drivers/base"
-
   class Configuration
     include Singleton
 
@@ -16,18 +15,20 @@ 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, :asset_manifest
     @@mount_at       = "/teaspoon"
     @@root           = nil # will default to Rails.root
-    @@asset_paths    = ["spec/javascripts", "spec/javascripts/stylesheets", "test/javascripts", "test/javascripts/stylesheets"]
+    @@asset_paths    = ["spec/javascripts", "spec/javascripts/stylesheets",
+                        "test/javascripts", "test/javascripts/stylesheets"]
     @@fixture_paths  = ["spec/javascripts/fixtures", "test/javascripts/fixtures"]
+    @@asset_manifest = ["teaspoon.css", "teaspoon-filterer.js", "teaspoon/*.js", "support/*.js"]
 
     # 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         = Teaspoon::Driver.default
     @@driver_options = nil
     @@driver_timeout = 180
     @@server         = nil
@@ -35,7 +36,7 @@ module Teaspoon
     @@server_timeout = 20
     @@fail_fast      = true
 
-    @@formatters     = ["dot"]
+    @@formatters     = [Teaspoon::Formatter.default]
     @@color          = true
     @@suppress_log   = false
 
@@ -55,55 +56,42 @@ module Teaspoon
     @@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(name, &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
+                    :hooks, :expand_assets
 
-      def initialize
+      def initialize(name = nil)
         @matcher       = "{spec/javascripts,app/assets}/**/*_spec.{js,js.coffee,coffee}"
         @helper        = "spec_helper"
-        @javascripts   = ["jasmine/1.3.1", "teaspoon-jasmine"]
+        @javascripts   = []
         @stylesheets   = ["teaspoon"]
 
         @boot_partial  = "boot"
         @body_partial  = "body"
 
-        @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"]
         instance_eval(&default[:block]) if default
-        yield self if block_given?
+        if block_given?
+          yield self
+          raise Teaspoon::UnspecifiedFramework.new(name: name) if @javascripts.length == 0
+        end
       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
+        framework = Teaspoon::Framework.fetch(name)
+        framework.modify_config(self)
 
-        @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
+        @javascripts = framework.javascripts_for(version)
+        return if @javascripts
+
+        raise Teaspoon::UnknownFrameworkVersion.new(name: name, version: version)
       end
       alias_method :use_framework=, :use_framework
 
@@ -122,12 +110,13 @@ module Teaspoon
     end
 
     class Coverage
-      attr_accessor :reports, :output_path,
+      attr_accessor :reports, :output_path, :ignore,
                     :statements, :functions, :branches, :lines
 
       def initialize
         @reports      = ["text-summary"]
         @output_path  = "coverage"
+        @ignore       = [%r{/.rvm/gems/}, %r{/lib/ruby/gems/}, %r{/vendor/assets/}, %r{/support/}, %r{/(.+)_helper.}]
 
         @statements   = nil
         @functions    = nil