turnip_formatter 0.2.11 → 0.3.0

data/lib/turnip_formatter/template/turnip_formatter.scss

@@ -1,101 +1,50 @@
-$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; }
-    }
-
-    @if $with_args {
+@import "bootstrap";
 
-        > 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;
-        }
-    }
-}
+article {
+  @extend .panel;
+  @extend .panel-success;
 
-@mixin content_centering {
-    margin: 0 auto;
-    padding: 2em;
-}
+  header {
+    @extend .panel-heading;
+  }
 
-body {
-    margin: 0;
-    background-color: #ffffff;
+  section {
+    @extend .panel-body;
+  }
 }
 
-div#report {
-    @include content_centering;
-    background: black;
-    color: $green-front;
+#report {
+    #status_display_switch {
+        label {
+            @extend .checkbox-inline;
+        }
+    }
 }
 
-footer {
-    @include content_centering;
-    background: black;
-    color: $green-front;
-    text-align: right;
-}
 
-div#main {
-    @include content_centering;
-    background-color: #ffffff;
+div#steps-statistics section.scenario {
+    @extend .panel;
 
-    .ui-tabs-nav {
-        border-width: 0;
-        padding: 0;
+    &.passed {
+        @extend .panel-success;
     }
 
-    .ui-tabs-panel {
-        border: 1px solid $gray-front;
+    &.failed {
+        @extend .panel-danger;
     }
-}
 
-div#steps-statistics section.scenario {
-    margin: 1em 0em;
-    padding-left: 1em;
-    border: 2px solid green;
+    &.pending {
+        @extend .panel-warning;
+    }
 
-    > header {
-        margin: 1em 0em;
+    div.scenario-title {
+        @extend .panel-heading;
 
         &:hover {
             text-decoration: underline;
             cursor: pointer;
         }
 
-        span.scenario_name {
-            font-weight: bold;
-            font-size: 14px;
-        }
-
-        span.feature_name {
-            font-size: 13px;
-            color: #839496;
-        }
-
         span.permalink {
             margin-right: 1em;
             font-size: 15px;
@@ -103,137 +52,90 @@ div#steps-statistics section.scenario {
         }
     }
 
-    > ul.tags {
-        font-size: 12px;
-
-        li {
-            color: #839496;
-            display: inline;
-        }
-    }
-
-    &.passed {
-        border-color: $green-front;
-
-        > header .scenario_name {
-            color: $green-front;
-            &:before { content: "\2713\20"; }
-        }
+    ul.tags {
+        @extend .list-inline;
     }
 
-    &.failed {
-        border-color: $red-front;
-
-        > header .scenario_name {
-            color: $red-front;
-            &:before { content: "\2717\20"; }
-        }
-    }
+    div.steps {
+        @extend .panel-group;
 
-    &.pending {
-        border-color: $yellow-front;
+        div.step {
+            @extend .panel;
 
-        > header .scenario_name {
-            color: $yellow-front;
-            &:before { content: "\d8\20"; }
-        }
-    }
-
-    ul.steps {
-        font-size: 12px;
-        list-style-type: none;
-
-        li.step {
-            padding: 0.5em;
-            font-weight: bold;
-            margin: 0.5em 0em;
-
-            @include step_span($green-front, $green-background);
+            &.passed {
+                @extend .panel-success;
+            }
 
-            &.failure {
-                @include step_span($red-front, $red-background, true);
+            &.failed {
+                @extend .panel-danger;
             }
 
             &.pending {
-                @include step_span($yellow-front, $yellow-background, true);
+                @extend .panel-warning;
             }
-        }
 
-        table.step_outline {
-            margin-top: 2em;
+            &.unexecuted {
+                @extend .panel-info;
+            }
 
-            tr:nth-child(odd) {
-                background-color: #ddddcc;
+            div.step-title {
+                @extend .panel-heading;
             }
 
-            tr:nth-child(even) {
-                background-color: #ccccdd;
+            div.step-body {
+                @extend .panel-body;
             }
 
-            td {
-                border: 2px solid black;
-                padding: 0.3em 1em;
+            table.step_outline {
+               margin-top: 2em;
+               @extend .table;
+               @extend .table-striped;
+               @extend .table-bordered;
             }
-        }
 
-        pre.multiline {
-            margin-top: 2em;
-            font-size: 13px;
-            color: #586e75;
+            pre.multiline {
+                margin-top: 2em;
+                font-size: 13px;
+                color: #586e75;
+            }
         }
     }
 }
 
-@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;
-            }
-        }
+        @extend .table;
+        @extend .table-hover;
 
-        tbody {
-            tr:nth-child(odd) {
-                background-color: #FFFFFF;
+        tbody td {
+            &.passed {
+                @extend .success;
             }
 
-            tr:nth-child(even) {
-                background-color: $gray-background;
+            &.failed {
+                @extend .danger;
             }
 
-            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;
-                }
+            &.pending {
+                @extend .warning;
             }
         }
     }
 }
 
+@mixin tablesorter-header {
+    background-position: center right;
+    background-repeat: no-repeat;
+    cursor: pointer;
+}
+
 div#speed-statistics {
+    table {
+        @extend .table;
+        @extend .table-hover;
+    }
+
     .tablesorter-header {
         @include tablesorter-header;
         background-image: url("data:image/gif;base64,R0lGODlhFQAJAIAAACMtMP///yH5BAEAAAEALAAAAAAVAAkAAAIXjI+AywnaYnhUMoqt3gZXPmVg94yJVQAAOw==");
@@ -269,3 +171,29 @@ section.exception {
         font-size: 14px;
     }
 }
+
+// Sticky footer styles
+// refs: http://getbootstrap.com/examples/sticky-footer/sticky-footer.css
+
+html {
+  position: relative;
+  min-height: 100%;
+}
+
+body {
+  margin-bottom: 80px;
+}
+
+footer {
+    @extend .text-right;
+    @extend .container;
+
+    bottom: 0;
+    height: 80px;
+    padding-top: 1em;
+    border-top: 1px solid #dddddd;
+
+    p {
+        @extend .text-muted;
+    }
+}

data/lib/turnip_formatter/template.rb

@@ -1,73 +1,68 @@
 # -*- coding: utf-8 -*-
 
-require 'turnip_formatter/template'
+require 'uri'
 require 'sass'
+require 'bootstrap-sass'
 
 module TurnipFormatter
   class Template
     class << self
       def project_name
-        RSpec.configuration.respond_to?(:project_name) ? RSpec.configuration.project_name : 'Turnip'
+        TurnipFormatter.configuration.title
       end
 
-      def add_js(js_string)
-        js_list << js_string
-      end
-
-      def add_js_file(file)
-        if URI(file).scheme
-          js_file_list << file
-        else
-          js_list << File.read(file)
+      def add_javascript(script)
+        case
+        when local_file?(script)
+          add_javascript_code File.read(script)
+        when remote_url?(script)
+          add_javascript_link script
         end
       end
 
-      def add_scss(scss_string)
-        css_list << Sass::Engine.new(scss_string, scss_option).render
-      end
-
-      def add_css_file(file)
-        if URI(file).scheme
-          css_file_list << file
-        else
-          add_scss_file(file)
+      def add_stylesheet(stylesheet)
+        case
+        when local_file?(stylesheet)
+          add_stylesheet_code File.read(stylesheet)
+        when remote_url?(stylesheet)
+          add_stylesheet_link stylesheet
         end
       end
 
-      def add_scss_file(path)
-        css_list << Sass::Engine.for_file(path, scss_option).render
+      def render_javascript_codes
+        js_code_list.join("\n")
       end
 
-      def js_render
-        js_list.join("\n")
-      end
-
-      def js_file_render
+      def render_javascript_links
         js_file_list.map do |file|
           "<script src=\"#{file}\" type=\"text/javascript\"></script>"
         end.join("\n")
       end
 
-      def css_render
-        css_list.join("\n")
+      def render_stylesheet_codes
+        TurnipFormatter.step_templates.each do |template|
+          add_stylesheet_code(template.class.scss)
+        end
+
+        css_code_list.join("\n")
       end
 
-      def css_file_render
+      def render_stylesheet_links
         css_file_list.map do |file|
           "<link rel=\"stylesheet\" href=\"#{file}\">"
         end.join("\n")
       end
 
-      def js_list
-        @js_list ||= []
+      def js_code_list
+        @js_code_list ||= []
       end
 
       def js_file_list
         @js_file_list ||= []
       end
 
-      def css_list
-        @css_list ||= []
+      def css_code_list
+        @css_code_list ||= []
       end
 
       def css_file_list
@@ -77,11 +72,42 @@ module TurnipFormatter
       def scss_option
         { syntax: :scss, style: :compressed }
       end
+
+      private
+
+      def add_javascript_code(code)
+        js_code_list << code
+      end
+
+      def add_javascript_link(link)
+        js_file_list << link
+      end
+
+      def add_stylesheet_code(code)
+        css_code_list << Sass::Engine.new(code, scss_option).render
+      end
+
+      def add_stylesheet_link(file)
+        css_file_list << file
+      end
+
+      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
+        null
+      end
     end
-  end
-end
 
-(File.dirname(__FILE__) + '/template').tap do |dirname|
-  TurnipFormatter::Template.add_css_file(dirname + '/turnip_formatter.scss')
-  TurnipFormatter::Template.add_js_file(dirname + '/turnip_formatter.js')
+    (File.dirname(__FILE__) + '/template').tap do |dirname|
+      add_stylesheet(dirname + '/turnip_formatter.scss')
+      add_javascript(dirname + '/turnip_formatter.js')
+    end
+  end
 end

data/lib/turnip_formatter/version.rb

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
 
 module TurnipFormatter
-  VERSION = "0.2.11"
+  VERSION = '0.3.0'
 end

data/lib/turnip_formatter.rb

@@ -1,19 +1,57 @@
-# -*- coding: utf-8 -*-
-
-require "turnip_formatter/version"
+require 'turnip_formatter/version'
 require 'turnip'
 
 module TurnipFormatter
+  class << self
+    attr_accessor :title
+
+    def step_templates
+      @step_templates ||= []
+    end
+
+    def step_templates_for(status)
+      step_templates.reduce([]) do |templates, t|
+        hooks = t.class.hooks
+        return templates unless hooks.key?(status)
+        templates + [t].product(hooks[status])
+      end
+    end
+
+    def add_stylesheet(stylesheets)
+      stylesheets = [stylesheets] if stylesheets.is_a? String
+
+      stylesheets.each do |s|
+        TurnipFormatter::Template.add_stylesheet(s)
+      end
+    end
+
+    def add_javascript(scripts)
+      scripts = [scripts] if scripts.is_a? String
+
+      scripts.each do |s|
+        TurnipFormatter::Template.add_javascript(s)
+      end
+    end
+
+    def configure
+      yield self
+    end
+
+    def configuration
+      self
+    end
+  end
+
   require 'rspec/core/formatters/turnip_formatter'
   require 'turnip_formatter/template'
-  require 'turnip_formatter/step_template'
+  require 'turnip_formatter/step_template/exception'
+  require 'turnip_formatter/step_template/source'
   require 'turnip_formatter/ext/turnip/rspec'
-  require 'turnip_formatter/ext/turnip/builder'
   require 'turnip_formatter/printer/index'
 end
 
 RSpecTurnipFormatter = RSpec::Core::Formatters::TurnipFormatter
 
-RSpec.configure do |config|
-  config.add_setting :project_name, :default => "Turnip"
+TurnipFormatter.configure do |config|
+  config.title = 'Turnip'
 end

data/spec/spec_helper.rb

@@ -10,10 +10,15 @@ end
 
 require 'rspec-html-matchers'
 require 'turnip_formatter'
-Dir.glob(File.dirname(__FILE__) + "/support/**/*.rb") { |f| require(f) }
+Dir.glob(File.dirname(__FILE__) + '/support/**/*.rb') { |f| require(f) }
 
 class NoopObject
   def method_missing(name, *args, &block)
     # nooooooop
   end
 end
+
+RSpec.configure do |config|
+  config.include ExampleHelper
+  config.include StepHelper
+end

data/spec/support/example_helper.rb

@@ -0,0 +1,36 @@
+module ExampleHelper
+  def passed_example
+    base_example { expect(true).to be true }
+  end
+
+  def failed_example
+    example = base_example { expect(true).to be false }
+    example.exception.backtrace.push ':in step:0 `'
+    example
+  end
+
+  def pending_example
+    example = base_example { pending('Pending') }
+    example.execution_result[:pending_message] = 'No such step(0): '
+    example
+  end
+
+  private
+
+    def base_example(&assertion)
+      group = ::RSpec::Core::ExampleGroup.describe('Feature').describe('Scenario')
+      example = group.example('example', example_metadata, &assertion)
+      group.run(NoopObject.new)
+      example
+    end
+
+    def example_metadata
+      {
+        turnip_formatter: {
+          steps: [ { name: 'Step 1', extra_args: [], keyword: 'When' } ],
+          tags: []
+        },
+        file_path: '/path/to/hoge.feature'
+      }
+    end
+end

data/spec/support/step_helper.rb

@@ -0,0 +1,27 @@
+require 'support/example_helper'
+
+module StepHelper
+  include ExampleHelper
+
+  def passed_step
+    base_step(passed_example)
+  end
+
+  def failed_step
+    base_step(failed_example).tap { |s| s.status = :failed }
+  end
+
+  def pending_step
+    base_step(pending_example).tap { |s| s.status = :pending  }
+  end
+
+  private
+
+    def base_step(example)
+      TurnipFormatter::Step.new(example, step_description)
+    end
+
+    def step_description
+      { name: 'StepName', keyword: 'Keyword', extra_args: ['Docstring'] }
+    end
+end

data/spec/turnip_formatter/printer/index_spec.rb

@@ -5,13 +5,13 @@ module TurnipFormatter::Printer
   describe Index do
 
     let(:formatter) do
-      double("Formatter", {
-          :scenarios        => [],
-          :passed_scenarios => [],
-          :failure_count    => 0,
-          :pending_count    => 0,
-          :duration         => 0
-        })
+      {
+        scenarios:      [],
+        scenario_files: [],
+        failed_count:   0,
+        pending_count:  0,
+        duration:       0
+      }
     end
 
     describe '.print_out' do
@@ -22,8 +22,8 @@ module TurnipFormatter::Printer
 
     context 'project_name is changed' do
       before do
-        @original_project_name = RSpec.configuration.project_name
-        RSpec.configuration.project_name = 'My Project'
+        @original_project_name = TurnipFormatter.configuration.title
+        TurnipFormatter.configuration.title = 'My Project'
       end
 
       describe '.print_out' do
@@ -33,7 +33,7 @@ module TurnipFormatter::Printer
       end
 
       after do
-        RSpec.configuration.project_name = @original_project_name
+        TurnipFormatter.configuration.title = @original_project_name
       end
     end
   end