turnip_formatter 0.0.4 → 0.0.5

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

@@ -39,6 +39,10 @@ module Turnip
       def run(feature_file)
         Turnip::Builder.build(feature_file).features.each do |feature|
           describe feature.name, feature.metadata_hash do
+            let :background_steps do
+              feature.backgrounds.map(&:steps).flatten
+            end
+
             before do
               example.metadata[:file_path] = feature_file
               initialize_scenario_metadata
@@ -46,8 +50,8 @@ module Turnip
               feature.backgrounds.each do |background|
                 push_scenario_metadata(background)
               end
-
-              feature.backgrounds.map(&:steps).flatten.each.with_index do |step, index|
+              
+              background_steps.each.with_index do |step, index|
                 run_step(feature_file, step, index)
               end
             end
@@ -58,7 +62,7 @@ module Turnip
                 end
 
                 it scenario.steps.map(&:description).join(' -> ') do
-                  scenario.steps.each.with_index do |step, index|
+                  scenario.steps.each.with_index(background_steps.size) do |step, index|
                     run_step(feature_file, step, index)
                   end
                 end

data/lib/turnip_formatter/step/dsl.rb

@@ -9,13 +9,24 @@ module TurnipFormatter
       # @param [TurnipFormatter::Step]  step
       #
       def extended(step)
-        ::TurnipFormatter::Step.templates[status].each do |style, block|
-          step.docs[style] = step.instance_eval(&block)
+        templates.each do |style, template|
+          step.docs[style] = {
+            klass: template[:klass],
+            value: step.instance_eval(&template[:block])
+          }
         end
       end
 
-      def add_template(style, &block)
-        ::TurnipFormatter::Step.add_template(status, style, &block)
+      def add_template(style, template = nil, &block)
+        ::TurnipFormatter::Step.add_template(status, style, template, &block)
+      end
+
+      def remove_template(style)
+        ::TurnipFormatter::Step.remove_template(status, style)
+      end
+
+      def templates
+        ::TurnipFormatter::Step.templates[status]
       end
     end
   end

data/lib/turnip_formatter/step.rb

@@ -9,9 +9,14 @@ module TurnipFormatter
         @templates ||= {}
       end
 
-      def add_template(status, style, &block)
+      def add_template(status, style, klass = nil, &block)
         templates[status] ||= {}
-        templates[status][style] = block
+        templates[status][style] = { klass: klass, block: block }
+      end
+
+      def remove_template(status, style)
+        templates[status].delete(style)
+        templates.delete(status.to_sym) if templates[status.to_sym].empty?
       end
 
       def status
@@ -26,7 +31,7 @@ module TurnipFormatter
     def initialize(example, description)
       @example = example
       @name = description[:keyword] + description[:name]
-      @docs = { extra_args: description[:extra_args] }
+      @docs = { extra_args: { klass: nil, value: description[:extra_args] } }
     end
 
     def attention?

data/lib/turnip_formatter/template.rb

@@ -95,13 +95,11 @@ module TurnipFormatter
     def step_args(step)
       output = []
 
-      step.docs.each do |style, value|
+      step.docs.each do |style, template|
         if style == :extra_args
-          output << step_extra_args(value)
+          output << step_extra_args(template[:value])
         else
-          # call StepException, StepSource, etc...
-          klass = ['step', style.to_s].map(&:capitalize).join
-          output << self.class.const_get(klass).build(value)
+          output << step_template(style, template[:klass]).build(template[:value])
         end
       end
 
@@ -115,6 +113,14 @@ module TurnipFormatter
       end.join("\n")
     end
 
+    def step_template(style, klass)
+      return klass if !!klass
+
+      # call Built-in template (StepException, StepSource, etc...)
+      klass = ['step', style.to_s].map(&:capitalize).join
+      self.class.const_get(klass)
+    end
+
     def report_area
       <<-EOS
         <div id="report">

data/lib/turnip_formatter/version.rb

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
 
 module TurnipFormatter
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/examples/features/battle2.feature

@@ -15,3 +15,12 @@ Feature: Battle a monster with weapon
      Then it should die
       And Fanfare
  
+  Scenario: boss monster
+
+    This scenario will error
+    So, fanfare is not...oh...
+
+    Given there is a boss monster
+     When I attack it
+     Then it should die
+      And Fanfare

data/spec/examples/steps/steps.rb

@@ -8,6 +8,10 @@ step "there is a strong monster" do
   @monster = 2
 end
 
+step "there is a boss monster" do
+  @monster = 3
+end
+
 step "I attack it" do
   @attack ||= 1 # no weapon
   @monster -= @attack

data/spec/turnip_formatter/step/failure_spec.rb

@@ -15,6 +15,28 @@ module TurnipFormatter
         step
       end
 
+      it 'exists built-in step template' do
+        templates = TurnipFormatter::Step::Failure.templates
+        expect(templates.keys).to eq([:source, :exception])
+      end
+
+      context 'add custom step template' do
+        before do
+          TurnipFormatter::Step::Failure.add_template :custom do
+            example.example_group.description
+          end
+        end
+
+        after do
+          TurnipFormatter::Step::Failure.remove_template :custom
+        end
+
+        it 'should get custom step template' do
+          templates = TurnipFormatter::Step::Failure.templates
+          expect(templates.keys).to eq([:source, :exception, :custom])
+        end
+      end
+
       describe '#attention?' do
         subject { step.attention? }
         it { should be_true }

data/spec/turnip_formatter/step/pending_spec.rb

@@ -13,6 +13,28 @@ module TurnipFormatter
         step
       end
 
+      it 'exists built-in step template' do
+        templates = TurnipFormatter::Step::Pending.templates
+        expect(templates.keys).to eq([:exception])
+      end
+
+      context 'add custom step template' do
+        before do
+          TurnipFormatter::Step::Pending.add_template :custom do
+            example.example_group.description
+          end
+        end
+
+        after do
+          TurnipFormatter::Step::Failure.remove_template :custom
+        end
+
+        it 'should get custom step template' do
+          templates = TurnipFormatter::Step::Pending.templates
+          expect(templates.keys).to eq([:exception, :custom])
+        end
+      end
+
       describe '#attention?' do
         subject { step.attention? }
         it { should be_true }

data/spec/turnip_formatter/step_spec.rb

@@ -21,5 +21,53 @@ module TurnipFormatter
       subject { step.docs }
       it { should include :extra_args }
     end
+
+    describe '#add_template' do
+      let :custom_template do
+        Module.new do
+          def self.build(hoge)
+            hoge * 3
+          end
+        end
+      end
+
+      before do
+        TurnipFormatter::Step.add_template :hoge, :source1 do
+          'aiueo'
+        end
+
+        TurnipFormatter::Step.add_template :hoge, :source2, custom_template do
+          '12345'
+        end
+      end
+
+      after do
+        TurnipFormatter::Step.remove_template(:hoge, :source1)
+        TurnipFormatter::Step.remove_template(:hoge, :source2)
+      end
+
+      it 'can add step template' do
+        style = TurnipFormatter::Step.templates[:hoge][:source1]
+        expect(style[:block].call).to eq('aiueo')
+
+        style = TurnipFormatter::Step.templates[:hoge][:source2]
+        expect(style[:klass].build(style[:block].call)).to eq('123451234512345')
+      end
+    end
+
+    describe '#remove_template' do
+      it 'can remove step template' do
+        TurnipFormatter::Step.add_template :hoge, :style1 do ; 'aiueo' end
+        TurnipFormatter::Step.add_template :hoge, :style2 do ; '12345' end
+        expect(TurnipFormatter::Step.templates[:hoge]).to have_key :style1
+        expect(TurnipFormatter::Step.templates[:hoge]).to have_key :style2
+
+        TurnipFormatter::Step.remove_template(:hoge, :style1)
+        expect(TurnipFormatter::Step.templates[:hoge]).to have_key :style2
+
+        TurnipFormatter::Step.remove_template(:hoge, :style2)
+        expect(TurnipFormatter::Step.templates).not_to have_key(:hoge)
+      end
+    end
   end
 end

data/spec/turnip_formatter/template_spec.rb

@@ -56,24 +56,61 @@ module TurnipFormatter
     end
     
     context 'Step has arguments' do
-      describe '#step_args' do
-        let(:table) { Turnip::Table.new [] }
+      let(:table) { Turnip::Table.new [] }
 
-        let(:step) do
-          step = double
-          step.stub(:docs).and_return(
-            extra_args: ['a', table], source: 'b', exception: 'c'
-          )
-          step
+      context 'original template' do
+        describe '#step_args' do
+          let(:step) do
+            step = double
+            step.stub(:docs).and_return(
+              extra_args: { klass: nil, value: ['a', table] },
+              source: { klass: nil, value: 'b' },
+              exception: { klass: nil, value: 'c' }
+              )
+            step
+          end
+          
+          it 'should call corresponding method in step' do
+            Template::StepMultiline.should_receive(:build).with('a').and_return('extra_args1')
+            Template::StepOutline.should_receive(:build).with(table).and_return('extra_args2')
+            Template::StepSource.should_receive(:build).with('b').and_return('source')
+            Template::StepException.should_receive(:build).with('c').and_return('exception')
+
+            expect(template.send(:step_args, step)).to eq("extra_args1\nextra_args2\nsource\nexception")
+          end
         end
-        
-        it 'should call corresponding method in step' do
-          Template::StepMultiline.should_receive(:build).with('a').and_return('extra_args1')
-          Template::StepOutline.should_receive(:build).with(table).and_return('extra_args2')
-          Template::StepSource.should_receive(:build).with('b').and_return('source')
-          Template::StepException.should_receive(:build).with('c').and_return('exception')
+      end
+
+      context 'custom template' do
+        describe '#step_args' do
+          let(:custom_template_1) do
+            Module.new do
+              def self.build(value)
+                "<html>#{value}</html>"
+              end
+            end
+          end
+
+          let(:custom_template_2) do
+            Module.new do
+              def self.build(value)
+                "<strong>#{value}</strong>"
+              end
+            end
+          end
 
-          expect(template.send(:step_args, step)).to eq("extra_args1\nextra_args2\nsource\nexception")
+          let(:step) do
+            step = double
+            step.stub(:docs).and_return(
+              source: { klass: custom_template_1, value: 'aiueo' },
+              exception: { klass: custom_template_2, value: '12345' }
+              )
+            step
+          end
+          
+          it 'should call corresponding method in step' do
+            expect(template.send(:step_args, step)).to eq("<html>aiueo</html>\n<strong>12345</strong>")
+          end
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turnip_formatter
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -172,7 +172,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -795170829
+      hash: -1609512988288769776
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -181,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -795170829
+      hash: -1609512988288769776
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23