turnip_formatter 0.1.2 → 0.2.0

data/.gitignore

@@ -17,4 +17,4 @@ test/version_tmp
 tmp
 vendor/bundle
 .sass-cache
-
+report.html

data/{spec/examples → example}/README.md

@@ -4,7 +4,7 @@
 
     $ cd /path/to/turnip_formatter
     $ bundle install --path vendor/bundle
-    $ bundle exec rspec -r ./spec/examples/spec_helper spec/examples/features
+    $ bundle exec rspec -r ./example/spec_helper example
     $ open report.html
 
 ## Screenshot
@@ -19,7 +19,7 @@ Scenario: normal monster
     And Fanfare
 ```
 
-![Basic step](https://github.com/gongo/turnip_formatter/raw/master/spec/examples/images/basic_step.png)
+![Basic step](https://github.com/gongo/turnip_formatter/raw/master/example/images/basic_step.png)
 
 ### Failed step
 
@@ -35,7 +35,7 @@ Scenario: strong monster
     And Fanfare
 ```
 
-![Failed step](https://github.com/gongo/turnip_formatter/raw/master/spec/examples/images/failed_step.png)
+![Failed step](https://github.com/gongo/turnip_formatter/raw/master/example/images/failed_step.png)
 
 ### Pending step and specify tag
 
@@ -60,9 +60,9 @@ Scenario: strong monster
       And Fanfare
 ```
 
-![Pending step](https://github.com/gongo/turnip_formatter/raw/master/spec/examples/images/pending_step.png)
+![Pending step](https://github.com/gongo/turnip_formatter/raw/master/example/images/pending_step.png)
 
-![Tag step](https://github.com/gongo/turnip_formatter/raw/master/spec/examples/images/tag_step.png)
+![Tag step](https://github.com/gongo/turnip_formatter/raw/master/example/images/tag_step.png)
 
 ### Background
 
@@ -85,7 +85,7 @@ Feature: Battle a monster with weapon
       And Fanfare
 ```
 
-![Background step](https://github.com/gongo/turnip_formatter/raw/master/spec/examples/images/background.png)
+![Background step](https://github.com/gongo/turnip_formatter/raw/master/example/images/background.png)
 
 ### Outline
 
@@ -108,7 +108,7 @@ Feature: Battle monsters
      Then I could not escape
 ```
 
-![outline](https://github.com/gongo/turnip_formatter/raw/master/spec/examples/images/outline.png)
+![outline](https://github.com/gongo/turnip_formatter/raw/master/example/images/outline.png)
 
 ### Multiline
 
@@ -123,4 +123,4 @@ Feature: A feature with multiline strings
     Then the song should have 2 lines
 ```
 
-![Multiline](https://github.com/gongo/turnip_formatter/raw/master/spec/examples/images/multiline.png)
+![Multiline](https://github.com/gongo/turnip_formatter/raw/master/example/images/multiline.png)

data/lib/turnip_formatter/formatter.css

@@ -136,27 +136,6 @@ div#steps-statistics section.scenario {
       margin-top: 2em;
       font-size: 13px;
       color: #586e75; }
-    div#steps-statistics section.scenario ul.steps div.step_exception {
-      margin: 1em 0em;
-      padding: 1em 0em 1em 1em;
-      border: 1px solid #999999;
-      background-color: #eee8d5;
-      color: #586e75; }
-      div#steps-statistics section.scenario ul.steps div.step_exception > pre {
-        margin-left: 1em; }
-    div#steps-statistics section.scenario ul.steps pre.source {
-      font-size: 12px;
-      font-family: monospace;
-      background-color: #073642;
-      color: #dddddd; }
-      div#steps-statistics section.scenario ul.steps pre.source code.ruby {
-        padding: 0.1em 0 0.2em 0; }
-        div#steps-statistics section.scenario ul.steps pre.source code.ruby .linenum {
-          width: 75px;
-          color: #fffbd3;
-          padding-right: 1em; }
-        div#steps-statistics section.scenario ul.steps pre.source code.ruby .offending {
-          background-color: gray; }
 
 div#speed-statistics table,
 div#feature-statistics table,

data/lib/turnip_formatter/formatter.scss

@@ -180,38 +180,6 @@ div#steps-statistics section.scenario {
             font-size: 13px;
             color: #586e75;
         }
-
-        div.step_exception {
-            margin: 1em 0em;
-            padding: 1em 0em 1em 1em;
-            border: 1px solid #999999;
-            background-color: #eee8d5;
-            color: #586e75;
-
-            > pre {
-                margin-left: 1em;
-            }
-        }
-
-        pre.source {
-            font-size: 12px;
-            font-family: monospace;
-            background-color: #073642;
-            color: #dddddd;
-
-            code.ruby {
-                padding: 0.1em 0 0.2em 0;
-
-                .linenum {
-                    width: 75px;
-                    color: #fffbd3;
-                    padding-right: 1em;
-                }
-
-                .offending { background-color: gray; }
-            }
-        }
-
     }
 }
 

data/lib/turnip_formatter/scenario.rb

@@ -53,6 +53,11 @@ module TurnipFormatter
       example.execution_result[:run_time]
     end
 
+    def feature_info
+      path = RSpec::Core::Metadata::relative_path(feature_file_path)
+      "\"#{feature_name}\" in #{path}"
+    end
+
     def feature_name
       example.example_group.metadata[:example_group][:example_group][:description]
     end

data/lib/turnip_formatter/step/dsl.rb

@@ -17,16 +17,16 @@ module TurnipFormatter
         end
       end
 
-      def add_template(style, template = nil, &block)
-        ::TurnipFormatter::Step.add_template(status, style, template, &block)
+      def add_template(klass, &block)
+        ::TurnipFormatter::Step.add_template(status, klass, &block)
       end
 
-      def remove_template(style)
-        ::TurnipFormatter::Step.remove_template(status, style)
+      def remove_template(klass)
+        ::TurnipFormatter::Step.remove_template(status, klass)
       end
 
       def templates
-        ::TurnipFormatter::Step.templates[status]
+        ::TurnipFormatter::Step.templates[status] || []
       end
     end
   end

data/lib/turnip_formatter/step/failure.rb

@@ -14,14 +14,6 @@ module TurnipFormatter
       def status
         Failure.status
       end
-
-      add_template :source do
-        example.exception.backtrace.first
-      end
-
-      add_template :exception do
-        example.exception
-      end
     end
   end
 end

data/lib/turnip_formatter/step/pending.rb

@@ -14,13 +14,6 @@ module TurnipFormatter
       def status
         Pending.status
       end
-
-      add_template :exception do
-        message = example.execution_result[:pending_message]
-        exception = RSpec::Core::Pending::PendingDeclaredInExample.new(message)
-        exception.set_backtrace(example.location)
-        exception
-      end
     end
   end
 end

data/lib/turnip_formatter/step.rb

@@ -9,13 +9,13 @@ module TurnipFormatter
         @templates ||= {}
       end
 
-      def add_template(status, style, klass = nil, &block)
+      def add_template(status, klass = nil, &block)
         templates[status] ||= {}
-        templates[status][style] = { klass: klass, block: block }
+        templates[status][klass] = { klass: klass, block: block }
       end
 
-      def remove_template(status, style)
-        templates[status].delete(style)
+      def remove_template(status, klass)
+        templates[status].delete(klass)
         templates.delete(status.to_sym) if templates[status.to_sym].empty?
       end
 

data/lib/turnip_formatter/step_template/exception.rb

@@ -0,0 +1,61 @@
+# -*- coding: utf-8 -*-
+
+require 'turnip_formatter/step/failure'
+require 'turnip_formatter/step/pending'
+require 'erb'
+
+module TurnipFormatter
+  module StepTemplate
+    module Exception
+      def self.build(exception)
+        template_step_exception.result(binding)
+      end
+
+      private
+
+      def self.template_step_exception
+        @template_step_exception ||= ERB.new(<<-EOS)
+          <div class="step_exception">
+            <span>Failure:</span>
+            <pre><%= ERB::Util.h(exception.to_s) %></pre>
+            <span>Backtrace:</span>
+            <ol>
+              <% exception.backtrace.each do |line| %>
+              <li><%= ERB::Util.h(line) %></li>
+              <% end %>
+            </ol>
+          </div>
+        EOS
+      end
+    end
+  end
+
+  Template.add_scss(<<-EOS)
+    div#steps-statistics section.scenario {
+        ul.steps {
+            div.step_exception {
+                margin: 1em 0em;
+                padding: 1em 0em 1em 1em;
+                border: 1px solid #999999;
+                background-color: #eee8d5;
+                color: #586e75;
+
+                > pre {
+                    margin-left: 1em;
+                }
+            }
+        }
+    }
+  EOS
+
+  Step::Failure.add_template StepTemplate::Exception do
+    example.exception
+  end
+
+  Step::Pending.add_template StepTemplate::Exception do
+    message = example.execution_result[:pending_message]
+    exception = RSpec::Core::Pending::PendingDeclaredInExample.new(message)
+    exception.set_backtrace(example.location)
+    exception
+  end
+end

data/lib/turnip_formatter/step_template/source.rb

@@ -0,0 +1,46 @@
+# -*- coding: utf-8 -*-
+
+require 'turnip_formatter/step/failure'
+require 'rspec/core/formatters/snippet_extractor'
+
+module TurnipFormatter
+  module StepTemplate
+    module Source
+      def self.build(location)
+        code = extractor.snippet([location])
+        '<pre class="source"><code class="ruby">' + code + '</code></pre>'
+      end
+
+      private
+
+      def self.extractor
+        @extractor ||= ::RSpec::Core::Formatters::SnippetExtractor.new
+      end
+    end
+  end
+
+  Template.add_scss(<<-EOS)
+    pre.source {
+        font-size: 12px;
+        font-family: monospace;
+        background-color: #073642;
+        color: #dddddd;
+
+        code.ruby {
+            padding: 0.1em 0 0.2em 0;
+
+            .linenum {
+                width: 75px;
+                color: #fffbd3;
+                padding-right: 1em;
+            }
+
+            .offending { background-color: gray; }
+        }
+    }
+  EOS
+
+  Step::Failure.add_template(StepTemplate::Source) do
+    example.exception.backtrace.first
+  end
+end

data/lib/turnip_formatter/step_template.rb

@@ -0,0 +1,8 @@
+# -*- coding: utf-8 -*-
+
+module TurnipFormatter
+  module StepTemplate
+    require 'turnip_formatter/step_template/exception'
+    require 'turnip_formatter/step_template/source'
+  end
+end

data/lib/turnip_formatter/template/exception.erb

@@ -0,0 +1,26 @@
+<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) %>
+    <% end %>
+
+    <% if example.pending %>
+      <dt>Example Pending description</dt>
+      <dd><%= h(example.metadata[:description]) %></dd>
+    <% end %>
+  </dl>
+</section>

data/lib/turnip_formatter/template/exception_backtrace.erb

@@ -0,0 +1,7 @@
+<dd>
+  <ol>
+    <% backtrace.each do |line| %>
+    <li><%= h(line) %></li>
+    <% end %>
+  </ol>
+</dd>

data/lib/turnip_formatter/template/scenario.erb

@@ -0,0 +1,24 @@
+<section class="scenario <%= h(scenario.status) %>">
+  <header>
+    <span class="permalink">
+      <a href="#<%= scenario.id %>">&para;</a>
+    </span>
+    <span class="scenario_name" id="<%= scenario.id %>">
+      Scenario: <%= h(scenario.name) %>
+    </span>
+    <span class="feature_name">
+      (Feature: <%= h(scenario.feature_info) %>)
+      at <%= h(scenario.run_time) %> sec
+    </span>
+  </header>
+  <%= print_scenario_tags(scenario) %>
+  <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>
+    <% end %>
+  </ul>
+</section>

data/lib/turnip_formatter/template/scenario_tags.erb

@@ -0,0 +1,5 @@
+<ul class="tags">
+  <% tags.each do |tag| %>
+  <li>@<%= h(tag) %></li>
+  <% end %>
+</ul>

data/lib/turnip_formatter/template/section_report.erb

@@ -0,0 +1,15 @@
+<div id="report">
+  <h1>Turnip Report</h1>
+  <section class="checkbox">
+    <label for="passed_check">Passed</label><input type="checkbox" checked 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" checked id="pending_check">
+  </section>
+
+  <section class="result">
+    <p>
+      <span id="total_count"></span> Scenario (<span id="failed_count"></span> failed <span id="pending_count"></span> pending).
+    </p>
+    <p>Finished in <span id="total_time"></span></p>
+  </section>
+</div>

data/lib/turnip_formatter/template/step_multiline.erb

@@ -0,0 +1 @@
+<pre class="multiline"><%= h(lines) %></pre>

data/lib/turnip_formatter/template/step_outline.erb

@@ -0,0 +1,9 @@
+<table class="step_outline">
+  <% table.each do |tr| %>
+  <tr>
+    <% tr.each do |td| %>
+    <td><%= h(td) %></td>
+    <% end %>
+  </tr>
+  <% end %>
+</table>