cucumber 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4396d10625822b4e94db4edbb67438e3e4394dae
-  data.tar.gz: 45960cc6f1cf3e3189dfd4f4ab5ac27c8ff8e4a3
+  metadata.gz: e99af93e987e5bd5b6424cda154b6f9ef1d4a834
+  data.tar.gz: db6cd2d1d62695ef7dd72a6b9505e921bc8b7e84
 SHA512:
-  metadata.gz: ac22570755b443d4f1cdb9a546d46f92283722d1cc799bb59274dd9cc476b0c609a471247ea7d1c7a2d8598d6d0d5e41c2efef49ce10b150e4337109d4cc998f
-  data.tar.gz: 125c07dddc5d0039333c677860a93820103871c9db3c3bba57d23496d4c07879208178c3a929d84c74bff15a14a4618cf7c12162c242d83e7b2533bc0261e357
+  metadata.gz: 965176d82959413e7551f10890c255ab09dafbb5a43ceb3072a81c89f6eb2775661506b6a8a1d188e596978c4d6ad654dd0859a5aafe058fcdfa707f5bfe6799
+  data.tar.gz: 9a5627119ee9557b23a6cfd5107694af06f5a7f30fb566ce47076519fb0c664b9debba4f3cb609fef2f758c2fc177c16715b8820ae66aef78b64b3da2d436295

data/.travis.yml

@@ -10,3 +10,13 @@ branches:
   only:
     - master
     - v1.3.x-bugfix
+
+before_install:
+  - gem update bundler
+
+notifications:
+  email:
+    - cukes-devs@googlegroups.com
+  webhooks:
+    urls: # gitter
+      - https://webhooks.gitter.im/e/dc010332f9d40fcc21c4

data/Gemfile

@@ -3,9 +3,11 @@ source "https://rubygems.org"
 gemspec
 unless ENV['CUCUMBER_USE_RELEASED_CORE']
   core_path = File.expand_path("../../cucumber-ruby-core", __FILE__)
+  wire_path = File.expand_path("../../cucumber-ruby-wire", __FILE__)
   if File.exist?(core_path) && !ENV['CUCUMBER_USE_GIT_CORE']
     gem 'cucumber-core', :path => core_path
+    gem 'cucumber-wire', :path => wire_path
   else
-    gem 'cucumber-core', :git => "git://github.com/cucumber/cucumber-ruby-core.git", branch: "integrate-gherkin3-parser"
+    gem 'cucumber-core', :git => "git://github.com/cucumber/cucumber-ruby-core.git"
   end
 end

data/History.md

@@ -1,4 +1,20 @@
-## [In Git](https://github.com/cucumber/cucumber-ruby/compare/v2.0.2...master)
+## [In Git](https://github.com/cucumber/cucumber-ruby/compare/v2.1...master)
+
+### New Features
+
+### Bugfixes
+
+* Let the formatters output the value of printed variables at time of the call to `#puts` ([#918](https://github.com/cucumber/cucumber-ruby/pull/918) [#915](https://github.com/cucumber/cucumber-ruby/issues/915) @enkessler @brasmusson)
+* Fix Configuration.with_options merge direction ([#922](https://github.com/cucumber/cucumber-ruby/pull/922) @limhoff-r7)
+* Consistent line breaks / truncation in backtraces ([#941](https://github.com/cucumber/cucumber-ruby/pull/941) @tooky)
+* Fix extra arg passed to ensure_io ([#939](https://github.com/cucumber/cucumber-ruby/pull/939A @benshan)
+
+### Refactoring
+
+* Remove wire protocol to plugin ([#878](https://github.com/cucumber/cucumber-ruby/pull/878) @mattwynne @tooky)
+* Remove event bus to separate gem ([#933](https://github.com/cucumber/cucumber-ruby/pull/933) @dg-ratiodata)
+
+## [v2.1](https://github.com/cucumber/cucumber-ruby/compare/v2.0.2...v2.1)
 
 ### New Features
 
@@ -16,7 +32,7 @@
 * Pass DocString as String ([891](https://github.com/cucumber/cucumber-ruby/pull/891) @aslakhellesoy)
 * Remove core_ext/proc.rb and use Proc#source_location instead ([888](https://github.com/cucumber/cucumber-ruby/pull/888) @brasmusson)
 * Move behaviour from `Cucumber::Cli::Configuration` to `Cucumber::Configuration` (@tooky, @mattwynne)
-* Integrate Gherkin3 parser ([884](https://github.com/cucumber/cucumber-ruby/pull/884) (@brassmusson)
+* Integrate Gherkin3 parser ([884](https://github.com/cucumber/cucumber-ruby/pull/884) (@brasmusson)
 
 ## [v2.0.2](https://github.com/cucumber/cucumber-ruby/compare/v2.0.1...v2.0.2)
 

data/README.md

@@ -1,4 +1,8 @@
-[![Join the chat at https://gitter.im/cucumber/cucumber-ruby](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/cucumber/cucumber-ruby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Build Status](https://secure.travis-ci.org/cucumber/cucumber-ruby.png)](http://travis-ci.org/cucumber/cucumber-ruby) [![Code Climate](https://codeclimate.com/github/cucumber/cucumber-ruby.png)](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) [![Dependency Status](https://gemnasium.com/cucumber/cucumber-ruby.png)](https://gemnasium.com/cucumber/cucumber-ruby)
+[![Join the chat at https://gitter.im/cucumber/cucumber-ruby](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/cucumber/cucumber-ruby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![Build Status](https://secure.travis-ci.org/cucumber/cucumber-ruby.svg)](http://travis-ci.org/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)
+[![Dependency Status](https://gemnasium.com/cucumber/cucumber-ruby.svg)](https://gemnasium.com/cucumber/cucumber-ruby)
 
 # Cucumber
 

data/cucumber.gemspec

@@ -1,10 +1,7 @@
 # -*- encoding: utf-8 -*-
-$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
-require "cucumber/platform"
-
 Gem::Specification.new do |s|
   s.name        = 'cucumber'
-  s.version     = Cucumber::VERSION
+  s.version     = File.read(File.expand_path("../lib/cucumber/version", __FILE__))
   s.authors     = ["Aslak Hellesøy", "Matt Wynne", "Steve Tooke"]
   s.description = 'Behaviour Driven Development with elegance and joy'
   s.summary     = "cucumber-#{s.version}"
@@ -20,6 +17,8 @@ Gem::Specification.new do |s|
   s.add_dependency 'gherkin3', '~> 3.1.0'
   s.add_dependency 'multi_json', '>= 1.7.5', '< 2.0'
   s.add_dependency 'multi_test', '>= 0.1.2'
+  s.add_dependency 'cucumber-wire', '~> 0.0.1'
+  s.add_dependency 'event-bus', '~> 0.1.0'
 
   s.add_development_dependency 'aruba', '~> 0.6.1'
   s.add_development_dependency 'json', '~> 1.7'

data/cucumber.yml

@@ -2,7 +2,7 @@
 cucumber_pro_opts = ENV['ENABLE_CUCUMBER_PRO'] ? "--format Cucumber::Pro --out /dev/null" : ""
 rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
 rerun_opts = rerun.to_s.strip.empty? ? "--format progress features" : "--format pretty #{rerun}"
-std_opts = "--format progress features --tags ~@wip --tag ~@wip-new-core -r features --strict #{cucumber_pro_opts}"
+std_opts = "--format progress features --tags ~@wip --tags ~@wip-new-core -r features --strict #{cucumber_pro_opts}"
 std_opts << " --tags ~@wip-jruby" if defined?(JRUBY_VERSION)
 
 wip_opts = "--color -r features --tags @wip,@wip-new-core"
@@ -17,4 +17,4 @@ ruby_2_0:    <%= std_opts %> --tags ~@jruby
 ruby_2_1:    <%= std_opts %> --tags ~@jruby
 wip:         --wip <%= wip_opts %> features <%= cucumber_pro_opts %>
 none:        --format pretty --format Cucumber::Pro --out /dev/null
-rerun:       <%= rerun_opts %> --format rerun --out rerun.txt --strict --tags ~@wip --tag ~@wip-new-core <%= cucumber_pro_opts %>
+rerun:       <%= rerun_opts %> --format rerun --out rerun.txt --strict --tag ~@wip-new-core <%= cucumber_pro_opts %>

data/features/docs/api/run_cli_main_with_existing_runtime.feature

@@ -1,26 +1,23 @@
 @spawn
 Feature: Run Cli::Main with existing Runtime
 
-  This is the API that Spork uses. It creates an existing runtime then
-  calls load_programming_language('rb') on it to load the RbDsl.
-  When the process forks, Spork them passes the runtime to Cli::Main to 
+  This is the API that Spork uses. It creates an existing runtime.
+  When the process forks, Spork them passes the runtime to Cli::Main to
   run it.
 
     Scenario: Run a single feature
       Given the standard step definitions
       Given a file named "features/success.feature" with:
         """
-        Feature: 
-          Scenario: 
+        Feature:
+          Scenario:
             Given this step passes
         """
       When I run the following Ruby code:
         """
         require 'cucumber'
         runtime = Cucumber::Runtime.new
-        runtime.load_programming_language('rb')
         Cucumber::Cli::Main.new([]).execute!(runtime)
-        
         """
       Then it should pass
       And the output should contain:

data/features/docs/defining_steps/skip_scenario.feature

@@ -29,7 +29,8 @@ Feature: Skip Scenario
 
       """
 
-  Scenario: Use legacy API from a hook
+  @spawn
+  Scenario: Use (deprecated) legacy API
     Given a file named "features/test.feature" with:
       """
       Feature: test
@@ -57,4 +58,7 @@ Feature: Skip Scenario
       2 steps (2 skipped)
 
       """
-
+    And the stderr should contain:
+      """
+      WARNING: skip_invoke! is deprecated
+      """

data/features/docs/formatters/api_methods.feature

@@ -0,0 +1,36 @@
+Feature: Formatter API methods
+
+  Some utility methods are provided to make it easier to write your own formatters.
+
+  Here are some examples.
+
+  Scenario: A formatter that uses `Cucumber::Formatter::Io#ensure_file`
+
+    The ensure_file method is a little helper function that some formatters use,
+    normally when given a CLI argument with `--out` to check that the file passed
+    by the user actually exists.
+
+    The second argument is the name of the formatter, used to print a useful
+    error message if the file can't be created for some reason.
+
+    Given a file named "features/f.feature" with:
+      """
+      Feature: Test
+        Scenario: Test
+      """
+    And a file named "features/support/custom_formatter.rb" with:
+      """
+      require 'cucumber/formatter/io'
+      module Cucumber
+        module Formatter
+          class Test
+            include Io
+            def initialize(runtime, path_or_io, options)
+              ensure_file("my/special/output.file", "custom formatter")
+            end
+          end
+        end
+      end
+      """
+    When I run `cucumber features/f.feature --format Cucumber::Formatter::Test`
+    Then it should pass

data/features/docs/profiles.feature

@@ -84,10 +84,10 @@ Feature: Profiles
   Scenario: Overriding the profile's features to run
     Given a file named "features/another.feature" with:
       """
-      Feature: Just this one should be ran
+      Feature: Just this one should be run
       """
     When I run `cucumber -p default features/another.feature`
-    Then exactly these features should be ran: features/another.feature
+    Then exactly these features should be run: features/another.feature
 
   Scenario: Overriding the profile's formatter
     You will most likely want to define a formatter in your default formatter.

data/features/lib/step_definitions/profile_steps.rb

@@ -10,6 +10,6 @@ Then /^exactly these files should be loaded:\s*(.*)$/ do |files|
   expect(all_stdout.scan(/^  \* (.*\.rb)$/).flatten).to eq files.split(/,\s+/)
 end
 
-Then /^exactly these features should be ran:\s*(.*)$/ do |files|
+Then /^exactly these features should be run:\s*(.*)$/ do |files|
   expect(all_stdout.scan(/^  \* (.*\.feature)$/).flatten).to eq files.split(/,\s+/)
 end

data/lib/cucumber.rb

@@ -21,10 +21,17 @@ module Cucumber
       @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}")
+    if Cucumber::RUBY_1_9
+      # Backported from Ruby 2.0 to 1.9
+      def Hash(other)
+        return {} if other.nil? || other == []
+        raise TypeError, "can't convert #{other.class} into Hash" unless other.respond_to?(:to_hash)
+        other.to_hash
+      end
+    else
+      def Hash(other)
+        Kernel::Hash(other)
+      end
     end
   end
 end

data/lib/cucumber/cli/configuration.rb

@@ -114,7 +114,7 @@ module Cucumber
       end
 
       def to_hash
-        Hash.try_convert(@options).merge(out_stream: @out_stream, error_stream: @error_stream)
+        Cucumber::Hash(@options).merge(out_stream: @out_stream, error_stream: @error_stream)
       end
 
       private
@@ -139,4 +139,4 @@ module Cucumber
       end
     end
   end
-end
+end

data/lib/cucumber/cli/options.rb

@@ -294,7 +294,7 @@ TEXT
       end
 
       def to_hash
-        Hash.try_convert(@options)
+        Cucumber::Hash(@options)
       end
 
     protected
@@ -456,4 +456,4 @@ TEXT
     end
 
   end
-end
+end

data/lib/cucumber/configuration.rb

@@ -3,6 +3,9 @@ require 'cucumber/cli/rerun_file'
 require 'cucumber/events'
 require 'forwardable'
 require 'cucumber/core/gherkin/tag_expression'
+require 'cucumber'
+require 'event/bus'
+require 'event/name_resolver'
 
 module Cucumber
   # The base class for configuring settings for a Cucumber run.
@@ -28,11 +31,11 @@ module Cucumber
     def_instance_delegator :event_bus, :notify
 
     def initialize(user_options = {})
-      @options = default_options.merge(Hash.try_convert(user_options))
+      @options = default_options.merge(Cucumber::Hash(user_options))
     end
 
     def with_options(new_options)
-      self.class.new(new_options.merge(@options))
+      self.class.new(@options.merge(new_options))
     end
 
     # TODO: Actually Deprecate???
@@ -193,6 +196,25 @@ module Cucumber
       @options
     end
 
+    # An array of procs that can generate snippets for undefined steps. These procs may be called if a
+    # formatter wants to display snippets to the user.
+    #
+    # Each proc should take the following arguments:
+    # 
+    #  - keyword
+    #  - step text
+    #  - multiline argument
+    #  - snippet type
+    #
+    def snippet_generators
+      @options[:snippet_generators] ||= []
+    end
+
+    def register_snippet_generator(generator)
+      snippet_generators << generator
+      self
+    end
+
   private
 
     def default_options
@@ -212,7 +234,7 @@ module Cucumber
         :snippets            => true,
         :source              => true,
         :duration            => true,
-        :event_bus           => Events::Bus.new(Cucumber::Events)
+        :event_bus           => Event::Bus.new(Event::NameResolver.new(Cucumber::Events))
       }
     end
 

data/lib/cucumber/deprecate.rb

@@ -0,0 +1,29 @@
+require 'cucumber/platform'
+require 'cucumber/gherkin/formatter/ansi_escapes'
+
+module Cucumber
+  module Deprecate
+    module ForUsers
+      AnsiEscapes = Cucumber::Gherkin::Formatter::AnsiEscapes
+
+      def self.call(message, method, remove_after_version)
+        STDERR.puts AnsiEscapes.failed + "WARNING: #{method} is deprecated and will be removed after version #{remove_after_version}. #{message}" + AnsiEscapes.reset
+      end
+    end
+
+    module ForDevelopers
+      def self.call(message, method, remove_after_version)
+        if Cucumber::VERSION > remove_after_version
+          raise "This method is due for removal after version #{remove_after_version}"
+        end
+      end
+    end
+
+    Strategy = $0.match(/rspec$/) ? ForDevelopers : ForUsers
+  end
+
+  def self.deprecate(*args)
+    Deprecate::Strategy.call(*args)
+  end
+
+end

data/lib/cucumber/filters/activate_steps.rb

@@ -1,17 +1,21 @@
 require 'cucumber/core/filter'
+require 'cucumber/step_match'
+require 'cucumber/events'
+require 'cucumber/errors'
 
 module Cucumber
   module Filters
-    class ActivateSteps < Core::Filter.new(:step_definitions)
+    class ActivateSteps < Core::Filter.new(:step_match_search, :configuration)
 
       def test_case(test_case)
-        CaseFilter.new(test_case, step_definitions).test_case.describe_to receiver
+        CaseFilter.new(test_case, step_match_search, configuration).test_case.describe_to receiver
       end
 
       class CaseFilter
-        def initialize(test_case, step_definitions)
+        def initialize(test_case, step_match_search, configuration)
           @original_test_case = test_case
-          @step_definitions = step_definitions
+          @step_match_search = step_match_search
+          @configuration = configuration
         end
 
         def test_case
@@ -25,7 +29,37 @@ module Cucumber
         end
 
         def attempt_to_activate(test_step)
-          @step_definitions.find_match(test_step).activate(test_step)
+          find_match(test_step).activate(test_step)
+        end
+
+        def find_match(test_step)
+          FindMatch.new(@step_match_search, @configuration, test_step).result
+        end
+
+        class FindMatch
+          def initialize(step_match_search, configuration, test_step)
+            @step_match_search, @configuration, @test_step = step_match_search, configuration, test_step
+          end
+
+          def result
+            return NoStepMatch.new(test_step.source.last, test_step.name) unless matches.any?
+            configuration.notify Events::StepMatch.new(test_step, match)
+            return SkippingStepMatch.new if configuration.dry_run?
+            match
+          end
+
+          private
+
+          attr_reader :step_match_search, :configuration, :test_step
+          private :step_match_search, :configuration, :test_step
+
+          def match
+            matches.first
+          end
+
+          def matches
+            step_match_search.call(test_step.name)
+          end
         end
       end
     end

data/lib/cucumber/formatter/console.rb

@@ -69,7 +69,8 @@ module Cucumber
           if status == :failed
             print_exception(element.exception, status, 0)
           else
-            @io.puts(format_string(element.backtrace_line, status))
+            message = linebreaks(element.backtrace_line, ENV['CUCUMBER_TRUNCATE_OUTPUT'].to_i)
+            @io.puts(format_string(message, status))
           end
           @io.puts
           @io.flush
@@ -123,9 +124,7 @@ module Cucumber
 
       def print_exception(e, status, indent)
         message = "#{e.message} (#{e.class})".force_encoding("UTF-8")
-        if ENV['CUCUMBER_TRUNCATE_OUTPUT']
-          message = linebreaks(message, ENV['CUCUMBER_TRUNCATE_OUTPUT'].to_i)
-        end
+        message = linebreaks(message, ENV['CUCUMBER_TRUNCATE_OUTPUT'].to_i)
 
         string = "#{message}\n#{e.backtrace.join("\n")}".indent(indent)
         @io.puts(format_string(string, status))
@@ -133,6 +132,7 @@ module Cucumber
 
       # http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/10655
       def linebreaks(s, max)
+        return s unless max && max > 0
         s.gsub(/.{1,#{max}}(?:\s|\Z)/){($& + 5.chr).gsub(/\n\005/,"\n").gsub(/\005/,"\n")}.rstrip
       end