turnip_formatter 0.2.11 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f797fdd3e324fcc850739157c99e215f89d78768
-  data.tar.gz: b94ada02b2acbfad137e314c1986adaa075caaab
+  metadata.gz: 29acbac39ffbed20aa935ee2325695f68b9348b7
+  data.tar.gz: 71a9a4eda76d0420a31bd6dab1dbd142b6a3b039
 SHA512:
-  metadata.gz: e6ee2cd266e8d3dd14180b3d11cd4fd0631733236cd92f3833dd43d186ec216d292a16cfce55e281df95a5b95b4526feae511518e57dfc3ab2c209f242cc9166
-  data.tar.gz: f32b416e146f53f70f5c993a9959ad0a72495845b1b6b68b03710333336856c3bf155c9e9ef4814dd74fd5c2249d9c36835e9b70664df0e5d74702e8933cb74d
+  metadata.gz: 561db6c050c5ad0432f528bdaefe8a46af59e5f1e382b7816a81bd0bc10f688eba031072b4799434c1c3ac36e1c02f7a795cfd7bd40f1e8e6335fa4e33c4bfa7
+  data.tar.gz: 98b1d901dcb4d3a3f42654d505f50962b7f88d96d4cbe65ae006e4ea7bdeb739b2fce7a3750d4f00d7858c3f024589de3bb9394c0abd2fe2a6205b11d05434fd

data/.travis.yml

@@ -3,4 +3,6 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.0
+  - 2.1.2
+  - jruby-1.7.10
 script: bundle exec rspec

data/README.md

@@ -14,6 +14,7 @@ Requirements
 * Ruby
     * `~> 1.9.3`
     * `~> 2.0.0`
+    * `~> 2.1.0`
 
 Installation
 --------------------
@@ -44,34 +45,29 @@ Run this command.
     $ rspec -r turnip_formatter --format RSpecTurnipFormatter --out report.html
 
 
-Screenshot
+Example
 --------------------
 
-### Step overview
-
-![Tab steps](https://github.com/gongo/turnip_formatter/raw/master/images/tab_steps.png)
-
-expand:
-
-![Expand tab steps](https://github.com/gongo/turnip_formatter/raw/master/images/tab_steps_expanding.png)
-
-### Speed Statistics
-
-![Expand tab steps](https://github.com/gongo/turnip_formatter/raw/master/images/tab_speed_statistics.png)
-
-### Feature Statistics
-
-![Expand tab steps](https://github.com/gongo/turnip_formatter/raw/master/images/tab_feature_statistics.png)
+See:
 
-### Tag Statistics
+- Feature and Steps
+    - https://github.com/gongo/turnip_formatter/tree/master/example
+- Report
+    - http://gongo.github.io/turnip_formatter/examples/report.html
 
-![Expand tab steps](https://github.com/gongo/turnip_formatter/raw/master/images/tab_tag_statistics.png)
-
-
-Example
+Configuration
 --------------------
 
-see https://github.com/gongo/turnip_formatter/tree/master/example
+```ruby
+TurnipFormatter.configure do |config|
+  config.title = 'My Report'                                 # <h1>My Report</h1>
+  config.add_stylesheet File.dirname(__FILE__) + '/foo.css'  # <style>..</style>
+  config.add_javascript File.dirname(__FILE__) + '/bar.js'   # <script>..</script>
+
+  config.add_stylesheet 'http://cdn.example.com/hoge.css'    # <link rel="..">
+  config.add_javascript '//cdn.example.com/fuga.js'          # <script src="..">
+end
+```
 
 Add-on
 --------------------

data/example/README.md

@@ -20,7 +20,7 @@ Scenario: normal monster
     And Fanfare
 ```
 
-![Basic step](https://github.com/gongo/turnip_formatter/raw/master/example/images/basic_step.png)
+![Basic step](./images/basic_step.png)
 
 ### Failed step
 
@@ -36,7 +36,7 @@ Scenario: strong monster
     And Fanfare
 ```
 
-![Failed step](https://github.com/gongo/turnip_formatter/raw/master/example/images/failed_step.png)
+![Failed step](./images/failed_step.png)
 
 ### Pending step and specify tag
 
@@ -61,9 +61,7 @@ Scenario: strong monster
       And Fanfare
 ```
 
-![Pending step](https://github.com/gongo/turnip_formatter/raw/master/example/images/pending_step.png)
-
-![Tag step](https://github.com/gongo/turnip_formatter/raw/master/example/images/tag_step.png)
+![Pending step](./images/pending_step.png)
 
 ### Background
 
@@ -86,7 +84,7 @@ Feature: Battle a monster with weapon
       And Fanfare
 ```
 
-![Background step](https://github.com/gongo/turnip_formatter/raw/master/example/images/background.png)
+![Background step](./images/background.png)
 
 ### Outline
 
@@ -109,7 +107,7 @@ Feature: Battle monsters
      Then I could not escape
 ```
 
-![outline](https://github.com/gongo/turnip_formatter/raw/master/example/images/outline.png)
+![outline](./images/outline.png)
 
 ### Multiline
 
@@ -124,4 +122,4 @@ Feature: A feature with multiline strings
     Then the song should have 2 lines
 ```
 
-![Multiline](https://github.com/gongo/turnip_formatter/raw/master/example/images/multiline.png)
+![Multiline](./images/multiline.png)

data/example/spec/bar.js

@@ -0,0 +1 @@
+alert('a');

data/example/spec/foo.css

@@ -0,0 +1,3 @@
+h1 {
+    color: red;
+}

data/example/spec/spec_helper.rb

@@ -1,8 +1,13 @@
 require 'turnip_formatter'
 
 RSpec.configure do |config|
-  config.project_name = "My project"
   config.add_formatter RSpecTurnipFormatter, 'report.html'
 end
 
-Dir.glob(File.dirname(__FILE__) + "/steps/**/*steps.rb") { |f| load f, true }
+Dir.glob(File.dirname(__FILE__) + '/steps/**/*steps.rb') { |f| load f, true }
+
+# TurnipFormatter.configure do |config|
+#   config.title = 'My Report'
+#   config.add_stylesheet File.dirname(__FILE__) + '/foo.css'
+#   config.add_javascript File.dirname(__FILE__) + '/bar.js'
+# end

data/lib/rspec/core/formatters/turnip_formatter.rb

@@ -5,50 +5,63 @@ require 'turnip_formatter/scenario/pass'
 require 'turnip_formatter/scenario/failure'
 require 'turnip_formatter/scenario/pending'
 require 'turnip_formatter/printer/index'
+require 'turnip_formatter/printer/scenario'
 
 module RSpec
   module Core
     module Formatters
       class TurnipFormatter < BaseFormatter
-        attr_reader :passed_scenarios, :failed_scenarios, :pending_scenarios
-        attr_reader :scenarios
+        attr_reader :scenarios, :scenario_output_files
+
+        SCENARIO_TEMPORARY_OUTPUT_DIR = File.expand_path('./turnip_tmp')
 
         def initialize(output)
           super(output)
-          @passed_scenarios  = []
-          @failed_scenarios  = []
-          @pending_scenarios = []
           @scenarios = []
+          @scenario_output_files = []
+
+          FileUtils.mkdir_p(SCENARIO_TEMPORARY_OUTPUT_DIR)
         end
 
         def dump_summary(duration, example_count, failure_count, pending_count)
-          super(duration, example_count, failure_count, pending_count)
-          output.puts ::TurnipFormatter::Printer::Index.print_out(self)
+          print_params = {
+            scenarios:      scenarios,
+            failed_count:   failure_count,
+            pending_count:  pending_count,
+            total_time:     duration,
+            scenario_files: scenario_output_files
+          }
+          output.puts ::TurnipFormatter::Printer::Index.print_out(print_params)
+          FileUtils.rm_rf(SCENARIO_TEMPORARY_OUTPUT_DIR)
         end
 
         def example_passed(example)
-          super(example)
-
           scenario = ::TurnipFormatter::Scenario::Pass.new(example)
-          @passed_scenarios << scenario
-          @scenarios << scenario
+          output_scenario(scenario)
         end
 
         def example_pending(example)
-          super(example)
-
           scenario = ::TurnipFormatter::Scenario::Pending.new(example)
-          @pending_scenarios << scenario
-          @scenarios << scenario
+          output_scenario(scenario)
         end
 
         def example_failed(example)
-          super(example)
-
           scenario = ::TurnipFormatter::Scenario::Failure.new(example)
-          @failed_scenarios << scenario
-          @scenarios << scenario
+          output_scenario(scenario)
         end
+
+        private
+
+          def output_scenario(scenario)
+            filepath = SCENARIO_TEMPORARY_OUTPUT_DIR + "/#{scenario.id}.html"
+
+            File.open(filepath, 'w') do |io|
+              io.puts ::TurnipFormatter::Printer::Scenario.print_out(scenario)
+            end
+
+            @scenario_output_files << filepath
+            @scenarios << scenario
+          end
       end
     end
   end

data/lib/turnip_formatter/printer/index.rb

@@ -10,16 +10,13 @@ module TurnipFormatter
       class << self
         include TurnipFormatter::Printer
 
-        #
-        # @param  RSpec::Core::Formatters::TurnipFormatter  formatter
-        #
-        def print_out(formatter)
+        def print_out(params)
           render_template(:index, {
-              scenarios:        formatter.scenarios,
-              passed_scenarios: formatter.passed_scenarios,
-              failed_count:     formatter.failure_count,
-              pending_count:    formatter.pending_count,
-              total_time:       formatter.duration,
+              scenarios:        params[:scenarios],
+              failed_count:     params[:failed_count],
+              pending_count:    params[:pending_count],
+              total_time:       params[:total_time],
+              scenario_files:   params[:scenario_files]
             }
           )
         end

data/lib/turnip_formatter/printer/scenario.rb

@@ -9,8 +9,10 @@ module TurnipFormatter
         include TurnipFormatter::Printer
 
         def print_out(scenario)
-          scenario.validation
-          render_template(:scenario, scenario: scenario)
+          #
+          # TODO output for scenario.valid? == false
+          #
+          render_template(:scenario, scenario: scenario) if scenario.valid?
         rescue => e
           TurnipFormatter::Printer::RuntimeError.print_out(scenario.example, e)
         end

data/lib/turnip_formatter/printer/step.rb

@@ -8,24 +8,26 @@ module TurnipFormatter
         include TurnipFormatter::Printer
 
         def print_out(step)
-          render_template(:step, { step: step, step_docs: documents(step.docs) })
+          step_templates = TurnipFormatter.step_templates_for(step.status)
+
+          render_template(:step,
+            {
+              step: step,
+              has_args_or_documents: has_args_or_documents?(step, step_templates),
+              step_docs: documents(step, step_templates)
+            }
+          )
         end
 
         private
 
-        def documents(docs)
-          docs.map do |style, template|
-            if style == :extra_args
-              TurnipFormatter::Printer::StepExtraArgs.print_out(template[:value])
-            else
-              #
-              # Template class which is registered in
-              #    +Step::Failure.add_template+
-              #    +Step::Pending.add_template+
-              # be called.
-              #
-              template[:klass].build(template[:value])
-            end
+        def has_args_or_documents?(step, templates)
+          (step.extra_args.length + templates.length) > 0
+        end
+
+        def documents(step, templates)
+          templates.map do |template, method|
+            template.send(method, step.example)
           end.join("\n")
         end
       end

data/lib/turnip_formatter/printer/step_extra_args.rb

@@ -7,6 +7,8 @@ module TurnipFormatter
         include TurnipFormatter::Printer
 
         def print_out(args)
+          return '' if args.nil?
+
           args.map do |arg|
             if arg.instance_of?(Turnip::Table)
               render_template(:step_outline, { table: arg.to_a })

data/lib/turnip_formatter/printer/tab_speed_statistics.rb

@@ -9,7 +9,8 @@ module TurnipFormatter
       class << self
         include TurnipFormatter::Printer
 
-        def print_out(passed_scenarios)
+        def print_out(scenarios)
+          passed_scenarios = scenarios.select { |s| s.status == 'passed' }
           results = speed_analysis(passed_scenarios)
           render_template(:tab_speed_statistics, { analysis_results: results })
         end

data/lib/turnip_formatter/printer/tab_tag_statistics.rb

@@ -28,9 +28,9 @@ module TurnipFormatter
           info = OpenStruct.new(
             name: name,
             scenario_count: scenarios.size,
-            passed_count: status_group["passed"].size,
-            failed_count: status_group["failed"].size,
-            pending_count: status_group["pending"].size,
+            passed_count: status_group['passed'].size,
+            failed_count: status_group['failed'].size,
+            pending_count: status_group['pending'].size,
             status: 'failed'
           )
 
@@ -57,8 +57,7 @@ module TurnipFormatter
         #
         def group_by_tag(scenarios)
           scenarios.map do |scenario|
-            begin
-              scenario.validation
+            if scenario.valid?
               if scenario.tags.empty?
                 { name: 'turnip', scenario: scenario }
               else
@@ -66,7 +65,7 @@ module TurnipFormatter
                   { name: '@' + tag, scenario: scenario }
                 end
               end
-            rescue
+            else
               { name: 'runtime error', scenario: scenario }
             end
           end.flatten.group_by { |s| s[:name] }.sort

data/lib/turnip_formatter/printer.rb

@@ -1,32 +1,27 @@
+require 'tilt'
+
 module TurnipFormatter
   module Printer
-    include ERB::Util
-
     #
     # @example
     #   render_template(:main, { name: 'user' })
-    #     # => ERB.new('/path/to/main.erb') render { name: 'user' }
+    #     # => Tilt.new('/path/to/main.erb') render { name: 'user' }
     #
     def render_template(name, params = {})
-      render_template_list(name).result(template_params_binding(params))
+      render_template_list(name).render(self, params)
     end
 
     private
 
     def render_template_list(name)
       if templates[name].nil?
-        path = File.dirname(__FILE__) + "/template/#{name.to_s}.erb"
-        templates[name] = ERB.new(File.read(path))
+        path = File.dirname(__FILE__) + "/template/#{name}.haml"
+        templates[name] = Tilt.new(path)
       end
 
       templates[name]
     end
 
-    def template_params_binding(params)
-      code = params.keys.map { |k| "#{k} = params[#{k.inspect}];" }.join
-      eval(code + ";binding")
-    end
-
     def templates
       @templates ||= {}
     end

data/lib/turnip_formatter/scenario/base.rb

@@ -0,0 +1,98 @@
+require 'turnip_formatter/step'
+
+module TurnipFormatter
+  module Scenario
+    class Base
+      include RSpec::Core::BacktraceFormatter
+
+      attr_reader :errors
+
+      #
+      # @param  [RSpec::Core::Example]  example
+      #
+      def initialize(example)
+        @example = example
+        @errors  = []
+
+        validation
+        clean_backtrace
+      end
+
+      def valid?
+        errors.empty?
+      end
+
+      def steps
+        @steps ||= raw_steps.map do |step|
+          TurnipFormatter::Step.new(example, step)
+        end
+      end
+
+      def id
+        'scenario_' + object_id.to_s
+      end
+
+      #
+      # @return  [String] scenario name
+      #
+      def name
+        example.example_group.description
+      end
+
+      #
+      # @return  [String] scenario status ('passed', 'failed' or 'pending')
+      #
+      def status
+        example.execution_result[:status]
+      end
+
+      #
+      # @return  [String] scenario run time
+      #
+      def run_time
+        example.execution_result[:run_time]
+      end
+
+      def feature_info
+        path = RSpec::Core::Metadata.relative_path(feature_file_path)
+        "\"#{feature_name}\" in #{path}"
+      end
+
+      def feature_name
+        example.example_group.metadata[:example_group][:example_group][:description]
+      end
+
+      def tags
+        example.metadata[:turnip_formatter][:tags]
+      end
+
+      def example
+        @example
+      end
+
+      protected
+
+        def validation
+          unless example.metadata.key?(:turnip_formatter)
+            @errors << 'has no steps information'
+          end
+        end
+
+      private
+
+        def feature_file_path
+          example.metadata[:file_path]
+        end
+
+        def raw_steps
+          example.metadata[:turnip_formatter][:steps]
+        end
+
+        def clean_backtrace
+          return if example.exception.nil?
+          formatted = format_backtrace(example.exception.backtrace, example.metadata)
+          example.exception.set_backtrace(formatted)
+        end
+    end
+  end
+end

data/lib/turnip_formatter/scenario/failure.rb

@@ -1,36 +1,34 @@
-# -*- coding: utf-8 -*-
-
-require 'turnip_formatter/scenario'
-require 'turnip_formatter/step/failure'
+require 'turnip_formatter/scenario/base'
 
 module TurnipFormatter
   module Scenario
-    class NotFailedScenarioError < ::StandardError; end
-    class NoExistFailedStepInformationError < ::StandardError; end
-
-    class Failure
-      include TurnipFormatter::Scenario
-
+    class Failure < Base
       def steps
         steps = super
-        steps[offending_line].extend TurnipFormatter::Step::Failure
+        steps[@offending_line].status = :failed
+        steps[(@offending_line + 1)..-1].each do |step|
+          step.status = :unexecuted
+        end
         steps
       end
 
-      def validation
-        raise NotFailedScenarioError if status != 'failed'
-        offending_line
-        super
-      end
+      protected
+
+        def validation
+          if failed_message =~ /:in step:(?<stepno>\d+) `/
+            @offending_line = $~[:stepno].to_i
+          else
+            @errors << 'has no failed step information'
+          end
+
+          super
+        end
 
       private
 
-      def offending_line
-        unless example.exception.backtrace.last =~ /:in step:(?<stepno>\d+) `/
-          raise NoExistFailedStepInformationError
+        def failed_message
+          example.exception.backtrace.last
         end
-        $~[:stepno].to_i
-      end
     end
   end
 end

data/lib/turnip_formatter/scenario/pass.rb

@@ -1,19 +1,8 @@
-# -*- coding: utf-8 -*-
-
-require 'turnip_formatter/scenario'
-require 'turnip_formatter/step/pending'
+require 'turnip_formatter/scenario/base'
 
 module TurnipFormatter
   module Scenario
-    class NotPassedScenarioError < ::StandardError; end
-
-    class Pass
-      include TurnipFormatter::Scenario
-
-      def validation
-        raise NotPassedScenarioError if status != 'passed'
-        super
-      end
+    class Pass < Base
     end
   end
 end

data/lib/turnip_formatter/scenario/pending.rb

@@ -1,40 +1,34 @@
-# -*- coding: utf-8 -*-
-
-require 'turnip_formatter/scenario'
-require 'turnip_formatter/step/pending'
+require 'turnip_formatter/scenario/base'
 
 module TurnipFormatter
   module Scenario
-    class NotPendingScenarioError < ::StandardError; end
-    class NoExistPendingStepInformationError < ::StandardError; end
-
-    class Pending
-      include TurnipFormatter::Scenario
-
+    class Pending < Base
       def steps
         steps = super
-        steps[offending_line].extend TurnipFormatter::Step::Pending
+        steps[@offending_line].status = :pending
+        steps[(@offending_line + 1)..-1].each do |step|
+          step.status = :unexecuted
+        end
         steps
       end
 
-      def validation
-        raise NotPendingScenarioError if status != 'pending'
-        offending_line
-        super
-      end
+      protected
 
-      private
+        def validation
+          if pending_message =~ /^No such step\((?<stepno>\d+)\): /
+            @offending_line = $~[:stepno].to_i
+          else
+            @errors << 'has no pending step information'
+          end
 
-      def offending_line
-        unless pending_message =~ /^No such step\((?<stepno>\d+)\): /
-          raise NoExistPendingStepInformationError
+          super
         end
-        $~[:stepno].to_i
-      end
 
-      def pending_message
-        example.execution_result[:pending_message]
-      end
+      private
+
+        def pending_message
+          example.execution_result[:pending_message]
+        end
     end
   end
 end