turnip_formatter 0.6.0.pre.beta.2 → 0.6.0.pre.beta.3

data/lib/turnip_formatter/{template → renderer/html/assets}/turnip_formatter.scss

@@ -74,7 +74,7 @@ div#steps-statistics section.scenario {
                 @extend .panel-warning;
             }
 
-            &.unexecuted {
+            &.unexecute {
                 @extend .panel-info;
             }
 

data/lib/turnip_formatter/renderer/html/base.rb

@@ -1,5 +1,5 @@
 require 'active_support/core_ext/string/inflections' # String#{demodulize,underscore}
-require 'tilt/erb'
+require 'erb'
 require 'forwardable'
 
 module TurnipFormatter
@@ -12,8 +12,8 @@ module TurnipFormatter
 
         class << self
           def view
-            @view ||= ::Tilt::ERBTemplate.new(
-              "#{TEMPLATE_DIRECTORY}/#{resource_name}.html.erb"
+            @view ||= ::ERB.new(
+              File.read("#{TEMPLATE_DIRECTORY}/#{resource_name}.html.erb")
             )
           end
 
@@ -39,7 +39,7 @@ module TurnipFormatter
         end
 
         def render
-          view.render(self)
+          view.result(binding)
         end
       end
     end

data/lib/turnip_formatter/renderer/html/index.rb

@@ -0,0 +1,83 @@
+require 'turnip_formatter'
+require 'turnip_formatter/renderer/html/scenario'
+require 'turnip_formatter/renderer/html/statistics_feature'
+require 'turnip_formatter/renderer/html/statistics_tag'
+require 'turnip_formatter/renderer/html/statistics_speed'
+
+module TurnipFormatter
+  module Renderer
+    module Html
+      #
+      # @resource [Hash]
+      #
+      #     scenarios: [Array<TurnipFormatter:Resource::Scenario::Base>]
+      #     failed_count: [Integer]
+      #     pending_count: [Integer]
+      #     total_time: [Float]
+      #
+      class Index < Base
+        def style_links
+          Html.render_stylesheet_links
+        end
+
+        def style_codes
+          Html.render_stylesheet_codes + Html.render_step_template_stylesheet_codes
+        end
+
+        def script_links
+          Html.render_javascript_links
+        end
+
+        def script_codes
+          Html.render_javascript_codes
+        end
+
+        def title
+          Html.project_name + ' report'
+        end
+
+        def scenarios_html
+          scenarios.map do |s|
+            begin
+              Scenario.new(s).render
+            rescue => e
+              RuntimeError.new([e, s]).render
+            end
+          end.join
+        end
+
+        def statistics_feature_html
+          StatisticsFeature.new(scenarios).render
+        end
+
+        def statistics_tag_html
+          StatisticsTag.new(scenarios).render
+        end
+
+        def statistics_speed_html
+          StatisticsSpeed.new(scenarios).render
+        end
+
+        def result_status
+          str = "#{scenarios.size} Scenario "
+          str += "(#{@resource[:failed_count]} failed #{@resource[:pending_count]} pending)"
+          str
+        end
+
+        def total_time
+          @resource[:total_time].to_s
+        end
+
+        def turnip_version
+          Turnip::VERSION
+        end
+
+        private
+
+        def scenarios
+          @resource[:scenarios]
+        end
+      end
+    end
+  end
+end

data/lib/turnip_formatter/renderer/html/runtime_error.rb

@@ -0,0 +1,20 @@
+require 'turnip_formatter/renderer/html/base'
+
+module TurnipFormatter
+  module Renderer
+    module Html
+      #
+      # @resource [Array<Exception, TurnipFormatter::Resource::Scenario::XXX>]
+      #
+      class RuntimeError < Base
+        def runtime_exception
+          @resource[0]
+        end
+
+        def scenario
+          @resource[1]
+        end
+      end
+    end
+  end
+end

data/lib/turnip_formatter/renderer/html/scenario.rb

@@ -0,0 +1,20 @@
+require 'turnip_formatter/renderer/html/step'
+
+module TurnipFormatter
+  module Renderer
+    module Html
+      #
+      # @resource [TurnipFormatter::Resource::Scenario::Base]
+      #
+      class Scenario < Base
+        delegate :id, :status, :run_time, :tags, :feature_info, :name, :feature
+
+        def steps_html
+          @steps_html ||= @resource.steps.map do |step|
+            Step.new(step).render
+          end.join
+        end
+      end
+    end
+  end
+end

data/lib/turnip_formatter/renderer/html/statistics_feature.rb

@@ -0,0 +1,45 @@
+require 'turnip_formatter/renderer/html/base'
+require 'ostruct'
+
+module TurnipFormatter
+  module Renderer
+    module Html
+      #
+      # @resource [Array<TurnipFormatter::Resource::Scenario::XXX>]
+      #
+      class StatisticsFeature < Base
+        def results
+          @results ||= features.map do |name, scenarios|
+            analysis(name, scenarios)
+          end
+        end
+
+        private
+
+        def features
+          @features ||= @resource.group_by { |s| s.feature.name }
+        end
+
+        def analysis(name, scenarios)
+          group = scenarios.group_by { |s| s.status }
+          group.default = []
+
+          info = OpenStruct.new(
+            name: name,
+            scenario_count: scenarios.size,
+            passed_count: group[:passed].size,
+            failed_count: group[:failed].size,
+            pending_count: group[:pending].size,
+            status: :failed
+          )
+
+          if info.failed_count.zero?
+            info.status = info.pending_count.zero? ? :passed : :pending
+          end
+
+          info
+        end
+      end
+    end
+  end
+end

data/lib/turnip_formatter/renderer/html/statistics_speed.rb

@@ -0,0 +1,39 @@
+require 'turnip_formatter/renderer/html/base'
+require 'ostruct'
+
+module TurnipFormatter
+  module Renderer
+    module Html
+      #
+      # @resource [Array<TurnipFormatter::Resource::Scenario::XXX>]
+      #
+      class StatisticsSpeed < Base
+        def results
+          @results ||= analysis(scenarios)
+        end
+
+        private
+
+        #
+        # Use the successfully steps only
+        #
+        def scenarios
+          @scenarios ||= @resource.select { |s| s.status == :passed }
+        end
+
+        def 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/renderer/html/statistics_tag.rb

@@ -0,0 +1,53 @@
+require 'turnip_formatter/renderer/html/base'
+require 'ostruct'
+
+module TurnipFormatter
+  module Renderer
+    module Html
+      #
+      # @resource [Array<TurnipFormatter::Resource::Scenario::XXX>]
+      #
+      class StatisticsTag < Base
+        def results
+          @results ||= tags.map do |name, scenarios|
+            analysis(name, scenarios)
+          end
+        end
+
+        private
+
+        def tags
+          @tags ||= @resource.map do |scenario|
+            if scenario.tags.empty?
+              { name: 'no_tag', scenario: scenario }
+            else
+              scenario.tags.map do |tag|
+                { name: '@' + tag, scenario: scenario }
+              end
+            end
+          end.flatten.group_by { |s| s[:name] }.sort
+        end
+
+        def analysis(name, scenarios)
+          group = scenarios.group_by { |s| s[:scenario].status }
+          group.default = []
+
+          info = OpenStruct.new(
+            name: name,
+            scenario_count: scenarios.size,
+            passed_count: group[:passed].size,
+            failed_count: group[:failed].size,
+            pending_count: group[:pending].size,
+            status: :failed
+          )
+
+          if info.failed_count.zero?
+            info.status = info.pending_count.zero? ? :passed : :pending
+          end
+
+          info
+        end
+      end
+    end
+  end
+end

data/lib/turnip_formatter/renderer/html/views/index.html.erb

@@ -0,0 +1,94 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8" />
+    <title><%= ERB::Util.h(title) %></title>
+
+    <%= style_links %>
+    <style><%= style_codes %></style>
+
+    <script src="https://code.jquery.com/jquery-1.11.0.min.js"></script>
+    <script src="https://netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery.tablesorter/2.17.0/jquery.tablesorter.min.js"></script>
+
+    <%= script_links %>
+    <script><%= script_codes %></script>
+  </head>
+
+  <body>
+    <header id="report">
+      <div class="container">
+        <div class="page-header">
+          <h1><%= ERB::Util.h(title) %></h1>
+        </div>
+
+        <section id="status_display_switch">
+          <label for="passed_check">
+            <input id="passed_check" type="checkbox" /> Passed
+          </label>
+          <label for="failed_check">
+            <input id="failed_check" type="checkbox" checked="checked" /> Failed
+          </label>
+          <label for="pending_check">
+            <input id="pending_check" type="checkbox" /> Pending
+          </label>
+        </section>
+
+        <section id="result">
+          <p><%= result_status %></p>
+          <p>Finished in <%= total_time %> sec</p>
+        </section>
+      </div>
+    </header>
+
+    <div id="main" class="container" role="main">
+      <ul id="statistics" class="nav nav-tabs">
+        <li class="active">
+          <a data-toggle="tab" href="#steps-statistics">Steps</a>
+        </li>
+        <li>
+          <a data-toggle="tab" href="#speed-statistics">Speed Statistics</a>
+        </li>
+        <li>
+          <a data-toggle="tab" href="#feature-statistics">Feature Sttistics</a>
+        </li>
+        <li>
+          <a data-toggle="tab" href="#tag-statistics">Tag Statistics</a>
+        </li>
+      </ul>
+
+      <div class="tab-content">
+        <div id="steps-statistics" class="tab-pane active">
+          <div class="checkbox">
+            <label>
+              <input id="scenario_display_check" type="checkbox" checked="checked" /> Folding
+            </label>
+          </div>
+
+          <div id="scenarios" class="panel-group"><%= scenarios_html %></div>
+        </div>
+        <div id="feature-statistics" class="tab-pane">
+          <h4>The results for the feature:</h4>
+          <%= statistics_feature_html %>
+        </div>
+        <div id="tag-statistics" class="tab-pane">
+          <h4>The results for the tab:</h4>
+          <%= statistics_tag_html %>
+        </div>
+        <div id="speed-statistics" class="tab-pane">
+          <h4>Ranking of running time of each <strong>successfully</strong> scenario:</h4>
+          <%= statistics_speed_html %>
+        </div>
+      </div>
+    </div>
+
+    <footer>
+      <p>Generated by &nbsp; <a href="https://rubygems.org/gems/turnip_formatter">turnip_formatter <%= turnip_version %></a></p>
+      <p>
+        Powered by
+        <a href="http://jquery.com/">&nbsp;jQuery 1.11.0</a>
+        &nbsp; and &nbsp;
+        <a href="http://mottie.github.io/tablesorter">tablesorter 2.17.0</a>
+    </footer>
+  </body>
+</html>

data/lib/turnip_formatter/renderer/html/views/runtime_error.html.erb

@@ -0,0 +1,20 @@
+<section class="exception">
+  <h1>TurnipFormatter Runtime Error</h1>
+  <h2><%= scenario.feature_info %></h2>
+
+  <dl>
+    <dt>Runtime Error</dt>
+    <dd>
+      <pre><%= runtime_exception.to_s %></pre>
+    </dd>
+
+    <dt>Runtime Error Backtrace</dt>
+    <dd>
+      <ol>
+        <% runtime_exception.backtrace.each do |line| %>
+          <li><%= ERB::Util.h(line) %></li>
+        <% end %>
+      </ol>
+    </dd>
+  </dl>
+</section>

data/lib/turnip_formatter/renderer/html/views/scenario.html.erb

@@ -0,0 +1,23 @@
+<section class="scenario <%= status %>" id="<%= id %>">
+  <div class="scenario-title">
+    <span class="permalink">
+      <a href="#<%= id %>">&para;</a>
+    </span>
+
+    <span data-toggle="collapse" data-target="#<%= id %>_body">
+      "Scenario: <%= ERB::Util.h(name) %> Feature <%= feature_info %> at <%= run_time %> sec"
+    </span>
+  </div>
+
+  <div class="panel-collapse collapse" id="<%= id %>_body">
+    <div class="panel-body">
+      <ul class="tags">
+        <% tags.each do |tag| %>
+          <li>@<%= ERB::Util.h(tag) %></li>
+        <% end %>
+      </ul>
+
+      <div class="steps"><%= steps_html %></div>
+    </div>
+  </div>
+</section>

data/lib/turnip_formatter/renderer/html/views/statistics_feature.html.erb

@@ -0,0 +1,24 @@
+<table>
+  <thead>
+    <tr>
+      <th>Feature</th>
+      <th>Scenarios</th>
+      <th>passed</th>
+      <th>failed</th>
+      <th>pending</th>
+      <th>status</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% results.each do |info| %>
+      <tr>
+        <td><%= info.name %></td>
+        <td><%= info.scenario_count %></td>
+        <td><%= info.passed_count %></td>
+        <td><%= info.failed_count %></td>
+        <td><%= info.pending_count %></td>
+        <td class="<%= info.status %>"><%= info.status %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/lib/turnip_formatter/renderer/html/views/statistics_speed.html.erb

@@ -0,0 +1,24 @@
+<table>
+  <thead>
+    <tr>
+      <th>Feature</th>
+      <th>Scenario</th>
+      <th>Duration</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% results.each do |info| %>
+      <tr>
+        <td>
+          <span><%= ERB::Util.h(info.feature_name) %></span>
+        </td>
+        <td>
+          <a href="#<%= info.id %>"><%= ERB::Util.h(info.name) %></a>
+        </td>
+        <td>
+          <span><%= info.run_time %> sec</span>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/lib/turnip_formatter/renderer/html/views/statistics_tag.html.erb

@@ -0,0 +1,24 @@
+<table>
+  <thead>
+    <tr>
+      <th>Tag</th>
+      <th>Scenarios</th>
+      <th>passed</th>
+      <th>failed</th>
+      <th>pending</th>
+      <th>status</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% results.each do |info| %>
+      <tr>
+        <td><%= info.name %></td>
+        <td><%= info.scenario_count %></td>
+        <td><%= info.passed_count %></td>
+        <td><%= info.failed_count %></td>
+        <td><%= info.pending_count %></td>
+        <td class="<%= info.status %>"><%= info.status %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/lib/turnip_formatter/renderer/html.rb

@@ -0,0 +1,84 @@
+module TurnipFormatter
+  module Renderer
+    module Html
+      @script_codes = []
+      @script_files = []
+      @style_codes = []
+      @style_files = []
+
+      class << self
+        attr_accessor :script_codes, :script_files, :style_codes, :style_files
+
+        def reset!
+          @script_codes = []
+          @script_files = []
+          @style_codes = []
+          @style_files = []
+        end
+
+        def project_name
+          TurnipFormatter.configuration.title
+        end
+
+        def add_javascript(script)
+          case
+          when local_file?(script)
+            script_codes << File.read(script)
+          when remote_url?(script)
+            script_files << script
+          end
+        end
+
+        def add_stylesheet(stylesheet)
+          case
+          when local_file?(stylesheet)
+            style_codes << File.read(stylesheet)
+          when remote_url?(stylesheet)
+            style_files << stylesheet
+          end
+        end
+
+        def render_javascript_codes
+          script_codes.join("\n")
+        end
+
+        def render_javascript_links
+          script_files.map do |file|
+            "<script src=\"#{file}\"></script>"
+          end.join("\n")
+        end
+
+        def render_stylesheet_codes
+          style_codes.join("\n")
+        end
+
+        def render_stylesheet_links
+          style_files.map do |file|
+            "<link rel=\"stylesheet\" href=\"#{file}\">"
+          end.join("\n")
+        end
+
+        def render_step_template_stylesheet_codes
+          TurnipFormatter.step_templates.map do |template|
+            template.class.css
+          end.join("\n")
+        end
+
+        private
+
+        def local_file?(path)
+          File.exist? path
+        end
+
+        def remote_url?(path)
+          uri = URI.parse(path)
+          return true if %w(http https).include?(uri.scheme)
+          return true if uri.scheme.nil? && path.start_with?('//')
+          false
+        rescue URI::InvalidURIError
+          false
+        end
+      end
+    end
+  end
+end

data/lib/turnip_formatter/resource/scenario/base.rb

@@ -0,0 +1,80 @@
+require 'forwardable'
+require 'turnip_formatter/resource/step'
+
+module TurnipFormatter
+  module Resource
+    module Scenario
+      class Base
+        attr_reader :example
+
+        extend Forwardable
+        def_delegators :raw, :line, :keyword, :name, :steps
+
+        #
+        # @param  [RSpec::Core::Example]  example
+        #
+        def initialize(example)
+          @example = example
+        end
+
+        def steps
+          @steps ||= (backgrounds.map(&:steps).flatten + raw.steps).map do |step|
+            TurnipFormatter::Resource::Step.new(example, step)
+          end
+        end
+
+        def id
+          'scenario_' + object_id.to_s
+        end
+
+        #
+        # @return  [Symbol] scenario status (:passed | :failed | :pending)
+        #
+        def status
+          execution_result.status.to_sym
+        end
+
+        #
+        # @return  [Float] scenario run time (sec)
+        #
+        def run_time
+          execution_result.run_time
+        end
+
+        def feature_info
+          path = RSpec::Core::Metadata.relative_path(feature_file_path)
+          "\"#{feature.name}\" in #{path}"
+        end
+
+        def backgrounds
+          feature.backgrounds
+        end
+
+        def tags
+          @tags ||= (feature.tag_names + raw.tag_names).sort.uniq
+        end
+
+        def feature
+          example.metadata[:turnip_formatter][:feature]
+        end
+
+        private
+
+        def raw
+          @raw = example.metadata[:turnip_formatter][:scenario]
+        end
+
+        def feature_file_path
+          example.metadata[:file_path]
+        end
+
+        #
+        # @return  [OpenStruct or ::RSpec::Core::Example::ExecutionResult]
+        #
+        def execution_result
+          @execution_result ||= example.execution_result
+        end
+      end
+    end
+  end
+end