teaspoon 1.1.3 → 1.2.2

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

data/lib/teaspoon/formatter/dot.rb

@@ -8,20 +8,20 @@ module Teaspoon
 
       protected
 
-      def log_spec(result)
-        return log_str(".", GREEN) if result.passing?
-        return log_str("*", YELLOW) if result.pending?
-        log_str("F", RED)
-      end
+        def log_spec(result)
+          return log_str(".", GREEN) if result.passing?
+          return log_str("*", YELLOW) if result.pending?
+          log_str("F", RED)
+        end
 
-      def log_console(message)
-        log_str(message)
-      end
+        def log_console(message)
+          log_str(message)
+        end
 
-      def log_result(result)
-        log_line("\n")
-        super
-      end
+        def log_result(result)
+          log_line("\n")
+          super
+        end
     end
   end
 end

data/lib/teaspoon/formatter/json.rb

@@ -5,33 +5,33 @@ module Teaspoon
     class Json < Base
       protected
 
-      def log_runner(result)
-        log_result(result)
-      end
+        def log_runner(result)
+          log_result(result)
+        end
 
-      def log_suite(result)
-        log_result(result)
-      end
+        def log_suite(result)
+          log_result(result)
+        end
 
-      def log_spec(result)
-        log_result(result)
-      end
+        def log_spec(result)
+          log_result(result)
+        end
 
-      def log_error(result)
-        log_result(result)
-      end
+        def log_error(result)
+          log_result(result)
+        end
 
-      def log_exception(result)
-        log_result(result)
-      end
+        def log_exception(result)
+          log_result(result)
+        end
 
-      def log_console(message)
-        log_line(%{{"type":"console","log":"#{message.gsub(/\n$/, '').gsub('\n', '\\n')}"}})
-      end
+        def log_console(message)
+          log_line(%{{"type":"console","log":"#{message.gsub(/\n$/, '').gsub('\n', '\\n')}"}})
+        end
 
-      def log_result(result)
-        log_str(result.original_json)
-      end
+        def log_result(result)
+          log_str(result.original_json)
+        end
     end
   end
 end

data/lib/teaspoon/formatter/junit.rb

@@ -6,74 +6,75 @@ module Teaspoon
     class Junit < Base
       protected
 
-      def log_runner(result)
-        log_line(%{<?xml version="1.0" encoding="UTF-8"?>})
-        log_line(%{<testsuites name="Teaspoon">})
-        log_line(%{<testsuite name="#{escape(@suite_name)}" tests="#{@total_count}" time="#{result.start}">})
-      end
+        def log_runner(result)
+          log_line(%{<?xml version="1.0" encoding="UTF-8"?>})
+          log_line(%{<testsuites name="Teaspoon">})
+          start_time = Time.parse(result.start).iso8601
+          log_line(%{<testsuite name="#{escape(@suite_name)}" tests="#{@total_count}" timestamp="#{start_time}">})
+        end
 
-      def log_suite(result)
-        log_end_suite
-        log_line(%{<testsuite name="#{escape(result.label)}">})
-      end
+        def log_suite(result)
+          log_end_suite
+          log_line(%{<testsuite name="#{escape(result.label)}">})
+        end
 
-      def log_passing_spec(result)
-        log_junit_spec(suite: result.suite, label: result.label)
-      end
+        def log_passing_spec(result)
+          log_junit_spec(suite: result.suite, label: result.label)
+        end
 
-      def log_pending_spec(result)
-        log_junit_spec(suite: result.suite, label: result.label) do
-          log_line(%{  <skipped/>})
+        def log_pending_spec(result)
+          log_junit_spec(suite: result.suite, label: result.label) do
+            log_line(%{  <skipped/>})
+          end
         end
-      end
 
-      def log_failing_spec(result)
-        log_junit_spec(suite: result.suite, label: result.label) do
-          log_line(%{  <failure type="AssertionFailed">#{cdata(result.message)}</failure>})
+        def log_failing_spec(result)
+          log_junit_spec(suite: result.suite, label: result.label) do
+            log_line(%{  <failure type="AssertionFailed">#{cdata(result.message)}</failure>})
+          end
         end
-      end
 
-      def log_result(_result)
-        log_end_suite
-      end
+        def log_result(_result)
+          log_end_suite
+        end
 
-      def log_coverage(message)
-        properties = "<properties>#{cdata(message)}</properties>"
-        log_line(%{<testsuite name="Coverage summary" tests="0">\n#{properties}\n</testsuite>})
-      end
+        def log_coverage(message)
+          properties = "<properties>#{cdata(message)}</properties>"
+          log_line(%{<testsuite name="Coverage summary" tests="0">\n#{properties}\n</testsuite>})
+        end
 
-      def log_threshold_failure(message)
-        log_line(%{<testsuite name="Coverage thresholds" tests="1">})
-        log_junit_spec(suite: "Coverage thresholds", label: "were not met") do
-          log_line(%{  <failure type="AssertionFailed">#{cdata(message)}</failure>})
+        def log_threshold_failure(message)
+          log_line(%{<testsuite name="Coverage thresholds" tests="1">})
+          log_junit_spec(suite: "Coverage thresholds", label: "were not met") do
+            log_line(%{  <failure type="AssertionFailed">#{cdata(message)}</failure>})
+          end
+          log_line(%{</testsuite>})
         end
-        log_line(%{</testsuite>})
-      end
 
-      def log_complete(_failure_count)
-        log_line(%{</testsuite>\n</testsuites>})
-      end
+        def log_complete(_failure_count)
+          log_line(%{</testsuite>\n</testsuites>})
+        end
 
       private
 
-      def log_end_suite
-        log_line(%{</testsuite>}) if @last_suite
-      end
+        def log_end_suite
+          log_line(%{</testsuite>}) if @last_suite
+        end
 
-      def log_junit_spec(opts, &_block)
-        log_line(%{<testcase classname="#{escape(opts[:suite])}" name="#{escape(opts[:label])}">})
-        yield if block_given?
-        log_line(%{<system-out>#{cdata(@stdout)}</system-out>}) unless @stdout.blank?
-        log_line(%{</testcase>})
-      end
+        def log_junit_spec(opts, &_block)
+          log_line(%{<testcase classname="#{escape(opts[:suite])}" name="#{escape(opts[:label])}">})
+          yield if block_given?
+          log_line(%{<system-out>#{cdata(@stdout)}</system-out>}) unless @stdout.blank?
+          log_line(%{</testcase>})
+        end
 
-      def escape(str)
-        CGI::escapeHTML(str)
-      end
+        def escape(str)
+          CGI.escapeHTML(str)
+        end
 
-      def cdata(str)
-        "\n<![CDATA[\n#{str.gsub(/\n$/, '')}\n]]>\n"
-      end
+        def cdata(str)
+          "\n<![CDATA[\n#{str.gsub(/\n$/, '')}\n]]>\n"
+        end
     end
   end
 end