cucumber_spinner 0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Henning Koch
+
+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.rdoc

@@ -0,0 +1,49 @@
+= CucumberSpinner
+
+CucumberSpinner is a formatter for Cucumber. It allows you to show the progress
+of your running features as a progress bar. Failing features are outputted at
+once, not at the end of your feature run.
+
+== Installation
+
+Install the gem with
+
+    sudo gem install cucumber_spinner
+
+To use the CucumberSpinner formatter, call cucumber with the following command
+line option:
+    
+    --formatter CucumberSpinner::ProgressBarFormatter --require cucumber_spinner
+
+You might want to use an alias, so for example put this at the end of your
+.bashrc
+    alias cuc='script/cucumber --formatter CucumberSpinner::ProgressBarFormatter --require cucumber_spinner'
+and then start your features with
+    cuc features
+
+Alternatively, you can require 'cucumber_spinner' in your cucumber environment,
+and modify your config/cucumber.yml.
+
+
+=== Caveats
+
+This has only been tested on cucumber 0.8.3 and ruby 1.8.7. Since cucumber does
+not expose every information we need (like the total number of steps) cleanly,
+this might easily break for other cucumber versions.
+
+There are currently no tests either.
+
+
+=== Credits
+
+Licensed under the MIT License.
+
+The Gem is inspired and based on nofxx's RSpecSpinner gem
+(http://github.com/nofxx/rspec_spinner), which is in turn based on the Advanced Progress Bar by Nicholas A. Evans.
+
+
+Written by Tobias Kraze
+
+{makandra.com}[http://makandra.com/]
+
+{gem-session.com}[http://gem-session.com/]

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rake'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+
+desc 'Default: Run all specs.'
+task :default => :spec
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new() do |t|
+  t.spec_opts = ['--options', "\"spec/support/spec.opts\""]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+desc 'Generate documentation for the cucumber_spinner gem.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'mail_magnet'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "cucumber_spinner"
+    gemspec.version = '0.1'
+    gemspec.summary = "Progress bar formatter for cucumber, shows failing scenarios immediately."
+    gemspec.email = "tobias.kraze@makandra.de"
+    gemspec.homepage = "http://github.com/makandra/cucumber_spinner"
+    gemspec.description = "Formatter for cucumber like the RSpecSpinner for RSpec. Shows a progress bar on the command line and prints failing scenarios immediately."
+    gemspec.authors = ["Tobias Kraze"]
+    gemspec.add_dependency('rtui', '>=0.2.2')
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1

data/cucumber_spinner.gemspec

@@ -0,0 +1,47 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{cucumber_spinner}
+  s.version = "0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tobias Kraze"]
+  s.date = %q{2010-07-28}
+  s.description = %q{Formatter for cucumber like the RSpecSpinner for RSpec. Shows a progress bar on the command line and prints failing scenarios immediately.}
+  s.email = %q{tobias.kraze@makandra.de}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "cucumber_spinner.gemspec",
+     "lib/cucumber_spinner.rb",
+     "lib/cucumber_spinner/formatted_io.rb",
+     "lib/cucumber_spinner/progress_bar_formatter.rb"
+  ]
+  s.homepage = %q{http://github.com/makandra/cucumber_spinner}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Progress bar formatter for cucumber, shows failing scenarios immediately.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rtui>, [">= 0.2.2"])
+    else
+      s.add_dependency(%q<rtui>, [">= 0.2.2"])
+    end
+  else
+    s.add_dependency(%q<rtui>, [">= 0.2.2"])
+  end
+end
+

data/lib/cucumber_spinner.rb

@@ -0,0 +1,2 @@
+require 'cucumber_spinner/formatted_io'
+require 'cucumber_spinner/progress_bar_formatter'

data/lib/cucumber_spinner/formatted_io.rb

@@ -0,0 +1,23 @@
+require 'cucumber/formatter/console'
+
+module CucumberSpinner
+
+  class FormattedIo
+    include Cucumber::Formatter::Console
+
+    attr_writer :status
+
+    def initialize(io)
+      @io = io
+    end
+
+    def print(string)
+      @io.print(format_string(string, @status))
+    end
+
+    def method_missing(method_name, *args)
+      @io.send(method_name, *args)
+    end
+  end
+
+end

data/lib/cucumber_spinner/progress_bar_formatter.rb

@@ -0,0 +1,155 @@
+require 'cucumber/formatter/io'
+require 'cucumber/formatter/pretty'
+require 'rtui'
+
+module CucumberSpinner
+
+  class ProgressBarFormatter
+    include Cucumber::Formatter::Io
+
+    attr_reader :step_mother
+
+    def initialize(step_mother, path_or_io, options)
+      @step_mother, @io, @options = step_mother, ensure_io(path_or_io, "progress"), options
+      @error_state = :passed
+      @coloured_io = FormattedIo.new(@io)
+      @coloured_io.status = @error_state
+      @pretty_printer_io = StringIO.new
+      @pretty_printer = Cucumber::Formatter::Pretty.new(step_mother, @pretty_printer_io, options)
+    end
+
+
+    def before_features(features)
+      @current = 0
+      @total = get_step_count(features)
+      @progress_bar = RTUI::Progress.new("#{@total} steps", @total, {:out => @coloured_io})
+    end
+
+    def after_step_result(keyword, step_match, multiline_arg, status, exception, source_indent, background)
+      increment
+
+      case status
+      when :pending: pending!
+      when :failed: 
+        failed!
+        print_scenario
+      when :undefined: 
+        undefined!
+        print_scenario
+      end
+    end
+
+    def after_features(features)
+      @io.puts
+      @io.puts
+      clear_pretty_output
+      @pretty_printer.after_features(features)
+      print_pretty_output
+    end
+
+    def before_feature_element(feature_element)
+      clear_pretty_output
+      @pretty_printer.before_feature_element(feature_element)
+    end
+
+    def self.delegate_to_pretty_printer(*methods)
+      methods.each do |method|
+        define_method(method) do |*args|
+          @pretty_printer.send(method, *args)
+        end
+      end
+    end
+    delegate_to_pretty_printer :before_feature, :comment_line, :after_tags, :tag_name, :feature_name, :after_feature_element, :before_background, :after_background, :background_name, :before_examples_array, :examples_name, :before_outline_table, :after_outline_table, :scenario_name, :before_step, :before_step_result, :step_name, :py_string, :exception, :before_multiline_arg, :after_multiline_arg, :before_table_row, :after_table_row, :after_table_cell, :table_cell_value
+
+
+    private
+
+    def clear_pretty_output
+      @pretty_printer_io.truncate(0)
+    end
+
+    def print_pretty_output
+      @io.print @pretty_printer_io.string
+    end
+
+    def print_scenario
+      erase_current_line
+      print_pretty_output
+      @io.puts
+    end
+
+    def erase_current_line
+      @io.print "\e[K"
+    end
+
+    def increment
+      with_color do
+        @current += 1
+        # HACK: need to make sure the progress is printed, even when the bar hasn't changed
+        @progress_bar.instance_variable_set("@previous", 0)
+        @progress_bar.instance_variable_set("@title", "#{@current}/#{@total}")
+        @progress_bar.inc
+      end
+      @io.flush
+    end
+
+    # stolen from the html formatter
+    def get_step_count(features)
+      count = 0
+      features = features.instance_variable_get("@features")
+      features.each do |feature|
+        #get background steps
+        if feature.instance_variable_get("@background")
+          background = feature.instance_variable_get("@background")
+          background.init
+          background_steps = background.instance_variable_get("@steps").instance_variable_get("@steps")
+          count += background_steps.size
+        end
+        #get scenarios
+        feature.instance_variable_get("@feature_elements").each do |scenario|
+          scenario.init
+          #get steps
+          steps = scenario.instance_variable_get("@steps").instance_variable_get("@steps")
+          count += steps.size
+
+          #get example table
+          examples = scenario.instance_variable_get("@examples_array")
+          unless examples.nil?
+            examples.each do |example|
+              example_matrix = example.instance_variable_get("@outline_table").instance_variable_get("@cell_matrix")
+              count += example_matrix.size
+            end
+          end
+
+          #get multiline step tables
+          steps.each do |step|
+            multi_arg = step.instance_variable_get("@multiline_arg")
+            next if multi_arg.nil?
+            matrix = multi_arg.instance_variable_get("@cell_matrix")
+            count += matrix.size unless matrix.nil?
+          end
+        end
+      end
+      return count
+    end
+
+    def pending!
+      @error_state = :pending if @error_state == :passed
+    end
+
+    def undefined!
+      @error_state = :undefined unless @error_state == :failed
+    end
+
+    def failed!
+      @error_state = :failed
+    end
+
+    def with_color
+      @coloured_io.status = @error_state
+      yield
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: cucumber_spinner
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Tobias Kraze
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-28 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rtui
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 2
+        - 2
+        version: 0.2.2
+  type: :runtime
+  version_requirements: *id001
+description: Formatter for cucumber like the RSpecSpinner for RSpec. Shows a progress bar on the command line and prints failing scenarios immediately.
+email: tobias.kraze@makandra.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- cucumber_spinner.gemspec
+- lib/cucumber_spinner.rb
+- lib/cucumber_spinner/formatted_io.rb
+- lib/cucumber_spinner/progress_bar_formatter.rb
+has_rdoc: true
+homepage: http://github.com/makandra/cucumber_spinner
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Progress bar formatter for cucumber, shows failing scenarios immediately.
+test_files: []
+