teabag 0.4.6 → 0.5.0

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

@@ -0,0 +1,24 @@
+// You can require javascript files here. A good place to start is by requiring your application.js.
+// require application
+//
+// Teabag includes some support files, but you can use anything from your own support path too.
+// require support/sinon
+// require support/your-support-file
+//
+// Deferring execution
+// If you're using CommonJS, RequireJS or some other asynchronous library you can defer execution. Call Teabag.execute()
+// after everything has been loaded. Simple example of a timeout:
+//
+// Teabag.defer = true
+// setTimeout(Teabag.execute, 1000)
+//
+// Matching files
+// By default Teabag 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/teabag.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/teabag

data/lib/tasks/teabag.rake

@@ -1,5 +1,5 @@
 desc "Run the javascript specs"
 task :teabag => :environment do
   require "teabag/console"
-  fail if Teabag::Console.new(ENV["suite"]).execute
+  fail if Teabag::Console.new({suite: ENV["suite"]}).execute
 end

data/lib/teabag/command_line.rb

@@ -0,0 +1,96 @@
+require "optparse"
+require "teabag/version"
+
+module Teabag
+  class CommandLine
+
+    def initialize
+      @options = {}
+      @files = opt_parser.parse!
+
+      begin
+        require_console
+        abort if Teabag::Console.new(@options, @files).execute
+      rescue Teabag::EnvironmentNotFound => e
+        STDOUT.print "Unable to load Teabag environment in {#{Teabag::Environment.standard_environments.join(', ')}}.\n"
+        STDOUT.print "Consider using -r path/to/teabag_env\n"
+        abort
+      end
+    end
+
+    def opt_parser
+      OptionParser.new do |parser|
+        parser.banner = "Usage: teabag [options] [files]\n\n"
+
+        parser.on("-r", "--require FILE", "Require Teabag environment file.") do |file|
+          @options[:environment] = file
+        end
+
+        #parser.on("-O", "--options PATH", "Specify the path to a custom options file.") do |path|
+        #  @options[:custom_options_file] = path
+        #end
+
+        parser.on("-d", "--driver DRIVER", "Specify driver:",
+                  "  phantomjs (default)",
+                  "  selenium") do |driver|
+          @options[:driver] = driver
+        end
+
+        parser.on("--server-timeout SECONDS", "Sets the timeout for the server to start.") do |seconds|
+          @options[:server_timeout] = seconds
+        end
+
+        parser.on("--[no-]fail-fast", "Abort after the first failing suite.") do |o|
+          @options[:fail_fast] = o
+        end
+
+        parser.separator("\n  **** Filtering ****\n\n")
+
+        parser.on("-s", "--suite SUITE", "Focus to a specific suite.") do |suite|
+          @options[:suite] = suite
+        end
+
+        parser.on("-g", "--filter FILTER", "Filter tests matching a specific filter.") do |filter|
+          @options[:filter] = filter
+        end
+
+        parser.separator("\n  **** Output ****\n\n")
+
+        parser.on("-f", "--format FORMATTERS", "Specify formatters (comma separated)",
+                  "  dot (default)",
+                  "  tap_y",
+                  "  swayze_or_oprah") do |formatters|
+          @options[:formatters] = formatters
+        end
+
+        parser.on("-q", "--[no-]suppress-log", "Suppress logs coming from console[log/debug/error].") do |o|
+          @options[:suppress_log] = o
+        end
+
+        parser.on("-c", "--[no-]colour", "Enable/Disable color output.") do |o|
+          @options[:color] = o
+        end
+
+        parser.separator("\n  **** Utility ****\n\n")
+
+        parser.on("-v", "--version", "Display the version.") do
+          puts Teabag::VERSION
+          exit
+        end
+
+        parser.on("-h", "--help", "You're looking at it.") do
+          puts parser
+          exit
+        end
+      end
+    end
+
+    def require_console
+      require "teabag/console"
+    end
+
+    def abort
+      exit(1)
+    end
+  end
+end

data/lib/teabag/configuration.rb

@@ -5,41 +5,22 @@ module Teabag
 
     include Singleton
 
-    cattr_accessor :root,
-                   :mount_at,
-                   :asset_paths,
-                   :fixture_path,
-                   :driver,
-                   :formatters,
-                   :server_timeout,
-                   :fail_fast,
-                   :suppress_log,
-                   :phantomjs_bin,
-                   :suites
-
-    @@mount_at          = "/teabag"
-    @@root              = nil # will default to Rails.root if left unset
-    @@asset_paths       = ["spec/javascripts", "spec/javascripts/stylesheets", "test/javascripts", "test/javascripts/stylesheets"]
-    @@fixture_path      = "spec/javascripts/fixtures"
-    @@suites            = {}
+    cattr_accessor :mount_at, :root, :asset_paths, :fixture_path, :suites
+    @@mount_at       = "/teabag"
+    @@root           = nil # will default to Rails.root if left unset
+    @@asset_paths    = ["spec/javascripts", "spec/javascripts/stylesheets", "test/javascripts", "test/javascripts/stylesheets"]
+    @@fixture_path   = "spec/javascripts/fixtures"
+    @@suites         = {"default" => proc{}}
 
     # console runner specific
-    @@driver            = "phantomjs"
-    @@formatters        = "dot"
-    @@server_timeout    = 20
-    @@fail_fast         = true
-    @@suppress_log      = false
-    @@phantomjs_bin     = nil
-
-    def self.root=(path)
-      @@root = Pathname.new(path.to_s) if path.present?
-    end
-
-    def self.suite(name = :default, &block)
-      @@suites[name.to_s] = block
-    end
-
-    self.suite(:default) {}
+    cattr_accessor :driver, :phantomjs_bin, :server_timeout, :fail_fast, :formatters, :suppress_log, :color
+    @@driver         = "phantomjs"
+    @@phantomjs_bin  = nil
+    @@server_timeout = 20
+    @@fail_fast      = true
+    @@formatters     = "dot"
+    @@suppress_log   = false
+    @@color          = true
 
     class Suite
       attr_accessor :matcher, :helper, :stylesheets, :javascripts
@@ -53,6 +34,15 @@ module Teabag
         yield self if block_given?
       end
     end
+
+    def self.root=(path)
+      @@root = Pathname.new(path.to_s) if path.present?
+    end
+
+    def self.suite(name = :default, &block)
+      @@suites[name.to_s] = block
+    end
+
   end
 
   autoload :Formatters, "teabag/formatters/base_formatter"
@@ -69,11 +59,11 @@ module Teabag
   private
 
   def self.override_from_env
-    %w(FAIL_FAST SUPPRESS_LOG).each do |directive|
+    %w(FAIL_FAST SUPPRESS_LOG COLOR).each do |directive|
       next unless ENV[directive].present?
       @@configuration.send("#{directive.downcase}=", ENV[directive] == "true")
     end
-    %w(FORMATTERS DRIVER).each do |directive|
+    %w(DRIVER FORMATTERS SERVER_TIMEOUT PHANTOMJS_BIN).each do |directive|
       next unless ENV[directive].present?
       @@configuration.send("#{directive.downcase}=", ENV[directive])
     end

data/lib/teabag/console.rb

@@ -1,14 +1,19 @@
-require "teabag/server"
+require 'open-uri'
+require 'teabag/environment'
 
 module Teabag
   class Console
 
-    def initialize(suite_name = nil)
-      # force asset debugging off -- gives us nicer errors on missing files, bad coffeescript, etc
-      Rails.application.config.assets.debug = false
+    def initialize(options = nil, files = [])
+      @options = options || {}
+      @files = files
 
-      if suite_name
-        @suites = [suite_name]
+      Teabag::Environment.load(@options)
+      require "teabag/server"
+      Rails.application.config.assets.debug = false if Teabag.configuration.driver == 'phantomjs'
+
+      if @options[:suite].present?
+        @suites = [@options[:suite]]
       else
         @suites = Teabag.configuration.suites.keys
       end
@@ -44,8 +49,15 @@ module Teabag
       @driver ||= Teabag::Drivers.const_get("#{Teabag.configuration.driver.to_s.camelize}Driver").new
     end
 
+    def filter
+      parts = []
+      parts << "grep=#{URI::encode(@options[:filter])}" if @options[:filter].present?
+      @files.each { |file| parts << "file[]=#{URI::encode(file)}" }
+      "?#{parts.join('&')}"
+    end
+
     def url(suite)
-      ["#{@server.url}#{Teabag.configuration.mount_at}", suite].join("/")
+      ["#{@server.url}#{Teabag.configuration.mount_at}", suite, filter].join("/")
     end
   end
 end

data/lib/teabag/drivers/phantomjs/runner.coffee

@@ -24,7 +24,7 @@ class @Runner
 
 
   waitForResults: =>
-    @fail("Timed out") if (Date.now() - @start) >= @timeout
+    @fail("Timed out") if (new Date().getTime() - @start) >= @timeout
     finished = @page.evaluate(-> window.Teabag && window.Teabag.finished)
     if finished then @finish() else setTimeout(@waitForResults, 200)
 
@@ -50,7 +50,7 @@ class @Runner
 
 
     onLoadFinished: (status) =>
-      @start = Date.now()
+      @start = new Date().getTime()
       defined = @page.evaluate(-> window.Teabag)
       unless status == "success" && defined
         @fail("Failed to load: #{@url}")

data/lib/teabag/drivers/selenium_driver.rb

@@ -9,11 +9,11 @@ module Teabag
         runner = Teabag::Runner.new(suite)
 
         driver = Selenium::WebDriver.for(:firefox)
-        driver.navigate.to("#{url}?reporter=Console")
+        driver.navigate.to("#{url}&reporter=Console")
 
         Selenium::WebDriver::Wait.new(timeout: 180, interval: 0.01, message: "Timed out").until do
           done = driver.execute_script("return window.Teabag && window.Teabag.finished")
-          driver.execute_script("return Teabag.getMessages()").each do |line|
+          driver.execute_script("return window.Teabag && window.Teabag.getMessages() || []").each do |line|
             runner.process("#{line}\n")
           end
           done

data/lib/teabag/environment.rb

@@ -0,0 +1,46 @@
+require "teabag/exceptions"
+
+module Teabag
+  module Environment
+
+    def self.load(options = {})
+      unless rails_loaded?
+        require_environment(options[:environment])
+        raise "Rails environment not found." unless rails_loaded?
+      end
+
+      require "teabag"
+
+      configure_from_options(options)
+    end
+
+    def self.require_environment(override = nil)
+      return require_env(File.expand_path(override, Dir.pwd)) if override
+
+      standard_environments.each do |filename|
+        file = File.expand_path(filename, Dir.pwd)
+        return require_env(file) if File.exists?(file)
+      end
+
+      raise Teabag::EnvironmentNotFound
+    end
+
+    def self.standard_environments
+      ["spec/teabag_env.rb", "test/teabag_env.rb", "teabag_env.rb"]
+    end
+
+    def self.configure_from_options(options)
+      options.each do |key, value|
+        Teabag.configuration.send("#{key.downcase}=", value) if Teabag.configuration.respond_to?("#{key.downcase}=")
+      end
+    end
+
+    def self.require_env(file)
+      require(file)
+    end
+
+    def self.rails_loaded?
+      defined?(Rails)
+    end
+  end
+end

data/lib/teabag/exceptions.rb

@@ -3,4 +3,5 @@ module Teabag
   class UnknownSuite < Exception; end
   class RunnerException < Exception; end
   class AssetNotServable < Exception; end
+  class EnvironmentNotFound < Exception; end
 end

data/lib/teabag/formatters/base_formatter.rb

@@ -29,6 +29,11 @@ module Teabag
         end
       end
 
+      def result(results)
+        return if failures.size == 0
+        raise Teabag::Failure if Teabag.configuration.fail_fast
+      end
+
       # Exceptions come from startup errors in the server
       def exception(exception = {})
         raise Teabag::RunnerException

data/lib/teabag/formatters/dot_formatter.rb

@@ -34,6 +34,7 @@ module Teabag
         log_information
         log_stats(results)
         log_failed_examples
+        super
       end
 
       protected
@@ -72,10 +73,9 @@ module Teabag
         return if failures.size == 0
         log "\nFailed examples:\n"
         failures.each do |failure|
-          log "\n#{Teabag.configuration.mount_at}/#{@suite_name}#{failure.link}", RED
+          log "\nteabag -s #{@suite_name} --filter=\"#{failure.link}\"", RED
         end
         log "\n\n"
-        raise Teabag::Failure if Teabag.configuration.fail_fast
       end
 
       private
@@ -85,6 +85,7 @@ module Teabag
       end
 
       def colorize(str, color_code)
+        return str unless Teabag.configuration.color
         "\e[#{color_code}m#{str}\e[0m"
       end
 

data/lib/teabag/formatters/junit_formatter.rb

@@ -0,0 +1,19 @@
+require 'teabag/formatters/base_formatter'
+
+module Teabag
+  module Formatters
+    class JunitFormatter < BaseFormatter
+
+      def initialize
+        super
+        @builder = Builder::XmlMarkup.new
+        @builder.instruct! :xml, version: "1.0", :encoding=>"UTF-8"
+      end
+
+      def spec
+        @builder.person { |b| b.name("Jim"); b.phone("555-1234") }
+        puts @builder
+      end
+    end
+  end
+end

data/lib/teabag/formatters/swayze_or_oprah_formatter.rb

@@ -3,8 +3,13 @@ module Teabag
     class SwayzeOrOprahFormatter < BaseFormatter
 
       def result(results)
-        quote = QUOTES[Random.rand(QUOTES.size)]
-        STDOUT.print("\n#{quote.inspect} -- Oprah Winfrey or Patrick Swayze?\n")
+        if failures.size == 0
+          quote = QUOTES[Random.rand(QUOTES.size)]
+          STDOUT.print("\n#{quote.inspect} -- Oprah Winfrey or Patrick Swayze?\n")
+        else
+          STDOUT.print("\nNo quote for you.\n")
+        end
+        super
       end
 
       QUOTES = [

data/lib/teabag/formatters/tap_y_formatter.rb

@@ -38,6 +38,7 @@ module Teabag
               "omit"  => 0,
               "todo"  => @pendings.size
             }
+        super
       end
 
       def error(error)

data/lib/teabag/runner.rb

@@ -9,7 +9,7 @@ module Teabag
 
     def initialize(suite_name = :default)
       @suite_name = suite_name
-      @formatters = Teabag.configuration.formatters.split(/,\s+/).map{ |f| resolve_formatter(f).new(suite_name) }
+      @formatters = Teabag.configuration.formatters.split(/,\s?/).map{ |f| resolve_formatter(f).new(suite_name) }
       @failure_count = 0
     end