teaspoon 1.1.5 → 1.2.0

data/lib/teaspoon/driver/selenium.rb

@@ -23,7 +23,10 @@ module Teaspoon
       end
 
       def run_specs(runner, url)
-        driver = ::Selenium::WebDriver.for(driver_options[:client_driver])
+        driver = ::Selenium::WebDriver.for(
+          driver_options[:client_driver],
+          **driver_options[:selenium_options].to_hash.to_options
+        )
         driver.navigate.to(url)
 
         ::Selenium::WebDriver::Wait.new(driver_options).until do
@@ -39,14 +42,15 @@ module Teaspoon
 
       protected
 
-      def driver_options
-        @driver_options ||= HashWithIndifferentAccess.new(
-          client_driver: :firefox,
-          timeout: Teaspoon.configuration.driver_timeout.to_i,
-          interval: 0.01,
-          message: "Timed out"
-        ).merge(@options)
-      end
+        def driver_options
+          @driver_options ||= HashWithIndifferentAccess.new(
+            client_driver: :firefox,
+            timeout: Teaspoon.configuration.driver_timeout.to_i,
+            interval: 0.01,
+            message: "Timed out",
+            selenium_options: {}
+          ).merge(@options)
+        end
     end
   end
 end

data/lib/teaspoon/engine.rb

@@ -82,32 +82,32 @@ module Teaspoon
 
       private
 
-      def self.using_phantomjs?
-        Teaspoon::Driver.matches?(Teaspoon.configuration.driver, :phantomjs)
-      end
+        def self.using_phantomjs?
+          Teaspoon::Driver.matches?(Teaspoon.configuration.driver, :phantomjs)
+        end
 
-      def self.render_exceptions_with_javascript
-        ActionDispatch::DebugExceptions.class_eval do
-          def render_exception(_env, exception)
-            message = "#{exception.class.name}: #{exception.message}"
-            body = "<script>throw Error(#{[message, exception.backtrace].join("\n").inspect})</script>"
-            [200, { "Content-Type" => "text/html;", "Content-Length" => body.bytesize.to_s }, [body]]
+        def self.render_exceptions_with_javascript
+          ActionDispatch::DebugExceptions.class_eval do
+            def render_exception(_env, exception)
+              message = "#{exception.class.name}: #{exception.message}"
+              body = "<script>throw Error(#{[message, exception.backtrace].join("\n").inspect})</script>"
+              [200, { "Content-Type" => "text/html;", "Content-Length" => body.bytesize.to_s }, [body]]
+            end
           end
         end
-      end
     end
   end
 end
 
 begin
-  require 'action_view'
-  if ActionView::VERSION::STRING >= '4.2.5'
-    require 'action_view/helpers/asset_tag_helper'
+  require "action_view"
+  if ActionView.gem_version >= Gem::Version.new("4.2.5")
+    require "action_view/helpers/asset_tag_helper"
     module ActionView::Helpers::AssetTagHelper
       def javascript_include_tag(*sources)
         options = sources.extract_options!.stringify_keys
-        path_options = options.extract!('protocol', 'extname', 'host').symbolize_keys
-        path_options[:debug] = options['allow_non_precompiled']
+        path_options = options.extract!("protocol", "extname", "host").symbolize_keys
+        path_options[:debug] = options["allow_non_precompiled"]
         sources.uniq.map { |source|
           tag_options = {
             "src" => path_to_javascript(source, path_options)
@@ -119,3 +119,14 @@ begin
   end
 rescue
 end
+
+# Some Sprockets patches to work with Sprockets 2.x
+unless Sprockets::Asset.public_method_defined?(:filename)
+  module Sprockets
+    class Asset
+      def filename
+        pathname.to_s
+      end
+    end
+  end
+end

data/lib/teaspoon/environment.rb

@@ -26,41 +26,41 @@ module Teaspoon
 
     private
 
-    def self.find_env(override = nil)
-      override ||= ENV["TEASPOON_ENV"]
-      env_files = override && !override.empty? ? [override] : standard_environments
+      def self.find_env(override = nil)
+        override ||= ENV["TEASPOON_ENV"]
+        env_files = override && !override.empty? ? [override] : standard_environments
 
-      env_files.each do |filename|
-        file = File.expand_path(filename, Dir.pwd)
-        ENV["TEASPOON_ENV"] = file if override
-        return file if File.exists?(file)
-      end
+        env_files.each do |filename|
+          file = File.expand_path(filename, Teaspoon.root)
+          ENV["TEASPOON_ENV"] = file if override
+          return file if File.exist?(file)
+        end
 
-      raise Teaspoon::EnvironmentNotFound.new(searched: env_files.join(", "))
-    end
+        raise Teaspoon::EnvironmentNotFound.new(searched: env_files.join(", "))
+      end
 
-    def self.standard_environments
-      ["spec/teaspoon_env.rb", "test/teaspoon_env.rb", "teaspoon_env.rb"]
-    end
+      def self.standard_environments
+        ["spec/teaspoon_env.rb", "test/teaspoon_env.rb", "teaspoon_env.rb"]
+      end
 
-    def self.require_env(file)
-      ::Kernel.load(file)
-    end
+      def self.require_env(file)
+        ::Kernel.load(file)
+      end
 
-    def self.rails_loaded?
-      !!defined?(Rails)
-    end
+      def self.rails_loaded?
+        !!defined?(Rails)
+      end
 
-    def self.load_rails
-      rails_env = ENV["TEASPOON_RAILS_ENV"] || File.expand_path("config/environment.rb", Dir.pwd)
+      def self.load_rails
+        rails_env = ENV["TEASPOON_RAILS_ENV"] || File.expand_path("config/environment.rb", Teaspoon.root)
 
-      # Try to load rails, assume teaspoon_env will do it if the expected
-      # environment isn't found.
-      if File.exists?(rails_env)
-        require rails_env
-      else
-        require_environment
+        # Try to load rails, assume teaspoon_env will do it if the expected
+        # environment isn't found.
+        if File.exist?(rails_env)
+          require rails_env
+        else
+          require_environment
+        end
       end
-    end
   end
 end

data/lib/teaspoon/exceptions.rb

@@ -2,13 +2,13 @@ module Teaspoon
   class Error < StandardError
     protected
 
-    def build_message(msg_or_options)
-      if msg_or_options.is_a?(String)
-        msg_or_options
-      else
-        yield msg_or_options
+      def build_message(msg_or_options)
+        if msg_or_options.is_a?(String)
+          msg_or_options
+        else
+          yield msg_or_options
+        end
       end
-    end
   end
 
   class Failure < Teaspoon::Error
@@ -29,7 +29,7 @@ module Teaspoon
       super(build_message(msg_or_options) do |options|
         msg = "Unknown framework: expected \"#{options[:name]}\" to be a registered framework. Available frameworks are #{options[:available]}."
         if options[:available].blank?
-          msg += " Do you need to update your Gemfile to use the teaspoon-#{options[:name]} gem? If you are upgrading, please see https://github.com/modeset/teaspoon/blob/master/CHANGELOG.md"
+          msg + " Do you need to update your Gemfile to use the teaspoon-#{options[:name]} gem? If you are upgrading, please see https://github.com/jejacks0n/teaspoon/blob/master/CHANGELOG.md"
         end
       end)
     end

data/lib/teaspoon/exporter.rb

@@ -20,33 +20,33 @@ module Teaspoon
 
     private
 
-    def executable
-      return @executable if @executable
-      @executable = which("wget")
-      return @executable unless @executable.blank?
-      raise Teaspoon::MissingDependencyError.new("Unable to locate `wget` for exporter.")
-    end
+      def executable
+        return @executable if @executable
+        @executable = which("wget")
+        return @executable unless @executable.blank?
+        raise Teaspoon::MissingDependencyError.new("Unable to locate `wget` for exporter.")
+      end
 
-    def create_export(path)
-      Dir.chdir(path) do
-        update_relative_paths
-        cleanup_output
-        move_output
+      def create_export(path)
+        Dir.chdir(path) do
+          update_relative_paths
+          cleanup_output
+          move_output
+        end
       end
-    end
 
-    def update_relative_paths
-      html = File.read(".#{Teaspoon.configuration.mount_at}/#{@suite}.html")
-      File.write("index.html", html.gsub!('"../', '"'))
-    end
+      def update_relative_paths
+        html = File.read(".#{Teaspoon.configuration.mount_at}/#{@suite}.html")
+        File.write("index.html", html.gsub!('"../', '"'))
+      end
 
-    def cleanup_output
-      FileUtils.rm_r(Dir["{.#{Teaspoon.configuration.mount_at},robots.txt.html}"])
-    end
+      def cleanup_output
+        FileUtils.rm_r(Dir["{.#{Teaspoon.configuration.mount_at},robots.txt.html}"])
+      end
 
-    def move_output
-      FileUtils.mkdir_p(@output_path)
-      FileUtils.mv(Dir["*"], @output_path, force: true)
-    end
+      def move_output
+        FileUtils.mkdir_p(@output_path)
+        FileUtils.mv(Dir["*"], @output_path, force: true)
+      end
   end
 end

data/lib/teaspoon/formatter/base.rb

@@ -7,7 +7,7 @@ module Teaspoon
 
       def initialize(suite_name = :default, output_file = nil)
         @suite_name  = suite_name.to_s
-        @output_file = output_file
+        @output_file = parse_output_file(output_file)
         @stdout      = ""
         @suite       = nil
         @last_suite  = nil
@@ -86,74 +86,92 @@ module Teaspoon
 
       protected
 
-      def log_runner(_result); end
+        def log_runner(_result); end
 
-      def log_suite(_result); end
+        def log_suite(_result); end
 
-      def log_spec(result)
-        return log_passing_spec(result) if result.passing?
-        return log_pending_spec(result) if result.pending?
-        log_failing_spec(result)
-      end
+        def log_spec(result)
+          return log_passing_spec(result) if result.passing?
+          return log_pending_spec(result) if result.pending?
+          log_failing_spec(result)
+        end
 
-      def log_passing_spec(_result); end
+        def log_passing_spec(_result); end
 
-      def log_pending_spec(_result); end
+        def log_pending_spec(_result); end
 
-      def log_failing_spec(_result); end
+        def log_failing_spec(_result); end
 
-      def log_error(_result); end
+        def log_error(_result); end
 
-      def log_exception(_result); end
+        def log_exception(_result); end
 
-      def log_console(_message); end
+        def log_console(_message); end
 
-      def log_result(_result); end
+        def log_result(_result); end
 
-      def log_coverage(_message); end
+        def log_coverage(_message); end
 
-      def log_threshold_failure(_message); end
+        def log_threshold_failure(_message); end
 
-      def log_complete(_failure_count); end
+        def log_complete(_failure_count); end
 
       private
 
-      def log_str(str, color_code = nil)
-        return log_to_file(str, @output_file) if @output_file
-        STDOUT.print(color_code ? colorize(str, color_code) : str)
-      end
+        def log_str(str, color_code = nil)
+          return log_to_file(str, @output_file) if @output_file
+          STDOUT.print(color_code ? colorize(str, color_code) : str)
+        end
 
-      def log_line(str = "", color_code = nil)
-        return log_to_file("#{str}\n", @output_file) if @output_file
-        STDOUT.print("#{color_code ? colorize(str, color_code) : str}\n")
-      end
+        def log_line(str = "", color_code = nil)
+          return log_to_file("#{str}\n", @output_file) if @output_file
+          STDOUT.print("#{color_code ? colorize(str, color_code) : str}\n")
+        end
 
-      def log_to_file(str, output_file)
-        @_output_file = File.open(output_file, "a") { |f| f.write(str) }
-      rescue IOError => e
-        raise Teaspoon::FileWriteError.new(e.message)
-      end
+        def log_to_file(str, output_file)
+          @_output_file = File.open(output_file, "a") { |f| f.write(str) }
+        rescue IOError => e
+          raise Teaspoon::FileWriteError.new(e.message)
+        end
 
-      def colorize(str, color_code)
-        return str unless Teaspoon.configuration.color || @output_file
-        "\e[#{color_code}m#{str}\e[0m"
-      end
+        def colorize(str, color_code)
+          return str unless Teaspoon.configuration.color || @output_file
+          "\e[#{color_code}m#{str}\e[0m"
+        end
 
-      def pluralize(str, value)
-        value == 1 ? "#{value} #{str}" : "#{value} #{str}s"
-      end
+        def pluralize(str, value)
+          value == 1 ? "#{value} #{str}" : "#{value} #{str}s"
+        end
+
+        def filename(file)
+          uri = URI(file)
 
-      def filename(file)
-        uri = URI(file)
+          params = String(uri.query).split("&").reject do |param|
+            RESERVED_PARAMS.include?(param.split("=").first)
+          end
 
-        params = String(uri.query).split("&").reject do |param|
-          RESERVED_PARAMS.include?(param.split("=").first)
+          filename = uri.path.sub(%r(^/assets/), "")
+          filename += "?#{params.join("&")}" if params.any?
+          filename
         end
 
-        filename = uri.path.sub(%r(^/assets/), "")
-        filename += "?#{params.join("&")}" if params.any?
-        filename
-      end
+        def parse_output_file(output)
+          return output unless output
+          output.gsub(/%{([^}]*)}/) { parse_output_capture($1) }
+        end
+
+        def parse_output_capture(cap)
+          case cap
+          when "suite_name"
+            @suite_name
+          when "date"
+            Time.now.to_i
+          else
+            warn ["Teaspoon::Formatter - Output File can only contain the placeholders %{suite_name} or %{date}.",
+                  "%{#{cap}} is not supported and will be ignored."].join("\n")
+            ""
+          end
+        end
     end
   end
 end

data/lib/teaspoon/formatter/clean.rb

@@ -5,8 +5,8 @@ module Teaspoon
     class Clean < Dot
       private
 
-      def log_failed_examples
-      end
+        def log_failed_examples
+        end
     end
   end
 end

data/lib/teaspoon/formatter/documentation.rb

@@ -8,54 +8,54 @@ module Teaspoon
 
       protected
 
-      def initialize(*args)
-        @level = 0
-        super
-      end
+        def initialize(*args)
+          @level = 0
+          super
+        end
 
-      def log_suite(result)
-        log_indent_line(result.label, result.level)
-        @level = result.level
-      end
+        def log_suite(result)
+          log_indent_line(result.label, result.level)
+          @level = result.level
+        end
 
-      def log_passing_spec(result)
-        log_indent_spec(result.label, GREEN)
-      end
+        def log_passing_spec(result)
+          log_indent_spec(result.label, GREEN)
+        end
 
-      def log_pending_spec(result)
-        log_indent_spec("#{result.label} (PENDING)", YELLOW)
-      end
+        def log_pending_spec(result)
+          log_indent_spec("#{result.label} (PENDING)", YELLOW)
+        end
 
-      def log_failing_spec(result)
-        log_indent_spec("#{result.label} (FAILED - #{@failures.length})", RED)
-      end
+        def log_failing_spec(result)
+          log_indent_spec("#{result.label} (FAILED - #{@failures.length})", RED)
+        end
 
-      def log_result(result)
-        log_line
-        super
-      end
+        def log_result(result)
+          log_line
+          super
+        end
 
       private
 
-      def log_indent_spec(str, color)
-        log_indent_line(str, level = (@last_suite ? @level + 1 : 0), color)
-        log_intent_stdout(level + 1)
-      end
-
-      def log_intent_stdout(level)
-        return if @stdout.blank?
-        log_indent_line("# #{@stdout.gsub(/\n$/, '').gsub("\n", "\n# ")}", level, CYAN)
-      end
-
-      def log_indent_line(str = "", level = nil, color = nil)
-        log_line(indent(str, level || @level), color)
-      end
-
-      def indent(str = "", level = nil)
-        indent = " " * (level * 2)
-        str.gsub!("\n", "\n#{indent}")
-        "#{indent}#{str}"
-      end
+        def log_indent_spec(str, color)
+          log_indent_line(str, level = (@last_suite ? @level + 1 : 0), color)
+          log_intent_stdout(level + 1)
+        end
+
+        def log_intent_stdout(level)
+          return if @stdout.blank?
+          log_indent_line("# #{@stdout.gsub(/\n$/, '').gsub("\n", "\n# ")}", level, CYAN)
+        end
+
+        def log_indent_line(str = "", level = nil, color = nil)
+          log_line(indent(str, level || @level), color)
+        end
+
+        def indent(str = "", level = nil)
+          indent = " " * (level * 2)
+          str.gsub!("\n", "\n#{indent}")
+          "#{indent}#{str}"
+        end
     end
   end
 end