RubyGems - turnip_formatter - Versions diffs - 0.0.1 - Mend

turnip_formatter 0.0.1

Files changed (50) hide show

data/.gitignore +20 -0
data/.rspec +1 -0
data/.travis.yml +5 -0
data/Gemfile +3 -0
data/Guardfile +5 -0
data/LICENSE.txt +22 -0
data/README.md +54 -0
data/Rakefile +1 -0
data/lib/rspec/core/formatters/turnip_formatter.rb +61 -0
data/lib/turnip_formatter/ext/turnip/builder.rb +46 -0
data/lib/turnip_formatter/ext/turnip/rspec.rb +73 -0
data/lib/turnip_formatter/formatter.css +159 -0
data/lib/turnip_formatter/formatter.scss +225 -0
data/lib/turnip_formatter/scenario/failure.rb +47 -0
data/lib/turnip_formatter/scenario/pass.rb +19 -0
data/lib/turnip_formatter/scenario/pending.rb +37 -0
data/lib/turnip_formatter/scenario.rb +63 -0
data/lib/turnip_formatter/step/failure.rb +21 -0
data/lib/turnip_formatter/step/pending.rb +21 -0
data/lib/turnip_formatter/step.rb +18 -0
data/lib/turnip_formatter/template.rb +243 -0
data/lib/turnip_formatter/version.rb +5 -0
data/lib/turnip_formatter.rb +14 -0
data/spec/examples/README.md +124 -0
data/spec/examples/features/battle.feature +36 -0
data/spec/examples/features/battle2.feature +17 -0
data/spec/examples/features/battle3.feature +16 -0
data/spec/examples/features/songs.feature +10 -0
data/spec/examples/images/background.png +0 -0
data/spec/examples/images/basic_step.png +0 -0
data/spec/examples/images/failed_step.png +0 -0
data/spec/examples/images/multiline.png +0 -0
data/spec/examples/images/outline.png +0 -0
data/spec/examples/images/pending_and_tagged_step.png +0 -0
data/spec/examples/spec_helper.rb +8 -0
data/spec/examples/steps/spell_steps.rb +5 -0
data/spec/examples/steps/steps.rb +50 -0
data/spec/rspec/core/formatters/turnip_formatter_spec.rb +101 -0
data/spec/spec_helper.rb +17 -0
data/spec/support/passed.feature +4 -0
data/spec/support/shared_context_examples.rb +17 -0
data/spec/turnip_formatter/scenario/failure_spec.rb +55 -0
data/spec/turnip_formatter/scenario/pass_spec.rb +73 -0
data/spec/turnip_formatter/scenario/pending_spec.rb +60 -0
data/spec/turnip_formatter/step/failure_spec.rb +41 -0
data/spec/turnip_formatter/step/pending_spec.rb +28 -0
data/spec/turnip_formatter/step_spec.rb +32 -0
data/spec/turnip_formatter/template_spec.rb +161 -0
data/turnip_formatter.gemspec +26 -0
metadata +206 -0

data/spec/examples/features/songs.feature ADDED Viewed

@@ -0,0 +1,10 @@
+# Based on turnip/examples
+Feature: A feature with multiline strings
+  Scenario: This is a feature with multiline strings
+    When the monster sings the following song
+    """
+    Oh here be monsters
+    This is cool
+    """
+    Then the song should have 2 lines

data/spec/examples/images/background.png ADDED Viewed

Binary file

data/spec/examples/images/basic_step.png ADDED Viewed

Binary file

data/spec/examples/images/failed_step.png ADDED Viewed

Binary file

data/spec/examples/images/multiline.png ADDED Viewed

Binary file

data/spec/examples/images/outline.png ADDED Viewed

Binary file

data/spec/examples/images/pending_and_tagged_step.png ADDED Viewed

Binary file

data/spec/examples/spec_helper.rb ADDED Viewed

@@ -0,0 +1,8 @@
+require 'turnip/rspec'
+require 'turnip_formatter'
+RSpec.configure do |config|
+  config.add_formatter RSpecTurnipFormatter, 'report.html'
+end
+Dir.glob(File.dirname(__FILE__) + "/steps/**/*steps.rb") { |f| load f, true }

data/spec/examples/steps/spell_steps.rb ADDED Viewed

@@ -0,0 +1,5 @@
+steps_for :magician do
+  step "I cast a spell 'fireball'" do
+    @attack = 3
+  end
+end

data/spec/examples/steps/steps.rb ADDED Viewed

@@ -0,0 +1,50 @@
+# Based on turnip/examples
+step "there is a monster" do
+  @monster = 1
+end
+step "there is a strong monster" do
+  @monster = 2
+end
+step "I attack it" do
+  @attack ||= 1 # no weapon
+  @monster -= @attack
+end
+step "it should die" do
+  expect(@monster).to be <= 0
+end
+step "Fanfare" do
+end
+step "I equip a weapon" do
+  @attack = 2
+end
+step "there are monsters:" do |monsters|
+  @monsters = monsters.map { |row| row[0] }
+end
+step "I escape" do
+  @escape_result = (@monsters.count <= 2)
+end
+step "I was able to escape" do
+  expect(@escape_result).to be_true
+end
+step "I could not escape" do
+  expect(@escape_result).to be_false
+end
+step "the monster sings the following song" do |song|
+  @song = song
+end
+step "the song should have :count lines" do |count|
+  @song.to_s.split("\n").length.should eq(count.to_i)
+end

data/spec/rspec/core/formatters/turnip_formatter_spec.rb ADDED Viewed

@@ -0,0 +1,101 @@
+require 'spec_helper'
+require 'stringio'
+module RSpec::Core::Formatters
+  describe TurnipFormatter do
+    let(:feature) { RSpec::Core::ExampleGroup.describe('Feature') }
+    let(:scenario) { feature.describe('Scenario') }
+    let(:scenario_metadata) do
+      {
+        steps: { descriptions: [], docstrings: [[]], keywords: ['When'], tags: [] },
+        file_path: '/path/to/hoge.feature'
+      }
+    end
+    let(:output) { StringIO.new }
+    let(:formatter) { TurnipFormatter.new(output) }
+    describe '#start' do
+      it 'should be output header section' do
+        formatter.start(0)
+        expect(output.string).to match '<!DOCTYPE html>'
+        expect(output.string).to match '<div id="main" role="main">'
+      end
+    end
+    describe '#example_passed' do
+      it 'should be output passed scenario section' do
+        scenario.example('passed', scenario_metadata) { expect(true).to be_true }
+        feature.run(formatter)
+        string = output.string
+        expect(string).to match 'class="scenario passed"'
+      end
+    end
+    describe '#example_failed' do
+      let(:failed_metadata) do
+        scenario_metadata.dup.tap do |metadata|
+          metadata[:steps][:descriptions] << 'this step is error'
+          metadata[:steps][:docstrings] << []
+          metadata[:steps][:keywords] << 'Given'
+        end
+      end
+      it 'should be output failed scenario section' do
+        scenario.example('failed', failed_metadata) do
+          begin
+            expect(true).to be_false
+          rescue => e
+            e.backtrace.push ":in step:0 `"
+            raise e
+          end
+        end
+        feature.run(formatter)
+        expect(output.string).to match 'class="scenario failed"'
+      end
+    end
+    describe '#example_pending' do
+      let(:pending_metadata) do
+        scenario_metadata.dup.tap do |metadata|
+          metadata[:steps][:descriptions] << 'this step is unimplement'
+          metadata[:steps][:docstrings] << []
+          metadata[:steps][:keywords] << 'Given'
+        end
+      end
+      it 'should be output pending scenario section' do
+        scenario.example('pending', pending_metadata) do
+          pending("No such step(0): 'this step is unimplement'")
+        end
+        feature.run(formatter)
+        expect(output.string).to match 'class="scenario pending"'
+      end
+      it 'should be output runtime exception section' do
+        scenario.example('pending', pending_metadata) do
+          pending("Pending")
+        end
+        feature.run(formatter)
+        expect(output.string).to match 'class="exception"'
+      end
+    end
+    describe '#dump_summary' do
+      it 'should be output summary section' do
+        formatter.dump_summary(0.0, 3, 2, 1)
+        actual = output.string
+        expect(actual).to match %r{getElementById\("total_count"\).innerHTML = "3";}
+        expect(actual).to match %r{getElementById\("failed_count"\).innerHTML = "2";}
+        expect(actual).to match %r{getElementById\("pending_count"\).innerHTML = "1";}
+        expect(actual).to match %r{getElementById\("total_time"\).innerHTML = "0.0";}
+        expect(actual).to match '</html>'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,17 @@
+require 'simplecov'
+require 'coveralls'
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.start do
+  add_filter 'spec/'
+  add_filter 'vendor/'
+end
+require 'turnip_formatter'
+Dir.glob(File.dirname(__FILE__) + "/support/**/*.rb") { |f| require(f) }
+class NoopObject
+  def method_missing(name, *args, &block)
+    # nooooooop
+  end
+end

data/spec/support/passed.feature ADDED Viewed

@@ -0,0 +1,4 @@
+Feature: Passed Feature
+  Scenario: Passed Scenario
+    When I do pull request #3
+    Then He had ignored my pull request #3

data/spec/support/shared_context_examples.rb ADDED Viewed

@@ -0,0 +1,17 @@
+shared_context "turnip_formatter scenario setup" do |proc|
+  let(:example) do
+    group = ::RSpec::Core::ExampleGroup.describe('Feature').describe('Scenario')
+    _example = group.example('example', metadata, &proc)
+    group.run(NoopObject.new)
+    _example
+  end
+end
+shared_context 'turnip_formatter passed scenario metadata' do
+  let(:metadata) do
+    {
+      steps: { descriptions: ['Step 1'], docstrings: [[]], keywords: ['When'], tags: [] },
+      file_path: '/path/to/hoge.feature'
+    }
+  end
+end

data/spec/turnip_formatter/scenario/failure_spec.rb ADDED Viewed

@@ -0,0 +1,55 @@
+require 'spec_helper'
+module TurnipFormatter::Scenario
+  describe Failure do
+    let(:scenario) { ::TurnipFormatter::Scenario::Failure.new(failure_example) }
+    include_context 'turnip_formatter passed scenario metadata'
+    context 'Turnip example' do
+      include_context 'turnip_formatter scenario setup', proc {
+        expect(true).to be_false
+      }
+      let(:failure_example) do
+        example.exception.backtrace.push ":in step:0 `"
+        example
+      end
+      describe '#validation' do
+        it 'should not raise exception' do
+          expect { scenario.validation }.not_to raise_error
+        end
+      end
+    end
+    context 'Not Turnip example' do
+      let(:failure_example) do
+        example
+      end
+      context 'Not failed example' do
+        include_context 'turnip_formatter scenario setup', proc {
+          expect(true).to be_true
+        }
+        describe '#validation' do
+          it 'should raise exception' do
+            expect { scenario.validation }.to raise_error NotFailedScenarioError
+          end
+        end
+      end
+      context 'Not exist failed step information' do
+        include_context 'turnip_formatter scenario setup', proc {
+          expect(true).to be_false
+        }
+        describe '#validation' do
+          it 'should raise exception' do
+            expect { scenario.validation }.to raise_error NoExistFailedStepInformationError
+          end
+        end
+      end
+    end
+  end
+end

data/spec/turnip_formatter/scenario/pass_spec.rb ADDED Viewed

@@ -0,0 +1,73 @@
+require 'spec_helper'
+module TurnipFormatter::Scenario
+  describe Pass do
+    let(:scenario) { ::TurnipFormatter::Scenario::Pass.new(example) }
+    include_context 'turnip_formatter scenario setup', proc {
+      expect(true).to be_true
+    }
+    context 'Turnip example' do
+      let(:metadata) do
+        {
+          steps: { descriptions: ['Step 1'], docstrings: [[]], keywords: ['When'], tags: [] },
+          file_path: '/path/to/hoge.feature'
+        }
+      end
+      describe '#validation' do
+        it 'should not raise exception' do
+          expect { scenario.validation }.not_to raise_error
+        end
+      end
+    end
+    context 'Not Turnip example' do
+      context 'Not passed example' do
+        let(:metadata) do
+          {
+            steps: { descriptions: ['Step 1'], docstrings: [[]], keywords: ['When'], tags: [] },
+            file_path: '/path/to/hoge.feature'
+          }
+        end
+        include_context 'turnip_formatter scenario setup', proc {
+          expect(true).to be_false
+        }
+        describe '#validation' do
+          it 'should raise exception' do
+            expect { scenario.validation }.to raise_error NotPassedScenarioError
+          end
+        end
+      end
+      context 'not exist feature file' do
+        let(:metadata) do
+          {
+            steps: { descriptions: ['Step 1'], docstrings: [[]], keywords: ['When'], tags: [] },
+            file_path: '/path/to/hoge.rb'
+          }
+        end
+        describe '#validation' do
+          it 'should raise exception' do
+            expect { scenario.validation }.to raise_error NoFeatureFileError
+          end
+        end
+      end
+      context 'not exist step information' do
+        let(:metadata) { { file_path: '/path/to/hoge.rb' } }
+        describe '#validation' do
+          it 'should raise exception' do
+            expect { scenario.validation }.to raise_error NotExistStepsInformationError
+          end
+        end
+      end
+    end
+  end
+end

data/spec/turnip_formatter/scenario/pending_spec.rb ADDED Viewed

@@ -0,0 +1,60 @@
+require 'spec_helper'
+module TurnipFormatter::Scenario
+  describe Failure do
+    let(:scenario) { ::TurnipFormatter::Scenario::Pending.new(pending_example) }
+    let(:pending_example) do
+      example.execution_result[:pending_message] = 'No such step(0): '
+      example
+    end
+    include_context 'turnip_formatter passed scenario metadata'
+    context 'Turnip example' do
+      include_context 'turnip_formatter scenario setup', proc {
+        pending('Pending')
+      }
+      describe '#validation' do
+        it 'should not raise exception' do
+          expect { scenario.validation }.not_to raise_error
+        end
+      end
+    end
+    context 'Not Turnip example' do
+      let(:failure_example) do
+        example
+      end
+      context 'Not pending example' do
+        include_context 'turnip_formatter scenario setup', proc {
+          expect(true).to be_true
+        }
+        describe '#validation' do
+          it 'should raise exception' do
+            expect { scenario.validation }.to raise_error NotPendingScenarioError
+          end
+        end
+      end
+      context 'Not exist pending step information' do
+        include_context 'turnip_formatter scenario setup', proc {
+          pending('Pending')
+        }
+        let(:pending_example) do
+          example
+        end
+        describe '#validation' do
+          it 'should raise exception' do
+            expect { scenario.validation }.to raise_error NoExistPendingStepInformationError
+          end
+        end
+      end
+    end
+  end
+end

data/spec/turnip_formatter/step/failure_spec.rb ADDED Viewed

@@ -0,0 +1,41 @@
+require 'spec_helper'
+module TurnipFormatter
+  class Step
+    describe Failure do
+      let(:description) { ['StepName', 'Keyword', ['Docstring']] }
+      let(:step) { ::TurnipFormatter::Step.new(description) }
+      let(:failure_step) { step.dup.extend TurnipFormatter::Step::Failure }
+      describe '#attention?' do
+        subject { failure_step.attention? }
+        it { should be_true }
+      end
+      describe '#status' do
+        subject { failure_step.status }
+        it { should eq 'failure' }
+      end
+      describe '#attention' do
+        it 'should have been implemented' do
+          expect(step).not_to respond_to(:attention)
+          expect(failure_step).to respond_to(:attention)
+        end
+        it 'should set exception informaton' do
+          exception = StandardError.new
+          expect(exception.backtrace).to be_nil
+          failure_step.attention(exception, ['/path/to/error.rb: 10'])
+          expect(failure_step.docs[:source]).to eq '/path/to/error.rb: 10'
+          failure_step.docs[:exception].tap do |e|
+            expect(e).to eql(exception)
+            expect(e.backtrace.first).to eq '/path/to/error.rb: 10'
+          end
+        end
+      end
+    end
+  end
+end

data/spec/turnip_formatter/step/pending_spec.rb ADDED Viewed

@@ -0,0 +1,28 @@
+require 'spec_helper'
+module TurnipFormatter
+  class Step
+    describe Failure do
+      let(:description) { ['StepName', 'Keyword', ['Docstring']] }
+      let(:step) { ::TurnipFormatter::Step.new(description) }
+      let(:pending_step) { step.dup.extend TurnipFormatter::Step::Pending }
+      describe '#attention?' do
+        subject { pending_step.attention? }
+        it { should be_true }
+      end
+      describe '#status' do
+        subject { pending_step.status }
+        it { should eq 'pending' }
+      end
+      describe '#attention' do
+        it 'should have been implemented' do
+          expect(step).not_to respond_to(:attention)
+          expect(pending_step).to respond_to(:attention)
+        end
+      end
+    end
+  end
+end

data/spec/turnip_formatter/step_spec.rb ADDED Viewed

@@ -0,0 +1,32 @@
+require 'spec_helper'
+module TurnipFormatter
+  describe Step do
+    let(:step) { ::TurnipFormatter::Step.new(description) }
+    let(:description) { ['StepName', 'Keyword', ['Docstring']] }
+    describe '#attention?' do
+      subject { step.attention? }
+      it { should be_false }
+    end
+    describe '#name' do
+      subject { step.name }
+      it { should eq('KeywordStepName') }
+    end
+    describe '#docs' do
+      subject { step.docs }
+      it { should include :extra_args }
+    end
+    context 'No docstring' do
+      let(:description) { ['StepName', 'Keyword', []] }
+      describe '#docs' do
+        subject { step.docs }
+        it { should_not include :extra_args }
+      end
+    end
+  end
+end

data/spec/turnip_formatter/template_spec.rb ADDED Viewed

@@ -0,0 +1,161 @@
+require 'spec_helper'
+module TurnipFormatter
+  describe Template do
+    let(:template) { ::TurnipFormatter::Template.new }
+    context 'Step has no tag' do
+      describe '#scenario_tags' do
+        let(:scenario) do
+          scenario = double('scenario')
+          scenario.stub(:tags).and_return([])
+          scenario
+        end
+        it 'should get null string' do
+          expect(template.send(:scenario_tags, scenario)).to be_empty
+        end
+      end
+    end
+    context 'Step has tags' do
+      describe '#scenario_tags' do
+        let(:scenario) do
+          scenario = double('scenario')
+          scenario.stub(:tags).and_return(['hoge', 'fuga'])
+          scenario
+        end
+        it 'should get null string' do
+          html = template.send(:scenario_tags, scenario)
+          expect(html).to match %r{ul class="tags"}
+          expect(html).to match %r{<li>@hoge</li>[[:space:]]+<li>@fuga</li>}
+        end
+      end
+    end
+    describe '#step_attr' do
+      let(:passed_step) do
+        step = double
+        step.stub(:attention?).and_return(false)
+        step.should_not_receive(:status)
+        step
+      end
+      let(:failed_step) do
+        step = double
+        step.stub(:attention?).and_return(true)
+        step.should_receive(:status) { 'failed' }
+        step
+      end
+      it 'should get tag attribute string' do
+        expect(template.send(:step_attr, passed_step)).to eq('class="step"')
+        expect(template.send(:step_attr, failed_step)).to eq('class="step failed"')
+      end
+    end
+    context 'Step has arguments' do
+      describe '#step_args' do
+        let(:template_stub) do
+          template.stub(:step_extra_args).and_return('extra_args')
+          template.stub(:step_source).and_return('source')
+          template.stub(:step_exception).and_return('exception')
+          template
+        end
+        let(:step) do
+          step = double
+          step.stub(:docs).and_return(extra_args: 'a', source: 'b', exception: 'c')
+          step
+        end
+        it 'should call corresponding method in step' do
+          expect(template_stub.send(:step_args, step)).to eq("extra_args\nsource\nexception")
+        end
+      end
+    end
+    context 'Step has no argument' do
+      describe '#step_args' do
+        let(:template_stub) do
+          template.should_not_receive(:step_extra_args)
+          template.should_not_receive(:step_source)
+          template.should_not_receive(:step_exception)
+          template
+        end
+        let(:step) do
+          step = double
+          step.stub(:docs).and_return({})
+          step
+        end
+        it 'should get null string' do
+          expect(template_stub.send(:step_args, step)).to be_empty
+        end
+      end
+    end
+    describe '#step_extra_args' do
+      let(:template_stub) do
+        template.tap do |t|
+          template.stub(:step_outline).and_return('outline')
+          template.stub(:step_multiline).and_return('multiline')
+        end
+      end
+      let(:extra_args_1) do
+        [::Turnip::Table.new([['a']]), 'b']
+      end
+      let(:extra_args_2) do
+        []
+      end
+      it 'should get string converted from extra_args' do
+        expect(template_stub.send(:step_extra_args, extra_args_1)).to eq("outline\nmultiline")
+        expect(template_stub.send(:step_extra_args, extra_args_2)).to be_empty
+      end
+    end
+    describe '#step_outline' do
+      let(:outline) {
+        ::Turnip::Table.new([
+            ["State", "Money"],
+            ["<Tokushima>", "555"],
+            ["<Okinawa>", "368"]
+          ])
+      }
+      it 'should get string converted to <table>' do
+        html = template.send(:step_outline, outline)
+        expect(html).to match %r{<td>State</td>[[:space:]]+<td>Money</td>}
+        expect(html).to match %r{<td>&lt;Tokushima&gt;</td>[[:space:]]+<td>555</td>}
+        expect(html).to match %r{<td>&lt;Okinawa&gt;</td>[[:space:]]+<td>368</td>}
+      end
+    end
+    describe '#step_multiline' do
+      it 'should get escaped string enclosed in <pre>' do
+        html = template.send(:step_multiline, 'a<a>a')
+        expect(html).to eq('<pre class="multiline">a&lt;a&gt;a</pre>')
+      end
+    end
+    describe '#step_exception' do
+      let(:exception) do
+        StandardError.new('StepExceptionError').tap do |e|
+          e.set_backtrace('/path/to/error.rb: 10')
+        end
+      end
+      it 'should get string Exception class name and backtrace' do
+        html = template.send(:step_exception, exception)
+        expect(html).to match %r{div class="step_exception"}
+        expect(html).to match %r{<pre>.*#{exception.message}.*</pre>}
+        expect(html).to match %r{<li>/path/to/error.rb: 10</li>}
+      end
+    end
+  end
+end