turnip_formatter 0.2.1 → 0.2.2

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

@@ -4,7 +4,7 @@ require 'rspec/core/formatters/base_formatter'
 require 'turnip_formatter/scenario/pass'
 require 'turnip_formatter/scenario/failure'
 require 'turnip_formatter/scenario/pending'
-require 'turnip_formatter/template'
+require 'turnip_formatter/printer/index'
 
 module RSpec
   module Core
@@ -15,25 +15,15 @@ module RSpec
 
         def initialize(output)
           super(output)
-          @template = ::TurnipFormatter::Template.new
-          @passed_scenarios = []
-          @failed_scenarios = []
+          @passed_scenarios  = []
+          @failed_scenarios  = []
           @pending_scenarios = []
           @scenarios = []
         end
 
-        def start(example_count)
-          super(example_count)
-          output.puts @template.print_header
-          output.puts @template.print_main_header
-        end
-
         def dump_summary(duration, example_count, failure_count, pending_count)
-          output.puts @template.print_main_footer(example_count, failure_count, pending_count, duration)
-          output.puts @template.print_tab_speed_statsitics(passed_scenarios)
-          output.puts @template.print_tab_feature_statsitics(scenarios)
-          output.puts @template.print_tab_tag_statsitics(scenarios)
-          output.puts @template.print_footer
+          super(duration, example_count, failure_count, pending_count)
+          output.puts ::TurnipFormatter::Printer::Index.print_out(self)
         end
 
         def example_passed(example)
@@ -41,8 +31,7 @@ module RSpec
 
           scenario = ::TurnipFormatter::Scenario::Pass.new(example)
           @passed_scenarios << scenario
-
-          output_scenario(scenario)
+          @scenarios << scenario
         end
 
         def example_pending(example)
@@ -50,8 +39,7 @@ module RSpec
 
           scenario = ::TurnipFormatter::Scenario::Pending.new(example)
           @pending_scenarios << scenario
-
-          output_scenario(scenario)
+          @scenarios << scenario
         end
 
         def example_failed(example)
@@ -59,22 +47,7 @@ module RSpec
 
           scenario = ::TurnipFormatter::Scenario::Failure.new(example)
           @failed_scenarios << scenario
-
-          output_scenario(scenario)
-        end
-
-        private
-
-        def output_scenario(scenario)
-          scenario.validation
           @scenarios << scenario
-          output.puts @template.print_scenario(scenario)
-        rescue => e
-          output_runtime_error(e)
-        end
-
-        def output_runtime_error(exception)
-          output.puts @template.print_runtime_error(examples.last, exception)
         end
       end
     end

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

@@ -9,8 +9,10 @@ module Turnip
         begin
           step(step)
         rescue Turnip::Pending
+          example.metadata[:line_number] = step.line
           pending("No such step(#{index}): '#{step}'")
         rescue StandardError => e
+          example.metadata[:line_number] = step.line
           e.backtrace.push "#{feature_file}:#{step.line}:in step:#{index} `#{step.description}'"
           raise e
         end

data/lib/turnip_formatter/printer/index.rb

@@ -0,0 +1,29 @@
+require 'turnip_formatter/printer'
+require 'turnip_formatter/printer/scenario'
+require 'turnip_formatter/printer/tab_feature_statistics'
+require 'turnip_formatter/printer/tab_tag_statistics'
+require 'turnip_formatter/printer/tab_speed_statistics'
+
+module TurnipFormatter
+  module Printer
+    class Index
+      class << self
+        include TurnipFormatter::Printer
+
+        #
+        # @param  RSpec::Core::Formatters::TurnipFormatter  formatter
+        #
+        def print_out(formatter)
+          render_template(:index, {
+              scenarios:        formatter.scenarios,
+              passed_scenarios: formatter.passed_scenarios,
+              failed_count:     formatter.failure_count,
+              pending_count:    formatter.pending_count,
+              total_time:       formatter.duration,
+            }
+          )
+        end
+      end
+    end
+  end
+end

data/lib/turnip_formatter/printer/runtime_error.rb

@@ -0,0 +1,41 @@
+require 'turnip_formatter/printer'
+require 'turnip_formatter/printer/step_extra_args'
+
+module TurnipFormatter
+  module Printer
+    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),
+              example_exception: example_exception(example),
+            }
+          )
+        end
+
+        private
+
+        def runtime_exception(exception)
+          render_template(:exception, { title: 'Runtime', exception: exception })
+        end
+
+        def example_exception(example)
+          unless example.exception
+            ''
+          else
+            render_template(:exception, {
+                title: 'Example',
+                exception: example.exception
+              }
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/turnip_formatter/printer/scenario.rb

@@ -0,0 +1,20 @@
+require 'turnip_formatter/printer'
+require 'turnip_formatter/printer/step'
+require 'turnip_formatter/printer/runtime_error'
+
+module TurnipFormatter
+  module Printer
+    class Scenario
+      class << self
+        include TurnipFormatter::Printer
+
+        def print_out(scenario)
+          scenario.validation
+          render_template(:scenario, scenario: scenario)
+        rescue => e
+          TurnipFormatter::Printer::RuntimeError.print_out(scenario.example, e)
+        end
+      end
+    end
+  end
+end

data/lib/turnip_formatter/printer/step.rb

@@ -0,0 +1,34 @@
+require 'turnip_formatter/printer'
+require 'turnip_formatter/printer/step_extra_args'
+
+module TurnipFormatter
+  module Printer
+    class Step
+      class << self
+        include TurnipFormatter::Printer
+
+        def print_out(step)
+          render_template(:step, { step: step, step_docs: documents(step.docs) })
+        end
+
+        private
+
+        def documents(docs)
+          docs.map do |style, template|
+            if style == :extra_args
+              TurnipFormatter::Printer::StepExtraArgs.print_out(template[:value])
+            else
+              #
+              # Template class which is registered in
+              #    +Step::Failure.add_template+
+              #    +Step::Pending.add_template+
+              # be called.
+              #
+              template[:klass].build(template[:value])
+            end
+          end.join("\n")
+        end
+      end
+    end
+  end
+end

data/lib/turnip_formatter/printer/step_extra_args.rb

@@ -0,0 +1,21 @@
+require 'turnip_formatter/printer'
+
+module TurnipFormatter
+  module Printer
+    class StepExtraArgs
+      class << self
+        include TurnipFormatter::Printer
+
+        def print_out(args)
+          args.map do |arg|
+            if arg.instance_of?(Turnip::Table)
+              render_template(:step_outline, { table: arg.to_a })
+            else
+              render_template(:step_multiline, { lines: arg })
+            end
+          end.join
+        end
+      end
+    end
+  end
+end

data/lib/turnip_formatter/printer/tab_feature_statistics.rb

@@ -0,0 +1,47 @@
+# -*- coding: utf-8 -*-
+
+require 'turnip_formatter/printer'
+require 'ostruct'
+
+module TurnipFormatter
+  module Printer
+    module TabFeatureStatistics
+      class << self
+        include TurnipFormatter::Printer
+
+        def print_out(scenarios)
+          features = scenarios.group_by { |s| s.feature_name }
+
+          results = features.map do |name, feature_scenarios|
+            feature_analysis(name, feature_scenarios)
+          end
+
+          render_template(:tab_feature_statistics, {analysis_results: results })
+        end
+
+        private
+
+        def feature_analysis(name, scenarios)
+          status_group = scenarios.group_by { |s| s.status }
+
+          info = OpenStruct.new(
+            name: name,
+            scenarios: scenarios.count,
+            passed: status_count(status_group["passed"]),
+            failed: status_count(status_group["failed"]),
+            pending: status_count(status_group["pending"]),
+            status: 'failed'
+          )
+
+          info.status = (info.pending.zero? ? 'passed' : 'pending') if info.failed.zero?
+
+          info
+        end
+
+        def status_count(scenarios)
+          scenarios.nil? ? 0 : scenarios.count
+        end
+      end
+    end
+  end
+end

data/lib/turnip_formatter/printer/tab_speed_statistics.rb

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+
+require 'turnip_formatter/printer'
+require 'ostruct'
+
+module TurnipFormatter
+  module Printer
+    class TabSpeedStatistics
+      class << self
+        include TurnipFormatter::Printer
+
+        def print_out(passed_scenarios)
+          results = speed_analysis(passed_scenarios)
+          render_template(:tab_speed_statistics, {analysis_results: results })
+        end
+
+        private
+
+        def speed_analysis(scenarios)
+          scenarios.map do |s|
+            OpenStruct.new(
+              {
+                id: s.id,
+                feature_name: s.feature_name,
+                name: s.name,
+                run_time: s.run_time
+              }
+            )
+          end.sort { |a, b| a.run_time <=> b.run_time }
+        end
+      end
+    end
+  end
+end

data/lib/turnip_formatter/printer/tab_tag_statistics.rb

@@ -0,0 +1,72 @@
+# -*- coding: utf-8 -*-
+
+require 'turnip_formatter/printer'
+require 'ostruct'
+
+module TurnipFormatter
+  module Printer
+    class TabTagStatistics
+      class << self
+        include TurnipFormatter::Printer
+
+        def print_out(scenarios)
+          tags = group_by_tag(scenarios)
+
+          results = tags.map do |name, tag_scenarios|
+            tag_analysis(name, tag_scenarios)
+          end
+
+          render_template(:tab_tag_statistics, { analysis_results: results })
+        end
+
+        private
+
+        def tag_analysis(name, scenarios)
+          status_group = scenarios.group_by { |s| s[:scenario].status }
+
+          info = OpenStruct.new(
+            name: name,
+            scenarios: scenarios.count,
+            passed: status_count(status_group["passed"]),
+            failed: status_count(status_group["failed"]),
+            pending: status_count(status_group["pending"]),
+            status: 'failed'
+          )
+
+          info.status = (info.pending.zero? ? 'passed' : 'pending') if info.failed.zero?
+          info
+        end
+
+        #
+        # Image...
+        #
+        # [
+        #   { tags: [:a, :b], val: 3 },
+        #   { tags: [:a], val: 4 },
+        #   { tags: [:b], val: 5 },
+        # ]
+        # # => [
+        #        [:a, [3, 4]],
+        #        [:b, [3, 5]],
+        #      ]
+        #
+        #
+        def group_by_tag(scenarios)
+          scenarios.map do |scenario|
+            if scenario.tags.empty?
+              { name: 'turnip', scenario: scenario }
+            else
+              scenario.tags.map do |tag|
+                { name: '@' + tag, scenario: scenario }
+              end
+            end
+          end.flatten.group_by { |s| s[:name] }.sort
+        end
+
+        def status_count(scenarios)
+          scenarios.nil? ? 0 : scenarios.count
+        end
+      end
+    end
+  end
+end

data/lib/turnip_formatter/printer.rb

@@ -0,0 +1,34 @@
+module TurnipFormatter
+  module Printer
+    include ERB::Util
+
+    #
+    # @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
+
+    private
+
+    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))
+      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

data/lib/turnip_formatter/template/exception.erb

@@ -1,26 +1,10 @@
-<section class="exception">
-  <h1>TurnipFormatter RuntimeError</h1>
-  <dl>
-    <dt>Runtime Exception</dt>
-    <dd><%= h(exception.to_s) %></dd>
-
-    <dt>Runtime Exception Backtrace</dt>
-    <%= print_exception_backtrace(exception) %>
-
-    <dt>Example Full Description</dt>
-    <dd><%= h(example.metadata[:full_description]) %></dd>
-
-    <% if example.exception %>
-      <dt>Example Exception</dt>
-      <dd><%= h(example.exception.to_s) %></dd>
-
-      <dt>Example Backtrace</dt>
-      <%= print_exception_backtrace(example.exception) %>
+<dt><%= h(title) %> Exception</dt>
+<dd><%= h(exception.to_s) %></dd>
+<dt><%= h(title) %> Exception Backtrace</dt>
+<dd>
+  <ol>
+    <% exception.backtrace.each do |line| %>
+      <li><%= h(line) %></li>
     <% end %>
-
-    <% if example.pending %>
-      <dt>Example Pending description</dt>
-      <dd><%= h(example.metadata[:description]) %></dd>
-    <% end %>
-  </dl>
-</section>
+  </ol>
+</dd>

data/lib/turnip_formatter/template/index.erb

@@ -0,0 +1,65 @@
+<!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><%= TurnipFormatter::Template.css_render %></style>
+    <script><%= TurnipFormatter::Template.js_render %></script>
+  </head>
+  <body>
+    <div id="report">
+      <h1>Turnip Report</h1>
+      <section class="checkbox">
+        <label for="passed_check">Passed</label><input type="checkbox" id="passed_check">
+        <label for="failed_check">Failed</label><input type="checkbox" checked id="failed_check">
+        <label for="pending_check">Pending</label><input type="checkbox" id="pending_check">
+      </section>
+
+      <section class="result">
+        <p>
+          <span id="total_count"><%= h(scenarios.size) %></span> Scenario
+          (<span id="failed_count"><%= h(failed_count) %></span> failed
+          <span id="pending_count"><%= h(pending_count) %></span> pending).
+        </p>
+        <p>Finished in <span id="total_time"><%= h(total_time) %></span></p>
+      </section>
+    </div>
+
+    <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>
+      <div id="steps-statistics">
+        <label><input type="checkbox" id="scenario_display_check" checked>step folding</label>
+        <% scenarios.each do |scenario| %>
+          <%= TurnipFormatter::Printer::Scenario.print_out(scenario) %>
+        <% end %>
+      </div>
+      <div id="feature-statistics">
+        <em>The results for the feature:</em>
+        <%= TurnipFormatter::Printer::TabFeatureStatistics.print_out(scenarios) %>
+      </div>
+      <div id="tag-statistics">
+        <em>The results for the tab:</em>
+        <%= TurnipFormatter::Printer::TabTagStatistics.print_out(scenarios) %>
+      </div>
+      <div id="speed-statistics">
+        <em>Ranking of running time of each <strong>successfully</strong> scenario:</em>
+        <%= TurnipFormatter::Printer::TabSpeedStatistics.print_out(passed_scenarios) %>
+      </div>
+    </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>

data/lib/turnip_formatter/template/runtime_exception.erb

@@ -0,0 +1,16 @@
+<section class="exception">
+  <h1>TurnipFormatter RuntimeError</h1>
+  <dl>
+    <%= runtime_exception %>
+
+    <dt>Example Full Description</dt>
+    <dd><%= h(example.metadata[:full_description]) %></dd>
+
+    <%= example_exception %>
+
+    <% if example.pending %>
+      <dt>Example Pending description</dt>
+      <dd><%= h(example.metadata[:description]) %></dd>
+    <% end %>
+  </dl>
+</section>

data/lib/turnip_formatter/template/scenario.erb

@@ -7,18 +7,19 @@
       Scenario: <%= h(scenario.name) %>
     </span>
     <span class="feature_name">
-      (Feature: <%= h(scenario.feature_info) %>)
-      at <%= h(scenario.run_time) %> sec
+      (Feature: <%= h(scenario.feature_info) %>) at <%= h(scenario.run_time) %> sec
     </span>
   </header>
-  <%= print_scenario_tags(scenario) %>
+
+  <ul class="tags">
+    <% scenario.tags.each do |tag| %>
+    <li>@<%= h(tag) %></li>
+    <% end %>
+  </ul>
+
   <ul class="steps">
     <% scenario.steps.each do |step| %>
-      <li <%= step_attr(step) %>><span><%= h(step.name) %></span>
-        <div class="args">
-          <%= step_args(step) %>
-        </div>
-      </li>
+      <%= TurnipFormatter::Printer::Step.print_out(step) %>
     <% end %>
   </ul>
 </section>

data/lib/turnip_formatter/template/step.erb

@@ -0,0 +1,4 @@
+<li class="step <%= step.status %>">
+  <span><%= h(step.name) %></span>
+  <div class="args"><%= step_docs %></div>
+</li>

data/lib/turnip_formatter/template/tab_feature_statistics.erb

@@ -0,0 +1,24 @@
+<table>
+  <thead>
+    <tr>
+      <th>Feature</th>
+      <th>Scearios</th>
+      <th>passed</th>
+      <th>failed</th>
+      <th>pending</th>
+      <th>status</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% analysis_results.each do |info| %>
+      <tr>
+        <td><%= info.name %></td>
+        <td><%= info.scenarios %></td>
+        <td><%= info.passed %></td>
+        <td><%= info.failed %></td>
+        <td><%= info.pending %></td>
+        <td class="<%= info.status %>"><%= info.status %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/lib/turnip_formatter/template/tab_speed_statistics.erb

@@ -0,0 +1,18 @@
+<table>
+  <thead>
+    <tr>
+      <th>Feature</th>
+      <th>Scenario</th>
+      <th>Duration</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% analysis_results.each do |info| %>
+    <tr>
+      <td><span><%= info.feature_name %></span></td>
+      <td><a href="#<%= info.id %>"><%= info.name %></a></td>
+      <td><span><%= info.run_time %></span> sec</td>
+    </tr>
+    <% end %>
+  </tbody>
+</table>

data/lib/turnip_formatter/template/tab_tag_statistics.erb

@@ -0,0 +1,24 @@
+<table>
+  <thead>
+    <tr>
+      <th>Tag</th>
+      <th>Scearios</th>
+      <th>passed</th>
+      <th>failed</th>
+      <th>pending</th>
+      <th>status</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% analysis_results.each do |info| %>
+      <tr>
+        <td><%= info.name %></td>
+        <td><%= info.scenarios %></td>
+        <td><%= info.passed %></td>
+        <td><%= info.failed %></td>
+        <td><%= info.pending %></td>
+        <td class="<%= info.status %>"><%= info.status %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>