aslakhellesoy-cucumber 0.3.92 → 0.3.93

data/History.txt

@@ -1,4 +1,19 @@
-== (In Git)
+== 0.3.93 2009-08-03
+
+Highlights in this release: Improved profile handling (cucumber.yml) and a fix for cucumber hanging.
+
+=== New features
+* script/generate cucumber --spork now sets up a spork gem dependency in the cucumber.rb environment. (Aslak Hellesøy)
+* Feature files defined on the command line override any that are present in profiles. (#344 Ben Mabey)
+* Default (STDOUT) formatter defined in profile can be overridden from the command line. (#344 Ben Mabey)
+* Displays which profile, if any, is being used. (Ben Mabey)
+* click_link_within(parent, link) webrat step (Joakim Kolsjö)
+
+=== Bugfixes
+* script/cucumber correctly loads the gem's binary if the plugin isn't installed. 
+* Cucumber hangs waiting for Ctrl+C if an Error is raised (#374 Aslak Hellesøy) 
+
+== 0.3.92 2009-07-29
 
 This release has some minor improvements to the new Table.diff! functionality. For example,
 if you're using Webrat and you want to compare a feature table with a HTML table containing
@@ -16,6 +31,9 @@ links in one of the columns, you can do:
 * Upgrade Sinatra example to work with rack-test 0.3.0 and aslakhellesoy-webrat 0.4.4.1 (Aslak Hellesøy)
 * require 'cucumber/webrat/table_locator' added to Spork environment for Rails (Anders Furseth)
 
+=== Changed Features
+* The 'default' profile is now ALWAYS used unless you specify another profile or use the -P or --no-profile flag. (#344 Ben Mabey)
+
 == 0.3.91 2009-07-27
 
 === New Features
@@ -23,6 +41,7 @@ links in one of the columns, you can do:
 * Run can be stopped programmatically by setting $cucumber_interrupted = true, for example in an After block. (Aslak Hellesøy)
 * Table support for cuke4duke
 
+
 == 0.3.90 2009-07-22
 
 The Hot summer release

data/Manifest.txt

@@ -262,6 +262,7 @@ features/html_formatter/a.html
 features/junit_formatter.feature
 features/language_from_header.feature
 features/multiline_names.feature
+features/profiles.feature
 features/rake_task.feature
 features/report_called_undefined_steps.feature
 features/snippet.feature
@@ -311,6 +312,8 @@ lib/cucumber/cli/configuration.rb
 lib/cucumber/cli/drb_client.rb
 lib/cucumber/cli/language_help_formatter.rb
 lib/cucumber/cli/main.rb
+lib/cucumber/cli/options.rb
+lib/cucumber/cli/profile_loader.rb
 lib/cucumber/core_ext/exception.rb
 lib/cucumber/core_ext/instance_exec.rb
 lib/cucumber/core_ext/proc.rb
@@ -382,11 +385,14 @@ spec/cucumber/broadcaster_spec.rb
 spec/cucumber/cli/configuration_spec.rb
 spec/cucumber/cli/drb_client_spec.rb
 spec/cucumber/cli/main_spec.rb
+spec/cucumber/cli/options_spec.rb
+spec/cucumber/cli/profile_loader_spec.rb
 spec/cucumber/core_ext/proc_spec.rb
 spec/cucumber/core_ext/string_spec.rb
 spec/cucumber/formatter/ansicolor_spec.rb
 spec/cucumber/formatter/color_io_spec.rb
 spec/cucumber/formatter/duration_spec.rb
+spec/cucumber/formatter/html_spec.rb
 spec/cucumber/formatter/progress_spec.rb
 spec/cucumber/parser/feature_parser_spec.rb
 spec/cucumber/parser/table_parser_spec.rb

data/cucumber.yml

@@ -1,2 +1,2 @@
-default: --format progress features --tags ~@proposed,~@in_progress
-wip: --tags @in_progress --wip features
+default: --format progress --tags ~@proposed,~@in-progress features
+wip: --tags @in-progress --wip features

data/examples/i18n/pt/features/adicao.feature

@@ -5,7 +5,7 @@ Funcionalidade: Adição
   Eu quero saber como somar dois números
 
   Cenário: Adicionar dois números
-		Dado que eu digitei 50 na calculadora
-		E que eu digitei 70 na calculadora
-		Quando eu aperto o botão de soma
-		Então o resultado na calculadora deve ser 120
+    Dado que eu digitei 50 na calculadora
+    E que eu digitei 70 na calculadora
+    Quando eu aperto o botão de soma
+    Então o resultado na calculadora deve ser 120

data/features/profiles.feature

@@ -0,0 +1,99 @@
+Feature: Profiles
+  In order to save time and prevent carpal tunnel syndrome
+  Cucumber users can save and reuse commonly used cucumber flags in a 'cucumber.yml' file.
+  These named arguments are called profiles and the yml file should be in the root of your project.
+  Any cucumber argument is valid in a profile.  To see all the available flags type 'cucumber --help'
+  For more information about profiles please see the wiki:
+  http://wiki.github.com/aslakhellesoy/cucumber/cucumberyml
+
+  Background: Basic App
+    Given a standard Cucumber project directory structure
+    And a file named "features/sample.feature" with:
+      """
+      Feature: Sample
+        Scenario: this is a test
+          Given I am just testing stuff
+      """
+    And a file named "features/support/env.rb"
+    And a file named "features/support/super_env.rb"
+    And the following profiles are defined:
+      """
+      default: features/sample.feature --require features/support/env.rb -v
+      super: features/sample.feature --require features/support/super_env.rb -v
+      """
+
+  Scenario: Explicitly defining a profile to run
+    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
+      """
+      Using the default and super profiles...
+      """
+    And exactly these files should be loaded: features/support/env.rb, features/support/super_env.rb
+
+  Scenario: Arguments passed in but no profile specified
+    When I run cucumber -v
+    Then the default profile should be used
+    And exactly these files should be loaded: features/support/env.rb
+
+  Scenario: Trying to use a missing profile
+    When I run cucumber -p foo
+    Then STDERR should be
+      """
+      Could not find profile: 'foo'
+
+      Defined profiles in cucumber.yml:
+        * default
+        * super
+
+      """
+
+  Scenario Outline: Disabling the default profile
+    When I run cucumber -v features/ <Flag>
+    Then the output should contain
+      """
+      Disabling profiles...
+      """
+    And exactly these files should be loaded: features/support/env.rb, features/support/super_env.rb
+
+    Examples:
+    |   Flag          |
+    | -P              |
+    | --no-profile    |
+
+
+  Scenario: Overriding the profile's features to run
+    Given a file named "features/another.feature" with:
+      """
+      Feature: Just this one should be ran
+      """
+      When I run cucumber -p default features/another.feature
+      Then exactly these features should be ran: features/another.feature
+
+  Scenario: Overriding the profile's formatter
+    You will most likely want to define a formatter in your default formatter.
+    However, you often want to run your features with a different formatter
+    yet still use the other the other arguments in the profile. Cucumber will
+    allow you to do this by giving precedence to the formatter specified on the
+    command line and override the one in the profile.
+
+    Given the following profiles are defined:
+      """
+      default: features/sample.feature --require features/support/env.rb -v --format profile
+      """
+    When I run cucumber features --format pretty
+    And the output should contain
+      """
+      Feature: Sample
+      """
+
+
+
+

data/features/step_definitions/cucumber_steps.rb

@@ -111,6 +111,10 @@ Then /^STDERR should not match$/ do |text|
   last_stderr.should_not =~ /#{text}/
 end
 
+Then /^STDERR should be$/ do |text|
+  last_stderr.should == text
+end
+
 Then /^STDERR should be empty$/ do
   last_stderr.should == ""
 end
@@ -128,3 +132,19 @@ Then /^"([^\"]*)" should be required$/ do |file_name|
   last_stdout.should include("* #{file_name}")
 end
 
+Then /^exactly these files should be loaded:\s*(.*)$/ do |files|
+  last_stdout.scan(/^  \* (.*\.rb)$/).flatten.should == files.split(/,\s+/)
+end
+
+Then /^exactly these features should be ran:\s*(.*)$/ do |files|
+  last_stdout.scan(/^  \* (.*\.feature)$/).flatten.should == files.split(/,\s+/)
+end
+
+Then /^the (.*) profile should be used$/ do |profile|
+  last_stdout.should =~ /Using the #{profile} profile/
+end
+
+Then /^print output$/ do
+  puts last_stdout
+end
+

data/features/work_in_progress.feature

@@ -52,6 +52,7 @@ Feature: Cucumber --work-in-progress switch
   @mri186
   Scenario: Pass with Failing Scenarios
     When I run cucumber -q -w -t @failing features/wip.feature
+    Then STDERR should be empty
     Then it should pass with
       """
       Feature: WIP

data/lib/cucumber/cli/configuration.rb

@@ -1,6 +1,10 @@
+require 'cucumber/cli/options'
+
 module Cucumber
   module Cli
     class YmlLoadError < StandardError; end
+    class ProfilesNotDefinedError < YmlLoadError; end
+    class ProfileNotFound < StandardError; end
 
     class Configuration
       BUILTIN_FORMATS = {
@@ -14,187 +18,24 @@ module Cucumber
         'tag_cloud' => 'Cucumber::Formatter::TagCloud',
         'steps'     => 'Cucumber::Formatter::Steps'
       }
-      DRB_FLAG = '--drb'
-      PROFILE_SHORT_FLAG = '-p'
-      PROFILE_LONG_FLAG = '--profile'
 
-      attr_reader :paths
       attr_reader :options
 
       def initialize(out_stream = STDOUT, error_stream = STDERR)
         @out_stream   = out_stream
         @error_stream = error_stream
-
-        @paths          = []
-        @options        = default_options
+        @options = Options.new(@out_stream, @error_stream, :default_profile => 'default')
       end
 
       def parse!(args)
-        args.concat(%w{--profile default}) if args.empty?
         @args = args
-        expand_profiles_into_args
-        return if parse_drb
-
-        @args.each do |arg|
-          if arg =~ /^(\w+)=(.*)$/
-            ENV[$1] = $2
-            @args.delete(arg)
-          end
-        end
+        @options.parse!(args)
+        raise("You can't use both --strict and --wip") if strict? && wip?
 
-        @args.extend(::OptionParser::Arguable)
-
-        @args.options do |opts|
-          opts.banner = ["Usage: cucumber [options] [ [FILE|DIR|URL][:LINE[:LINE]*] ]+", "",
-            "Examples:",
-            "cucumber examples/i18n/en/features",
-            "cucumber --language it examples/i18n/it/features/somma.feature:6:98:113",
-            "cucumber -s -i http://rubyurl.com/eeCl", "", "",
-          ].join("\n")
-          opts.on("-r LIBRARY|DIR", "--require LIBRARY|DIR",
-            "Require files before executing the features. If this",
-            "option is not specified, all *.rb files that are",
-            "siblings or below the features will be loaded auto-",
-            "matically. Automatic loading is disabled when this",
-            "option is specified, and all loading becomes explicit.",
-            "Files under directories named \"support\" are always",
-            "loaded first.",
-            "This option can be specified multiple times.") do |v|
-            @options[:require] ||= []
-            @options[:require] << v
-          end
-          opts.on("-l LANG", "--language LANG",
-            "Specify language for features (Default: #{@options[:lang]})",
-            %{Run with "--language help" to see all languages},
-            %{Run with "--language LANG help" to list keywords for LANG}) do |v|
-            if v == 'help'
-              list_languages_and_exit
-            elsif args==['help']
-              list_keywords_and_exit(v)
-            else
-              @options[:lang] = v
-            end
-          end
-          opts.on("-f FORMAT", "--format FORMAT",
-            "How to format features (Default: pretty)",
-            "Available formats: #{BUILTIN_FORMATS.keys.sort.join(", ")}",
-            "FORMAT can also be the fully qualified class name of",
-            "your own custom formatter. If the class isn't loaded,",
-            "Cucumber will attempt to require a file with a relative",
-            "file name that is the underscore name of the class name.",
-            "Example: --format Foo::BarZap -> Cucumber will look for",
-            "foo/bar_zap.rb. You can place the file with this relative",
-            "path underneath your features/support directory or anywhere",
-            "on Ruby's LOAD_PATH, for example in a Ruby gem.") do |v|
-            @options[:formats] << [v, @out_stream]
-            @active_format = v
-          end
-          opts.on("-o", "--out [FILE|DIR]",
-            "Write output to a file/directory instead of STDOUT. This option",
-            "applies to the previously specified --format, or the",
-            "default format if no format is specified. Check the specific",
-            "formatter's docs to see whether to pass a file or a dir.") do |v|
-            @options[:formats] << ['pretty', nil] if @options[:formats].empty?
-            @options[:formats][-1][1] = v
-          end
-          opts.on("-t TAGS", "--tags TAGS",
-            "Only execute the features or scenarios with the specified tags.",
-            "TAGS must be comma-separated without spaces. Prefix tags with ~ to",
-            "exclude features or scenarios having that tag. Tags can be specified",
-            "with or without the @ prefix.") do |v|
-            include_tags, exclude_tags = *parse_tags(v)
-            @options[:include_tags] += include_tags
-            @options[:exclude_tags] += exclude_tags
-          end
-          opts.on("-n NAME", "--name NAME",
-            "Only execute the feature elements which match part of the given name.",
-            "If this option is given more than once, it will match against all the",
-            "given names.") do |v|
-            @options[:name_regexps] << /#{v}/
-          end
-          opts.on("-e", "--exclude PATTERN", "Don't run feature files or require ruby files matching PATTERN") do |v|
-            @options[:excludes] << Regexp.new(v)
-          end
-          opts.on(PROFILE_SHORT_FLAG, "#{PROFILE_LONG_FLAG} PROFILE", "Pull commandline arguments from cucumber.yml.") do |v|
-            # Processing of this is done previsouly so that the DRb flag can be detected within profiles.
-          end
-          opts.on("-c", "--[no-]color",
-            "Whether or not to use ANSI color in the output. Cucumber decides",
-            "based on your platform and the output destination if not specified.") do |v|
-            Term::ANSIColor.coloring = v
-          end
-          opts.on("-d", "--dry-run", "Invokes formatters without executing the steps.",
-            "This also omits the loading of your support/env.rb file if it exists.",
-            "Implies --quiet.") do
-            @options[:dry_run] = true
-            @quiet = true
-          end
-          opts.on("-a", "--autoformat DIRECTORY",
-            "Reformats (pretty prints) feature files and write them to DIRECTORY.",
-            "Be careful if you choose to overwrite the originals.",
-            "Implies --dry-run --formatter pretty.") do |directory|
-            @options[:autoformat] = directory
-            Term::ANSIColor.coloring = false
-            @options[:dry_run] = true
-            @quiet = true
-          end
-          opts.on("-m", "--no-multiline",
-            "Don't print multiline strings and tables under steps.") do
-            @options[:no_multiline] = true
-          end
-          opts.on("-s", "--no-source",
-            "Don't print the file and line of the step definition with the steps.") do
-            @options[:source] = false
-          end
-          opts.on("-i", "--no-snippets", "Don't print snippets for pending steps.") do
-            @options[:snippets] = false
-          end
-          opts.on("-q", "--quiet", "Alias for --no-snippets --no-source.") do
-            @quiet = true
-          end
-          opts.on("-b", "--backtrace", "Show full backtrace for all errors.") do
-            Exception.cucumber_full_backtrace = true
-          end
-          opts.on("-S", "--strict", "Fail if there are any undefined steps.") do
-            @options[:strict] = true
-          end
-          opts.on("-w", "--wip", "Fail if there are any passing scenarios.") do
-            @options[:wip] = true
-          end
-          opts.on("-v", "--verbose", "Show the files and features loaded.") do
-            @options[:verbose] = true
-          end
-          opts.on("-g", "--guess", "Guess best match for Ambiguous steps.") do
-            @options[:guess] = true
-          end
-          opts.on("-x", "--expand", "Expand Scenario Outline Tables in output.") do
-            @options[:expand] = true
-          end
-          opts.on("--no-diff", "Disable diff output on failing expectations.") do
-            @options[:diff_enabled] = false
-          end
-          opts.on(DRB_FLAG, "Run features against a DRb server. (i.e. with the spork gem)") do
-            # Processing of this is done previsouly in order to short circuit args from being lost.
-          end
-          opts.on_tail("--version", "Show version.") do
-            @out_stream.puts VERSION::STRING
-            Kernel.exit
-          end
-          opts.on_tail("-h", "--help", "You're looking at it.") do
-            @out_stream.puts opts.help
-            Kernel.exit
-          end
-        end.parse!
+        return @args.replace(@options.expanded_args_without_drb) if drb?
 
+        set_environment_variables
         arrange_formats
-
-        @options[:snippets] = true if !@quiet && @options[:snippets].nil?
-        @options[:source]   = true if !@quiet && @options[:source].nil?
-
-        raise("You can't use both --strict and --wip") if @options[:strict] && @options[:wip]
-
-        # Whatever is left after option parsing is the FILE arguments
-        @paths += @args
       end
 
       def verbose?
@@ -218,18 +59,11 @@ module Cucumber
       end
 
       def drb?
-        @drb
+        @options[:drb]
       end
 
-      def parse_tags(tag_string)
-        tag_names = tag_string.split(",")
-        excludes, includes = tag_names.partition{|tag| tag =~ /^~/}
-        excludes = excludes.map{|tag| tag[1..-1]}
-
-        # Strip @
-        includes = includes.map{|tag| Ast::Tags.strip_prefix(tag)}
-        excludes = excludes.map{|tag| Ast::Tags.strip_prefix(tag)}
-        [includes, excludes]
+      def paths
+        @options[:paths]
       end
 
       def build_formatter_broadcaster(step_mother)
@@ -270,7 +104,7 @@ module Cucumber
       end
 
       def files_to_require
-        requires = @options[:require] || require_dirs
+        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.
@@ -285,7 +119,7 @@ module Cucumber
       end
 
       def feature_files
-        potential_feature_files = @paths.map do |path|
+        potential_feature_files = @options[:paths].map do |path|
           path = path.gsub(/\\/, '/') # In case we're on windows. Globs don't work with backslashes.
           path = path.chomp('/')
           File.directory?(path) ? Dir["#{path}/**/*.feature"] : path
@@ -294,7 +128,13 @@ module Cucumber
         potential_feature_files
       end
 
-    protected
+    private
+
+      def set_environment_variables
+        @options[:env_vars].each do |var, value|
+          ENV[var] = value
+        end
+      end
 
       def arrange_formats
         @options[:formats] << ['pretty', @out_stream] if @options[:formats].empty?
@@ -309,11 +149,11 @@ module Cucumber
       end
 
       def feature_dirs
-        @paths.map { |f| File.directory?(f) ? f : File.dirname(f) }.uniq
+        paths.map { |f| File.directory?(f) ? f : File.dirname(f) }.uniq
       end
 
       def require_dirs
-        feature_dirs+Dir['vendor/{gems,plugins}/*/cucumber']
+        feature_dirs + Dir['vendor/{gems,plugins}/*/cucumber']
       end
 
       def constantize(camel_cased_word)
@@ -341,90 +181,6 @@ module Cucumber
           downcase
       end
 
-      def expand_profiles_into_args
-        while (profile_index = @args.index(PROFILE_SHORT_FLAG) || @args.index(PROFILE_LONG_FLAG)) do
-          @args.delete_at(profile_index)
-          @args[profile_index] = args_from_profile(@args[profile_index])
-          @args.flatten!
-        end
-      end
-
-      def args_from_profile(profile)
-        unless cucumber_yml.has_key?(profile)
-          raise(<<-END_OF_ERROR)
-Could not find profile: '#{profile}'
-
-Defined profiles in cucumber.yml:
-  * #{cucumber_yml.keys.join("\n  * ")}
-        END_OF_ERROR
-        end
-
-        args_from_yml = cucumber_yml[profile] || ''
-
-        case(args_from_yml)
-          when String
-            raise "The '#{profile}' profile in cucumber.yml was blank.  Please define the command line arguments for the '#{profile}' profile in cucumber.yml.\n" if args_from_yml =~ /^\s*$/
-            args_from_yml = args_from_yml.split(' ')
-          when Array
-            raise "The '#{profile}' profile in cucumber.yml was empty.  Please define the command line arguments for the '#{profile}' profile in cucumber.yml.\n" if args_from_yml.empty?
-          else
-            raise "The '#{profile}' profile in cucumber.yml was a #{args_from_yml.class}. It must be a String or Array"
-        end
-        args_from_yml
-      end
-
-      def cucumber_yml
-        return @cucumber_yml if @cucumber_yml
-        unless File.exist?('cucumber.yml')
-          raise(YmlLoadError,"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 'yaml'
-        begin
-          @cucumber_yml = YAML::load(IO.read('cucumber.yml'))
-        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
-
-        if @cucumber_yml.nil? || !@cucumber_yml.is_a?(Hash)
-          raise(YmlLoadError,"cucumber.yml was found, but was blank or malformed. Please refer to cucumber's documentation on correct profile usage.\n")
-        end
-
-        return @cucumber_yml
-      end
-
-      # TODO: Move to Language
-      def list_keywords_and_exit(lang)
-        unless Cucumber::LANGUAGES[lang]
-          raise("No language with key #{lang}")
-        end
-        LanguageHelpFormatter.list_keywords(@out_stream, lang)
-        Kernel.exit
-      end
-
-      def list_languages_and_exit
-        LanguageHelpFormatter.list_languages(@out_stream)
-        Kernel.exit
-      end
-
-      def parse_drb
-        @drb = @args.delete(DRB_FLAG) ? true : false
-      end
-
-      def default_options
-        {
-          :strict       => false,
-          :require      => nil,
-          :lang         => nil,
-          :dry_run      => false,
-          :formats      => [],
-          :excludes     => [],
-          :include_tags => [],
-          :exclude_tags => [],
-          :name_regexps => [],
-          :diff_enabled => true
-        }
-      end
     end
 
   end