turnip_formatter 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea1f372fc6ecf5a43d8f00841896ca2d51c04f50
-  data.tar.gz: 78bdffd1e4b1326bd44ff556fb4697d269776855
+  metadata.gz: b6ea6e7c30acce995aed363bc6c336fb599191c3
+  data.tar.gz: 32e82be9d23f41ca9b413fa8a5ea837dd4eeabdb
 SHA512:
-  metadata.gz: 8f54ee9957426623ccafed4561f8d3d219eaaa6bf74e5a73e891a878f6442aae0424ecf0e2009d3c5ea3e823345b98da386cf50c89632c8bcecaa3103ec08cfa
-  data.tar.gz: 78bbdd9833dea112843c297303e12c60df6ddfead24a9a3b87b27473a4e01c55e41d4ece88b042b9b1b79ff763dcb565b26d0a3c8ce9fc34b54f30c9fac06fc4
+  metadata.gz: 0469f34a5cf7f6da1f7345a7089a3c2ef610f6a43872e2129e63196813d5f67ee5adfd2d4d3c15ee8bc559beb8c74912d6829679a99417a29133ebf9480da1bf
+  data.tar.gz: 0fbbe1f9020621b623ed4da5dcf5f0db40461e6199a55aa244ed4bf4046bfde0efba6d0df27804e8ff37a231f7edef214895781bcd32b80dd95cf473b637e0a8

data/.gitignore

@@ -16,5 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 vendor/bundle
-.sass-cache
 report.html

data/Rakefile

@@ -1 +1,13 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'sass'
+require 'bootstrap-sass'
+
+desc 'Compile report CSS file'
+task :compile do
+  input = open('lib/turnip_formatter/template/turnip_formatter.scss').read
+  engine = Sass::Engine.new(input, syntax: :scss, style: :compressed)
+
+  File.open('lib/turnip_formatter/template/turnip_formatter.css', 'w') do |f|
+    f.write engine.render
+  end
+end

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

@@ -10,35 +10,30 @@ module RSpec
               scenarios:      scenarios,
               failed_count:   failure_count,
               pending_count:  pending_count,
-              total_time:     duration,
-              scenario_files: scenario_output_files
+              total_time:     duration
             }
             output_html(print_params)
           end
 
           def example_passed(example)
             scenario = ::TurnipFormatter::Scenario::Pass.new(example)
-            output_scenario(scenario)
+            scenarios << scenario
           end
 
           def example_pending(example)
-            clean_backtrace(example)
             scenario = ::TurnipFormatter::Scenario::Pending.new(example)
-            output_scenario(scenario)
+            scenarios << scenario
           end
 
           def example_failed(example)
-            clean_backtrace(example)
             scenario = ::TurnipFormatter::Scenario::Failure.new(example)
-            output_scenario(scenario)
+            scenarios << scenario
           end
 
-          private
-
-          def clean_backtrace(example)
-            return if example.exception.nil?
-            formatted = format_backtrace(example.exception.backtrace, example)
-            example.exception.set_backtrace(formatted)
+          module Helper
+            def formatted_backtrace(example)
+              RSpec::Core::BacktraceFormatter.format_backtrace(example.exception.backtrace, example.metadata)
+            end
           end
         end
       end

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

@@ -14,35 +14,30 @@ module RSpec
               scenarios:      scenarios,
               failed_count:   summary.failure_count,
               pending_count:  summary.pending_count,
-              total_time:     summary.duration,
-              scenario_files: scenario_output_files
+              total_time:     summary.duration
             }
             output_html(print_params)
           end
 
           def example_passed(notification)
             scenario = ::TurnipFormatter::Scenario::Pass.new(notification.example)
-            output_scenario(scenario)
+            scenarios << scenario
           end
 
           def example_pending(notification)
-            clean_backtrace(notification)
             scenario = ::TurnipFormatter::Scenario::Pending.new(notification.example)
-            output_scenario(scenario)
+            scenarios << scenario
           end
 
           def example_failed(notification)
-            clean_backtrace(notification)
             scenario = ::TurnipFormatter::Scenario::Failure.new(notification.example)
-            output_scenario(scenario)
+            scenarios << scenario
           end
 
-          private
-
-          def clean_backtrace(notification)
-            if notification.respond_to?(:formatted_backtrace)
-              formatted = notification.formatted_backtrace
-              notification.example.exception.set_backtrace(formatted)
+          module Helper
+            def formatted_backtrace(example)
+              formatter = RSpec.configuration.backtrace_formatter
+              formatter.format_backtrace(example.exception.backtrace, example.metadata)
             end
           end
         end

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

@@ -13,41 +13,26 @@ module RSpec
   module Core
     module Formatters
       class TurnipFormatter < BaseFormatter
-        attr_reader :scenarios, :scenario_output_files
-
-        SCENARIO_TEMPORARY_OUTPUT_DIR = File.expand_path('./turnip_tmp')
+        attr_accessor :scenarios
 
         if Formatters.respond_to?(:register)
           include TurnipFormatter::ForRSpec3
+          extend TurnipFormatter::ForRSpec3::Helper
         else
           include TurnipFormatter::ForRSpec2
+          extend TurnipFormatter::ForRSpec2::Helper
         end
 
         def initialize(output)
           super(output)
           @scenarios = []
-          @scenario_output_files = []
-
-          FileUtils.mkdir_p(SCENARIO_TEMPORARY_OUTPUT_DIR)
         end
 
         private
 
-          def output_html(params)
-            output.puts ::TurnipFormatter::Printer::Index.print_out(params)
-            FileUtils.rm_rf(SCENARIO_TEMPORARY_OUTPUT_DIR)
-          end
-
-          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
+        def output_html(params)
+          output.puts ::TurnipFormatter::Printer::Index.print_out(params)
+        end
       end
     end
   end

data/lib/turnip_formatter/ext/turnip/rspec.rb

@@ -4,90 +4,32 @@ require 'turnip/rspec'
 
 module Turnip
   module RSpec
-    module Execute
-      def run_step(feature_file, step, index)
-        example = Turnip::RSpec.fetch_current_example(self)
-
-        begin
-          step(step)
-        rescue Turnip::Pending => e
-          example.metadata[:line_number] = step.line
-          example.metadata[:location] = "#{example.metadata[:file_path]}:#{step.line}"
-
-          if ::RSpec::Version::STRING >= '2.99.0'
-            skip("No such step(#{index}): '#{e}'")
-          else
-            pending("No such step(#{index}): '#{e}'")
-          end
-        rescue StandardError, ::RSpec::Expectations::ExpectationNotMetError => e
-          example.metadata[:line_number] = step.line
-          e.backtrace.push "#{feature_file}:#{step.line}:in step:#{index} `#{step.description}'"
-          raise e
-        end
-      end
+    class << self
+      alias_method :original_run, :run
 
-      def push_scenario_metadata(scenario)
-        example = Turnip::RSpec.fetch_current_example(self)
+      def run(feature_file)
+        features = original_run(feature_file)
+        example_groups = ::RSpec.world.example_groups[-features.length..-1]
 
-        steps = scenario.steps
-        example.metadata[:turnip_formatter].tap do |turnip|
-          steps.each do |step|
-            turnip[:steps] << {
-              name: step.description,
-              extra_args: step.extra_args,
-              keyword: step.keyword
-            }
-          end
-          turnip[:tags] += scenario.tags if scenario.respond_to?(:tags)
+        features.zip(example_groups).each do |feature, example_group|
+          update_metadata(feature, example_group)
         end
       end
-    end
-
-    class << self
-      def run(feature_file)
-        Turnip::Builder.build(feature_file).features.each do |feature|
-          ::RSpec.describe feature.name, feature.metadata_hash do
-            let(:backgrounds) do
-              feature.backgrounds
-            end
-
-            let(:background_steps) do
-              backgrounds.map(&:steps).flatten
-            end
-
-            before do
-              example = Turnip::RSpec.fetch_current_example(self)
-
-              example.metadata[:file_path] = feature_file
-              example.metadata[:turnip_formatter] = {
-                steps: [], tags: feature.tags
-              }
-
-              backgrounds.each do |background|
-                push_scenario_metadata(background)
-              end
 
-              background_steps.each.with_index do |step, index|
-                run_step(feature_file, step, index)
-              end
-            end
+      #
+      # @param  [Turnip::Builder::Feature]   feature
+      # @param  [RSpec::Core::ExampleGroup]  example_group
+      #
+      def update_metadata(feature, example_group)
+        background_steps = feature.backgrounds.map(&:steps).flatten
+        examples = example_group.children
 
-            feature.scenarios.each do |scenario|
-              instance_eval <<-EOS, feature_file, scenario.line
-                describe scenario.name, scenario.metadata_hash do
-                  before do
-                    push_scenario_metadata(scenario)
-                  end
+        feature.scenarios.zip(examples).each do |scenario, parent_example|
+          example = parent_example.examples.first
+          steps   = background_steps + scenario.steps
+          tags    = (feature.tags + scenario.tags).uniq
 
-                  it scenario.steps.map(&:description).join(' -> ') do
-                    scenario.steps.each.with_index(background_steps.size) do |step, index|
-                      run_step(feature_file, step, index)
-                    end
-                  end
-                end
-              EOS
-            end
-          end
+          example.metadata[:turnip_formatter] = { steps: steps, tags: tags }
         end
       end
     end

data/lib/turnip_formatter/printer/runtime_error.rb

@@ -23,15 +23,13 @@ module TurnipFormatter
         end
 
         def example_exception(example)
-          unless example.exception
-            ''
-          else
-            render_template(:exception, {
-                title: 'Example',
-                exception: example.exception
-              }
-            )
-          end
+          return '' unless example.exception
+
+          render_template(:exception, {
+              title: 'Example',
+              exception: example.exception
+            }
+          )
         end
       end
     end

data/lib/turnip_formatter/printer.rb

@@ -1,4 +1,4 @@
-require 'tilt'
+require 'slim'
 
 module TurnipFormatter
   module Printer
@@ -11,12 +11,12 @@ module TurnipFormatter
       render_template_list(name).render(self, params)
     end
 
-    private
+  private
 
     def render_template_list(name)
       if templates[name].nil?
-        path = File.dirname(__FILE__) + "/template/#{name}.haml"
-        templates[name] = Tilt.new(path)
+        path = File.dirname(__FILE__) + "/template/#{name}.slim"
+        templates[name] = Slim::Template.new(path)
       end
 
       templates[name]

data/lib/turnip_formatter/scenario/base.rb

@@ -3,7 +3,7 @@ require 'turnip_formatter/step'
 module TurnipFormatter
   module Scenario
     class Base
-      attr_reader :errors
+      attr_reader :errors, :example
 
       #
       # @param  [RSpec::Core::Example]  example
@@ -63,10 +63,6 @@ module TurnipFormatter
         example.metadata[:turnip_formatter][:tags]
       end
 
-      def example
-        @example
-      end
-
       protected
 
       def validation

data/lib/turnip_formatter/scenario/failure.rb

@@ -5,30 +5,40 @@ module TurnipFormatter
     class Failure < Base
       def steps
         steps = super
-        steps[@offending_line].status = :failed
-        steps[(@offending_line + 1)..-1].each do |step|
-          step.status = :unexecuted
+        return steps unless failed_line_number
+
+        steps.each do |step|
+          case
+          when step.line == failed_line_number
+            step.status = :failed
+          when step.line > failed_line_number
+            step.status = :unexecuted
+          end
         end
+
         steps
       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
+      def validation
+        @errors << 'has no failed step information' unless failed_line_number
+        super
+      end
 
       private
 
-        def failed_message
-          example.exception.backtrace.last
+      def failed_line_number
+        return @failed_line_number if @failed_line_number
+        return unless example.exception
+
+        filepath = File.basename(feature_file_path)
+        line = example.exception.backtrace.find do |backtrace|
+          backtrace.match(/#{filepath}:(\d+)/)
         end
+
+        @failed_line_number = Regexp.last_match[1].to_i if line
+      end
     end
   end
 end

data/lib/turnip_formatter/scenario/pending.rb

@@ -5,31 +5,37 @@ module TurnipFormatter
     class Pending < Base
       def steps
         steps = super
-        steps[@offending_line].status = :pending
-        steps[(@offending_line + 1)..-1].each do |step|
-          step.status = :unexecuted
+        return steps unless pending_line_number
+
+        steps.each do |step|
+          case
+          when step.line == pending_line_number
+            step.status = :pending
+          when step.line > pending_line_number
+            step.status = :unexecuted
+          end
         end
+
         steps
       end
 
       protected
 
-        def validation
-          if pending_message =~ /^No such step\((?<stepno>\d+)\): /
-            @offending_line = $~[:stepno].to_i
-          else
-            @errors << 'has no pending step information'
-          end
-
-          super
-        end
+      def validation
+        @errors << 'has no pending step information' unless pending_line_number
+        super
+      end
 
       private
 
-        def pending_message
-          result = TurnipFormatter::Helper.example_execution_result(example)
-          result.pending_message
-        end
+      def pending_line_number
+        example.metadata[:line_number]
+      end
+
+      def pending_message
+        result = TurnipFormatter::Helper.example_execution_result(example)
+        result.pending_message
+      end
     end
   end
 end

data/lib/turnip_formatter/step.rb

@@ -1,17 +1,23 @@
+require 'forwardable'
+
 module TurnipFormatter
   class Step
+    extend Forwardable
+
     attr_reader :name, :example, :extra_args
     attr_accessor :status
 
+    def_delegators :@raw, :extra_args, :line, :keyword, :description
+
     #
-    # @param  [RSpec::Core::Example]  example
-    # @param  [Hash]  raw
+    # @param  [RSpec::Core::Example]   example
+    # @param  [Turnip::Builder::Step]  raw
     #
     def initialize(example, raw)
-      @example    = example
-      @name       = raw[:keyword].strip + ' ' + raw[:name]
-      @extra_args = raw[:extra_args]
-      @status     = :passed
+      @example = example
+      @raw     = raw
+      @name    = raw.keyword.strip + ' ' + raw.description
+      @status  = :passed
     end
   end
 end

data/lib/turnip_formatter/step_template/base.rb

@@ -25,10 +25,14 @@ module TurnipFormatter
         #
         # Return SCSS string that be used in this class
         #
-        def scss
+        def css
           ''
         end
       end
+
+      def formatted_backtrace(example)
+        RSpec::Core::Formatters::TurnipFormatter.formatted_backtrace(example)
+      end
     end
   end
 end

data/lib/turnip_formatter/step_template/exception.rb

@@ -1,5 +1,5 @@
 require 'turnip_formatter/step_template/base'
-require 'haml'
+require 'slim'
 
 module TurnipFormatter
   module StepTemplate
@@ -7,23 +7,19 @@ module TurnipFormatter
       on_failed :build_failed
       on_pending :build_pending
 
-      def self.scss
+      def self.css
         <<-EOS
-          div#steps-statistics section.scenario {
-              div.steps {
-                  div.step_exception {
-                      margin: 1em 0em;
-                      padding: 1em;
-                      border: 1px solid #999999;
-                      background-color: #eee8d5;
-                      color: #586e75;
+          section.scenario div.steps div.step_exception {
+              margin: 1em 0em;
+              padding: 1em;
+              border: 1px solid #999999;
+              background-color: #eee8d5;
+              color: #586e75;
+          }
 
-                      dd {
-                          margin-top: 1em;
-                          margin-left: 1em;
-                      }
-                  }
-              }
+          section.scenario div.steps div.step_exception dd {
+              margin-top: 1em;
+              margin-left: 1em;
           }
         EOS
       end
@@ -32,7 +28,7 @@ module TurnipFormatter
       # @param  [RSpec::Core::Example]  example
       #
       def build_failed(example)
-        build(example.exception.to_s, example.exception.backtrace)
+        build(example.exception.to_s, formatted_backtrace(example))
       end
 
       #
@@ -50,18 +46,7 @@ module TurnipFormatter
         end
 
         def template_step_exception
-          @template_step_exception ||= Haml::Engine.new(<<-EOS)
-%div.step_exception
-  %dl
-    %dt Failure:
-    %dd
-      %pre&= message
-    %dt Backtrace:
-    %dd
-      %ol
-        - backtrace.each do |line|
-          %li&= line
-          EOS
+          @template_step_exception ||= Slim::Template.new(File.dirname(__FILE__) + "/exception.slim")
         end
     end
   end

data/lib/turnip_formatter/step_template/exception.slim

@@ -0,0 +1,10 @@
+div.step_exception
+  dl
+    dt Failure:
+    dd
+      pre= message
+    dt Backtrace:
+    dd
+      ol
+       - backtrace.each do |line|
+         li= line

data/lib/turnip_formatter/step_template/source.rb

@@ -6,25 +6,27 @@ module TurnipFormatter
     class Source < Base
       on_failed :build
 
-      def self.scss
+      def self.css
         <<-EOS
           pre.source {
               font-size: 12px;
               font-family: monospace;
               background-color: #073642;
               color: #dddddd;
+          }
 
-              code.ruby {
-                  padding: 0.1em 0 0.2em 0;
+          pre.source code.ruby {
+              padding: 0.1em 0 0.2em 0;
+          }
 
-                  .linenum {
-                      width: 75px;
-                      color: #fffbd3;
-                      padding-right: 1em;
-                  }
+          pre.source code.ruby .linenum {
+              width: 75px;
+              color: #fffbd3;
+              padding-right: 1em;
+          }
 
-                  .offending { background-color: gray; }
-              }
+          pre.source code.ruby .offending {
+              background-color: gray;
           }
         EOS
       end
@@ -37,7 +39,7 @@ module TurnipFormatter
       private
 
         def location(example)
-          example.exception.backtrace.first
+          formatted_backtrace(example).first
         end
 
         def extractor

data/lib/turnip_formatter/template/exception.slim

@@ -0,0 +1,8 @@
+dt= "#{title} Exception"
+dd
+  pre= exception.to_s
+dt= "#{title} Exception Backtrace"
+dd
+  ol
+    - exception.backtrace.each do |line|
+      li= line