turnip_formatter 0.2.11 → 0.3.0

data/lib/turnip_formatter/step.rb

@@ -1,47 +1,17 @@
-# -*- coding: utf-8 -*-
-
 module TurnipFormatter
   class Step
-    attr_reader :name, :docs, :example
-
-    class << self
-      def templates
-        @templates ||= {}
-      end
-
-      def add_template(status, klass = nil, &block)
-        templates[status] ||= {}
-        templates[status][klass] = { klass: klass, block: block }
-      end
-
-      def remove_template(status, klass)
-        key = status.to_sym
-        return unless templates.key?(key)
-        templates[key].delete(klass)
-        templates.delete(key) if templates[key].empty?
-      end
-
-      def status
-        ''
-      end
-    end
+    attr_reader :name, :example, :extra_args
+    attr_accessor :status
 
     #
     # @param  [RSpec::Core::Example]  example
-    # @param  [Hash]  description
+    # @param  [Hash]  raw
     #
-    def initialize(example, description)
-      @example = example
-      @name = description[:keyword] + description[:name]
-      @docs = { extra_args: { klass: nil, value: description[:extra_args] } }
-    end
-
-    def attention?
-      !status.empty?
-    end
-
-    def status
-      self.class.status
+    def initialize(example, raw)
+      @example    = example
+      @name       = raw[:keyword].strip + ' ' + raw[:name]
+      @extra_args = raw[:extra_args]
+      @status     = :passed
     end
   end
 end

data/lib/turnip_formatter/step_template/base.rb

@@ -0,0 +1,34 @@
+module TurnipFormatter
+  module StepTemplate
+    class Base
+      class << self
+        def inherited(child)
+          TurnipFormatter.step_templates << child.new
+        end
+
+        def on_passed(template)
+          hooks[:passed] << template
+        end
+
+        def on_failed(template)
+          hooks[:failed] << template
+        end
+
+        def on_pending(template)
+          hooks[:pending] << template
+        end
+
+        def hooks
+          @hooks ||= { passed: [], failed: [], pending: [] }
+        end
+
+        #
+        # Return SCSS string that be used in this class
+        #
+        def scss
+          ''
+        end
+      end
+    end
+  end
+end

data/lib/turnip_formatter/step_template/exception.rb

@@ -1,61 +1,70 @@
-# -*- coding: utf-8 -*-
-
-require 'turnip_formatter/step/failure'
-require 'turnip_formatter/step/pending'
-require 'erb'
+require 'turnip_formatter/step_template/base'
+require 'haml'
 
 module TurnipFormatter
   module StepTemplate
-    module Exception
-      def self.build(exception)
-        template_step_exception.result(binding)
-      end
+    class Exception < Base
+      on_failed :build_failed
+      on_pending :build_pending
 
-      private
+      def self.scss
+        <<-EOS
+          div#steps-statistics section.scenario {
+              div.steps {
+                  div.step_exception {
+                      margin: 1em 0em;
+                      padding: 1em;
+                      border: 1px solid #999999;
+                      background-color: #eee8d5;
+                      color: #586e75;
 
-      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>
+                      dd {
+                          margin-top: 1em;
+                          margin-left: 1em;
+                      }
+                  }
+              }
+          }
         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
+      #
+      # @param  [RSpec::Core::Example]  example
+      #
+      def build_failed(example)
+        build(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
+      #
+      # @param  [RSpec::Core::Example]  example
+      #
+      def build_pending(example)
+        message = example.execution_result[:pending_message]
+        exception = RSpec::Core::Pending::PendingDeclaredInExample.new(message)
+        exception.set_backtrace([example.location])
+        build(exception)
+      end
+
+      private
+
+        def build(exception)
+          template_step_exception.render(exception)
+        end
+
+        def template_step_exception
+          @template_step_exception ||= Haml::Engine.new(<<-EOS)
+%div.step_exception
+  %dl
+    %dt Failure:
+    %dd
+      %pre&= exception.to_s
+    %dt Backtrace:
+    %dd
+      %ol
+        - exception.backtrace.each do |line|
+          %li&= line
+          EOS
+        end
+    end
   end
 end

data/lib/turnip_formatter/step_template/source.rb

@@ -1,46 +1,48 @@
-# -*- coding: utf-8 -*-
-
-require 'turnip_formatter/step/failure'
+require 'turnip_formatter/step_template/base'
 require 'rspec/core/formatters/snippet_extractor'
 
 module TurnipFormatter
   module StepTemplate
-    module Source
-      def self.build(location)
-        code = extractor.snippet([location])
+    class Source < Base
+      on_failed :build
+
+      def self.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
+      end
+
+      def build(example)
+        code = extractor.snippet([location(example)])
         '<pre class="source"><code class="ruby">' + code + '</code></pre>'
       end
 
       private
 
-      def self.extractor
-        @extractor ||= ::RSpec::Core::Formatters::SnippetExtractor.new
-      end
-    end
-  end
+        def location(example)
+          example.exception.backtrace.first
+        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
+        def extractor
+          @extractor ||= ::RSpec::Core::Formatters::SnippetExtractor.new
+        end
+    end
   end
 end

data/lib/turnip_formatter/template/exception.haml

@@ -0,0 +1,8 @@
+%dt&= title + ' Exception'
+%dd
+  %pre&= exception.to_s
+%dt&= title + ' Exception Backtrace'
+%dd
+  %ol
+    - exception.backtrace.each do |line|
+      %li&= line

data/lib/turnip_formatter/template/index.haml

@@ -0,0 +1,88 @@
+!!! 5
+%html
+  %head
+    %meta{ :charset => "UTF-8" }
+    %title= TurnipFormatter::Template.project_name + ' report'
+
+    = TurnipFormatter::Template.render_stylesheet_links
+    %style= TurnipFormatter::Template.render_stylesheet_codes
+
+    %script{ src: 'http://code.jquery.com/jquery-1.11.0.min.js' }
+    %script{ src: 'http://netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js' }
+    %script{ src: 'http://cdnjs.cloudflare.com/ajax/libs/jquery.tablesorter/2.17.0/jquery.tablesorter.min.js' }
+
+    = TurnipFormatter::Template.render_javascript_links
+    %script= TurnipFormatter::Template.render_javascript_codes
+
+  %body
+    %header#report
+      .container
+        .page-header
+          %h1= TurnipFormatter::Template.project_name + ' Report'
+
+        %section#status_display_switch
+          %label{ for: 'passed_check' }
+            %input#passed_check{ type: 'checkbox' }
+            Passed
+          %label{ for: 'failed_check' }
+            %input#failed_check{ type: 'checkbox', checked: 'checked' }
+            Failed
+          %label{ for: 'pending_check' }
+            %input#pending_check{ type: 'checkbox' }
+            Pending
+
+        %section.result
+          %p
+            %span#total_count&= scenarios.size
+            Scenario (
+            %span#failed_count&= failed_count
+            failed
+            %span#pending_count&= pending_count
+            pending).
+          %p
+            Finished in
+            %span#total_time&= total_time.to_s + ' sec'
+
+    #main.container{ role: 'main' }
+      %ul#statistics{ class: 'nav nav-tabs' }
+        %li.active
+          %a{ href: '#steps-statistics', data: { toggle: 'tab' } } Steps
+        %li
+          %a{ href: '#speed-statistics', data: { toggle: 'tab' } } Speed Statistics
+        %li
+          %a{ href: '#feature-statistics', data: { toggle: 'tab' } } Feature Statistics
+        %li
+          %a{ href: '#tag-statistics', data: { toggle: 'tab' } } Tag Statistics
+
+      .tab-content
+        #steps-statistics{ class: 'tab-pane active' }
+          .checkbox
+            %label
+              %input#scenario_display_check{ type: 'checkbox', checked: 'checked' }
+              Folding
+          #scenarios.panel-group
+            - scenario_files.each do |f|
+              = File.read(f)
+
+        #feature-statistics.tab-pane
+          %h4 The results for the feature:
+          = TurnipFormatter::Printer::TabFeatureStatistics.print_out(scenarios)
+
+        #tag-statistics.tab-pane
+          %h4 The results for the tab:
+          = TurnipFormatter::Printer::TabTagStatistics.print_out(scenarios)
+
+        #speed-statistics.tab-pane
+          %h4 Ranking of running time of each <strong>successfully</strong> scenario:
+          = TurnipFormatter::Printer::TabSpeedStatistics.print_out(scenarios)
+
+    %footer
+      %p
+        Generated by
+        %a{ href: 'https://rubygems.org/gems/turnip_formatter'} turnip_formatter
+        = TurnipFormatter::VERSION
+      %p
+        Powered by
+        %a{ href: 'http://jquery.com/' } jQuery 1.11.0
+        and
+        %a{ href: 'http://mottie.github.io/tablesorter/' } tablesorter 2.17.0

data/lib/turnip_formatter/template/runtime_exception.haml

@@ -0,0 +1,13 @@
+%section.exception
+  %h1 TurnipFormatter RuntimeError
+  %dl
+    = runtime_exception
+
+    %dt Example Full Description
+    %dd&= example.metadata[:full_description]
+
+    = example_exception
+
+    - if example.pending
+      %dt Example Pending description
+      %dd&= example.metadata[:description]

data/lib/turnip_formatter/template/scenario.haml

@@ -0,0 +1,14 @@
+%section{ class: "scenario #{scenario.status}", id: scenario.id }
+  %div.scenario-title
+    %span.permalink
+      %a{ href: "##{scenario.id}"} ¶
+    %span{ data: { toggle: "collapse", target: "##{scenario.id}_body" } }
+      &= "Scenario: #{scenario.name} Feature #{scenario.feature_info} at #{scenario.run_time} sec"
+  %div{ class: "panel-collapse collapse", id: "#{scenario.id}_body" }
+    %div.panel-body
+      %ul.tags
+        - scenario.tags.each do |tag|
+          %li @#{tag}
+      %div.steps
+        - scenario.steps.each do |step|
+          = TurnipFormatter::Printer::Step.print_out(step)

data/lib/turnip_formatter/template/step.haml

@@ -0,0 +1,6 @@
+%div{ class: "step #{step.status}" }
+  %div.step-title&= step.name
+  - if has_args_or_documents
+    %div.step-body
+      = TurnipFormatter::Printer::StepExtraArgs.print_out(step.extra_args)
+      ~ step_docs

data/lib/turnip_formatter/template/step_multiline.haml

@@ -0,0 +1 @@
+%pre.multiline&= lines

data/lib/turnip_formatter/template/step_outline.haml

@@ -0,0 +1,6 @@
+%table.step_outline
+  - table.each do |tr|
+    %tr
+      - tr.each do |td|
+        %td
+          &= td

data/lib/turnip_formatter/template/tab_feature_statistics.haml

@@ -0,0 +1,18 @@
+%table
+  %thead
+    %tr
+      %th Feature
+      %th Scearios
+      %th passed
+      %th failed
+      %th pending
+      %th status
+  %tbody
+    - analysis_results.each do |info|
+      %tr
+        %td= info.name
+        %td= info.scenario_count
+        %td= info.passed_count
+        %td= info.failed_count
+        %td= info.pending_count
+        %td{ class: info.status }= info.status

data/lib/turnip_formatter/template/tab_speed_statistics.haml

@@ -0,0 +1,16 @@
+%table
+  %thead
+    %tr
+      %th Feature
+      %th Scenario
+      %th Duration
+  %tbody
+    - analysis_results.each do |info|
+      %tr
+        %td
+          %span&= info.feature_name
+        %td
+          %a{ href: '#' + info.id}&= info.name
+        %td
+          %span&= info.run_time
+          sec

data/lib/turnip_formatter/template/tab_tag_statistics.haml

@@ -0,0 +1,18 @@
+%table
+  %thead
+    %tr
+      %th Tag
+      %th Scearios
+      %th passed
+      %th failed
+      %th pending
+      %th status
+  %tbody
+    - analysis_results.each do |info|
+      %tr
+        %td&= info.name
+        %td&= info.scenario_count
+        %td&= info.passed_count
+        %td&= info.failed_count
+        %td&= info.pending_count
+        %td{ class: info.status }&= info.status

data/lib/turnip_formatter/template/turnip_formatter.js

@@ -1,25 +1,16 @@
 $(function() {
-    var scenarioHeader = 'section.scenario header';
-    $(scenarioHeader).siblings().hide();
+    $('#statistics ul li a').click(function (e) {
+        e.preventDefault()
+        $(this).tab('show')
+    })
 
-    /**
-     * Step folding/expanding
-     */
-    $(scenarioHeader).click(function() {
-        $(this).siblings().slideToggle();
+    $('#speed-statistics a').click(function(e) {
+        $('#statistics a[href="#steps-statistics"]').tab('show');
     });
 
-    /**
-     * All step folding/expanding action
-     */
     $('#scenario_display_check').change(function() {
-        var steps = $(scenarioHeader).siblings();
-
-        if (this.checked) {
-            steps.slideUp();
-        } else {
-            steps.slideDown();
-        }
+        var action = $(this).prop("checked") ? 'show' : 'hide';
+        $('.panel-collapse').collapse(action);
     });
 
     ["passed", "failed", "pending"].forEach(function(status) {
@@ -35,14 +26,6 @@ $(function() {
     $(".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 }