cucumber 0.3.98 → 0.3.99

data/History.txt

@@ -1,3 +1,12 @@
+== 0.3.99 2009-09-03
+
+=== New Features
+* Support for Croatian (Bkrsta)
+* Make #feature available from scenario so you can do: Before{|scenario| scenario.feature}. (Aslak Hellesøy)
+* cucumber.yml parsing supports ERB syntax (#427 Gregory Hnatiuk)
+* New AfterConfiguration hook added; a block can be specified that takes Cucumber::Cli::Configuration (#423 Brent Snook)
+* Cucumber::Cli::Configuration#feature_dirs and #out_stream exposed as public attributes so that they may be used in AfterConfiguration hook (#423 Brent Snook)
+
 == 0.3.98 2009-08-25
 
 Just a small release to help Cuke4Duke, which will be presented at Agile2009

data/Manifest.txt

@@ -269,6 +269,7 @@ features/html_formatter/a.html
 features/junit_formatter.feature
 features/language_from_header.feature
 features/multiline_names.feature
+features/post_configuration_hook.feature
 features/profiles.feature
 features/rake_task.feature
 features/report_called_undefined_steps.feature

data/features/post_configuration_hook.feature

@@ -0,0 +1,37 @@
+Feature: Post Configuration Hook [#423]
+
+  In order to extend Cucumber
+  As a developer
+  I want to manipulate the Cucumber configuration after it has been created
+
+  Scenario: configuration modified to use HTML formatter
+
+    Given a standard Cucumber project directory structure
+    And a file named "features/support/env.rb" with:
+      """
+      AfterConfiguration do |config|
+        config.options[:formats] << ['html', config.out_stream]
+      end
+      """
+    When I run cucumber features
+    Then STDERR should be empty
+    And the output should contain
+      """
+      html
+      """
+
+  Scenario: feature directories read from configuration
+
+    Given a standard Cucumber project directory structure
+    And a file named "features/support/env.rb" with:
+      """
+      AfterConfiguration do |config|
+        config.out_stream << "AfterConfiguration hook read feature directories: #{config.feature_dirs}" 
+      end
+      """
+    When I run cucumber features
+    Then STDERR should be empty
+    And the output should contain
+      """
+      AfterConfiguration hook read feature directories: features
+      """

data/features/profiles.feature

@@ -30,6 +30,19 @@ Feature: Profiles
       """
     And exactly these files should be loaded: features/support/super_env.rb
 
+  Scenario: Explicitly defining a profile defined in an ERB formatted file
+    Given the following profiles are defined:
+      """
+      <% requires = "--require features/support/super_env.rb" %>
+      super: <%= "features/sample.feature #{requires} -v" %>
+      """
+    When I run cucumber features/sample.feature --profile super
+    Then the output should contain
+      """
+      Using the super profile...
+      """
+    And exactly these files should be loaded: features/support/super_env.rb
+
   Scenario: Defining multiple profiles to run
     When I run cucumber features/sample.feature --profile default --profile super
     Then the output should contain

data/lib/autotest/cucumber_mixin.rb

@@ -96,7 +96,7 @@ module Autotest::CucumberMixin
         $stdout.sync = old_sync
       end
       self.features_to_run = dirty_features_file.read.strip
-      self.tainted = true unless self.features_to_run == []
+      self.tainted = true unless self.features_to_run == ''
     end
     hook :ran_features
   end
@@ -122,4 +122,4 @@ module Autotest::CucumberMixin
 
     return "#{Cucumber::RUBY_BINARY} #{Cucumber::BINARY} #{args}"
   end
-end
+end

data/lib/cucumber/ast/feature_element.rb

@@ -2,7 +2,7 @@ require 'enumerator'
 
 module Cucumber
   module FeatureElement #:nodoc:
-    attr_writer :feature
+    attr_accessor :feature
 
     def attach_steps(steps)
       steps.each {|step| step.feature_element = self}

data/lib/cucumber/cli/configuration.rb

@@ -10,7 +10,7 @@ module Cucumber
     class Configuration
       include Constantize
       
-      attr_reader :options
+      attr_reader :options, :out_stream
 
       def initialize(out_stream = STDOUT, error_stream = STDERR)
         @out_stream   = out_stream
@@ -94,21 +94,29 @@ module Cucumber
         end
       end
 
-      def step_defs_to_load
+      def all_files_to_load
         requires = @options[:require].empty? ? require_dirs : @options[:require]
         files = requires.map do |path|
           path = path.gsub(/\\/, '/') # In case we're on windows. Globs don't work with backslashes.
           path = path.gsub(/\/$/, '') # Strip trailing slash.
           File.directory?(path) ? Dir["#{path}/**/*"] : path
         end.flatten.uniq
-        sorted_files = files.sort { |a,b| (b =~ %r{/support/} || -1) <=> (a =~ %r{/support/} || -1) }.reject{|f| f =~ /^http/}
-        env_files = sorted_files.select {|f| f =~ %r{/support/env\..*} }
-        files = env_files + sorted_files.reject {|f| f =~ %r{/support/env\..*} }
         remove_excluded_files_from(files)
         files.reject! {|f| !File.file?(f)}
         files.reject! {|f| File.extname(f) == '.feature' }
-        files.reject! {|f| f =~ %r{/support/env\..*} } if @options[:dry_run]
-        files
+        files.reject! {|f| f =~ /^http/}
+        files      
+      end
+      
+      def step_defs_to_load
+        all_files_to_load.reject {|f| f =~ %r{/support/} }
+      end
+      
+      def support_to_load
+        support_files = all_files_to_load.select {|f| f =~ %r{/support/} }
+        env_files = support_files.select {|f| f =~ %r{/support/env\..*} }
+        other_files = support_files - env_files
+        @options[:dry_run] ? other_files : env_files + other_files
       end
 
       def feature_files
@@ -120,6 +128,10 @@ module Cucumber
         remove_excluded_files_from(potential_feature_files)
         potential_feature_files
       end
+      
+      def feature_dirs
+        paths.map { |f| File.directory?(f) ? f : File.dirname(f) }.uniq
+      end
 
     private
 
@@ -136,8 +148,9 @@ module Cucumber
       def arrange_formats
         @options[:formats] << ['pretty', @out_stream] if @options[:formats].empty?
         @options[:formats] = @options[:formats].sort_by{|f| f[1] == @out_stream ? -1 : 1}
-        if @options[:formats].length > 1 && @options[:formats][1][1] == @out_stream
-          raise "All but one formatter must use --out, only one can print to STDOUT"
+        streams = @options[:formats].map { |(_, stream)| stream }
+        if streams != streams.uniq
+          raise "All but one formatter must use --out, only one can print to each stream (or STDOUT)"
         end
       end
 
@@ -145,10 +158,6 @@ module Cucumber
         files.reject! {|path| @options[:excludes].detect {|pattern| path =~ pattern } }
       end
 
-      def feature_dirs
-        paths.map { |f| File.directory?(f) ? f : File.dirname(f) }.uniq
-      end
-
       def require_dirs
         feature_dirs + Dir['vendor/{gems,plugins}/*/cucumber']
       end

data/lib/cucumber/cli/main.rb

@@ -53,10 +53,8 @@ module Cucumber
         logger.level = Logger::DEBUG if configuration.verbose?
         step_mother.log = logger
 
-        # Feature files must be loaded before files are required.
-        # This is because i18n step methods are only aliased when
-        # features are loaded. If we swap the order, the requires
-        # will fail.
+        step_mother.load_code_files(configuration.support_to_load)
+        step_mother.after_configuration(configuration)
         features = step_mother.load_plain_text_features(configuration.feature_files)
         step_mother.load_code_files(configuration.step_defs_to_load)
         enable_diffing

data/lib/cucumber/cli/profile_loader.rb

@@ -43,9 +43,16 @@ Defined profiles in cucumber.yml:
           raise(ProfilesNotDefinedError,"cucumber.yml was not found.  Please refer to cucumber's documentation on defining profiles in cucumber.yml.  You must define a 'default' profile to use the cucumber command without any arguments.\nType 'cucumber --help' for usage.\n")
         end
 
+        require 'erb'
         require 'yaml'
+        begin 
+          @cucumber_erb = ERB.new(IO.read('cucumber.yml')).result
+        rescue Exception => e 
+          raise(YmlLoadError,"cucumber.yml was found, but could not be parsed with ERB.  Please refer to cucumber's documentation on correct profile usage.\n#{$!.inspect}")
+        end
+
         begin
-          @cucumber_yml = YAML::load(IO.read('cucumber.yml'))
+          @cucumber_yml = YAML::load(@cucumber_erb)
         rescue StandardError => e
           raise(YmlLoadError,"cucumber.yml was found, but could not be parsed. Please refer to cucumber's documentation on correct profile usage.\n")
         end

data/lib/cucumber/language_support/language_methods.rb

@@ -10,6 +10,12 @@ module Cucumber
         execute_after(scenario)
         end_scenario
       end
+      
+      def after_configuration(configuration)
+        hooks[:after_configuration].each do |hook|
+          hook.invoke('AfterConfiguration', configuration)
+        end
+      end
 
       def execute_after_step(scenario)
         hooks_for(:after_step, scenario).each do |hook|

data/lib/cucumber/language_support/step_definition_methods.rb

@@ -1,3 +1,5 @@
+require 'cucumber/core_ext/string'
+
 module Cucumber
   module LanguageSupport
     module StepDefinitionMethods

data/lib/cucumber/languages.yml

@@ -251,6 +251,21 @@
   and: וגם
   but: אבל
   space_after_keyword: true
+"hr":
+  name: Croatian
+  native: hrvatski
+  encoding: UTF-8
+  feature: Osobina|Mogućnost|Mogucnost
+  background: Pozadina
+  scenario: Scenarij
+  scenario_outline: Skica|Koncept
+  examples: Primjeri|Scenariji
+  given: Zadan|Zadani|Zadano
+  when: Kada|Kad
+  then: Onda
+  and: I
+  but: Ali
+  space_after_keyword: true
 "hu":
   name: Hungarian
   native: magyar

data/lib/cucumber/rb_support/rb_dsl.rb

@@ -65,6 +65,12 @@ module Cucumber
       def AfterStep(*tag_names, &proc)
         RbDsl.register_rb_hook('after_step', tag_names, proc)
       end
+      
+      # Registers a proc that will run after Cucumber is configured. You can register as 
+      # as you want (typically from ruby scripts under <tt>support/hooks.rb</tt>).
+      def AfterConfiguration(&proc)
+        RbDsl.register_rb_hook('after_configuration', [], proc)
+      end      
 
       # Registers a new Ruby StepDefinition. This method is aliased
       # to <tt>Given</tt>, <tt>When</tt> and <tt>Then</tt>, and

data/lib/cucumber/rb_support/rb_hook.rb

@@ -10,8 +10,8 @@ module Cucumber
         @proc = proc
       end
 
-      def invoke(location, scenario)
-        @rb_language.current_world.cucumber_instance_exec(false, location, scenario, &@proc)
+      def invoke(location, argument)
+        @rb_language.current_world.cucumber_instance_exec(false, location, argument, &@proc)
       end
     end
   end

data/lib/cucumber/step_mother.rb

@@ -233,6 +233,12 @@ module Cucumber
       end
     end
     
+    def after_configuration(configuration) #:nodoc
+      @programming_languages.each do |programming_language|
+        programming_language.after_configuration(configuration)
+      end
+    end  
+    
     private
 
     # Registers a StepDefinition. This can be a Ruby StepDefintion,

data/lib/cucumber/version.rb

@@ -2,7 +2,7 @@ module Cucumber #:nodoc:
   class VERSION #:nodoc:
     MAJOR = 0
     MINOR = 3
-    TINY  = 98
+    TINY  = 99
     PATCH = nil # Set to nil for official release
 
     STRING = [MAJOR, MINOR, TINY, PATCH].compact.join('.')

data/rails_generators/cucumber/templates/cucumber.rake

@@ -7,12 +7,12 @@ begin
   namespace :cucumber do
     Cucumber::Rake::Task.new({:ok => 'db:test:prepare'}, 'Run features that should pass') do |t|
       t.fork = true # You may get faster startup if you set this to false
-      t.cucumber_opts = "--tags ~@wip --strict --format #{ENV['CUCUMBER_FORMAT'] || 'pretty'}<%= spork? ? ' --drb' : '' %>"
+      t.cucumber_opts = "--color --tags ~@wip --strict --format #{ENV['CUCUMBER_FORMAT'] || 'pretty'}<%= spork? ? ' --drb' : '' %>"
     end
 
     Cucumber::Rake::Task.new({:wip => 'db:test:prepare'}, 'Run features that are being worked on') do |t|
       t.fork = true # You may get faster startup if you set this to false
-      t.cucumber_opts = "--tags @wip:2 --wip --format #{ENV['CUCUMBER_FORMAT'] || 'pretty'}<%= spork? ? ' --drb' : '' %>"
+      t.cucumber_opts = "--color --tags @wip:2 --wip --format #{ENV['CUCUMBER_FORMAT'] || 'pretty'}<%= spork? ? ' --drb' : '' %>"
     end
 
     desc 'Run all features'

data/spec/cucumber/cli/configuration_spec.rb

@@ -18,7 +18,6 @@ module Cli
     end
 
     before(:each) do
-      #given_cucumber_yml_defined_as({'default' => '-q'})
       File.stub!(:exist?).and_return(false) # Meaning, no cucumber.yml exists
       Kernel.stub!(:exit).and_return(nil)
     end
@@ -33,24 +32,12 @@ module Cli
 
     attr_reader :out, :error
 
-
-    it "should require files in support paths first" do
-      given_the_following_files("/features/step_definitions/foo.rb","/features/support/bar.rb")
-
-      config.parse!(%w{--require /features})
-
-      config.step_defs_to_load.should == [
-        "/features/support/bar.rb",
-        "/features/step_definitions/foo.rb"
-      ]
-    end
-
     it "should require env.rb files first" do
       given_the_following_files("/features/support/a_file.rb","/features/support/env.rb")
 
       config.parse!(%w{--require /features})
 
-      config.step_defs_to_load.should == [
+      config.support_to_load.should == [
         "/features/support/env.rb",
         "/features/support/a_file.rb"
       ]
@@ -61,7 +48,7 @@ module Cli
 
       config.parse!(%w{--require /features --dry-run})
 
-      config.step_defs_to_load.should == [
+      config.support_to_load.should == [
         "/features/support/a_file.rb"
       ]
     end
@@ -85,7 +72,7 @@ module Cli
 
         config.parse!(%w{--require /features --exclude a_file.rb})
 
-        config.step_defs_to_load.should == [
+        config.all_files_to_load.should == [
           "/features/support/env.rb"
         ]
       end
@@ -97,7 +84,7 @@ module Cli
 
         config.parse!(%w{--require /features --exclude foo[df] --exclude blah})
 
-        config.step_defs_to_load.should == [
+        config.all_files_to_load.should == [
           "/features/support/bar.rb",
           "/features/support/fooz.rb"
         ]
@@ -152,6 +139,13 @@ module Cli
         config.parse!([])
         config.options[:require].should == ['from/yml']
       end
+      
+      it "parses ERB syntax in the cucumber.yml file" do
+        given_cucumber_yml_defined_as({'default' => '<%="--require some_file"%>'})
+
+        config.parse!([])
+        config.options[:require].should include('some_file')
+      end
 
       it "provides a helpful error message when a specified profile does not exists in cucumber.yml" do
         given_cucumber_yml_defined_as({'default' => '--require from/yml', 'html_report' =>  '--format html'})
@@ -183,9 +177,7 @@ END_OF_MESSAGE
 
 
       ["--no-profile", "-P"].each do |flag|
-
         context 'when none is specified with #{flag}' do
-
           it "disables profiles" do
             given_cucumber_yml_defined_as({'default' => '-v --require file_specified_in_default_profile.rb'})
 
@@ -199,13 +191,9 @@ END_OF_MESSAGE
             config.parse!("#{flag} --require some_file.rb".split(" "))
             out.string.should =~ /Disabling profiles.../
           end
-
         end
-
       end
 
-
-
       it "issues a helpful error message when a specified profile exists but is nil or blank" do
         [nil, '   '].each do |bad_input|
           given_cucumber_yml_defined_as({'foo' => bad_input})
@@ -240,6 +228,13 @@ END_OF_MESSAGE
 
         lambda{config.parse!([])}.should raise_error(expected_error_message)
       end
+
+      it "issues a helpful error message when cucumber.yml can not be parsed by ERB" do
+        expected_error_message = /cucumber.yml was found, but could not be parsed with ERB.  Please refer to cucumber's documentation on correct profile usage./
+        given_cucumber_yml_defined_as("<% this_fails %>")
+
+        lambda{config.parse!([])}.should raise_error(expected_error_message)
+      end
     end
 
 
@@ -291,7 +286,13 @@ END_OF_MESSAGE
     it "should not accept multiple --format options when both use implicit STDOUT" do
       lambda do
         config.parse!(%w{--format pretty --format progress})
-      end.should raise_error("All but one formatter must use --out, only one can print to STDOUT")
+      end.should raise_error("All but one formatter must use --out, only one can print to each stream (or STDOUT)")
+    end
+
+    it "should not accept multiple --out streams pointing to the same place" do
+      lambda do
+        config.parse!(%w{--format pretty --out file1 --format progress --out file1})
+      end.should raise_error("All but one formatter must use --out, only one can print to each stream (or STDOUT)")
     end
 
     it "should associate --out to previous --format" do

data/spec/cucumber/cli/main_spec.rb

@@ -86,6 +86,36 @@ module Cucumber
         end
       end
 
+      describe "setup step sequence" do
+        
+        it "should load files and execute hooks in order" do
+          Configuration.stub!(:new).and_return(configuration = mock('configuration', :null_object => true))
+          step_mother = mock('step mother', :null_object => true)
+          configuration.stub!(:drb?).and_return false
+          cli = Main.new(%w{--verbose example.feature}, @out)
+          cli.stub!(:require)
+          
+          configuration.stub!(:support_to_load).and_return(['support'])
+          configuration.stub!(:step_defs_to_load).and_return(['step defs'])
+          
+          # Support must be loaded first to ensure post configuration hook can
+          # run before anything else.
+          step_mother.should_receive(:load_code_files).with(['support']).ordered
+          # The post configuration hook/s (if any) need to be run next to enable
+          # extensions to do their thing before features are loaded
+          step_mother.should_receive(:after_configuration).with(configuration).ordered
+          # Feature files must be loaded before step definitions are required.
+          # This is because i18n step methods are only aliased when
+          # features are loaded. If we swap the order, the requires
+          # will fail.
+          step_mother.should_receive(:load_plain_text_features).ordered
+          step_mother.should_receive(:load_code_files).with(['step defs']).ordered
+
+          cli.execute!(step_mother)
+        end
+        
+      end
+      
     [ProfilesNotDefinedError, YmlLoadError, ProfileNotFound].each do |exception_klass|
 
       it "rescues #{exception_klass}, prints the message to the error stream and returns true" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cucumber
 version: !ruby/object:Gem::Version 
-  version: 0.3.98
+  version: 0.3.99
 platform: ruby
 authors: 
 - "Aslak Helles\xC3\xB8y"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-25 00:00:00 -05:00
+date: 2009-09-03 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -346,6 +346,7 @@ files:
 - features/junit_formatter.feature
 - features/language_from_header.feature
 - features/multiline_names.feature
+- features/post_configuration_hook.feature
 - features/profiles.feature
 - features/rake_task.feature
 - features/report_called_undefined_steps.feature