cucumber 0.1.6 → 0.1.7

data/History.txt

@@ -1,3 +1,56 @@
+== 0.1.7
+
+This release fixes a few bugs and adds some new features. The most notable features are:
+
+=== Calling steps from steps
+
+Step definitions are a little bit closer to having regular method semantics.
+You define them, but now you can also call them from other steps. Here is an
+example:
+
+  Given /I am logged in as an (.*) named (.*)$/ do |role, name|
+    Given "I am registered as #{role}, #{name}, secret"
+    When "I log in with #{name}, secret"
+  end
+  
+  Given /I am registered as (.*), (.*), (.*)/ do |role, name, password|
+    # (Code removed for brevity)
+  end
+
+  When /I log in with (.*), (.*)/ do |name, password|
+    # (Code removed for brevity)
+  end
+
+This means that steps can be reused in other steps. The GivenScenario feature achieves a similar
+effect (on the scenario level), but this feature is something we're not very happy with, mostly
+because it's not parameterisable. Calling steps from steps is.
+
+GivenScenario will still be working several releases, but the plan is to remove it completely in 
+the 0.3.0 release.
+
+=== Seeing where a step is defined
+
+Prior to this release it could be hard to find out where the ruby step definition matching
+a plain text step is defined. Not anymore! Cucumber will now output this:
+
+  Scenario: Regular numbers
+    Given I have entered 3 into the calculator   # features/steps/calculator_steps.rb:12
+    And I have entered 2 into the calculator     # features/steps/calculator_steps.rb:12
+    When I press divide                          # features/steps/calculator_steps.rb:16
+    Then the result should be 1.5 on the screen  # features/steps/calculator_steps.rb:20
+    And the result class should be Float         # features/steps/calculator_steps.rb:24
+
+=== Bugfixes
+* Fixed a bug in the command line args being lost when using --profile (#27, Joseph Wilk)
+* Fixed a bug in Webrat selects (Tim Glen)
+* Fixed parsing of DOS line endings (#2, #28, Aslak Hellesøy)
+
+=== New features
+* Steps can be called from other steps (#3, Bryan Helmkamp, Aslak Hellesøy)
+* Added But keyword to all languages (#21, Aslak Hellesøy)
+* Added --no-source option to display step definition location next to step text (#26, Joseph Wilk, Aslak Hellesøy)
+* Added more Webrat steps (#25, Tim Glen)
+
 == 0.1.6
 
 First gem release!

data/Manifest.txt

@@ -31,6 +31,8 @@ examples/danish_calculator/Rakefile
 examples/danish_calculator/features/steps/kalkulator_steps.rb
 examples/danish_calculator/features/summering.feature
 examples/danish_calculator/lib/kalkulator.rb
+examples/dos_line_endings/Rakefile
+examples/dos_line_endings/features/dos_line_endings.feature
 examples/estonian_calculator/Rakefile
 examples/estonian_calculator/features/kalkulaator_steps.rb
 examples/estonian_calculator/features/liitmine.feature
@@ -140,6 +142,7 @@ spec/cucumber/formatters/progress_formatter_spec.rb
 spec/cucumber/sell_cucumbers.feature
 spec/cucumber/step_mother_spec.rb
 spec/cucumber/tree/scenario_spec.rb
+spec/cucumber/tree/step_spec.rb
 spec/cucumber/treetop_parser/empty_feature.feature
 spec/cucumber/treetop_parser/empty_scenario.feature
 spec/cucumber/treetop_parser/feature_parser_spec.rb
@@ -147,6 +150,7 @@ spec/cucumber/treetop_parser/fit_scenario.feature
 spec/cucumber/treetop_parser/given_scenario.feature
 spec/cucumber/treetop_parser/multiple_tables.feature
 spec/cucumber/treetop_parser/spaces.feature
+spec/cucumber/treetop_parser/test_dos.feature
 spec/cucumber/treetop_parser/with_comments.feature
 spec/spec.opts
 spec/spec_helper.rb

data/Rakefile

@@ -1,3 +1,4 @@
+ENV['NODOT'] = 'true' # We don't want class diagrams in RDoc
 require 'config/requirements'
 require 'config/hoe' # setup Hoe + all gem configuration
 

data/examples/calculator/cucumber.yml

@@ -1 +1 @@
-default: --format progress features
+default: --format pretty features

data/examples/dos_line_endings/Rakefile

@@ -0,0 +1,6 @@
+$:.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new do |t|
+  t.cucumber_opts = "--format pretty"
+end

data/examples/dos_line_endings/features/dos_line_endings.feature

@@ -0,0 +1,9 @@
+Feature: DOS line endings
+  In order to have less bug reports
+  As a windows developer
+  I want to write features with DOS line endigs
+
+  Scenario: Just lots of DOS
+    Given I am on DOS
+    And Any version of Windows is really just DOS
+    Then Windows still sucks

data/examples/tickets/features/steps/tickets_steps.rb

@@ -2,4 +2,16 @@ require 'spec'
 
 Given "be_empty" do
   [1,2].should_not be_empty
-end
+end
+
+Given "nested step is called" do
+  Given "nested step"
+end
+
+Given "nested step" do
+  @magic = 'mushroom'
+end
+
+Then "nested step should be executed" do
+  @magic.should == 'mushroom'
+end

data/examples/tickets/features/tickets.feature

@@ -4,4 +4,8 @@ Feature: Cucumber
   I don't want no stinkin bugs
 
   Scenario: RSpec be_*
-    Given be_empty
+    Given be_empty
+    
+  Scenario: Call step from step
+    Given nested step is called
+    Then nested step should be executed

data/gem_tasks/treetop.rake

@@ -9,12 +9,22 @@ class FeatureCompiler
 
     langs.each do |lang, words|
       grammar_file = File.dirname(__FILE__) + "/../lib/cucumber/treetop_parser/feature_#{lang}.treetop"
+      ruby_file    = File.dirname(__FILE__) + "/../lib/cucumber/treetop_parser/feature_#{lang}.rb"
       grammar = template.result(binding)
       File.open(grammar_file, "wb") do |io|
         io.write(grammar)
       end
       sh "#{tt} #{grammar_file}"
       FileUtils.rm(grammar_file)
+      
+      # Change code so it isn't part of RDoc
+      lines = IO.read(ruby_file).split("\n")
+      lines.each do |line|
+        if line =~ /\s*(def|class|module)/
+          line << " #:nodoc:"
+        end
+      end
+      File.open(ruby_file, 'wb'){|io| io.write(lines.join("\n"))}
     end
   end
 end

data/generators/cucumber/templates/common_webrat.rb

@@ -14,7 +14,7 @@ When /^I fill in "(.*)" with "(.*)"$/ do |field, value|
 end
 
 When /^I select "(.*)" from "(.*)"$/ do |field, value|
-  selects(field, :with => value) 
+  selects(value, :from => field) 
 end
 
 When /^I check "(.*)"$/ do |field|

data/lib/cucumber.rb

@@ -13,6 +13,8 @@ require 'cucumber/treetop_parser/feature_parser'
 require 'cucumber/cli'
 
 module Cucumber
+  LANGUAGE_FILE = File.expand_path(File.dirname(__FILE__) + '/cucumber/languages.yml')
+
   class << self
     attr_reader :language
     
@@ -26,7 +28,7 @@ module Cucumber
     
     def config
       require 'yaml'
-      @config ||= YAML.load_file(File.dirname(__FILE__) + '/cucumber/languages.yml')
+      @config ||= YAML.load_file(LANGUAGE_FILE)
     end
   end  
 end

data/lib/cucumber/cli.rb

@@ -4,11 +4,11 @@ require 'cucumber'
 module Cucumber
   class CLI
     class << self
-      attr_writer :step_mother, :features
+      attr_writer :step_mother, :executor, :features
     
       def execute
         @execute_called = true
-        parse(ARGV).execute!(@step_mother, @features)
+        parse(ARGV).execute!(@step_mother, @executor, @features)
       end
       
       def execute_called?
@@ -33,7 +33,7 @@ module Cucumber
       return parse_args_from_profile('default') if args.empty?
       args.extend(OptionParser::Arguable)
 
-      @options = { :require => nil, :lang => 'en', :format => 'pretty', :dry_run => false }
+      @options ||= { :require => nil, :lang => 'en', :format => 'pretty', :dry_run => false, :source => true }
       args.options do |opts|
         opts.banner = "Usage: cucumber [options] FILES|DIRS"
         opts.on("-r LIBRARY|DIR", "--require LIBRARY|DIR", "Require files before executing the features.",
@@ -46,7 +46,8 @@ module Cucumber
           @options[:line] = v
         end
         opts.on("-a LANG", "--language LANG", "Specify language for features (Default: #{@options[:lang]})",
-          "Available languages: #{Cucumber.languages.join(", ")}") do |v|
+          "Available languages: #{Cucumber.languages.join(", ")}",
+          "Look at #{Cucumber::LANGUAGE_FILE} for keywords") do |v|
           @options[:lang] = v
         end
         opts.on("-f FORMAT", "--format FORMAT", "How to format features (Default: #{@options[:format]})",
@@ -64,6 +65,9 @@ module Cucumber
         opts.on("-d", "--dry-run", "Invokes formatters without executing the steps.") do
           @options[:dry_run] = true
         end
+        opts.on("-n", "--no-source", "Don't show the file and line of the step definition with the steps.") do
+          @options[:source] = false
+        end
         opts.on_tail("--version", "Show version") do
           puts VERSION::STRING
           exit
@@ -86,14 +90,14 @@ module Cucumber
       parse_options!(args_from_yml.split(' '))
     end
     
-    def execute!(step_mother, features)
+    def execute!(step_mother, executor, features)
       Cucumber.load_language(@options[:lang])
-      $executor = Executor.new(formatter(step_mother), step_mother)
+      executor.formatter = formatter(step_mother)
       require_files
       load_plain_text_features(features)
-      $executor.line = @options[:line].to_i if @options[:line]
-      $executor.visit_features(features)
-      exit 1 if $executor.failed
+      executor.line = @options[:line].to_i if @options[:line]
+      executor.visit_features(features)
+      exit 1 if executor.failed
     end
     
   private
@@ -141,7 +145,7 @@ module Cucumber
     def formatter(step_mother)
       case @options[:format]
       when 'pretty'
-        Formatters::PrettyFormatter.new(STDOUT)
+        Formatters::PrettyFormatter.new(STDOUT, step_mother, @options)
       when 'progress'
         Formatters::ProgressFormatter.new(STDOUT)
       when 'html'
@@ -154,10 +158,7 @@ end
 
 extend Cucumber::StepMethods
 Cucumber::CLI.step_mother = step_mother
+Cucumber::CLI.executor = executor
 
-extend(Cucumber::Tree)
+extend Cucumber::Tree
 Cucumber::CLI.features = features
-
-at_exit do
-  Cucumber::CLI.execute unless Cucumber::CLI.execute_called?
-end

data/lib/cucumber/core_ext/proc.rb

@@ -23,10 +23,19 @@ module Cucumber
         arity == -1 ? 0 : arity
       end
 
-      def backtrace_line
-        to_s.match(/[\d\w]+@(.*)>/)[1] + ":in `#{name}'"
+      def to_backtrace_line
+        "#{file}:in `#{name}'"
       end
       
+      def to_comment_line
+        "# #{file}"
+      end
+      
+      def file
+        file = to_s.match(/[\d\w]+@(.*)>/)[1]
+        file =~ /^\.\/(.*)/ ? $1 : file
+      end
+
       def meth
         @meth ||= "__cucumber_#{object_id}"
       end

data/lib/cucumber/executor.rb

@@ -3,17 +3,15 @@ require 'cucumber/core_ext/proc'
 module Cucumber
   class Executor
     attr_reader :failed
+    attr_accessor :formatter
     
     def line=(line)
       @line = line
     end
 
-    def initialize(formatter, step_mother)
-      @formatter = formatter
+    def initialize(step_mother)
       @world_proc = lambda do 
-        world = Object.new
-        world.extend(Spec::Matchers) if defined?(Spec::Matchers)
-        world
+        Object.new
       end
       @before_scenario_procs = []
       @after_scenario_procs = []
@@ -42,9 +40,9 @@ module Cucumber
 
     def visit_features(features)
       raise "Line number can only be specified when there is 1 feature. There were #{features.length}." if @line && features.length != 1
-      @formatter.visit_features(features) if @formatter.respond_to?(:visit_features)
+      formatter.visit_features(features) if formatter.respond_to?(:visit_features)
       features.accept(self)
-      @formatter.dump
+      formatter.dump
     end
 
     def visit_feature(feature)
@@ -52,7 +50,7 @@ module Cucumber
     end
 
     def visit_header(header)
-      @formatter.header_executing(header) if @formatter.respond_to?(:header_executing)
+      formatter.header_executing(header) if formatter.respond_to?(:header_executing)
     end
 
     def visit_row_scenario(scenario)
@@ -67,12 +65,16 @@ module Cucumber
       if @line.nil? || scenario.at_line?(@line)
         @error = nil
         @pending = nil
+
         @world = @world_proc.call
-        @formatter.scenario_executing(scenario) if @formatter.respond_to?(:scenario_executing)
+        @world.extend(Spec::Matchers) if defined?(Spec::Matchers)
+        define_step_call_methods(@world)
+
+        formatter.scenario_executing(scenario) if formatter.respond_to?(:scenario_executing)
         @before_scenario_procs.each{|p| p.call_in(@world, *[])}
         scenario.accept(self)
         @after_scenario_procs.each{|p| p.call_in(@world, *[])}
-        @formatter.scenario_executed(scenario) if @formatter.respond_to?(:scenario_executed)
+        formatter.scenario_executed(scenario) if formatter.respond_to?(:scenario_executed)
       end
     end
 
@@ -90,31 +92,46 @@ module Cucumber
           regexp, args, proc = step.regexp_args_proc(@step_mother)
           step.execute_in(@world, regexp, args, proc)
           @after_step_procs.each{|p| p.call_in(@world, *[])}
-          @formatter.step_passed(step, regexp, args)
+          formatter.step_passed(step, regexp, args)
         rescue Pending
           record_pending_step(step, regexp, args)
         rescue => e
           @failed = true
           @error = step.error = e
-          @formatter.step_failed(step, regexp, args)
+          formatter.step_failed(step, regexp, args)
         end
       else
         begin
           regexp, args, proc = step.regexp_args_proc(@step_mother)
           step.execute_in(@world, regexp, args, proc)
-          @formatter.step_skipped(step, regexp, args)
+          formatter.step_skipped(step, regexp, args)
         rescue Pending
           record_pending_step(step, regexp, args)
         rescue Exception
-          @formatter.step_skipped(step, regexp, args)
+          formatter.step_skipped(step, regexp, args)
         end
       end
     end
     
     def record_pending_step(step, regexp, args)
       @pending = true
-      @formatter.step_pending(step, regexp, args)
+      formatter.step_pending(step, regexp, args)
     end
 
+    def define_step_call_methods(world)
+      world.instance_variable_set('@__executor', self)
+      world.instance_eval do
+        class << self
+          def run_step(name)
+            _, args, proc = @__executor.instance_variable_get(:@step_mother).regexp_args_proc(name)
+            proc.call_in(self, *args)
+          end
+
+          %w{given when then and but}.each do |keyword|
+            alias_method Cucumber.language[keyword], :run_step
+          end
+        end
+      end
+    end
   end
 end

data/lib/cucumber/formatters/ansicolor.rb

@@ -1,11 +1,22 @@
+gem 'term-ansicolor'
+# Hack to work around Win32/Console, which bundles a licence-violating, outdated
+# copy of term/ansicolor that doesn't implement Term::ANSIColor#coloring=. 
+# We want the official one!
+$LOAD_PATH.each{|path| $LOAD_PATH.unshift($LOAD_PATH.delete(path)) if path =~ /term-ansicolor/}
+
 require 'term/ansicolor'
+require 'rbconfig'
+
+win = Config::CONFIG['host_os'] =~ /mswin|mingw/
+jruby = defined?(JRUBY_VERSION)
+
 begin
-  require 'Win32/Console/ANSI' if PLATFORM =~ /mswin|mingw/
+  require 'Win32/Console/ANSI' if (win && !jruby)
 rescue LoadError
   STDERR.puts "You must gem install win32console to get coloured output on this ruby platform (#{PLATFORM})"
   ::Term::ANSIColor.coloring = false
 end
-::Term::ANSIColor.coloring = false if !STDOUT.tty?
+::Term::ANSIColor.coloring = false if !STDOUT.tty? || (win && jruby)
 
 module Cucumber
   module Formatters
@@ -44,6 +55,7 @@ module Cucumber
     #   ** magenta
     #   ** cyan
     #   ** white
+    #   ** grey
     #   ** on_black
     #   ** on_red
     #   ** on_green
@@ -67,7 +79,8 @@ module Cucumber
         :failed_param  => "#{param}red",
         :skipped       => 'bold,cyan',
         :skipped_param => "#{param}cyan",
-        :pending       => 'bold,yellow' # No pending_param
+        :pending       => 'bold,yellow', # No pending_param
+        :comment       => 'grey'
       }
       if ENV['CUCUMBER_COLORS']
         ENV['CUCUMBER_COLORS'].split(':').each do |pair|
@@ -76,6 +89,15 @@ module Cucumber
         end
       end
       
+      #Not supported in Term::ANSIColor
+      def grey(m)
+        if ENV['CUCUMBER_COLORS_DISABLED'] == '1'
+          m
+        else
+          "\e[90m#{m}\e[0m" 
+        end
+      end
+      
       ALIASES.each do |m, color_string|
         colors = color_string.split(",").reverse
         define_method(m) do |*s|