turnip_formatter 0.0.1

data/lib/turnip_formatter/scenario/failure.rb

@@ -0,0 +1,47 @@
+# -*- coding: utf-8 -*-
+
+require 'turnip_formatter/scenario'
+require 'turnip_formatter/step/failure'
+require 'rspec/core/formatters/helpers'
+
+module TurnipFormatter
+  module Scenario
+    class NotFailedScenarioError < ::StandardError; end
+    class NoExistFailedStepInformationError < ::StandardError; end
+
+    class Failure
+      include TurnipFormatter::Scenario
+      include RSpec::Core::BacktraceFormatter
+
+      def steps
+        steps = super
+        steps[offending_line].tap do |step|
+          step.extend TurnipFormatter::Step::Failure
+          step.attention(exception, backtrace)
+        end
+        steps
+      end
+
+      def validation
+        raise NotFailedScenarioError if (status != 'failed')
+        offending_line
+        super
+      end
+
+      private
+
+      def offending_line
+        unless backtrace.last =~ /:in step:(?<stepno>\d+) `/
+          raise NoExistFailedStepInformationError
+        end
+        $~[:stepno].to_i
+      end
+
+      def backtrace
+        @backtrace ||= format_backtrace(exception.backtrace, scenario.metadata).map do |b|
+          backtrace_line(b)
+        end.compact
+      end
+    end
+  end
+end

data/lib/turnip_formatter/scenario/pass.rb

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+
+require 'turnip_formatter/scenario'
+require 'turnip_formatter/step/pending'
+
+module TurnipFormatter
+  module Scenario
+    class NotPassedScenarioError < ::StandardError; end
+
+    class Pass
+      include TurnipFormatter::Scenario
+
+      def validation
+        raise NotPassedScenarioError if status != 'passed'
+        super
+      end
+    end
+  end
+end

data/lib/turnip_formatter/scenario/pending.rb

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+
+require 'turnip_formatter/scenario'
+require 'turnip_formatter/step/pending'
+
+module TurnipFormatter
+  module Scenario
+    class NotPendingScenarioError < ::StandardError; end
+    class NoExistPendingStepInformationError < ::StandardError; end
+
+    class Pending
+      include TurnipFormatter::Scenario
+
+      def steps
+        steps = super
+        steps[offending_line].tap do |step|
+          step.extend TurnipFormatter::Step::Pending
+          step.attention(pending_message, scenario.location)
+        end
+        steps
+      end
+
+      def validation
+        raise NotPendingScenarioError if status != 'pending'
+        offending_line
+        super
+      end
+
+      private
+
+      def offending_line
+        raise NoExistPendingStepInformationError unless pending_message =~ /^No such step\((?<stepno>\d+)\): /
+        $~[:stepno].to_i
+      end
+    end
+  end
+end

data/lib/turnip_formatter/scenario.rb

@@ -0,0 +1,63 @@
+# -*- coding: utf-8 -*-
+
+require 'turnip_formatter/step'
+
+module TurnipFormatter
+  module Scenario
+    class NotExistStepsInformationError < ::StandardError; end
+    class NoFeatureFileError < ::StandardError; end
+
+    #
+    # @param  [RSpec::Core::Example]  example
+    #
+    def initialize(example)
+      @scenario = example
+    end
+
+    def validation
+      raise NotExistStepsInformationError unless scenario.metadata.member?(:steps)
+      raise NoFeatureFileError unless feature_file_path.end_with?('.feature')
+    end
+
+    def steps
+      descriptions.map { |desc| TurnipFormatter::Step.new(desc) }
+    end
+
+    def method_missing(name, *args, &block)
+      if scenario.execution_result.member?(name.to_sym)
+        scenario.execution_result[name.to_sym]
+      else
+        super
+      end
+    end
+
+    def name
+      scenario.example_group.description
+    end
+
+    def feature_name
+      @scenario.example_group.metadata[:example_group][:example_group][:description]
+    end
+
+    def feature_file_path
+      scenario.metadata[:file_path]
+    end
+
+    def tags
+      scenario.metadata[:steps][:tags]
+    end
+
+    private
+
+    def scenario
+      @scenario
+    end
+
+    def descriptions
+      descriptions = scenario.metadata[:steps][:descriptions]
+      keywords = scenario.metadata[:steps][:keywords]
+      docstrings = scenario.metadata[:steps][:docstrings]
+      descriptions.zip(keywords, docstrings)
+    end
+  end
+end

data/lib/turnip_formatter/step/failure.rb

@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+
+module TurnipFormatter
+  class Step
+    module Failure
+      def attention?
+        true
+      end
+
+      def attention(exception, backtrace)
+        exception.set_backtrace(backtrace)
+        docs[:source]    = backtrace.first
+        docs[:exception] = exception
+      end
+
+      def status
+        'failure'
+      end
+    end
+  end
+end

data/lib/turnip_formatter/step/pending.rb

@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+
+module TurnipFormatter
+  class Step
+    module Pending
+      def attention?
+        true
+      end
+
+      def attention(message, location)
+        exception = RSpec::Core::Pending::PendingDeclaredInExample.new(message)
+        exception.set_backtrace(location)
+        docs[:exception] = exception
+      end
+
+      def status
+        'pending'
+      end
+    end
+  end
+end

data/lib/turnip_formatter/step.rb

@@ -0,0 +1,18 @@
+# -*- coding: utf-8 -*-
+
+module TurnipFormatter
+  class Step
+    attr_reader :name, :docs
+
+    def initialize(description)
+      step_name, keyword, docstring = description
+      @name = keyword + step_name
+      @docs = {}
+      @docs[:extra_args] = docstring unless docstring.empty?
+    end
+
+    def attention?
+      false
+    end
+  end
+end

data/lib/turnip_formatter/template.rb

@@ -0,0 +1,243 @@
+# -*- coding: utf-8 -*-
+
+require 'erb'
+require 'rspec/core/formatters/snippet_extractor'
+
+module TurnipFormatter
+  class Template
+    include ERB::Util
+    include RSpec::Core::BacktraceFormatter
+
+    def print_header
+      <<-EOS
+        <!DOCTYPE html>
+          <head>
+            <meta charset="UTF-8">
+            <style>
+            #{File.read(File.dirname(__FILE__) + '/formatter.css')}
+            </style>
+            <script type="text/javascript" src="http://code.jquery.com/jquery-1.9.1.min.js"></script>
+            <script>
+              $(function() {
+                  ["passed", "failed", "pending"].forEach(function(status) {
+                      $('#' + status + '_check').click(function() {
+                          if (this.checked) {
+                              $('.scenario.' + status).show();
+                          } else {
+                              $('.scenario.' + status).hide();
+                          }
+                      });
+                  });
+              });
+            </script>
+          </head>
+          <body>
+            #{report_area}
+            <div id="main" role="main">
+      EOS
+    end
+
+    def print_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
+
+      <<-EOS
+            </div>
+            #{update_report_js}
+          </body>
+        </html>
+      EOS
+    end
+
+    def print_scenario(scenario)
+      template_scenario.result(binding)
+    end
+
+    def print_runtime_error(example, exception)
+      
+      if example.exception
+        example_backtrace = format_backtrace(example.exception.backtrace[0..14], example.metadata).map do |l|
+          RSpec::Core::Metadata::relative_path(l)
+        end
+      end
+
+      template_exception.result(binding)
+    end
+
+    private
+
+    def feature_name(scenario)
+      path = RSpec::Core::Metadata::relative_path(scenario.feature_file_path)
+      name = scenario.feature_name
+      "\"#{name}\" in #{path}"
+    end
+
+    def scenario_tags(scenario)
+      return '' if scenario.tags.empty?
+      template_scenario_tags.result(binding)
+    end
+
+    def step_attr(step)
+      attr = 'step'
+      attr += " #{step.status}" if step.attention?
+      "class=\"#{h(attr)}\""
+    end
+
+    def step_args(step)
+      args = []
+      [:extra_args, :source, :exception].each do |k|
+        args << send("step_#{k}", step.docs[k]) unless step.docs[k].nil?
+      end
+      args.join("\n")
+    end
+
+    def step_extra_args(extra_args)
+      extra_args.map do |arg|
+        if arg.instance_of?(Turnip::Table)
+          step_outline(arg)
+        else
+          step_multiline(arg)
+        end
+      end.join("\n")
+    end
+
+    def step_outline(table)
+      template_step_outline.result(binding)
+    end
+
+    def step_multiline(lines)
+      '<pre class="multiline">' + h(lines) + '</pre>'
+    end
+
+    def step_source(location)
+      @snippet_extractor ||= ::RSpec::Core::Formatters::SnippetExtractor.new
+      '<pre class="source"><code class="ruby">' + @snippet_extractor.snippet([location]) + '</code></pre>'
+    end
+
+    def step_exception(exception)
+      template_step_exception.result(binding)
+    end
+
+    def report_area
+      <<-EOS
+        <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>
+      EOS
+    end
+
+    def template_scenario
+      @template_scenario ||= ERB.new(<<-EOS)
+        <section class="scenario <%= h(scenario.status) %>">
+          <header>
+            <span class="permalink">
+              <a href="#<%= scenario.object_id %>">&para;</a>
+            </span>
+            <span class="scenario_name" id="<%= scenario.object_id %>">
+              Scenario: <%= h(scenario.name) %>
+            </span>
+            <span class="feature_name">(Feature: <%= h(feature_name(scenario)) %>)</span>
+          </header>
+          <%= 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>
+      EOS
+    end
+
+    def template_scenario_tags
+      @template_scenario_tags ||= ERB.new(<<-EOS)
+        <ul class="tags">
+          <% scenario.tags.each do |tag| %>
+          <li>@<%= h(tag) %></li>
+          <% end %>
+       </ul>
+      EOS
+    end
+
+    def template_step_outline
+      @template_step_outline ||= ERB.new(<<-EOS)
+        <table class="step_outline">
+          <% table.each do |tr| %>
+          <tr>
+            <% tr.each do |td| %>
+            <td><%= h(td) %></td>
+            <% end %>
+          </tr>
+          <% end %>
+        </table>
+      EOS
+    end
+
+    def template_step_exception
+      @template_step_exception ||= ERB.new(<<-EOS)
+        <div class="step_exception">
+          <span>Failure:</span>
+          <pre><%= h(exception.to_s) %></pre>
+          <span>Backtrace:</span>
+          <ol>
+            <% exception.backtrace.each do |line| %>
+            <li><%= h(line) %></li>
+            <% end %>
+          </ol>
+        </div>
+      EOS
+    end
+
+    def template_exception
+      @template_exception ||= ERB.new(<<-EOS)
+        <section class="exception">
+          <h1>TurnipFormatter RuntimeError</h1>
+          <dl>
+            <dt>Exception</dt>
+            <dd><%= h(exception.to_s) %></dd>
+
+            <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>Backtrace:</dt>
+              <dd>
+                <ol>
+                  <% example_backtrace.each do |line| %>
+                  <li><%= h(line) %></li>
+                  <% end %>
+                </ol>
+              </dd>
+            <% end %>
+
+            <% if example.pending %>
+              <dt>Example Pending description</dt>
+              <dd><%= h(example.metadata[:description]) %></dd>
+            <% end %>
+          </dl>
+        </section>
+      EOS
+    end
+  end
+end

data/lib/turnip_formatter/version.rb

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

data/lib/turnip_formatter.rb

@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+
+require "turnip_formatter/version"
+require 'turnip'
+
+module TurnipFormatter
+  require 'rspec/core/formatters/turnip_formatter'
+  require 'turnip_formatter/template'
+  require 'turnip_formatter/ext/turnip/rspec'
+  require 'turnip_formatter/ext/turnip/builder'
+end
+
+RSpecTurnipFormatter = RSpec::Core::Formatters::TurnipFormatter
+

data/spec/examples/README.md

@@ -0,0 +1,124 @@
+# TurnipFormatter Demo
+
+## Usage
+
+    $ cd /path/to/turnip_formatter
+    $ bundle install --path vendor/bundle
+    $ bundle exec rspec -r ./spec/examples/spec_helper spec/examples/features
+    $ open report.html
+
+## Screenshot
+
+### Basic step
+
+```feature
+Scenario: normal monster
+  Given there is a monster
+   When I attack it
+   Then it should die
+    And Fanfare
+```
+
+![Basic step](https://github.com/gongo/turnip_formatter/raw/master/spec/examples/images/basic_step.png)
+
+### Failed step
+
+```feature
+Scenario: strong monster
+
+  This scenario will error
+  So, fanfare is not...oh...
+
+  Given there is a strong monster
+   When I attack it
+   Then it should die
+    And Fanfare
+```
+
+![Failed step](https://github.com/gongo/turnip_formatter/raw/master/spec/examples/images/failed_step.png)
+
+### Pending step and specify tag
+
+```feature
+  Scenario: spell magic
+
+    This scenario will error because he can't cast spell
+
+    Given there is a strong monster
+     When I cast a spell 'fireball'
+      And I attack it
+     Then it should die
+      And Fanfare
+
+  @magician
+  Scenario: spell magic 
+
+    Given there is a strong monster
+     When I cast a spell 'fireball'
+      And I attack it
+     Then it should die
+      And Fanfare
+```
+
+![Pending step](https://github.com/gongo/turnip_formatter/raw/master/spec/examples/images/pending_and_tagged_step.png)
+
+### Background
+
+```feature
+Feature: Battle a monster with weapon
+
+  Background:
+    Given I equip a weapon
+
+  Scenario: normal monster
+    Given there is a monster
+     When I attack it
+     Then it should die
+      And Fanfare
+
+  Scenario: strong monster
+    Given there is a strong monster
+     When I attack it
+     Then it should die
+      And Fanfare
+```
+
+![Background step](https://github.com/gongo/turnip_formatter/raw/master/spec/examples/images/background.png)
+
+### Outline
+
+```feature
+Feature: Battle monsters
+
+  Scenario: Escape
+    Given there are monsters:
+      | gargoyle   |
+      | Cockatrice |
+     When I escape
+     Then I was able to escape
+
+  Scenario: Inescapable
+    Given there are monsters:
+      | gargoyle   |
+      | Cockatrice |
+      | basilisk   |
+     When I escape
+     Then I could not escape
+```
+
+![outline](https://github.com/gongo/turnip_formatter/raw/master/spec/examples/images/outline.png)
+
+### Multiline
+
+```feature
+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
+```
+
+![Multiline](https://github.com/gongo/turnip_formatter/raw/master/spec/examples/images/multiline.png)

data/spec/examples/features/battle.feature

@@ -0,0 +1,36 @@
+Feature: Battle a monster
+
+  Scenario: normal monster
+    Given there is a monster
+     When I attack it
+     Then it should die
+      And Fanfare
+
+  Scenario: strong monster
+
+    This scenario will error
+    So, fanfare is not...oh...
+
+    Given there is a strong monster
+     When I attack it
+     Then it should die
+      And Fanfare
+
+  Scenario: spell magic
+
+    This scenario will error because he can't cast spell
+
+    Given there is a strong monster
+     When I cast a spell 'fireball'
+      And I attack it
+     Then it should die
+      And Fanfare
+
+  @magician
+  Scenario: spell magic 
+
+    Given there is a strong monster
+     When I cast a spell 'fireball'
+      And I attack it
+     Then it should die
+      And Fanfare

data/spec/examples/features/battle2.feature

@@ -0,0 +1,17 @@
+Feature: Battle a monster with weapon
+
+  Background:
+    Given I equip a weapon
+
+  Scenario: normal monster
+    Given there is a monster
+     When I attack it
+     Then it should die
+      And Fanfare
+
+  Scenario: strong monster
+    Given there is a strong monster
+     When I attack it
+     Then it should die
+      And Fanfare
+ 

data/spec/examples/features/battle3.feature

@@ -0,0 +1,16 @@
+Feature: Battle monsters
+
+  Scenario: Escape
+    Given there are monsters:
+      | gargoyle   |
+      | Cockatrice |
+     When I escape
+     Then I was able to escape
+
+  Scenario: Inescapable
+    Given there are monsters:
+      | gargoyle   |
+      | Cockatrice |
+      | basilisk   |
+     When I escape
+     Then I could not escape