kosmas58-cucumber 0.3.96 → 0.3.97

data/lib/cucumber/rake/task.rb

@@ -8,7 +8,7 @@ module Cucumber
     #
     #   Cucumber::Rake::Task.new
     #
-    # This will create a task named 'cucumber' described as 'Run Cucumber features'. 
+    # This will define a task named <tt>cucumber</tt> described as 'Run Cucumber features'. 
     # It will use steps from 'features/**/*.rb' and features in 'features/**/*.feature'.
     #
     # To further configure the task, you can pass a block:
@@ -82,10 +82,10 @@ module Cucumber
         end
       end
 
-      LIB = File.expand_path(File.dirname(__FILE__) + '/../..') # :nodoc:
+      LIB = File.expand_path(File.dirname(__FILE__) + '/../..') #:nodoc:
 
       # TODO: remove depreated accessors for 0.4.0
-      def self.deprecate_accessor(attribute) # :nodoc:
+      def self.deprecate_accessor(attribute) #:nodoc:
         attr_reader attribute
         class_eval <<-EOF, __FILE__, __LINE__ + 1
           def #{attribute}=(value)
@@ -133,7 +133,9 @@ module Cucumber
         @rcov_opts = String === opts ? opts.split(' ') : opts
       end
 
-      # Whether or not to fork a new ruby interpreter. Defaults to true.
+      # Whether or not to fork a new ruby interpreter. Defaults to true. You may gain
+      # some startup speed if you set it to false, but this may also cause issues with
+      # your load path and gems.
       attr_accessor :fork
 
       # Define what profile to be used.  When used with cucumber_opts it is simply appended to it. Will be ignored when CUCUMBER_OPTS is used.
@@ -165,14 +167,14 @@ module Cucumber
         define_task
       end
 
-      def define_task # :nodoc:
+      def define_task #:nodoc:
         desc @desc
         task @task_name do
           runner.run
         end
       end
 
-      def runner(task_args = nil) # :nodoc:
+      def runner(task_args = nil) #:nodoc:
         cucumber_opts = [(ENV['CUCUMBER_OPTS'] ? ENV['CUCUMBER_OPTS'].split(/\s+/) : nil) || cucumber_opts_with_profile]
         if(@rcov)
           RCovCucumberRunner.new(libs, binary, cucumber_opts, feature_files(task_args), rcov_opts)
@@ -183,11 +185,11 @@ module Cucumber
         end
       end
 
-      def cucumber_opts_with_profile # :nodoc:
+      def cucumber_opts_with_profile #:nodoc:
         @profile ? [cucumber_opts, '--profile', @profile] : cucumber_opts
       end
 
-      def feature_files(task_args = nil) # :nodoc:
+      def feature_files(task_args = nil) #:nodoc:
         if ENV['FEATURE']
           FileList[ ENV['FEATURE'] ]
         else
@@ -199,7 +201,7 @@ module Cucumber
         end
       end
 
-      def step_files(task_args = nil) # :nodoc:
+      def step_files(task_args = nil) #:nodoc:
         if ENV['STEPS']
           FileList[ ENV['STEPS'] ]
         else
@@ -222,14 +224,14 @@ module Cucumber
         super(task_name, desc)
       end
 
-      def define_task # :nodoc:
+      def define_task #:nodoc:
         desc @desc
         task @task_name, :feature_name do |t, args|
           runner(args).run
         end
       end
 
-      def feature_files(task_arguments) # :nodoc:
+      def feature_files(task_arguments) #:nodoc:
         FileList[File.join("features", "**", "#{task_arguments[:feature_name]}.feature")]
       end
 

data/lib/cucumber/rb_support/rb_dsl.rb

@@ -7,11 +7,23 @@ module Cucumber
     # object.
     module RbDsl
       class << self
-        attr_accessor :step_mother, :rb_language
+        attr_writer :rb_language
         
         def alias_adverb(adverb)
           alias_method adverb, :register_rb_step_definition
         end
+
+        def build_rb_world_factory(world_modules, proc)
+          @rb_language.build_rb_world_factory(world_modules, proc)
+        end
+
+        def register_rb_hook(phase, tag_names, proc)
+          @rb_language.register_rb_hook(phase, tag_names, proc)
+        end
+
+        def register_rb_step_definition(regexp, proc)
+          @rb_language.register_rb_step_definition(regexp, proc)
+        end
       end
 
       # Registers any number of +world_modules+ (Ruby Modules) and/or a Proc.
@@ -33,38 +45,38 @@ module Cucumber
       #    World(MyModule)
       #
       def World(*world_modules, &proc)
-        RbDsl.rb_language.build_world_factory(*world_modules, &proc)
+        RbDsl.build_rb_world_factory(world_modules, proc)
       end
 
-      # Registers a Before proc. You can call this method as many times as you
-      # want (typically from ruby scripts under <tt>support</tt>).
+      # Registers a proc that will run before each Scenario. You can register as 
+      # as you want (typically from ruby scripts under <tt>support/hooks.rb</tt>).
       def Before(*tag_names, &proc)
-        RbDsl.step_mother.register_hook(:before, RbHook.new(RbDsl.rb_language, tag_names, proc))
+        RbDsl.register_rb_hook('before', tag_names, proc)
       end
 
+      # Registers a proc that will run after each Scenario. You can register as 
+      # as you want (typically from ruby scripts under <tt>support/hooks.rb</tt>).
       def After(*tag_names, &proc)
-        RbDsl.step_mother.register_hook(:after, RbHook.new(RbDsl.rb_language, tag_names, proc))
+        RbDsl.register_rb_hook('after', tag_names, proc)
       end
 
+      # Registers a proc that will run after each Step. You can register as 
+      # as you want (typically from ruby scripts under <tt>support/hooks.rb</tt>).
       def AfterStep(*tag_names, &proc)
-        RbDsl.step_mother.register_hook(:after_step, RbHook.new(RbDsl.rb_language, tag_names, proc))
+        RbDsl.register_rb_hook('after_step', tag_names, proc)
       end
 
-      # Registers a new Ruby StepDefinition.
-      # This method is aliased
+      # Registers a new Ruby StepDefinition. This method is aliased
       # to <tt>Given</tt>, <tt>When</tt> and <tt>Then</tt>, and
       # also to the i18n translations whenever a feature of a
       # new language is loaded.
       #
-      # See Cucumber#alias_steps for details on how to
-      # create your own aliases.
-      #
-      # The +&proc+ gets executed in the context of a <tt>world</tt>
-      # object, which is defined by #World. A new <tt>world</tt>
+      # The +&proc+ gets executed in the context of a <tt>World</tt>
+      # object, which is defined by #World. A new <tt>World</tt>
       # object is created for each scenario and is shared across
       # step definitions within that scenario.
       def register_rb_step_definition(regexp, &proc)
-        RbDsl.step_mother.register_step_definition(RbStepDefinition.new(RbDsl.rb_language, regexp, &proc))
+        RbDsl.register_rb_step_definition(regexp, proc)
       end
     end
   end

data/lib/cucumber/rb_support/rb_hook.rb

@@ -1,8 +1,7 @@
 module Cucumber
   module RbSupport
+    # Wrapper for Before, After and AfterStep hooks
     class RbHook
-      include LanguageSupport::HookMethods
-
       attr_reader :tag_names
       
       def initialize(rb_language, tag_names, proc)

data/lib/cucumber/rb_support/rb_language.rb

@@ -1,63 +1,57 @@
 require 'cucumber/rb_support/rb_dsl'
+require 'cucumber/rb_support/rb_world'
 require 'cucumber/rb_support/rb_step_definition'
 
 module Cucumber
   module RbSupport
+    # Raised if a World block returns Nil.
     class NilWorld < StandardError
       def initialize
         super("World procs should never return nil")
       end
     end
 
+    # Raised if there are 2 or more World blocks.
     class MultipleWorld < StandardError
       def initialize(first_proc, second_proc)
         message = "You can only pass a proc to #World once, but it's happening\n"
         message << "in 2 places:\n\n"
         message << first_proc.backtrace_line('World') << "\n"
         message << second_proc.backtrace_line('World') << "\n\n"
-        message << "Use Ruby modules instead to extend your worlds. See the Cucumber::StepMother#World RDoc\n"
+        message << "Use Ruby modules instead to extend your worlds. See the Cucumber::RbSupport::RbDsl#World RDoc\n"
         message << "or http://wiki.github.com/aslakhellesoy/cucumber/a-whole-new-world.\n\n"
         super(message)
       end
     end
 
+    # The Ruby implementation of the programming language API.
     class RbLanguage
       include LanguageSupport::LanguageMethods
-      attr_reader :current_world, :step_mother
+      attr_reader :current_world
       
       def initialize(step_mother)
         @step_mother = step_mother
-        RbDsl.step_mother = step_mother
         RbDsl.rb_language = self
       end
-      
-      def load_step_def_file(step_def_file)
+
+      def alias_adverbs(adverbs)
+        adverbs.each do |adverb|
+          RbDsl.alias_adverb(adverb)
+          RbWorld.alias_adverb(adverb)
+        end
+      end
+
+      def step_definitions_for(code_file)
         begin
-          require step_def_file
+          load_code_file(code_file)
+          step_definitions
         rescue LoadError => e
-          e.message << "\nFailed to load #{step_def_file}"
+          e.message << "\nFailed to load #{code_filr}"
           raise e
+        ensure
+          @step_definitions = nil
         end
       end
-      
-      def build_world_factory(*world_modules, &proc)
-        if(proc)
-          raise MultipleWorld.new(@world_proc, proc) if @world_proc
-          @world_proc = proc
-        end
-        @world_modules ||= []
-        @world_modules += world_modules
-      end
-
-      def begin_scenario
-        create_world
-        extend_world
-        connect_world(@step_mother)
-      end
-
-      def end_scenario
-        @current_world = nil
-      end
 
       def snippet_text(step_keyword, step_name, multiline_arg_class = nil)
         escaped = Regexp.escape(step_name).gsub('\ ', ' ').gsub('/', '\/')
@@ -78,11 +72,41 @@ module Cucumber
         "#{step_keyword} /^#{escaped}$/ do#{block_arg_string}\n  #{multiline_class_comment}pending\nend"
       end
 
-      def alias_adverbs(adverbs)
-        adverbs.each do |adverb|
-          RbDsl.alias_adverb(adverb)
-          World.alias_adverb(adverb)
+      def begin_rb_scenario
+        create_world
+        extend_world
+        connect_world
+      end
+
+      def register_rb_hook(phase, tag_names, proc)
+        add_hook(phase, RbHook.new(self, tag_names, proc))
+      end
+
+      def register_rb_step_definition(regexp, proc)
+        add_step_definition(RbStepDefinition.new(self, regexp, proc))
+      end
+
+      def build_rb_world_factory(world_modules, proc)
+        if(proc)
+          raise MultipleWorld.new(@world_proc, proc) if @world_proc
+          @world_proc = proc
         end
+        @world_modules ||= []
+        @world_modules += world_modules
+      end
+
+      protected
+
+      def load_code_file(code_file)
+        require code_file # This will cause self.add_step_definition and self.add_hook to be called from RbDsl
+      end
+
+      def begin_scenario
+        begin_rb_scenario
+      end
+      
+      def end_scenario
+        @current_world = nil
       end
 
       private
@@ -100,15 +124,15 @@ module Cucumber
       end
 
       def extend_world
-        @current_world.extend(World)
+        @current_world.extend(RbWorld)
         @current_world.extend(::Spec::Matchers) if defined?(::Spec::Matchers)
         (@world_modules || []).each do |mod|
           @current_world.extend(mod)
         end
       end
 
-      def connect_world(step_mother)
-        @current_world.__cucumber_step_mother = step_mother
+      def connect_world
+        @current_world.__cucumber_step_mother = @step_mother
       end
 
       def check_nil(o, proc)

data/lib/cucumber/rb_support/rb_step_definition.rb

@@ -3,54 +3,58 @@ require 'cucumber/core_ext/string'
 require 'cucumber/core_ext/proc'
 
 module Cucumber
-  # A Step Definition holds a Regexp and a Proc, and is created
-  # by calling <tt>Given</tt>, <tt>When</tt> or <tt>Then</tt>
-  # in the <tt>step_definitions</tt> ruby files - for example:
-  #
-  #   Given /I have (\d+) cucumbers in my belly/ do
-  #     # some code here
-  #   end
-  #
-  class RbStepDefinition
-    include LanguageSupport::StepDefinitionMethods
+  module RbSupport
+    # A Ruby Step Definition holds a Regexp and a Proc, and is created
+    # by calling <tt>Given</tt>, <tt>When</tt> or <tt>Then</tt>
+    # in the <tt>step_definitions</tt> ruby files. See also RbDsl.
+    #
+    # Example:
+    #
+    #   Given /I have (\d+) cucumbers in my belly/ do
+    #     # some code here
+    #   end
+    #
+    class RbStepDefinition
+      include LanguageSupport::StepDefinitionMethods
 
-    class MissingProc < StandardError
-      def message
-        "Step definitions must always have a proc"
+      class MissingProc < StandardError
+        def message
+          "Step definitions must always have a proc"
+        end
       end
-    end
 
-    attr_reader :proc
+      attr_reader :proc
 
-    def initialize(rb_language, pattern, &proc)
-      raise MissingProc if proc.nil?
-      if String === pattern
-        p = pattern.gsub(/\$\w+/, '(.*)') # Replace $var with (.*)
-        pattern = Regexp.new("^#{p}$") 
+      def initialize(rb_language, pattern, proc)
+        raise MissingProc if proc.nil?
+        if String === pattern
+          p = pattern.gsub(/\$\w+/, '(.*)') # Replace $var with (.*)
+          pattern = Regexp.new("^#{p}$") 
+        end
+        @rb_language, @regexp, @proc = rb_language, pattern, proc
       end
-      @rb_language, @regexp, @proc = rb_language, pattern, proc
-    end
 
-    def regexp
-      @regexp
-    end
+      def regexp
+        @regexp
+      end
 
-    def invoke(args)
-      args = args.map{|arg| Ast::PyString === arg ? arg.to_s : arg}
-      begin
-        @rb_language.current_world.cucumber_instance_exec(true, regexp.inspect, *args, &@proc)
-      rescue Cucumber::ArityMismatchError => e
-        e.backtrace.unshift(self.backtrace_line)
-        raise e
+      def invoke(args)
+        args = args.map{|arg| Ast::PyString === arg ? arg.to_s : arg}
+        begin
+          @rb_language.current_world.cucumber_instance_exec(true, regexp.inspect, *args, &@proc)
+        rescue Cucumber::ArityMismatchError => e
+          e.backtrace.unshift(self.backtrace_line)
+          raise e
+        end
       end
-    end
 
-    def file_colon_line
-      @proc.file_colon_line
-    end
+      def file_colon_line
+        @proc.file_colon_line
+      end
     
-    def file
-      @file ||= file_colon_line.split(':')[0]
+      def file
+        @file ||= file_colon_line.split(':')[0]
+      end
     end
   end
 end

data/lib/cucumber/rb_support/rb_world.rb

@@ -0,0 +1,93 @@
+module Cucumber
+  module RbSupport
+    # All steps are run in the context of an object that extends this module.
+    module RbWorld
+      class << self
+        def alias_adverb(adverb)
+          alias_method adverb, :__cucumber_invoke
+        end
+      end
+    
+      attr_writer :__cucumber_step_mother
+
+      # Call a step from within a step definition. This method is aliased to
+      # the same i18n as RbDsl.
+      def __cucumber_invoke(name, multiline_argument=nil) #:nodoc:
+        begin
+          step_match = @__cucumber_step_mother.step_match(name)
+          step_match.invoke(multiline_argument)
+        rescue Exception => e
+          e.nested! if Undefined === e
+          raise e
+        end
+      end
+
+      # Returns a Cucumber::Ast::Table for +text_or_table+, which can either
+      # be a String:
+      #
+      #   table(%{
+      #     | account | description | amount |
+      #     | INT-100 | Taxi        | 114    |
+      #     | CUC-101 | Peeler      | 22     |
+      #   })
+      #
+      # or a 2D Array:
+      #
+      #   table([
+      #     %w{ account description amount },
+      #     %w{ INT-100 Taxi        114    },
+      #     %w{ CUC-101 Peeler      22     }
+      #   ])
+      #
+      def table(text_or_table, file=nil, line_offset=0)
+        if Array === text_or_table
+          Ast::Table.new(text_or_table)
+        else
+          @table_parser ||= Parser::TableParser.new
+          @table_parser.parse_or_fail(text_or_table.strip, file, line_offset)
+        end
+      end
+
+      # Output +announcement+ alongside the formatted output.
+      # This is an alternative to using Kernel#puts - it will display
+      # nicer, and in all outputs (in case you use several formatters)
+      #
+      # Beware that the output will be printed *before* the corresponding
+      # step. This is because the step itself will not be printed until
+      # after it has run, so it can be coloured according to its status.
+      def announce(announcement)
+        @__cucumber_step_mother.announce(announcement)
+      end
+
+      # Mark the matched step as pending.
+      def pending(message = "TODO")
+        if block_given?
+          begin
+            yield
+          rescue Exception => e
+            raise Pending.new(message)
+          end
+          raise Pending.new("Expected pending '#{message}' to fail. No Error was raised. No longer pending?")
+        else
+          raise Pending.new(message)
+        end
+      end
+
+      # The default implementation of Object#inspect recursively
+      # traverses all instance variables and invokes inspect. 
+      # This can be time consuming if the object graph is large.
+      #
+      # This can cause unnecessary delays when certain exceptions 
+      # occur. For example, MRI internally invokes #inspect on an 
+      # object that raises a NoMethodError. (JRuby does not do this).
+      #
+      # A World object can have many references created by the user
+      # or frameworks (Rails), so to avoid long waiting times on
+      # such errors in World we define it to just return a simple String.
+      #
+      def inspect #:nodoc:
+        sprintf("#<%s:0x%x>", self.class, self.object_id)
+      end
+    end
+  end
+end

data/lib/cucumber/rspec_neuter.rb

@@ -1,11 +1,11 @@
 require 'optparse'
 
-module Spec
-  module Runner
+module Spec #:nodoc:
+  module Runner #:nodoc:
     # Neuters RSpec's option parser.
     # (RSpec's option parser tries to parse ARGV, which
     # will fail when running cucumber)
-    class OptionParser < ::OptionParser
+    class OptionParser < ::OptionParser #:nodoc:
       NEUTERED_RSPEC = Object.new
       def NEUTERED_RSPEC.method_missing(m, *args); self; end
       

data/lib/cucumber/step_match.rb

@@ -1,5 +1,5 @@
 module Cucumber
-  class StepMatch
+  class StepMatch #:nodoc:
     attr_reader :step_definition, :args
 
     def initialize(step_definition, step_name, formatted_step_name, args)
@@ -33,7 +33,7 @@ module Cucumber
     end
   end
   
-  class NoStepMatch
+  class NoStepMatch #:nodoc:
     attr_reader :step_definition, :name
 
     def initialize(step, name)