turnip_formatter 0.0.1

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor/bundle
+.sass-cache
+

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+script: bundle exec rspec

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Wataru MIYAGUNI
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+RSpec::Core::Formatters::TurnipFormatter
+========================================
+
+TurnipFormatter is a pretty custom formatter for [Turnip](https://github.com/jnicklas/turnip).
+
+[![Build Status](https://travis-ci.org/gongo/turnip_formatter.png?branch=master)](https://travis-ci.org/gongo/turnip_formatter)
+[![Coverage Status](https://coveralls.io/repos/gongo/turnip_formatter/badge.png?branch=master)](https://coveralls.io/r/gongo/turnip_formatter)
+[![Code Climate](https://codeclimate.com/github/gongo/turnip_formatter.png)](https://codeclimate.com/github/gongo/turnip_formatter)
+[![Dependency Status](https://gemnasium.com/gongo/turnip_formatter.png)](https://gemnasium.com/gongo/turnip_formatter)
+
+Requirements
+--------------------
+
+* Ruby
+    * `~> 1.9.3`
+    * `~> 2.0.0`
+
+Installation
+--------------------
+
+### RubyGems
+
+    $ gem install turnip_formatter
+
+### Bundler
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :test do
+  gem 'turnip_formatter'
+end
+```
+
+And then execute:
+
+    $ bundle install
+
+Usage
+--------------------
+
+Run this command.
+
+    $ rspec -r turnip_formatter --format RSpecTurnipFormatter --out report.html
+
+Example
+--------------------
+
+see https://github.com/gongo/turnip_formatter/tree/master/spec/examples
+
+License
+--------------------
+
+see LICENSE.txt

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rspec/core/formatters/turnip_formatter.rb

@@ -0,0 +1,61 @@
+# -*- coding: utf-8 -*-
+
+require 'rspec/core/formatters/base_formatter'
+require 'turnip_formatter/scenario/pass'
+require 'turnip_formatter/scenario/failure'
+require 'turnip_formatter/scenario/pending'
+require 'turnip_formatter/template'
+
+module RSpec
+  module Core
+    module Formatters
+      class TurnipFormatter < BaseFormatter
+
+        def initialize(output)
+          super(output)
+          @template = ::TurnipFormatter::Template.new
+        end
+
+        def start(example_count)
+          super(example_count)
+          output.puts @template.print_header
+        end
+
+        def dump_summary(duration, example_count, failure_count, pending_count)
+          output.puts @template.print_footer(example_count, failure_count, pending_count, duration)
+        end
+
+        def example_passed(example)
+          super(example)
+          scenario = ::TurnipFormatter::Scenario::Pass.new(example)
+          output_scenario(scenario)
+        end
+
+        def example_pending(example)
+          super(example)
+          scenario = ::TurnipFormatter::Scenario::Pending.new(example)
+          output_scenario(scenario)
+        end
+
+        def example_failed(example)
+          super(example)
+          scenario = ::TurnipFormatter::Scenario::Failure.new(example)
+          output_scenario(scenario)
+        end
+
+        private
+
+        def output_scenario(scenario)
+          scenario.validation
+          output.puts @template.print_scenario(scenario)
+        rescue => e
+          output_runtime_error(e)
+        end
+
+        def output_runtime_error(exception)
+          output.puts @template.print_runtime_error(examples.last, exception)
+        end
+      end
+    end
+  end
+end

data/lib/turnip_formatter/ext/turnip/builder.rb

@@ -0,0 +1,46 @@
+# -*- coding: utf-8 -*-
+
+require 'turnip/builder'
+
+module Turnip
+  class Builder
+    class ScenarioOutline
+      def to_scenarios(examples)
+        rows = examples.rows.map(&:cells)
+        headers = rows.shift
+        rows.map do |row|
+          Scenario.new(@raw).tap do |scenario|
+            scenario.steps = steps.map do |step|
+              new_description = substitute(step.description, headers, row)
+              new_extra_args = step.extra_args.map do |ea|
+                next ea unless ea.instance_of?(Turnip::Table)
+                Turnip::Table.new(ea.map {|t_row| t_row.map {|t_col| substitute(t_col, headers, row) } })
+              end
+              Step1.new(new_description, new_extra_args, step.line, step.keyword)
+            end
+          end
+        end
+      end
+    end
+
+    class Step1 < Struct.new(:description, :extra_args, :line, :keyword, :tags)
+      def split(*args)
+        self.to_s.split(*args)
+      end
+
+      def to_s
+        description
+      end
+    end
+
+    def step(step)
+      extra_args = []
+      if step.doc_string
+        extra_args.push step.doc_string.value
+      elsif step.rows
+        extra_args.push Turnip::Table.new(step.rows.map { |row| row.cells(&:value) })
+      end
+      @current_step_context.steps << Step1.new(step.name, extra_args, step.line, step.keyword)
+    end
+  end
+end

data/lib/turnip_formatter/ext/turnip/rspec.rb

@@ -0,0 +1,73 @@
+# -*- coding: utf-8 -*-
+
+require 'turnip/rspec'
+
+module Turnip
+  module RSpec
+    module Execute
+      def run_step(feature_file, step, index)
+        begin
+          step(step)
+        rescue Turnip::Pending
+          pending("No such step(#{index}): '#{step}'")
+        rescue StandardError => e
+          e.backtrace.push "#{feature_file}:#{step.line}:in step:#{index} `#{step.description}'"
+          raise e
+        end
+      end
+
+      def initialize_scenario_metadata
+        example.metadata[:steps] = {
+          descriptions: [],
+          docstrings: [],
+          keywords: [],
+          tags: [],
+        }
+      end
+
+      def push_scenario_metadata(scenario)
+        steps = scenario.steps
+        example.metadata[:steps].tap do |meta|
+          meta[:descriptions] += steps.map(&:description)
+          meta[:docstrings]   += steps.map(&:extra_args)
+          meta[:keywords]     += steps.map(&:keyword)
+          meta[:tags]          = scenario.tags if scenario.respond_to?(:tags)
+        end
+      end
+    end
+
+    class << self
+      def run(feature_file)
+        Turnip::Builder.build(feature_file).features.each do |feature|
+          describe feature.name, feature.metadata_hash do
+            before do
+              example.metadata[:file_path] = feature_file
+              initialize_scenario_metadata
+
+              feature.backgrounds.each do |background|
+                push_scenario_metadata(background)
+              end
+
+              feature.backgrounds.map(&:steps).flatten.each.with_index do |step, index|
+                run_step(feature_file, step, index)
+              end
+            end
+            feature.scenarios.each do |scenario|
+              describe scenario.name, scenario.metadata_hash do
+                before do
+                  push_scenario_metadata(scenario)
+                end
+
+                it scenario.steps.map(&:description).join(' -> ') do
+                  scenario.steps.each.with_index do |step, index|
+                    run_step(feature_file, step, index)
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/turnip_formatter/formatter.css

@@ -0,0 +1,159 @@
+body {
+  background-color: #586e75; }
+
+div#report {
+  width: 90%;
+  margin: 0 auto;
+  padding: 2em;
+  background: black;
+  color: #aaffaa; }
+
+div#main {
+  width: 90%;
+  margin: 0 auto;
+  padding: 2em;
+  background-color: #fff9f9; }
+
+section.scenario {
+  margin: 1em 0em;
+  padding-left: 1em;
+  border: 2px solid green; }
+  section.scenario > header {
+    margin: 1em 0em; }
+    section.scenario > header span.scenario_name {
+      font-weight: bold;
+      font-size: 14px; }
+    section.scenario > header span.feature_name {
+      font-size: 13px;
+      color: #839496; }
+    section.scenario > header span.permalink {
+      margin-right: 1em;
+      font-size: 15px; }
+      section.scenario > header span.permalink a {
+        color: #268bd2; }
+  section.scenario > ul.tags {
+    font-size: 12px; }
+    section.scenario > ul.tags li {
+      color: #839496;
+      display: inline; }
+  section.scenario.passed {
+    border-color: green; }
+    section.scenario.passed > header .scenario_name {
+      color: #859900; }
+      section.scenario.passed > header .scenario_name:before {
+        content: "\2713\20"; }
+  section.scenario.failed {
+    border-color: #dc322f; }
+    section.scenario.failed > header .scenario_name {
+      color: #dc322f; }
+      section.scenario.failed > header .scenario_name:before {
+        content: "\2717\20"; }
+  section.scenario.pending {
+    border-color: #b58900; }
+    section.scenario.pending > header .scenario_name {
+      color: #b58900; }
+      section.scenario.pending > header .scenario_name:before {
+        content: "\d8\20"; }
+  section.scenario ul.steps {
+    font-size: 12px;
+    list-style-type: none; }
+    section.scenario ul.steps li.step {
+      padding: 0.5em;
+      font-weight: bold;
+      margin: 0.5em 0em; }
+      section.scenario ul.steps li.step > span {
+        padding: 0.5em;
+        background-color: #eeffee;
+        border: 1px solid #00aa00;
+        color: #00aa00; }
+        section.scenario ul.steps li.step > span:hover {
+          border-width: 3px; }
+        section.scenario ul.steps li.step > span ~ * {
+          margin-left: 2em; }
+      section.scenario ul.steps li.step div.args {
+        font-size: 11px; }
+      section.scenario ul.steps li.step.failure > span {
+        background-color: #ffdddd;
+        border: 1px solid #dd0000;
+        color: #dd0000; }
+        section.scenario ul.steps li.step.failure > span:hover {
+          border-width: 3px; }
+        section.scenario ul.steps li.step.failure > span ~ * {
+          margin-left: 2em; }
+      section.scenario ul.steps li.step.failure > div.args {
+        padding: 1em;
+        background-color: #ffeeee;
+        border: 1px solid #cc8888; }
+      section.scenario ul.steps li.step.failure ~ li > span {
+        background-color: #cccccc;
+        border: 1px solid #444444;
+        color: #333333; }
+        section.scenario ul.steps li.step.failure ~ li > span:hover {
+          border-width: 3px; }
+        section.scenario ul.steps li.step.failure ~ li > span ~ * {
+          margin-left: 2em; }
+      section.scenario ul.steps li.step.pending > span {
+        background-color: #ffffbb;
+        border: 1px solid #666600;
+        color: #666600; }
+        section.scenario ul.steps li.step.pending > span:hover {
+          border-width: 3px; }
+        section.scenario ul.steps li.step.pending > span ~ * {
+          margin-left: 2em; }
+      section.scenario ul.steps li.step.pending > div.args {
+        padding: 1em;
+        background-color: #ffffaa;
+        border: 1px solid #999944; }
+      section.scenario ul.steps li.step.pending ~ li > span {
+        background-color: #cccccc;
+        border: 1px solid #444444;
+        color: #333333; }
+        section.scenario ul.steps li.step.pending ~ li > span:hover {
+          border-width: 3px; }
+        section.scenario ul.steps li.step.pending ~ li > span ~ * {
+          margin-left: 2em; }
+    section.scenario ul.steps table.step_outline {
+      margin-top: 2em; }
+      section.scenario ul.steps table.step_outline tr:nth-child(odd) {
+        background-color: #ddddcc; }
+      section.scenario ul.steps table.step_outline tr:nth-child(even) {
+        background-color: #ccccdd; }
+      section.scenario ul.steps table.step_outline td {
+        border: 2px solid black;
+        padding: 0.3em 1em; }
+    section.scenario ul.steps pre.multiline {
+      margin-top: 2em;
+      font-size: 13px;
+      color: #586e75; }
+    section.scenario ul.steps div.step_exception {
+      margin: 1em 0em 1em 0em;
+      padding: 1em 0em 1em 1em;
+      border: 1px solid #999999;
+      background-color: #eee8d5;
+      color: #586e75; }
+      section.scenario ul.steps div.step_exception > pre {
+        margin-left: 1em; }
+    section.scenario ul.steps pre.source {
+      font-size: 12px;
+      font-family: monospace;
+      background-color: #073642;
+      color: #dddddd; }
+      section.scenario ul.steps pre.source code.ruby {
+        padding: 0.1em 0 0.2em 0; }
+        section.scenario ul.steps pre.source code.ruby .linenum {
+          width: 75px;
+          color: #fffbd3;
+          padding-right: 1em; }
+        section.scenario ul.steps pre.source code.ruby .offending {
+          background-color: gray; }
+
+section.exception {
+  margin: 1em 0em;
+  border: 2px solid #268bd2;
+  padding: 2em; }
+  section.exception dt {
+    line-height: 2em;
+    font-size: 15px; }
+  section.exception dd {
+    line-height: 2em;
+    font-size: 14px; }

data/lib/turnip_formatter/formatter.scss

@@ -0,0 +1,225 @@
+@mixin step_span {
+    &:hover { border-width: 3px; }
+    ~ * { margin-left: 2em; }
+}
+
+@mixin noop_step_span {
+    @include step_span;
+
+    background-color: #cccccc;
+    border: 1px solid #444444;
+    color: #333333;
+}
+
+body {
+    background-color: #586e75;
+}
+
+div#report {
+    width: 90%;
+    margin: 0 auto;
+    padding: 2em;
+    background: black;
+    color: #aaffaa;
+
+}
+
+div#main {
+    width: 90%;
+    margin: 0 auto;
+    padding: 2em;
+    background-color: #fff9f9;
+}
+
+section.scenario {
+    margin: 1em 0em;
+    padding-left: 1em;
+    border: 2px solid green;
+
+    > header {
+        margin: 1em 0em;
+
+        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;
+            a { color: #268bd2; }
+        }
+    }
+
+    > ul.tags {
+        font-size: 12px;
+
+        li {
+            color: #839496;
+            display: inline;
+        }
+    }
+
+    &.passed {
+        border-color: green;
+
+        > header .scenario_name {
+            color: #859900;
+            &:before { content: "\2713\20"; }
+        }
+    }
+
+    &.failed {
+        border-color: #dc322f;
+
+        > header .scenario_name {
+            color: #dc322f;
+            &:before { content: "\2717\20"; }
+        }
+    }
+
+    &.pending {
+        border-color: #b58900;
+
+        > header .scenario_name {
+            color: #b58900;
+            &: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;
+
+            > span {
+                padding: 0.5em;
+                background-color: #eeffee;
+                border: 1px solid #00aa00;
+                color: #00aa00;
+
+                @include step_span;
+            }
+
+            div.args {
+                font-size: 11px;
+            }
+
+            &.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; }
+            }
+
+            &.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; }
+            }
+        }
+
+        table.step_outline {
+            margin-top: 2em;
+
+            tr:nth-child(odd) { 
+                background-color: #ddddcc;
+            }
+
+            tr:nth-child(even) {
+                background-color: #ccccdd;
+            }
+
+            td {
+                border: 2px solid black;
+                padding: 0.3em 1em;
+            }
+        }
+
+        pre.multiline {
+            margin-top: 2em;
+            font-size: 13px;
+            color: #586e75;
+        }
+
+        div.step_exception {
+            margin: 1em 0em 1em 0em;
+            padding: 1em 0em 1em 1em;
+            border: 1px solid #999999;
+            background-color: #eee8d5;
+            color: #586e75;
+
+            > pre {
+                margin-left: 1em;
+            }
+        }
+
+        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; }
+            }
+        }
+
+    }
+}
+
+section.exception {
+    margin: 1em 0em;
+    border: 2px solid #268bd2;
+    padding: 2em;
+
+    dt {
+        line-height: 2em;
+        font-size: 15px;
+    }
+
+    dd {
+        line-height: 2em;
+        font-size: 14px;
+    }
+}