cucumber 2.0.0.rc.4 → 4.0.0.rc.2

data/CONTRIBUTING.md

@@ -13,13 +13,24 @@ We appreciate that. But before you do, please learn our basic rules:
 
 # Contributing to Cucumber
 
-This document is a guide for those maintaining Cucumber, and others who would like to submit patches.
+The rest of this document is a guide for those maintaining Cucumber, and others who would like to submit patches.
 
-## WARNING
+## Talking with other devs
 
-The master branch is the in-development branch for version 2.0 of Cucumber. This code is work in progress and some way off 
-release. If you have a minor change that you'd like released soon, we suggest submitting a pull request against the 
-`1.3.x-bugfix` branch.
+You can chat with the core team on https://gitter.im/cucumber/contributors. We try to have office hours on Fridays.
+
+## Installing your own gems
+
+A `Gemfile.local`-file can be used to have your own gems installed to support
+your normal development workflow.
+
+Example:
+
+~~~ruby
+gem 'pry'
+gem 'pry-byebug'
+gem 'byebug'
+~~~
 
 ## Note on Patches/Pull Requests
 
@@ -39,30 +50,22 @@ release. If you have a minor change that you'd like released soon, we suggest su
 
     To get code coverage results, run `bundle exec rake cov`
 
+## First timer? No problem!
+
+If you are new to the project or to OSS, check the label
+[Easy](https://github.com/cucumber/cucumber-ruby/labels/Easy). Also, you can
+help us to correct style violations reported here:
+[.rubocop_todo.yml](https://github.com/cucumber/cucumber-ruby/blob/master/.rubocop_todo.yml).
+
 ## Release Process
 
-* Bump the version number in `lib/cucumber/platform.rb`.
-* Make sure `History.md` is updated with the upcoming version number, and has entries for all fixes.
-* No need to add a `History.md` header at this point - this should be done when a new change is made, later.
-* Make sure you have up-to-date and clean copy of cucumber/cucumber.github.com.git at the same level as cucumber repo.
+* Bump the version number in `lib/cucumber/version`.
+* Make sure `CHANGELOG.md` is updated with the upcoming version number, and has entries for all fixes.
 
 Now release it
 
     bundle update
     bundle exec rake
     git commit -m "Release X.Y.Z"
+    # Make sure you run gem signin as the cukebot@cucumber.io user before running the following step. Credentials can be found in 1Password
     rake release
-
-## Gaining Release Karma
-
-To become a release manager, create a pull request adding your name to the list below, and include your Rubygems email address in the ticket. One of the existing Release managers will then add you.
-
-Current release managers:
-  * Matt Wynne
-  * Aslak Hellesøy
-  * Oleg Sukhodolsky
-  * Steve Tooke
-
-To grant release karma, issue the following command:
-
-    gem owner cucumber --add <NEW OWNER RUBYGEMS EMAIL>

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2008-2013 Aslak Hellesøy
+Copyright (c) Aslak Hellesøy
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,22 +1,39 @@
-[![Build Status](https://secure.travis-ci.org/cucumber/cucumber.png)](http://travis-ci.org/cucumber/cucumber) [![Code Climate](https://codeclimate.com/github/cucumber/cucumber.png)](https://codeclimate.com/github/cucumber/cucumber) [![Coverage Status](https://coveralls.io/repos/cucumber/cucumber/badge.png?branch=master)](https://coveralls.io/r/cucumber/cucumber?branch=master) [![Dependency Status](https://gemnasium.com/cucumber/cucumber.png)](https://gemnasium.com/cucumber/cucumber)
+[![OpenCollective](https://opencollective.com/cucumber/backers/badge.svg)](https://opencollective.com/cucumber)
+[![OpenCollective](https://opencollective.com/cucumber/sponsors/badge.svg)](https://opencollective.com/cucumber)
+
+[![CircleCI](https://circleci.com/gh/cucumber/cucumber-ruby.svg?style=svg)](https://circleci.com/gh/cucumber/cucumber-ruby)
+
+[![Code Climate](https://codeclimate.com/github/cucumber/cucumber-ruby.svg)](https://codeclimate.com/github/cucumber/cucumber-ruby)
+[![Coverage Status](https://coveralls.io/repos/cucumber/cucumber-ruby/badge.svg?branch=master)](https://coveralls.io/r/cucumber/cucumber-ruby?branch=master)
 
 # Cucumber
 
 Cucumber is a tool for running automated tests written in plain language. Because they're
-written in plain language, they can be read by anyone on your team. Because they can be 
+written in plain language, they can be read by anyone on your team. Because they can be
 read by anyone, you can use them to help improve communication, collaboration and trust on
 your team.
 
 Where to get more info:
 
-  * The main website: http://cukes.info/
-  * Documentation: https://wiki.github.com/cucumber/cucumber/
-  * API Documentation: http://cukes.info/api/cucumber/ruby/yardoc/
-  * Support forum: https://groups.google.com/forum/?fromgroups#!forum/cukes
-  * IRC channel: irc://irc.freenode.net/cucumber
+ * The main website: https://cucumber.io/ 
+ * Documentation: https://cucumber.io/docs
+ * Ruby API Documentation: http://www.rubydoc.info/github/cucumber/cucumber-ruby/
+ * Support forum: https://groups.google.com/group/cukes
+ * Chat: ([Slack](https://cucumber.io/support#slack) and [Gitter](https://cucumber.io/support#gitter))
 
 See [CONTRIBUTING.md](CONTRIBUTING.md) for info on contributing to Cucumber.
 
+## Supported platforms
+* Ruby 2.6
+* Ruby 2.5
+* Ruby 2.4
+* Ruby 2.3
+* JRuby 9.1
+
+## Code of Conduct
+
+Everyone interacting in this codebase and issue tracker is expected to follow the Cucumber [code of conduct](https://github.com/cucumber/cucumber/blob/master/CODE_OF_CONDUCT.md).
+
 ## Copyright
 
-Copyright (c) 2008-2013 Aslak Hellesøy and Contributors. See LICENSE for details.
+Copyright (c) Cucumber Ltd. and Contributors. See LICENSE for details.

data/bin/cucumber

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
-$:.unshift(File.dirname(__FILE__) + '/../lib') unless $:.include?(File.dirname(__FILE__) + '/../lib')
-
-load File.expand_path(File.dirname(__FILE__) + '/../spec/simplecov_setup.rb')
+file_name = File.dirname(__FILE__) + '/../lib'
+$LOAD_PATH.unshift(file_name) unless $LOAD_PATH.include?(file_name)
 
+require 'simplecov_setup'
 require 'cucumber/rspec/disable_option_parser'
 require 'cucumber/cli/main'
 # The dup is to keep ARGV intact, so that tools like ruby-debug can respawn.

data/lib/autotest/cucumber.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'autotest'
 require 'autotest/cucumber_mixin'
 

data/lib/autotest/cucumber_mixin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'autotest'
 require 'tempfile'
 require 'cucumber'
@@ -5,7 +7,7 @@ require 'cucumber/cli/profile_loader'
 
 module Autotest::CucumberMixin
   def self.included(receiver)
-    receiver::ALL_HOOKS << [:run_features, :ran_features]
+    receiver::ALL_HOOKS << %i[run_features ran_features]
   end
 
   attr_accessor :features_to_run
@@ -21,12 +23,10 @@ module Autotest::CucumberMixin
     reset_features
     add_sigint_handler
 
-    self.last_mtime = Time.now if $f
-
     loop do # ^c handler
       begin
         get_to_green
-        if self.tainted then
+        if tainted
           rerun_all_tests
           rerun_all_features if all_good
         else
@@ -37,7 +37,7 @@ module Autotest::CucumberMixin
         # time a file is changed to see if anything breaks.
         reset_features
       rescue Interrupt
-        break if self.wants_to_quit
+        break if wants_to_quit
         reset
         reset_features
       end
@@ -46,15 +46,16 @@ module Autotest::CucumberMixin
   end
 
   def all_features_good
-    features_to_run == ""
+    features_to_run == ''
   end
 
-  def get_to_green
-    begin
+  def get_to_green # rubocop:disable Naming/AccessorMethodName
+    loop do
       super
       run_features
       wait_for_changes unless all_features_good
-    end until all_features_good
+      break if all_features_good
+    end
   end
 
   def rerun_all_features
@@ -69,67 +70,63 @@ module Autotest::CucumberMixin
   def run_features
     hook :run_features
     Tempfile.open('autotest-cucumber') do |dirty_features_file|
-      cmd = self.make_cucumber_cmd(self.features_to_run, dirty_features_file.path)
-      return if cmd.empty?
-      puts cmd unless $q
+      cmd = make_cucumber_cmd(features_to_run, dirty_features_file.path)
+      break if cmd.empty?
       old_sync = $stdout.sync
       $stdout.sync = true
       self.results = []
       line = []
       begin
-        open("| #{cmd}", "r") do |f|
-          until f.eof? do
-            c = f.getc or break
-            if RUBY_VERSION >= "1.9" then
-              print c
-            else
-              putc c
-            end
+        open("| #{cmd}", 'r') do |f| # rubocop:disable Security/Open
+          until f.eof?
+            c = f.getc || break
+            print(c)
             line << c
-            if c == ?\n then
-              self.results << if RUBY_VERSION >= "1.9" then
-                                line.join
-                              else
-                                line.pack "c*"
-                              end
-              line.clear
-            end
+            next unless c == "\n"
+            results << line.join
+            line.clear
           end
         end
       ensure
         $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 features_to_run == ''
     end
     hook :ran_features
   end
 
-  def make_cucumber_cmd(features_to_run, dirty_features_filename)
-    return '' if features_to_run == ''
+  def make_cucumber_cmd(features_to_run, _dirty_features_filename)
+    return '' if features_to_run.empty?
 
     profile_loader = Cucumber::Cli::ProfileLoader.new
 
-    profile ||= "autotest-all" if profile_loader.has_profile?("autotest-all") && features_to_run == :all
-    profile ||= "autotest"     if profile_loader.has_profile?("autotest")
-    profile ||= nil
+    profile = profile(profile_loader)
 
-    if profile
-      args = ["--profile", profile]
-    else
-      args = %w{--format} << (features_to_run == :all ? "progress" : "pretty")
-    end
-    # No --color option as some IDEs (Netbeans) don't output them very well (1 failed step)
-    args += %w{--format rerun --out} << dirty_features_filename
-    args << (features_to_run == :all ? "" : features_to_run)
+    args = created_args(features_to_run, profile)
 
-    # Unless I do this, all the steps turn up undefined during the rerun...
-    unless features_to_run == :all
-      args << 'features/step_definitions' << 'features/support'
-    end
+    "#{Cucumber::RUBY_BINARY} #{Cucumber::BINARY} #{args}"
+  end
+
+  def profile(profile_loader)
+    profile ||= 'autotest-all' if profile_loader.profile?('autotest-all') && features_to_run == :all
+    profile ||= 'autotest'     if profile_loader.profile?('autotest')
+    profile || nil
+  end
+
+  def created_args(features_to_run, profile)
+    args = if profile
+             ['--profile', profile]
+           else
+             %w[--format] << (features_to_run == :all ? 'progress' : 'pretty')
+           end
+    # No --color option as some IDEs (Netbeans) don't output them very well (1 failed step)
+    args += %w[--format rerun --out] << dirty_features_filename
+    args << (features_to_run == :all ? '' : features_to_run)
 
-    args = args.join(' ')
+    # All steps becom undefined during rerun unless the following is run.
+    args << 'features/step_definitions' << 'features/support' unless features_to_run == :all
 
-    return "#{Cucumber::RUBY_BINARY} #{Cucumber::BINARY} #{args}"
+    args.join(' ')
   end
 end

data/lib/autotest/cucumber_rails.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'autotest/rails'
 require 'autotest/cucumber_mixin'
 

data/lib/autotest/cucumber_rails_rspec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'autotest/cucumber_mixin'
 require 'autotest/rails_rspec'
 

data/lib/autotest/cucumber_rails_rspec2.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'autotest/cucumber_mixin'
 require 'autotest/rails_rspec2'
 

data/lib/autotest/cucumber_rspec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'autotest/cucumber_mixin'
 require 'autotest/rspec'
 

data/lib/autotest/cucumber_rspec2.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'autotest/cucumber_mixin'
 require 'autotest/rspec2'
 

data/lib/autotest/discover.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 Autotest.add_discovery do
   if File.directory?('features')
     if ENV['AUTOFEATURE'] =~ /true/i
-      "cucumber"
+      'cucumber'
     elsif ENV['AUTOFEATURE'] =~ /false/i
       # noop
     else
-      puts "(Not running features.  To run features in autotest, set AUTOFEATURE=true.)"
+      puts '(Not running features.  To run features in autotest, set AUTOFEATURE=true.)'
     end
   end
 end

data/lib/cucumber.rb

@@ -1,7 +1,7 @@
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+# frozen_string_literal: true
 
 require 'yaml'
+require 'cucumber/encoding'
 require 'cucumber/platform'
 require 'cucumber/runtime'
 require 'cucumber/cli/main'
@@ -10,7 +10,7 @@ require 'cucumber/term/ansicolor'
 
 module Cucumber
   class << self
-    attr_accessor :wants_to_quit
+    attr_accessor :wants_to_quit, :use_legacy_autoloader
 
     def logger
       return @log if @log
@@ -22,11 +22,5 @@ module Cucumber
     def logger=(logger)
       @log = logger
     end
-
-    def deprecate(class_name, method, message)
-      return self # deprecation warnings will come in v2.1
-      called_by = caller[1]
-      warn("Deprecated: #{class_name}##{method} #{message}. Caller: #{called_by}")
-    end
   end
 end

data/lib/cucumber/cli/configuration.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 require 'logger'
 require 'cucumber/cli/options'
+require 'cucumber/cli/rerun_file'
 require 'cucumber/constantize'
-require 'gherkin/tag_expression'
+require 'cucumber'
 
 module Cucumber
   module Cli
@@ -17,16 +20,14 @@ module Cucumber
       def initialize(out_stream = STDOUT, error_stream = STDERR)
         @out_stream   = out_stream
         @error_stream = error_stream
-        @options = Options.new(@out_stream, @error_stream, :default_profile => 'default')
+        @options = Options.new(@out_stream, @error_stream, default_profile: 'default')
       end
 
       def parse!(args)
         @args = args
         @options.parse!(args)
         arrange_formats
-        raise("You can't use both --strict and --wip") if strict? && wip?
-        # todo: remove
-        @options[:tag_expression] = Gherkin::TagExpression.new(@options[:tag_expressions])
+        raise("You can't use both --strict and --wip") if strict.strict? && wip?
         set_environment_variables
       end
 
@@ -42,7 +43,7 @@ module Cucumber
         Integer(@options[:seed] || rand(0xFFFF))
       end
 
-      def strict?
+      def strict
         @options[:strict]
       end
 
@@ -62,81 +63,28 @@ module Cucumber
         @options[:expand]
       end
 
-      def snippet_type
-        @options[:snippet_type] || :regexp
-      end
-
-      def formatter_class(format)
-        if(builtin = Options::BUILTIN_FORMATS[format])
-          constantize(builtin[0])
-        else
-          constantize(format)
-        end
-      end
-
-      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
-        remove_excluded_files_from(files)
-        files.reject! {|f| !File.file?(f)}
-        files.reject! {|f| File.extname(f) == '.feature' }
-        files.reject! {|f| f =~ /^http/}
-        files.sort
+      def fail_fast?
+        @options[:fail_fast]
       end
 
-      def step_defs_to_load
-        all_files_to_load.reject {|f| f =~ %r{/support/} }
+      def retry_attempts
+        @options[:retry]
       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
-        potential_feature_files = with_default_features_path(paths).map do |path|
-          path = path.gsub(/\\/, '/') # In case we're on windows. Globs don't work with backslashes.
-          path = path.chomp('/')
-          if File.directory?(path)
-            Dir["#{path}/**/*.feature"].sort
-          elsif path[0..0] == '@' and # @listfile.txt
-              File.file?(path[1..-1]) # listfile.txt is a file
-            IO.read(path[1..-1]).split(/(.*?\.feature.*?) /).collect(&:strip).reject(&:empty?)
-          else
-            path
-          end
-        end.flatten.uniq
-        remove_excluded_files_from(potential_feature_files)
-        potential_feature_files
-      end
-
-      def feature_dirs
-        dirs = paths.map { |f| File.directory?(f) ? f : File.dirname(f) }.uniq
-        dirs.delete('.') unless paths.include?('.')
-        with_default_features_path(dirs)
+      def snippet_type
+        @options[:snippet_type] || :cucumber_expression
       end
 
       def log
         logger = Logger.new(@out_stream)
         logger.formatter = LogFormatter.new
         logger.level = Logger::INFO
-        logger.level = Logger::DEBUG if self.verbose?
+        logger.level = Logger::DEBUG if verbose?
         logger
       end
 
-      # todo: remove
-      def tag_expression
-        Gherkin::TagExpression.new(@options[:tag_expressions])
-      end
-
       def tag_limits
-        tag_expression.limits.to_hash
+        @options[:tag_limits]
       end
 
       def tag_expressions
@@ -155,38 +103,18 @@ module Cucumber
         @options[:formats]
       end
 
-      def options
-        warn("Deprecated: Configuration#options will be removed from the next release of Cucumber. Please use the configuration object directly instead.")
-        @options
-      end
-
       def paths
         @options[:paths]
       end
 
-      def formatter_factories
-        @options[:formats].map do |format_and_out|
-          format = format_and_out[0]
-          path_or_io = format_and_out[1]
-          begin
-            factory = formatter_class(format)
-            yield factory, path_or_io, @options
-          rescue Exception => e
-            e.message << "\nError creating formatter: #{format}"
-            raise e
-          end
-        end
+      def to_hash
+        Hash(@options).merge(out_stream: @out_stream, error_stream: @error_stream, seed: seed)
       end
 
       private
 
-      def with_default_features_path(paths)
-        return ['features'] if paths.empty?
-        paths
-      end
-
       class LogFormatter < ::Logger::Formatter
-        def call(severity, time, progname, msg)
+        def call(_severity, _time, _progname, msg)
           msg
         end
       end
@@ -198,24 +126,13 @@ module Cucumber
       end
 
       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}
-        @options[:formats].uniq!
-        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)"
+        @options[:formats] << ['pretty', {}, @out_stream] if @options[:formats].empty?
+        @options[:formats] = @options[:formats].sort_by do |f|
+          f[2] == @out_stream ? -1 : 1
         end
+        @options[:formats].uniq!
+        @options.check_formatter_stream_conflicts
       end
-
-      def remove_excluded_files_from(files)
-        files.reject! {|path| @options[:excludes].detect {|pattern| path =~ pattern } }
-      end
-
-      def require_dirs
-        feature_dirs + Dir['vendor/{gems,plugins}/*/cucumber']
-      end
-
     end
-
   end
 end