spinach-console-reporter 0.0.1 → 0.0.2

data/.gitignore

@@ -1,3 +1,4 @@
+.DS_Store
 *.gem
 *.rbc
 .bundle

data/README.md

@@ -1,6 +1,18 @@
-# Spinach::Console::Reporter
+# Spinach::Reporter::Console
 
-TODO: Write a gem description
+[![Gem Version](https://fury-badge.herokuapp.com/rb/spinach-console-reporter.png)](http://badge.fury.io/rb/spinach-console-reporter)
+
+This is a reporter that meant to use on Jenkins, combined with (https://github.com/dblock/jenkins-ansicolor-plugin) to bring the color output to Jenkins console.
+
+See the comparison:
+
+### Before
+
+![before](https://raw.github.com/ywen/spinach-console-reporter/master/images/before.png "Before")
+
+### After
+
+![after](https://raw.github.com/ywen/spinach-console-reporter/master/images/after.png "After")
 
 ## Installation
 
@@ -18,8 +30,9 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
-
+```bash
+$ bundle exec spinach -r console
+```
 ## Contributing
 
 1. Fork it

data/lib/spinach-console-reporter.rb

@@ -1,2 +1,2 @@
 require_relative "spinach-console-reporter/error_reporting"
-require_relative "spinach-console-reporter/out"
+require_relative "spinach-console-reporter/console"

data/lib/spinach-console-reporter/console.rb

@@ -0,0 +1,274 @@
+# encoding: utf-8
+module Spinach
+  class Reporter
+    class Console < Spinach::Reporter
+      include ErrorReporting
+
+      # The output buffers to store the reports.
+      attr_reader :out, :error
+
+      # The last scenario error
+      attr_accessor :scenario_error
+
+      # The last scenario
+      attr_accessor :scenario
+
+      # Initialitzes the runner
+      #
+      # @param [Hash] options
+      #  Sets a custom output buffer by setting options[:output]
+      #  Sets a custom error buffer by setting options[:error]
+      #
+      def initialize(*args)
+        super(*args)
+        @out = options[:output] || $stdout
+        @error = options[:error] || $stdout
+        @max_step_name_length = 0
+      end
+
+      # Prints the feature name to the standard output
+      #
+      # @param [Hash] data
+      #   The feature in a JSON Gherkin format
+      #
+      def before_feature_run(feature)
+        name = feature.name
+        out.puts %Q|\n#{magenta("Feature:")} #{magenta(name)}|
+      end
+
+      # Prints the scenario name to the standard ouput
+      #
+      # @param [Hash] data
+      #   The feature in a JSON Gherkin format
+      #
+      def before_scenario_run(scenario, step_definitions = nil)
+        @max_step_name_length = scenario.steps.map(&:name).map(&:length).max if scenario.steps.any?
+        name = scenario.name
+        out.puts "\n  #{green('Scenario:')} #{green(name)}"
+      end
+
+      # Adds an error report and re
+      #
+      # @param [Hash] data
+      #   The feature in a JSON Gherkin format
+      #
+      def after_scenario_run(scenario, step_definitions = nil)
+        if scenario_error
+          report_error(scenario_error, :full)
+          self.scenario_error = nil
+        end
+      end
+
+      # Adds a passed step to the output buffer.
+      #
+      # @param [Step] step
+      #   The step.
+      #
+      # @param [Array] step_location
+      #   The step source location
+      #
+      def on_successful_step(step, step_location, step_definitions = nil)
+        output_step('✔', step, :green, step_location)
+        self.scenario = [current_feature, current_scenario, step]
+        successful_steps << scenario
+      end
+
+      # Adds a failing step to the output buffer.
+      #
+      # @param [Hash] step
+      #   The step in a JSON Gherkin format
+      #
+      # @param [Exception] failure
+      #   The exception that caused the failure
+      #
+      def on_failed_step(step, failure, step_location, step_definitions = nil)
+        output_step('✘', step, :red, step_location)
+        self.scenario_error = [current_feature, current_scenario, step, failure]
+        failed_steps << scenario_error
+      end
+
+      # Adds a step that has raised an error to the output buffer.
+      #
+      # @param [Hash] step
+      #   The step in a JSON Gherkin format
+      #
+      # @param [Exception] failure
+      #   The exception that caused the failure
+      #
+      def on_error_step(step, failure, step_location, step_definitions = nil)
+        output_step('!', step, :red, step_location)
+        self.scenario_error = [current_feature, current_scenario, step, failure]
+        error_steps << scenario_error
+      end
+
+      # Adds an undefined step to the output buffer.
+      #
+      # @param [Hash] step
+      #   The step in a JSON Gherkin format
+      #
+      def on_undefined_step(step, failure, step_definitions = nil)
+        output_step('?', step, :yellow)
+        self.scenario_error = [current_feature, current_scenario, step, failure]
+        undefined_steps << scenario_error
+      end
+
+      # Adds an undefined step to the output buffer.
+      #
+      # @param [Hash] step
+      #   The step in a JSON Gherkin format
+      #
+      def on_pending_step(step, failure)
+        output_step('P', step, :yellow)
+        self.scenario_error = [current_feature, current_scenario, step, failure]
+        pending_steps << scenario_error
+      end
+
+      # Adds a feature not found message to the output buffer.
+      #
+      # @param [Hash] feature
+      #   the feature in a json gherkin format
+      #
+      # @param [Spinach::FeatureNotFoundException] exception
+      #   the related exception
+      #
+      def on_feature_not_found(feature)
+        generator = Generators::FeatureGenerator.new(feature)
+        lines = "Could not find steps for `#{feature.name}` feature\n\n"
+        lines << "\nPlease create the file #{generator.filename} at #{generator.path}, with:\n\n"
+
+        lines << generator.generate
+
+        lines.split("\n").each do |line|
+          out.puts "    #{line}".yellow
+        end
+        out.puts "\n\n"
+
+        undefined_features << feature
+      end
+
+      # Adds a step that has been skipped to the output buffer.
+      #
+      # @param [Hash] step
+      #   The step that Gherkin extracts
+      #
+      def on_skipped_step(step, step_definitions = nil)
+        output_step('~', step, :cyan)
+      end
+
+      # Adds to the output buffer a step result
+      #
+      # @param [String] symbol
+      #   A symbol to prepend before the step keyword (might be useful to
+      #   indicate if everything went ok or not).
+      #
+      # @param [Hash] step
+      #   The step in a JSON Gherkin format
+      #
+      # @param [Symbol] color
+      #   The color code to use with Colorize to colorize the output.
+      #
+      # @param [Array] step_location
+      #   step source location and file line
+      #
+      def output_step(symbol, step, color, step_location = nil)
+        step_location = step_location.first.gsub("#{File.expand_path('.')}/", '# ')+":#{step_location.last.to_s}" if step_location
+        max_length = @max_step_name_length + 30 # Colorize and output format correction
+
+        # REMEMBER TO CORRECT PREVIOUS MAX LENGTH IF OUTPUT FORMAT IS MODIFIED
+        buffer = []
+        buffer << indent(4)
+        # buffer << symbol.foreground(color).bright
+        buffer << indent(2)
+        buffer << send(color, step.keyword)
+        buffer << indent(1)
+        buffer << send(color, step.name)
+        joined = buffer.join.ljust(max_length)
+
+        out.puts(joined + white(step_location.to_s))
+      end
+
+      # It prints the error summary if the run has failed
+      # It always print feature success summary
+      #
+      # @param [True,False] success
+      #   whether the run has succeed or not
+      #
+      def after_run(success)
+        error_summary unless success
+        out.puts ""
+        run_summary
+      end
+
+      # Prints the feature success summary for this run.
+      #
+      def run_summary
+        successful_summary = format_summary(:green,  successful_steps, 'Successful')
+        undefined_summary  = format_summary(:yellow, undefined_steps,  'Undefined')
+        pending_summary    = format_summary(:yellow, pending_steps,    'Pending')
+        failed_summary     = format_summary(:red,    failed_steps,     'Failed')
+        error_summary      = format_summary(:red,    error_steps,      'Error')
+
+        out.puts "Steps Summary: #{successful_summary}, #{undefined_summary}, #{pending_summary}, #{failed_summary}, #{error_summary}\n\n"
+      end
+
+      # Constructs the full step definition
+      #
+      # @param [Hash] step
+      #   The step.
+      #
+      def full_step(step)
+        "#{step.keyword} #{step.name}"
+      end
+
+      private
+
+      def indent(n = 1)
+        " " * n
+      end
+
+      def format_summary(color, steps, message)
+        buffer = []
+        buffer << "(".colorize(color)
+        buffer << steps.length.to_s.colorize(:"light_#{color}")
+        buffer << ") ".colorize(color)
+        buffer << message.colorize(color)
+        buffer.join
+      end
+      def color(text, color_code)
+        "#{color_code}#{text}\e[0m"
+      end
+
+      def bold(text)
+        color(text, "\e[1m")
+      end
+
+      def red(text)
+        color(text, "\e[31m")
+      end
+
+      def green(text)
+        color(text, "\e[32m")
+      end
+
+      def yellow(text)
+        color(text, "\e[33m")
+      end
+
+      def blue(text)
+        color(text, "\e[34m")
+      end
+
+      def magenta(text)
+        color(text, "\e[35m")
+      end
+
+      def cyan(text)
+        color(text, "\e[36m")
+      end
+
+      def white(text)
+        color(text, "\e[37m")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -20,5 +20,4 @@ end
 Spork.each_run do
   load "#{File.dirname(__FILE__)}/../lib/spinach-console-reporter.rb"
   Dir["#{File.dirname(__FILE__)}/../lib/spinach-console-reporter/*.rb"].each {|f| load f}
-end
-
+end

data/spinach-console-reporter.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "spinach-console-reporter"
   gem.require_paths = ["lib"]
-  gem.version       = "0.0.1"
+  gem.version       = "0.0.2"
   gem.add_runtime_dependency(%q<spinach>)
   gem.add_development_dependency(%q<rspec>)
   gem.add_development_dependency(%q<rake>)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spinach-console-reporter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-05 00:00:00.000000000 Z
+date: 2013-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spinach
@@ -156,10 +156,12 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- images/after.png
+- images/before.png
 - lib/spinach-console-reporter.rb
+- lib/spinach-console-reporter/console.rb
 - lib/spinach-console-reporter/error_reporting.rb
 - lib/spinach-console-reporter/gem_description.rb
-- lib/spinach-console-reporter/out.rb
 - spec/spec_helper.rb
 - spinach-console-reporter.gemspec
 - tasks/ci.rake
@@ -183,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: A console reporter for spinach

data/lib/spinach-console-reporter/out.rb

@@ -1,276 +0,0 @@
-# encoding: utf-8
-module Spinach
-  module Console
-    module Reporter
-      class Out < Spinach::Reporter
-        include ErrorReporting
-
-        # The output buffers to store the reports.
-        attr_reader :out, :error
-
-        # The last scenario error
-        attr_accessor :scenario_error
-
-        # The last scenario
-        attr_accessor :scenario
-
-        # Initialitzes the runner
-        #
-        # @param [Hash] options
-        #  Sets a custom output buffer by setting options[:output]
-        #  Sets a custom error buffer by setting options[:error]
-        #
-        def initialize(*args)
-          super(*args)
-          @out = options[:output] || $stdout
-          @error = options[:error] || $stdout
-          @max_step_name_length = 0
-        end
-
-        # Prints the feature name to the standard output
-        #
-        # @param [Hash] data
-        #   The feature in a JSON Gherkin format
-        #
-        def before_feature_run(feature)
-          name = feature.name
-          out.puts %Q|\n#{magenta("Feature:")} #{magenta(name)}|
-        end
-
-        # Prints the scenario name to the standard ouput
-        #
-        # @param [Hash] data
-        #   The feature in a JSON Gherkin format
-        #
-        def before_scenario_run(scenario, step_definitions = nil)
-          @max_step_name_length = scenario.steps.map(&:name).map(&:length).max if scenario.steps.any?
-          name = scenario.name
-          out.puts "\n  #{green('Scenario:')} #{green(name)}"
-        end
-
-        # Adds an error report and re
-        #
-        # @param [Hash] data
-        #   The feature in a JSON Gherkin format
-        #
-        def after_scenario_run(scenario, step_definitions = nil)
-          if scenario_error
-            report_error(scenario_error, :full)
-            self.scenario_error = nil
-          end
-        end
-
-        # Adds a passed step to the output buffer.
-        #
-        # @param [Step] step
-        #   The step.
-        #
-        # @param [Array] step_location
-        #   The step source location
-        #
-        def on_successful_step(step, step_location, step_definitions = nil)
-          output_step('✔', step, :green, step_location)
-          self.scenario = [current_feature, current_scenario, step]
-          successful_steps << scenario
-        end
-
-        # Adds a failing step to the output buffer.
-        #
-        # @param [Hash] step
-        #   The step in a JSON Gherkin format
-        #
-        # @param [Exception] failure
-        #   The exception that caused the failure
-        #
-        def on_failed_step(step, failure, step_location, step_definitions = nil)
-          output_step('✘', step, :red, step_location)
-          self.scenario_error = [current_feature, current_scenario, step, failure]
-          failed_steps << scenario_error
-        end
-
-        # Adds a step that has raised an error to the output buffer.
-        #
-        # @param [Hash] step
-        #   The step in a JSON Gherkin format
-        #
-        # @param [Exception] failure
-        #   The exception that caused the failure
-        #
-        def on_error_step(step, failure, step_location, step_definitions = nil)
-          output_step('!', step, :red, step_location)
-          self.scenario_error = [current_feature, current_scenario, step, failure]
-          error_steps << scenario_error
-        end
-
-        # Adds an undefined step to the output buffer.
-        #
-        # @param [Hash] step
-        #   The step in a JSON Gherkin format
-        #
-        def on_undefined_step(step, failure, step_definitions = nil)
-          output_step('?', step, :yellow)
-          self.scenario_error = [current_feature, current_scenario, step, failure]
-          undefined_steps << scenario_error
-        end
-
-        # Adds an undefined step to the output buffer.
-        #
-        # @param [Hash] step
-        #   The step in a JSON Gherkin format
-        #
-        def on_pending_step(step, failure)
-          output_step('P', step, :yellow)
-          self.scenario_error = [current_feature, current_scenario, step, failure]
-          pending_steps << scenario_error
-        end
-
-        # Adds a feature not found message to the output buffer.
-        #
-        # @param [Hash] feature
-        #   the feature in a json gherkin format
-        #
-        # @param [Spinach::FeatureNotFoundException] exception
-        #   the related exception
-        #
-        def on_feature_not_found(feature)
-          generator = Generators::FeatureGenerator.new(feature)
-          lines = "Could not find steps for `#{feature.name}` feature\n\n"
-          lines << "\nPlease create the file #{generator.filename} at #{generator.path}, with:\n\n"
-
-          lines << generator.generate
-
-          lines.split("\n").each do |line|
-            out.puts "    #{line}".yellow
-          end
-          out.puts "\n\n"
-
-          undefined_features << feature
-        end
-
-        # Adds a step that has been skipped to the output buffer.
-        #
-        # @param [Hash] step
-        #   The step that Gherkin extracts
-        #
-        def on_skipped_step(step, step_definitions = nil)
-          output_step('~', step, :cyan)
-        end
-
-        # Adds to the output buffer a step result
-        #
-        # @param [String] symbol
-        #   A symbol to prepend before the step keyword (might be useful to
-        #   indicate if everything went ok or not).
-        #
-        # @param [Hash] step
-        #   The step in a JSON Gherkin format
-        #
-        # @param [Symbol] color
-        #   The color code to use with Colorize to colorize the output.
-        #
-        # @param [Array] step_location
-        #   step source location and file line
-        #
-        def output_step(symbol, step, color, step_location = nil)
-          step_location = step_location.first.gsub("#{File.expand_path('.')}/", '# ')+":#{step_location.last.to_s}" if step_location
-          max_length = @max_step_name_length + 30 # Colorize and output format correction
-
-          # REMEMBER TO CORRECT PREVIOUS MAX LENGTH IF OUTPUT FORMAT IS MODIFIED
-          buffer = []
-          buffer << indent(4)
-          # buffer << symbol.foreground(color).bright
-          buffer << indent(2)
-          buffer << send(color, step.keyword)
-          buffer << indent(1)
-          buffer << send(color, step.name)
-          joined = buffer.join.ljust(max_length)
-
-          out.puts(joined + white(step_location.to_s))
-        end
-
-        # It prints the error summary if the run has failed
-        # It always print feature success summary
-        #
-        # @param [True,False] success
-        #   whether the run has succeed or not
-        #
-        def after_run(success)
-          error_summary unless success
-          out.puts ""
-          run_summary
-        end
-
-        # Prints the feature success summary for this run.
-        #
-        def run_summary
-          successful_summary = format_summary(:green,  successful_steps, 'Successful')
-          undefined_summary  = format_summary(:yellow, undefined_steps,  'Undefined')
-          pending_summary    = format_summary(:yellow, pending_steps,    'Pending')
-          failed_summary     = format_summary(:red,    failed_steps,     'Failed')
-          error_summary      = format_summary(:red,    error_steps,      'Error')
-
-          out.puts "Steps Summary: #{successful_summary}, #{undefined_summary}, #{pending_summary}, #{failed_summary}, #{error_summary}\n\n"
-        end
-
-        # Constructs the full step definition
-        #
-        # @param [Hash] step
-        #   The step.
-        #
-        def full_step(step)
-          "#{step.keyword} #{step.name}"
-        end
-
-        private
-
-        def indent(n = 1)
-          " " * n
-        end
-
-        def format_summary(color, steps, message)
-          buffer = []
-          buffer << "(".colorize(color)
-          buffer << steps.length.to_s.colorize(:"light_#{color}")
-          buffer << ") ".colorize(color)
-          buffer << message.colorize(color)
-          buffer.join
-        end
-        def color(text, color_code)
-          "#{color_code}#{text}\e[0m"
-        end
-
-        def bold(text)
-          color(text, "\e[1m")
-        end
-
-        def red(text)
-          color(text, "\e[31m")
-        end
-
-        def green(text)
-          color(text, "\e[32m")
-        end
-
-        def yellow(text)
-          color(text, "\e[33m")
-        end
-
-        def blue(text)
-          color(text, "\e[34m")
-        end
-
-        def magenta(text)
-          color(text, "\e[35m")
-        end
-
-        def cyan(text)
-          color(text, "\e[36m")
-        end
-
-        def white(text)
-          color(text, "\e[37m")
-        end
-      end
-    end
-  end
-end