RubyGems - turnip_formatter - Versions diffs - 0.2.1 → 0.2.2 - Mend

turnip_formatter 0.2.1 → 0.2.2

Files changed (42) hide show

data/lib/rspec/core/formatters/turnip_formatter.rb +7 -34
data/lib/turnip_formatter/ext/turnip/rspec.rb +2 -0
data/lib/turnip_formatter/printer/index.rb +29 -0
data/lib/turnip_formatter/printer/runtime_error.rb +41 -0
data/lib/turnip_formatter/printer/scenario.rb +20 -0
data/lib/turnip_formatter/printer/step.rb +34 -0
data/lib/turnip_formatter/printer/step_extra_args.rb +21 -0
data/lib/turnip_formatter/printer/tab_feature_statistics.rb +47 -0
data/lib/turnip_formatter/printer/tab_speed_statistics.rb +34 -0
data/lib/turnip_formatter/printer/tab_tag_statistics.rb +72 -0
data/lib/turnip_formatter/printer.rb +34 -0
data/lib/turnip_formatter/template/exception.erb +9 -25
data/lib/turnip_formatter/template/index.erb +65 -0
data/lib/turnip_formatter/template/runtime_exception.erb +16 -0
data/lib/turnip_formatter/template/scenario.erb +9 -8
data/lib/turnip_formatter/template/step.erb +4 -0
data/lib/turnip_formatter/template/tab_feature_statistics.erb +24 -0
data/lib/turnip_formatter/template/tab_speed_statistics.erb +18 -0
data/lib/turnip_formatter/template/tab_tag_statistics.erb +24 -0
data/lib/turnip_formatter/template/turnip_formatter.js +51 -0
data/lib/turnip_formatter/{formatter.scss → template/turnip_formatter.scss} +0 -0
data/lib/turnip_formatter/template.rb +21 -254
data/lib/turnip_formatter/version.rb +1 -1
data/lib/turnip_formatter.rb +1 -1
data/spec/rspec/core/formatters/turnip_formatter_spec.rb +11 -28
data/spec/turnip_formatter/printer/scenario_spec.rb +33 -0
data/spec/turnip_formatter/printer/step_extra_args_spec.rb +32 -0
data/spec/turnip_formatter/printer/step_spec.rb +86 -0
data/spec/turnip_formatter/printer/tab_feature_statistics_spec.rb +83 -0
data/spec/turnip_formatter/printer/tab_speed_statistics_spec.rb +51 -0
data/spec/turnip_formatter/printer/tab_tag_statistics_spec.rb +90 -0
data/spec/turnip_formatter/template_spec.rb +0 -173
data/turnip_formatter.gemspec +2 -0
metadata +63 -14
data/lib/turnip_formatter/formatter.css +0 -205
data/lib/turnip_formatter/template/scenario_tags.erb +0 -5
data/lib/turnip_formatter/template/tab/feature_statistics.rb +0 -78
data/lib/turnip_formatter/template/tab/speed_statistics.rb +0 -61
data/lib/turnip_formatter/template/tab/tag_statistics.rb +0 -101
data/spec/turnip_formatter/template/tab/feature_statistics_spec.rb +0 -87
data/spec/turnip_formatter/template/tab/speed_statistics_spec.rb +0 -56
data/spec/turnip_formatter/template/tab/tag_statistics_spec.rb +0 -88

data/lib/turnip_formatter/template/turnip_formatter.js ADDED Viewed

@@ -0,0 +1,51 @@
+$(function() {
+    var scenarioHeader = 'section.scenario header';
+    $(scenarioHeader).siblings().hide();
+    /**
+     * Step folding/expanding
+     */
+    $(scenarioHeader).click(function() {
+        $(this).siblings().slideToggle();
+    });
+    /**
+     * All step folding/expanding action
+     */
+    $('#scenario_display_check').change(function() {
+        var steps = $(scenarioHeader).siblings();
+        if (this.checked) {
+            steps.slideUp();
+        } else {
+            steps.slideDown();
+        }
+    });
+    ["passed", "failed", "pending"].forEach(function(status) {
+        $('#' + status + '_check').click(function() {
+            if (this.checked) {
+                $('.scenario.' + status).show();
+            } else {
+                $('.scenario.' + status).hide();
+            }
+        });
+    });
+    $(".scenario.passed").hide();
+    $(".scenario.pending").hide();
+    /**
+     * Tabs
+     */
+    $('div#main').tabs();
+    $('div#speed-statistics a').click(function() {
+        $('div#main').tabs("option", "active", 0);
+    });
+    $("div#speed-statistics table").tablesorter({
+        headers: {
+            1: { sorter: false }
+        }
+    });
+});

data/lib/turnip_formatter/{formatter.scss → template/turnip_formatter.scss} RENAMED Viewed

File without changes

data/lib/turnip_formatter/template.rb CHANGED Viewed

@@ -1,22 +1,28 @@
 # -*- coding: utf-8 -*-
-require 'erb'
-require 'rspec/core/formatters/helpers'
-require 'turnip_formatter/template/tab/speed_statistics'
-require 'turnip_formatter/template/tab/feature_statistics'
-require 'turnip_formatter/template/tab/tag_statistics'
+require 'turnip_formatter/template'
 require 'sass'
+require 'uglifier'
 module TurnipFormatter
   class Template
-    include ERB::Util
-    include RSpec::Core::BacktraceFormatter
     class << self
       def add_js(js_string)
         js_list << js_string
       end
+      def add_js_file(file)
+        js_list << Uglifier.compile(File.read(file))
+      end
+      def add_scss(scss_string)
+        css_list << Sass::Engine.new(scss_string, scss_option).render
+      end
+      def add_scss_file(path)
+        css_list << Sass::Engine.for_file(path, scss_option).render
+      end
       def js_render
         js_list.join("\n")
       end
@@ -25,10 +31,6 @@ module TurnipFormatter
         css_list.join("\n")
       end
-      def add_scss(scss_string)
-        css_list << scss_compile(scss_string)
-      end
       def js_list
         @js_list ||= []
       end
@@ -37,249 +39,14 @@ module TurnipFormatter
         @css_list ||= []
       end
-      def scss_compile(scss)
-        Sass::Engine.new(scss, syntax: :scss).render
-      end
-    end
-    def print_header
-      <<-EOS
-        <!DOCTYPE html>
-        <html>
-          <head>
-            <meta charset="UTF-8">
-            <title>turnip formatter report</title>
-            <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js"></script>
-            <script src="http://ajax.googleapis.com/ajax/libs/jqueryui/1.10.2/jquery-ui.min.js"></script>
-            <script src="http://cdnjs.cloudflare.com/ajax/libs/jquery.tablesorter/2.9.1/jquery.tablesorter.min.js"></script>
-            <link rel="stylesheet" href="http://ajax.googleapis.com/ajax/libs/jqueryui/1.10.2/themes/smoothness/jquery-ui.css">
-            <style>
-              #{File.read(File.dirname(__FILE__) + '/formatter.css')}
-              #{self.class.css_render}
-            </style>
-            <script>
-              $(function() {
-                  var scenarioHeader = 'section.scenario header';
-                  $(scenarioHeader).siblings().hide();
-                  /**
-                   * Step folding/expanding
-                   */
-                  $(scenarioHeader).click(function() {
-                      var steps = $(this).siblings();
-                      steps.slideToggle();
-                  });
-                  /**
-                   * All step folding/expanding action
-                   */
-                  $('#scenario_display_check').change(function() {
-                      var steps = $(scenarioHeader).siblings();
-                      if (this.checked) {
-                          steps.slideUp();
-                      } else {
-                          steps.slideDown();
-                      }
-                  });
-                  ["passed", "failed", "pending"].forEach(function(status) {
-                      $('#' + status + '_check').click(function() {
-                          if (this.checked) {
-                              $('.scenario.' + status).show();
-                          } else {
-                              $('.scenario.' + status).hide();
-                          }
-                      });
-                  });
-                  $(".scenario.passed").hide();
-                  $(".scenario.pending").hide();
-                  /**
-                   * Tabs
-                   */
-                   var tab_area = 'div#main';
-                   $(tab_area).tabs();
-                   $('div#speed-statistics a').click(function() {
-                       $(tab_area).tabs("option", "active", 0);
-                   });
-                   $("div#speed-statistics table").tablesorter({
-                       headers: {
-                           1: { sorter: false }
-                       }
-                   });
-                   #{self.class.js_render}
-              });
-            </script>
-          </head>
-          <body>
-            #{print_section_report}
-            <div id="main" role="main">
-              <ul>
-                <li><a href="#steps-statistics">Steps</a></li>
-                <li><a href="#speed-statistics">Speed Statistics</a></li>
-                <li><a href="#feature-statistics">Feature Statistics</a></li>
-                <li><a href="#tag-statistics">Tag Statistics</a></li>
-              </ul>
-      EOS
-    end
-    def print_main_header
-      <<-EOS
-        <div id="steps-statistics">
-          <label><input type="checkbox" id="scenario_display_check" checked>step folding</label>
-      EOS
-    end
-    def print_main_footer(total_count, failed_count, pending_count, total_time)
-      update_report_js_tmp = '<script type="text/javascript">document.getElementById("%s").innerHTML = "%s";</script>'
-      update_report_js = ''
-      %w{ total_count failed_count pending_count total_time }.each do |key|
-        update_report_js += update_report_js_tmp % [key, eval(key)]
-      end
-      "#{update_report_js}</div>"
-    end
-    def print_tab_speed_statsitics(passed_scenarios)
-      statistics = TurnipFormatter::Template::Tab::SpeedStatistics.new(passed_scenarios)
-      <<-EOS
-        <div id="speed-statistics">
-          <em>Ranking of running time of each <strong>successfully</strong> scenario:</em>
-          #{statistics.build}
-        </div>
-      EOS
-    end
-    def print_tab_feature_statsitics(scenarios)
-      statistics = TurnipFormatter::Template::Tab::FeatureStatistics.new(scenarios)
-      <<-EOS
-        <div id="feature-statistics">
-          <em>The results for the feature:</em>
-          #{statistics.build}
-        </div>
-      EOS
-    end
-    def print_tab_tag_statsitics(scenarios)
-      statistics = TurnipFormatter::Template::Tab::TagStatistics.new(scenarios)
-      <<-EOS
-        <div id="tag-statistics">
-          <em>The results for the tab:</em>
-          #{statistics.build}
-        </div>
-      EOS
-    end
-    def print_footer
-      <<-EOS
-            </div>
-            <footer>
-              <p>Generated by <a href="https://rubygems.org/gems/turnip_formatter">turnip_formatter</a> #{TurnipFormatter::VERSION}</p>
-              <p>Powered by <a href="http://jquery.com/">jQuery</a> 1.9.1, <a href="http://jqueryui.com/">jQuery UI</a> 1.10.2 and <a href="http://mottie.github.io/tablesorter/">tablesorter</a> 2.9.1</p>
-            </footer>
-          </body>
-        </html>
-      EOS
-    end
-    def print_scenario(scenario)
-      render_template(:scenario, { scenario: scenario })
-    end
-    def print_runtime_error(example, exception)
-      exception.set_backtrace(format_backtrace(exception.backtrace))
-      render_template(:exception, { example: example, exception: exception })
-    end
-    def print_exception_backtrace(e)
-      render_template(:exception_backtrace, { backtrace: e.backtrace })
-    end
-    def print_scenario_tags(scenario)
-      if scenario.tags.empty?
-        ''
-      else
-        render_template(:scenario_tags, { tags: scenario.tags })
-      end
-    end
-    def print_step_extra_args(extra_args)
-      extra_args.map do |arg|
-        if arg.instance_of?(Turnip::Table)
-          print_step_outline(arg)
-        else
-          print_step_multiline(arg)
-        end
-      end.join("\n")
-    end
-    def print_step_outline(table)
-      render_template(:step_outline, { table: table.to_a })
-    end
-    def print_step_multiline(lines)
-      render_template(:step_multiline, { lines: lines })
-    end
-    def print_section_report
-      render_template(:section_report)
-    end
-    private
-    def step_attr(step)
-      attr = 'step'
-      attr += " #{step.status}" if step.attention?
-      "class=\"#{h(attr)}\""
-    end
-    def step_args(step)
-      output = []
-      step.docs.each do |style, template|
-        if style == :extra_args
-          output << print_step_extra_args(template[:value])
-        else
-          output << template[:klass].build(template[:value])
-        end
-      end
-      output.join("\n")
-    end
-    #
-    # @example
-    #   render_template(:main, { name: 'user' })
-    #     # => ERB.new('/path/to/main.erb') render { name: 'user' }
-    #
-    def render_template(name, params = {})
-      render_template_list(name).result(template_params_binding(params))
-    end
-    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))
+      def scss_option
+        { syntax: :scss, style: :compressed }
       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
   end
 end
+(File.dirname(__FILE__) + '/template').tap do |dirname|
+  TurnipFormatter::Template.add_scss_file(dirname + '/turnip_formatter.scss')
+  TurnipFormatter::Template.add_js_file(dirname + '/turnip_formatter.js')
+end

data/lib/turnip_formatter/version.rb CHANGED Viewed

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

data/lib/turnip_formatter.rb CHANGED Viewed

@@ -9,7 +9,7 @@ module TurnipFormatter
   require 'turnip_formatter/step_template'
   require 'turnip_formatter/ext/turnip/rspec'
   require 'turnip_formatter/ext/turnip/builder'
+  require 'turnip_formatter/printer/index'
 end
 RSpecTurnipFormatter = RSpec::Core::Formatters::TurnipFormatter

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

@@ -10,29 +10,17 @@ module RSpec::Core::Formatters
     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
       before do
         scenario.example('passed', metadata) { expect(true).to be_true }
         feature.run(formatter)
       end
-      it 'should be output passed scenario section' do
-        string = output.string
-        expect(string).to match 'class="scenario passed"'
-      end
       it 'should get passed scenario count' do
         expect(formatter.passed_scenarios).to have(1).elements
         expect(formatter.failed_scenarios).to have(0).elements
         expect(formatter.pending_scenarios).to have(0).elements
+        expect(formatter.scenarios).to have(1).elements
       end
     end
@@ -49,14 +37,11 @@ module RSpec::Core::Formatters
         feature.run(formatter)
       end
-      it 'should be output failed scenario section' do
-        expect(output.string).to match 'class="scenario failed"'
-      end
       it 'should get failed scenario count' do
         expect(formatter.passed_scenarios).to have(0).elements
         expect(formatter.failed_scenarios).to have(1).elements
         expect(formatter.pending_scenarios).to have(0).elements
+        expect(formatter.scenarios).to have(1).elements
       end
     end
@@ -68,27 +53,25 @@ module RSpec::Core::Formatters
         feature.run(formatter)
       end
-      it 'should be output pending scenario section' do
-        expect(output.string).to match 'class="scenario pending"'
-      end
       it 'should get pending scenario count' do
         expect(formatter.passed_scenarios).to have(0).elements
         expect(formatter.failed_scenarios).to have(0).elements
         expect(formatter.pending_scenarios).to have(1).elements
+        expect(formatter.scenarios).to have(1).elements
       end
     end
     describe '#dump_summary' do
-      it 'should be output summary section' do
+      before do
         formatter.dump_summary(0.0, 3, 2, 1)
-        actual = output.string
+      end
+      subject { 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>'
+      it 'should be output summary section' do
+        should include '(<span id="failed_count">2</span> failed'
+        should include '<span id="pending_count">1</span> pending)'
+        should include '<span id="total_time">0.0</span>'
       end
     end
   end

data/spec/turnip_formatter/printer/scenario_spec.rb ADDED Viewed

@@ -0,0 +1,33 @@
+require 'spec_helper'
+require 'turnip_formatter/printer/scenario'
+module TurnipFormatter::Printer
+  describe Scenario do
+    include_context 'turnip_formatter scenario setup'
+    include_context 'turnip_formatter standard scenario metadata'
+    let(:scenario) do
+      TurnipFormatter::Scenario::Pass.new(example)
+    end
+    context 'turnip example' do
+      describe '.print_out' do
+        subject { Scenario.print_out(scenario) }
+        it { should include "<a href=\"##{scenario.id}\">" } # scenario.id
+        it { should include 'Scenario: Scenario' } # h(scenario.name)
+      end
+    end
+    context 'not turnip example' do
+      describe '.print_out' do
+        before do
+          scenario.stub(:validation) { raise NoFeatureFileError }
+          RuntimeError.should_receive(:print_out)
+        end
+        it { Scenario.print_out(scenario) }
+      end
+    end
+  end
+end

data/spec/turnip_formatter/printer/step_extra_args_spec.rb ADDED Viewed

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'turnip_formatter/printer/step_extra_args'
+module TurnipFormatter::Printer
+  describe StepExtraArgs do
+    context 'Turnip::Table' do
+      describe '.print_out' do
+        let(:string) do
+          ::Turnip::Table.new([
+              ["State", "Money"],
+              ["<Tokushima>", "555"],
+              ["<Okinawa>", "368"]
+            ])
+        end
+        subject { StepExtraArgs.print_out([string]) }
+        it { should match %r{<td>State</td>[[:space:]]+<td>Money</td>} }
+        it { should match %r{<td>&lt;Tokushima&gt;</td>[[:space:]]+<td>555</td>} }
+        it { should match %r{<td>&lt;Okinawa&gt;</td>[[:space:]]+<td>368</td>} }
+      end
+    end
+    context 'String' do
+      describe '.print_out' do
+        let(:string) { 'a<a>a' }
+        subject { StepExtraArgs.print_out([string]) }
+        it { should include '<pre class="multiline">a&lt;a&gt;a</pre>' }
+      end
+    end
+  end
+end

data/spec/turnip_formatter/printer/step_spec.rb ADDED Viewed

@@ -0,0 +1,86 @@
+require 'spec_helper'
+require 'turnip_formatter/printer/step'
+module TurnipFormatter::Printer
+  describe Step do
+    let(:exception_style) { ::TurnipFormatter::StepTemplate::Exception }
+    let(:source_style) { ::TurnipFormatter::StepTemplate::Source }
+    subject { Step.print_out(step) }
+    context 'Step has arguments' do
+      let(:table) { Turnip::Table.new [] }
+      context 'original template' do
+        describe '#step_args' do
+          let(:step) do
+            docs = {}
+            docs[:extra_args] = { klass: nil, value: ['a', table] }
+            docs[source_style] = { klass: source_style, value: 'b' }
+            docs[exception_style] = { klass: exception_style, value: 'c' }
+            double(status: '', name: 'step', docs: docs)
+          end
+          before do
+            StepExtraArgs.should_receive(:print_out).with(['a', table]).and_return('extra_args')
+            source_style.should_receive(:build).with('b').and_return('source')
+            exception_style.should_receive(:build).with('c').and_return('exception')
+          end
+          it { should include "<div class=\"args\">extra_args\nsource\nexception</div>" }
+        end
+      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
+          let(:step) do
+            docs = {
+              source: { klass: custom_template_1, value: 'aiueo' },
+              exception: { klass: custom_template_2, value: '12345' }
+            }
+            double(status: '', name: 'step', docs: docs)
+          end
+          it 'should call corresponding method in step' do
+            should include "<div class=\"args\"><html>aiueo</html>\n<strong>12345</strong></div>"
+          end
+        end
+      end
+    end
+    context 'Step has no argument' do
+      describe '#step_args' do
+        let(:step) do
+          double(status: '', name: 'step', docs: [])
+        end
+        before do
+          StepExtraArgs.should_not_receive(:print_out)
+          source_style.should_not_receive(:build)
+          exception_style.should_not_receive(:build)
+        end
+        it { should include '<div class="args"></div>' }
+      end
+    end
+  end
+end

data/spec/turnip_formatter/printer/tab_feature_statistics_spec.rb ADDED Viewed

@@ -0,0 +1,83 @@
+require 'spec_helper'
+require 'turnip_formatter/printer/tab_feature_statistics'
+module TurnipFormatter::Printer
+  describe TabFeatureStatistics do
+    include_context 'turnip_formatter scenario setup'
+    include_context 'turnip_formatter standard scenario metadata'
+    let :base_scenario do
+      TurnipFormatter::Scenario::Pass.new(example)
+    end
+    let :statistics do
+      TurnipFormatter::Printer::TabFeatureStatistics
+    end
+    context 'feature only passed scenario' do
+      let :scenarios do
+        # Feature: Hago (passed:2 failed:0, pending:0)
+        ['passed', 'passed'].map do |status|
+          scenario = base_scenario.dup
+          scenario.stub(:status).and_return(status)
+          scenario
+        end
+      end
+      describe '.feature_analysis' do
+        it 'should get passed feature information' do
+          info = statistics.send(:feature_analysis, 'Hoge', scenarios)
+          expect(info.name).to eq 'Hoge'
+          expect(info.passed).to eq 2
+          expect(info.failed).to be_zero
+          expect(info.pending).to be_zero
+          expect(info.status).to eq 'passed'
+        end
+      end
+    end
+    context 'feature with failed scenario' do
+      let :scenarios do
+        # Feature: Hoge (passed:1 failed:2, pending:0)
+        ['passed', 'failed', 'failed'].map do |status|
+          scenario = base_scenario.dup
+          scenario.stub(:status).and_return(status)
+          scenario
+        end
+      end
+      describe '.feature_analysis' do
+        it 'should get failed feature information' do
+          info = statistics.send(:feature_analysis, 'Fuga', scenarios)
+          expect(info.name).to eq 'Fuga'
+          expect(info.passed).to eq 1
+          expect(info.failed).to eq 2
+          expect(info.pending).to be_zero
+          expect(info.status).to eq 'failed'
+        end
+      end
+    end
+    context 'feature with pending scenario' do
+      let :scenarios do
+        # Feature: Fuga (passed:1 failed:0, pending:1)
+        ['passed', 'pending'].map do |status|
+          scenario = base_scenario.dup
+          scenario.stub(:status).and_return(status)
+          scenario
+        end
+      end
+      describe '.feature_analysis' do
+        it 'should get pending feature information' do
+          info = statistics.send(:feature_analysis, 'Hago', scenarios)
+          expect(info.name).to eq 'Hago'
+          expect(info.passed).to eq 1
+          expect(info.failed).to be_zero
+          expect(info.pending).to eq 1
+          expect(info.status).to eq 'pending'
+        end
+      end
+    end
+  end
+end