turnip_formatter 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29acbac39ffbed20aa935ee2325695f68b9348b7
-  data.tar.gz: 71a9a4eda76d0420a31bd6dab1dbd142b6a3b039
+  metadata.gz: ea1f372fc6ecf5a43d8f00841896ca2d51c04f50
+  data.tar.gz: 78bdffd1e4b1326bd44ff556fb4697d269776855
 SHA512:
-  metadata.gz: 561db6c050c5ad0432f528bdaefe8a46af59e5f1e382b7816a81bd0bc10f688eba031072b4799434c1c3ac36e1c02f7a795cfd7bd40f1e8e6335fa4e33c4bfa7
-  data.tar.gz: 98b1d901dcb4d3a3f42654d505f50962b7f88d96d4cbe65ae006e4ea7bdeb739b2fce7a3750d4f00d7858c3f024589de3bb9394c0abd2fe2a6205b11d05434fd
+  metadata.gz: 8f54ee9957426623ccafed4561f8d3d219eaaa6bf74e5a73e891a878f6442aae0424ecf0e2009d3c5ea3e823345b98da386cf50c89632c8bcecaa3103ec08cfa
+  data.tar.gz: 78bbdd9833dea112843c297303e12c60df6ddfead24a9a3b87b27473a4e01c55e41d4ece88b042b9b1b79ff763dcb565b26d0a3c8ce9fc34b54f30c9fac06fc4

data/.travis.yml

@@ -6,3 +6,7 @@ rvm:
   - 2.1.2
   - jruby-1.7.10
 script: bundle exec rspec
+gemfile:
+  - spec/gemfiles/Gemfile-rspec-2.14.x
+  - spec/gemfiles/Gemfile-rspec-2.99.x
+  - spec/gemfiles/Gemfile-rspec-3.0.x

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

@@ -0,0 +1,47 @@
+# -*- coding: utf-8 -*-
+
+module RSpec
+  module Core
+    module Formatters
+      class TurnipFormatter < BaseFormatter
+        module ForRSpec2
+          def dump_summary(duration, _, failure_count, pending_count)
+            print_params = {
+              scenarios:      scenarios,
+              failed_count:   failure_count,
+              pending_count:  pending_count,
+              total_time:     duration,
+              scenario_files: scenario_output_files
+            }
+            output_html(print_params)
+          end
+
+          def example_passed(example)
+            scenario = ::TurnipFormatter::Scenario::Pass.new(example)
+            output_scenario(scenario)
+          end
+
+          def example_pending(example)
+            clean_backtrace(example)
+            scenario = ::TurnipFormatter::Scenario::Pending.new(example)
+            output_scenario(scenario)
+          end
+
+          def example_failed(example)
+            clean_backtrace(example)
+            scenario = ::TurnipFormatter::Scenario::Failure.new(example)
+            output_scenario(scenario)
+          end
+
+          private
+
+          def clean_backtrace(example)
+            return if example.exception.nil?
+            formatted = format_backtrace(example.exception.backtrace, example)
+            example.exception.set_backtrace(formatted)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# -*- coding: utf-8 -*-
+
+module RSpec
+  module Core
+    module Formatters
+      class TurnipFormatter < BaseFormatter
+        module ForRSpec3
+          def self.included(klass)
+            RSpec::Core::Formatters.register klass, :example_passed, :example_pending, :example_failed, :dump_summary
+          end
+
+          def dump_summary(summary)
+            print_params = {
+              scenarios:      scenarios,
+              failed_count:   summary.failure_count,
+              pending_count:  summary.pending_count,
+              total_time:     summary.duration,
+              scenario_files: scenario_output_files
+            }
+            output_html(print_params)
+          end
+
+          def example_passed(notification)
+            scenario = ::TurnipFormatter::Scenario::Pass.new(notification.example)
+            output_scenario(scenario)
+          end
+
+          def example_pending(notification)
+            clean_backtrace(notification)
+            scenario = ::TurnipFormatter::Scenario::Pending.new(notification.example)
+            output_scenario(scenario)
+          end
+
+          def example_failed(notification)
+            clean_backtrace(notification)
+            scenario = ::TurnipFormatter::Scenario::Failure.new(notification.example)
+            output_scenario(scenario)
+          end
+
+          private
+
+          def clean_backtrace(notification)
+            if notification.respond_to?(:formatted_backtrace)
+              formatted = notification.formatted_backtrace
+              notification.example.exception.set_backtrace(formatted)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -6,6 +6,8 @@ require 'turnip_formatter/scenario/failure'
 require 'turnip_formatter/scenario/pending'
 require 'turnip_formatter/printer/index'
 require 'turnip_formatter/printer/scenario'
+require_relative './turnip_formatter/for_rspec2'
+require_relative './turnip_formatter/for_rspec3'
 
 module RSpec
   module Core
@@ -15,6 +17,12 @@ module RSpec
 
         SCENARIO_TEMPORARY_OUTPUT_DIR = File.expand_path('./turnip_tmp')
 
+        if Formatters.respond_to?(:register)
+          include TurnipFormatter::ForRSpec3
+        else
+          include TurnipFormatter::ForRSpec2
+        end
+
         def initialize(output)
           super(output)
           @scenarios = []
@@ -23,35 +31,13 @@ module RSpec
           FileUtils.mkdir_p(SCENARIO_TEMPORARY_OUTPUT_DIR)
         end
 
-        def dump_summary(duration, example_count, failure_count, pending_count)
-          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)
-          scenario = ::TurnipFormatter::Scenario::Pass.new(example)
-          output_scenario(scenario)
-        end
-
-        def example_pending(example)
-          scenario = ::TurnipFormatter::Scenario::Pending.new(example)
-          output_scenario(scenario)
-        end
-
-        def example_failed(example)
-          scenario = ::TurnipFormatter::Scenario::Failure.new(example)
-          output_scenario(scenario)
-        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"
 

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

@@ -12,8 +12,14 @@ module Turnip
           step(step)
         rescue Turnip::Pending => e
           example.metadata[:line_number] = step.line
-          pending("No such step(#{index}): '#{e}'")
-        rescue StandardError => e
+          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
@@ -40,7 +46,7 @@ module Turnip
     class << self
       def run(feature_file)
         Turnip::Builder.build(feature_file).features.each do |feature|
-          describe feature.name, feature.metadata_hash do
+          ::RSpec.describe feature.name, feature.metadata_hash do
             let(:backgrounds) do
               feature.backgrounds
             end

data/lib/turnip_formatter/helper.rb

@@ -0,0 +1,22 @@
+module TurnipFormatter
+  module Helper
+    module HelperMethods
+      #
+      # @param  [RSpec::Core::Example]  example
+      # @param  [OpenStruct or ::RSpec::Core::Example::ExecutionResult]
+      #
+      def example_execution_result(example)
+        case example.execution_result
+        when Hash
+          # RSpec 2
+          OpenStruct.new(example.execution_result)
+        when ::RSpec::Core::Example::ExecutionResult
+          # RSpec 3
+          example.execution_result
+        end
+      end
+    end
+
+    extend HelperMethods
+  end
+end

data/lib/turnip_formatter/printer/runtime_error.rb

@@ -6,10 +6,8 @@ module TurnipFormatter
     class RuntimeError
       class << self
         include TurnipFormatter::Printer
-        include RSpec::Core::BacktraceFormatter
 
         def print_out(example, exception)
-          exception.set_backtrace(format_backtrace(exception.backtrace))
           render_template(:runtime_exception, {
               example: example,
               runtime_exception: runtime_exception(exception),

data/lib/turnip_formatter/scenario/base.rb

@@ -3,8 +3,6 @@ require 'turnip_formatter/step'
 module TurnipFormatter
   module Scenario
     class Base
-      include RSpec::Core::BacktraceFormatter
-
       attr_reader :errors
 
       #
@@ -15,7 +13,6 @@ module TurnipFormatter
         @errors  = []
 
         validation
-        clean_backtrace
       end
 
       def valid?
@@ -43,14 +40,14 @@ module TurnipFormatter
       # @return  [String] scenario status ('passed', 'failed' or 'pending')
       #
       def status
-        example.execution_result[:status]
+        execution_result.status.to_s
       end
 
       #
       # @return  [String] scenario run time
       #
       def run_time
-        example.execution_result[:run_time]
+        execution_result.run_time
       end
 
       def feature_info
@@ -59,7 +56,7 @@ module TurnipFormatter
       end
 
       def feature_name
-        example.example_group.metadata[:example_group][:example_group][:description]
+        parent_example_group[:description]
       end
 
       def tags
@@ -72,27 +69,41 @@ module TurnipFormatter
 
       protected
 
-        def validation
-          unless example.metadata.key?(:turnip_formatter)
-            @errors << 'has no steps information'
-          end
+      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 feature_file_path
+        example.metadata[:file_path]
+      end
 
-        def raw_steps
-          example.metadata[:turnip_formatter][:steps]
-        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)
+      #
+      # @return  [Hash]  parent example group
+      #
+      def parent_example_group
+        if example.example_group.metadata.key?(:parent_example_group)
+          # RSpec 3
+          example.example_group.metadata[:parent_example_group]
+        else
+          # RSpec 2
+          example.example_group.metadata[:example_group][:example_group]
         end
+      end
+
+      #
+      # @return  [OpenStruct or ::RSpec::Core::Example::ExecutionResult]
+      #
+      def execution_result
+        @execution_result ||= Helper.example_execution_result(example)
+      end
     end
   end
 end

data/lib/turnip_formatter/scenario/pending.rb

@@ -27,7 +27,8 @@ module TurnipFormatter
       private
 
         def pending_message
-          example.execution_result[:pending_message]
+          result = TurnipFormatter::Helper.example_execution_result(example)
+          result.pending_message
         end
     end
   end

data/lib/turnip_formatter/step_template/exception.rb

@@ -32,23 +32,21 @@ module TurnipFormatter
       # @param  [RSpec::Core::Example]  example
       #
       def build_failed(example)
-        build(example.exception)
+        build(example.exception.to_s, example.exception.backtrace)
       end
 
       #
       # @param  [RSpec::Core::Example]  example
       #
       def build_pending(example)
-        message = example.execution_result[:pending_message]
-        exception = RSpec::Core::Pending::PendingDeclaredInExample.new(message)
-        exception.set_backtrace([example.location])
-        build(exception)
+        result = TurnipFormatter::Helper.example_execution_result(example)
+        build(result.pending_message, [example.location])
       end
 
       private
 
-        def build(exception)
-          template_step_exception.render(exception)
+        def build(message, backtrace)
+          template_step_exception.render(Object.new, { message: message, backtrace: backtrace })
         end
 
         def template_step_exception
@@ -57,11 +55,11 @@ module TurnipFormatter
   %dl
     %dt Failure:
     %dd
-      %pre&= exception.to_s
+      %pre&= message
     %dt Backtrace:
     %dd
       %ol
-        - exception.backtrace.each do |line|
+        - backtrace.each do |line|
           %li&= line
           EOS
         end

data/lib/turnip_formatter/version.rb

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
 
 module TurnipFormatter
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

data/lib/turnip_formatter.rb

@@ -43,6 +43,7 @@ module TurnipFormatter
   end
 
   require 'rspec/core/formatters/turnip_formatter'
+  require 'turnip_formatter/helper'
   require 'turnip_formatter/template'
   require 'turnip_formatter/step_template/exception'
   require 'turnip_formatter/step_template/source'

data/spec/gemfiles/Gemfile-rspec-2.14.x

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+gemspec :path => '../..'
+gem 'rspec', '~> 2.14.0'

data/spec/gemfiles/Gemfile-rspec-2.99.x

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+gemspec :path => '../..'
+gem 'rspec', '~> 2.99.0'

data/spec/gemfiles/Gemfile-rspec-3.0.x

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+gemspec :path => '../..'
+gem 'rspec', '~> 3.0.0'

data/spec/support/example_helper.rb

@@ -10,9 +10,19 @@ module ExampleHelper
   end
 
   def pending_example
-    example = base_example { pending('Pending') }
-    example.execution_result[:pending_message] = 'No such step(0): '
-    example
+    if ::RSpec::Version::STRING >= '2.99.0'
+      base_example { skip('No such step(0): ') }
+    else
+      base_example { pending('No such step(0): ') }
+    end
+  end
+
+  def invalid_pending_example
+    if ::RSpec::Version::STRING >= '2.99.0'
+      base_example { skip('Pending') }
+    else
+      base_example { pending('Pending') }
+    end
   end
 
   private
@@ -20,6 +30,7 @@ module ExampleHelper
     def base_example(&assertion)
       group = ::RSpec::Core::ExampleGroup.describe('Feature').describe('Scenario')
       example = group.example('example', example_metadata, &assertion)
+      example.metadata[:file_path] = '/path/to/hoge.feature'
       group.run(NoopObject.new)
       example
     end
@@ -29,8 +40,7 @@ module ExampleHelper
         turnip_formatter: {
           steps: [ { name: 'Step 1', extra_args: [], keyword: 'When' } ],
           tags: []
-        },
-        file_path: '/path/to/hoge.feature'
+        }
       }
     end
 end

data/spec/turnip_formatter/scenario/pending_spec.rb

@@ -13,7 +13,7 @@ describe TurnipFormatter::Scenario::Pending do
 
     context 'called by not turnip example' do
       let(:example) do
-        pending_example.tap { |e| e.execution_result[:pending_message] = '' }
+        invalid_pending_example
       end
 
       it { should be false }

data/turnip_formatter.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'haml'
   spec.add_dependency 'sass'
   spec.add_dependency 'bootstrap-sass'
-  spec.add_dependency 'rspec', '~> 2.14.0'
+  spec.add_dependency 'rspec', ['>=2.14.0', '<4.0']
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec-html-matchers'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: turnip_formatter
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Wataru MIYAGUNI
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-12 00:00:00.000000000 Z
+date: 2014-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: turnip
@@ -84,16 +84,22 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.14.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.14.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -198,8 +204,11 @@ files:
 - example/spec/steps/spell_steps.rb
 - example/spec/steps/steps.rb
 - lib/rspec/core/formatters/turnip_formatter.rb
+- lib/rspec/core/formatters/turnip_formatter/for_rspec2.rb
+- lib/rspec/core/formatters/turnip_formatter/for_rspec3.rb
 - lib/turnip_formatter.rb
 - lib/turnip_formatter/ext/turnip/rspec.rb
+- lib/turnip_formatter/helper.rb
 - lib/turnip_formatter/printer.rb
 - lib/turnip_formatter/printer/index.rb
 - lib/turnip_formatter/printer/runtime_error.rb
@@ -231,6 +240,9 @@ files:
 - lib/turnip_formatter/template/turnip_formatter.js
 - lib/turnip_formatter/template/turnip_formatter.scss
 - lib/turnip_formatter/version.rb
+- spec/gemfiles/Gemfile-rspec-2.14.x
+- spec/gemfiles/Gemfile-rspec-2.99.x
+- spec/gemfiles/Gemfile-rspec-3.0.x
 - spec/spec_helper.rb
 - spec/support/example_helper.rb
 - spec/support/passed.feature
@@ -275,6 +287,9 @@ signing_key:
 specification_version: 4
 summary: RSpec custom formatter for Turnip
 test_files:
+- spec/gemfiles/Gemfile-rspec-2.14.x
+- spec/gemfiles/Gemfile-rspec-2.99.x
+- spec/gemfiles/Gemfile-rspec-3.0.x
 - spec/spec_helper.rb
 - spec/support/example_helper.rb
 - spec/support/passed.feature