turnip_formatter 0.0.6 → 0.1.0

data/lib/turnip_formatter/formatter.scss

@@ -1,14 +1,44 @@
-@mixin step_span {
-    &:hover { border-width: 3px; }
-    ~ * { margin-left: 2em; }
-}
+$red-front: #ED1C24;
+$green-front: #509B49;
+$yellow-front: #D6A921;
+$red-background: #FFDDDD;
+$green-background: #EEFFEE;
+$yellow-background: #FFFFDD;
+$gray-front: #7A7B7D;
+$gray-background: #DDDDDD;
+
+@mixin step_span($front, $back, $with_args: false) {
+    > span {
+        border: 1px solid $front;
+        padding: 0.5em;
+        background-color: $back;
+        color: $front;
+
+        &:hover { border-width: 3px; }
+        ~ * { margin-left: 2em; }
+    }
 
-@mixin noop_step_span {
-    @include step_span;
+    @if $with_args {
 
-    background-color: #cccccc;
-    border: 1px solid #444444;
-    color: #333333;
+        > div.args {
+            font-size: 11px;
+            padding: 1em;
+            background-color: $back;
+            border: 1px solid $front;
+        }
+
+        /* skip/pending step style */
+        ~ li > span {
+            background-color: $gray-background;
+            border-color: $gray-front;
+            color: $gray-front;
+        }
+    }
+}
+
+@mixin content_centering {
+    margin: 0 auto;
+    padding: 2em;
 }
 
 body {
@@ -16,30 +46,33 @@ body {
 }
 
 div#report {
-    width: 90%;
-    margin: 0 auto;
-    padding: 2em;
+    @include content_centering;
     background: black;
-    color: #aaffaa;
+    color: $green-front;
 }
 
 footer {
-    width: 90%;
-    margin: 0 auto;
-    padding: 2em;
+    @include content_centering;
     background: black;
-    color: #aaffaa;
+    color: $green-front;
     text-align: right;
 }
 
 div#main {
-    width: 90%;
-    margin: 0 auto;
-    padding: 2em;
+    @include content_centering;
     background-color: #fff9f9;
+
+    .ui-tabs-nav {
+        border-width: 0;
+        padding: 0;
+    }
+
+    .ui-tabs-panel {
+        border: 1px solid $gray-front;
+    }
 }
 
-section.scenario {
+div#steps-statistics section.scenario {
     margin: 1em 0em;
     padding-left: 1em;
     border: 2px solid green;
@@ -79,28 +112,28 @@ section.scenario {
     }
 
     &.passed {
-        border-color: green;
+        border-color: $green-front;
 
         > header .scenario_name {
-            color: #859900;
+            color: $green-front;
             &:before { content: "\2713\20"; }
         }
     }
 
     &.failed {
-        border-color: #dc322f;
+        border-color: $red-front;
 
         > header .scenario_name {
-            color: #dc322f;
+            color: $red-front;
             &:before { content: "\2717\20"; }
         }
     }
 
     &.pending {
-        border-color: #b58900;
+        border-color: $yellow-front;
 
         > header .scenario_name {
-            color: #b58900;
+            color: $yellow-front;
             &:before { content: "\d8\20"; }
         }
     }
@@ -114,53 +147,14 @@ section.scenario {
             font-weight: bold;
             margin: 0.5em 0em;
 
-            > span {
-                padding: 0.5em;
-                background-color: #eeffee;
-                border: 1px solid #00aa00;
-                color: #00aa00;
-
-                @include step_span;
-            }
-
-            div.args {
-                font-size: 11px;
-            }
+            @include step_span($green-front, $green-background);
 
             &.failure {
-                > span {
-                    background-color: #ffdddd;
-                    border: 1px solid #dd0000;
-                    color: #dd0000;
-
-                    @include step_span;
-                }
-
-                > div.args {
-                    padding: 1em;
-                    background-color: #ffeeee;
-                    border: 1px solid #cc8888;
-                }
-
-                ~ li > span { @include noop_step_span; }
+                @include step_span($red-front, $red-background, true);
             }
 
             &.pending {
-                > span {
-                    background-color: #ffffbb;
-                    border: 1px solid #666600;
-                    color: #666600;
-
-                    @include step_span;
-                }
-
-                > div.args {
-                    padding: 1em;
-                    background-color: #ffffaa;
-                    border: 1px solid #999944;
-                }
-
-                ~ li > span { @include noop_step_span; }
+                @include step_span($yellow-front, $yellow-background, true);
             }
         }
 
@@ -188,7 +182,7 @@ section.scenario {
         }
 
         div.step_exception {
-            margin: 1em 0em 1em 0em;
+            margin: 1em 0em;
             padding: 1em 0em 1em 1em;
             border: 1px solid #999999;
             background-color: #eee8d5;
@@ -221,6 +215,76 @@ section.scenario {
     }
 }
 
+@mixin tablesorter-header {
+    background-position: center right;
+    background-repeat: no-repeat;
+    cursor: pointer;
+}
+
+div#speed-statistics,
+div#feature-statistics,
+div#tag-statistics {
+    table {
+        width: 100%;
+        margin: 1em 0em;
+        
+        thead {
+            th {
+                border-bottom: 1px solid $gray-front;
+            }
+        }
+
+        tbody {
+            tr:nth-child(odd) { 
+                background-color: #FFFFFF;
+            }
+
+            tr:nth-child(even) {
+                background-color: $gray-background;
+            }
+
+            td {
+                border: 1px solid $gray-front;
+                padding: 0.3em 1em;
+
+                &.passed {
+                    background-color: $green-background;
+                    color: $green-front;
+                }
+                &.failed {
+                    background-color: $red-background;
+                    color: $red-front;
+                }
+                &.pending {
+                    background-color: $yellow-background;
+                    color: $yellow-front;
+                }
+            }
+        }
+    }
+}
+
+div#speed-statistics {
+    .tablesorter-header {
+        @include tablesorter-header;
+        background-image: url("data:image/gif;base64,R0lGODlhFQAJAIAAACMtMP///yH5BAEAAAEALAAAAAAVAAkAAAIXjI+AywnaYnhUMoqt3gZXPmVg94yJVQAAOw==");
+
+        &.sorter-false {
+            background: none;
+        }
+    }
+
+    .tablesorter-headerAsc {
+        @include tablesorter-header;
+        background-image: url("data:image/gif;base64,R0lGODlhFQAEAIAAACMtMP///yH5BAEAAAEALAAAAAAVAAQAAAINjI8Bya2wnINUMopZAQA7");
+    }
+
+    .tablesorter-headerDesc {
+        @include tablesorter-header;
+        background-image: url("data:image/gif;base64,R0lGODlhFQAEAIAAACMtMP///yH5BAEAAAEALAAAAAAVAAQAAAINjB+gC+jP2ptn0WskLQA7");
+    }
+}
+
 section.exception {
     margin: 1em 0em;
     border: 2px solid #268bd2;

data/lib/turnip_formatter/scenario.rb

@@ -27,6 +27,10 @@ module TurnipFormatter
         TurnipFormatter::Step.new(example, desc)
       end
     end
+
+    def id
+      "step_" + object_id.to_s
+    end
     
     #
     # @return  [String] scenario name

data/lib/turnip_formatter/template/tab/feature_statistics.rb

@@ -0,0 +1,78 @@
+# -*- coding: utf-8 -*-
+
+require 'turnip_formatter/template'
+
+module TurnipFormatter
+  class Template
+    module Tab
+      class FeatureStatistics
+        attr_reader :features
+
+        #
+        # @param [Array]  passed_examples  Array of TurnipFormatter::Scenario
+        #
+        def initialize(scenarios)
+          @features = scenarios.group_by { |s| s.feature_name }
+        end
+
+        def build
+          html = <<-EOS
+            <table>
+              <thead>
+                <tr>
+                  <th>Feature</th>
+                  <th>Scearios</th>
+                  <th>passed</th>
+                  <th>failed</th>
+                  <th>pending</th>
+                  <th>status</th>
+                </tr>
+              </thead>
+              <tbody>
+          EOS
+          
+          html += @features.map do |feature_name, scenarios|
+            info = feature_analysis(feature_name, scenarios)
+            build_tr(info)
+          end.join
+
+          html += '</tbody></table>'
+        end
+
+        private
+
+        def feature_analysis(name, scenarios)
+          status_group = scenarios.group_by { |s| s.status }
+
+          info = {
+            name: name,
+            scenarios: scenarios.count,
+            passed: status_count(status_group["passed"]),
+            failed: status_count(status_group["failed"]),
+            pending: status_count(status_group["pending"])
+          }
+          info[:status] = info[:failed].zero? ? (info[:pending].zero? ? 'passed' : 'pending') : 'failed'
+
+          info
+        end
+
+        def status_count(scenarios)
+          scenarios.nil? ? 0 : scenarios.count
+        end
+
+        def build_tr(info)
+          <<-EOS
+            <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>
+          EOS
+        end
+      end
+    end
+  end
+end

data/lib/turnip_formatter/template/tab/speed_statistics.rb

@@ -0,0 +1,61 @@
+# -*- coding: utf-8 -*-
+
+require 'turnip_formatter/template'
+require 'ostruct'
+
+module TurnipFormatter
+  class Template
+    module Tab
+      class SpeedStatistics
+        attr_reader :scenarios
+
+        #
+        # @param [Array]  passed_examples  Array of TurnipFormatter::Scenario::Pass
+        #
+        def initialize(passed_scenarios)
+          @scenarios = passed_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
+
+        def build
+          html = <<-EOS
+            <table>
+              <thead>
+                <tr>
+                  <th>Feature</th>
+                  <th>Scenario</th>
+                  <th>Duration</th>
+                </tr>
+              </thead>
+              <tbody>
+          EOS
+
+          html += scenarios.map do |scenario|
+            <<-EOS
+                <tr>
+                  <td><span>#{scenario.feature_name}</span></td>
+                  <td><a href=\"\##{scenario.id}\">#{scenario.name}</a></td>
+                  <td><span>#{scenario.run_time}</span> sec</td>
+                </tr>
+            EOS
+          end.join
+
+          html += <<-EOS
+              </tbody>
+            </table>
+          EOS
+
+          html
+        end
+      end
+    end
+  end
+end

data/lib/turnip_formatter/template/tab/tag_statistics.rb

@@ -0,0 +1,101 @@
+# -*- coding: utf-8 -*-
+
+require 'turnip_formatter/template'
+
+module TurnipFormatter
+  class Template
+    module Tab
+      class TagStatistics
+        attr_reader :scenarios
+
+        #
+        # @param [Array]  passed_examples  Array of TurnipFormatter::Scenario
+        #
+        def initialize(scenarios)
+          @scenarios = scenarios
+        end
+
+        def build
+          html = <<-EOS
+            <table>
+              <thead>
+                <tr>
+                  <th>Tag</th>
+                  <th>Scearios</th>
+                  <th>passed</th>
+                  <th>failed</th>
+                  <th>pending</th>
+                  <th>status</th>
+                </tr>
+              </thead>
+              <tbody>
+          EOS
+          
+          html += tag_analysis.map { |info| build_tr(info) }.join
+          html += '</tbody></table>'
+        end
+
+        private
+
+        def tag_analysis
+          group_by_tag.map do |tag, scenarios|
+            status_group = scenarios.group_by { |s| s[:scenario].status }
+            info = OpenStruct.new(
+              name: tag,
+              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
+        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.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
+
+        def build_tr(info)
+          <<-EOS
+            <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>
+          EOS
+        end
+      end
+    end
+  end
+end

data/lib/turnip_formatter/template.rb

@@ -2,6 +2,9 @@
 
 require 'erb'
 require 'rspec/core/formatters/helpers'
+require 'turnip_formatter/template/tab/speed_statistics'
+require 'turnip_formatter/template/tab/feature_statistics'
+require 'turnip_formatter/template/tab/tag_statistics'
 
 module TurnipFormatter
   class Template
@@ -19,13 +22,20 @@ module TurnipFormatter
         <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>
             #{File.read(File.dirname(__FILE__) + '/formatter.css')}
             </style>
-            <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js"></script>
+
             <script>
               $(function() {
                   var scenarioHeader = 'section.scenario header';
+                  $(scenarioHeader).siblings().hide();
                    
                   /**
                    * Step folding/expanding
@@ -57,31 +67,91 @@ module TurnipFormatter
                           }
                       });
                   });
+
+                  /**
+                   * Tabs
+                   */
+                   var tab_area = 'div#main';
+                   $(tab_area).tabs();
+                    
+                   $('div#speed-statistics a').click(function() {
+                       $(tab_area).tabs("option", "active", 0);
+                   });
+
+                   $("div#speed-statistics table").tablesorter({
+                       headers: {
+                           1: { sorter: false }
+                       }
+                   });
               });
             </script>
           </head>
           <body>
             #{report_area}
             <div id="main" role="main">
-              <label><input type="checkbox" id="scenario_display_check">step folding</label>
+              <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>
       EOS
     end
 
-    def print_footer(total_count, failed_count, pending_count, total_time)
+    def print_main_header
+      <<-EOS
+        <div id="steps-statistics">
+          <label><input type="checkbox" id="scenario_display_check" checked>step folding</label>
+      EOS
+    end
+
+    def print_main_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
 
+      "#{update_report_js}</div>"
+    end
+
+    def print_tab_speed_statsitics(passed_scenarios)
+      statistics = TurnipFormatter::Template::Tab::SpeedStatistics.new(passed_scenarios)
       <<-EOS
-            </div>
-            #{update_report_js}
+        <div id="speed-statistics">
+          <em>Ranking of running time of each <strong>successfully</strong> scenario:</em>
+          #{statistics.build}
+        </div>
+      EOS
+    end
+
+    def print_tab_feature_statsitics(scenarios)
+      statistics = TurnipFormatter::Template::Tab::FeatureStatistics.new(scenarios)
+      <<-EOS
+        <div id="feature-statistics">
+          <em>The results for the feature:</em>
+          #{statistics.build}
+        </div>
+      EOS
+    end
 
+    def print_tab_tag_statsitics(scenarios)
+      statistics = TurnipFormatter::Template::Tab::TagStatistics.new(scenarios)
+      <<-EOS
+        <div id="tag-statistics">
+          <em>The results for the tab:</em>
+          #{statistics.build}
+        </div>
+      EOS
+    end
+
+    def print_footer
+      <<-EOS
+            </div>
             <footer>
-              Generated by <a href="https://rubygems.org/gems/turnip_formatter">turnip_formatter</a> #{TurnipFormatter::VERSION} and <a href="http://jquery.com/">jQuery</a>
+              <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>
@@ -175,9 +245,9 @@ module TurnipFormatter
         <section class="scenario <%= h(scenario.status) %>">
           <header>
             <span class="permalink">
-              <a href="#<%= scenario.object_id %>">&para;</a>
+              <a href="#<%= scenario.id %>">&para;</a>
             </span>
-            <span class="scenario_name" id="<%= scenario.object_id %>">
+            <span class="scenario_name" id="<%= scenario.id %>">
               Scenario: <%= h(scenario.name) %>
             </span>
             <span class="feature_name">

data/lib/turnip_formatter/version.rb

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

data/spec/examples/features/battle3.feature

@@ -1,5 +1,6 @@
 Feature: Battle monsters
 
+  @watch
   Scenario: Escape
     Given there are monsters:
       | gargoyle   |

data/spec/examples/features/songs.feature

@@ -8,3 +8,12 @@ Feature: A feature with multiline strings
     This is cool
     """
     Then the song should have 2 lines
+
+  Scenario: This is a feature with multiline strings
+    When a monster sings the following song
+    """
+    Oh here be monsters
+    This is cool
+    """
+    Then the song should have 2 lines
+