cucumber-core 1.5.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1fc45a561bb99340344287c1e671c9cdfe5c3e7
-  data.tar.gz: 71d6d270193517dec221d7a61a557abae8bdbeb0
+  metadata.gz: bb172018d9e05188dafca358b06cfe31d5d10575
+  data.tar.gz: d41a9aa632138309140db42346519eeb349ee322
 SHA512:
-  metadata.gz: 39f345c74c57332f0022faaab37e74cbb6029d544551435a9ab0b2986af82c4c6c33f13554315bf5a01fe5e00760bedbcb131cc9454fceac38025933dd93e07d
-  data.tar.gz: 3dfc0894b9e62ecffc08f39b85acc0bfd4ddea7e5bda3ebd11a7fe164011a383e667abee3c0158268b2fcca35607c7c3bb433c338a8ddae731fb63248867ecad
+  metadata.gz: 117f9542f1c84472c5cac771e2eff5284ea9be7f965d40d0e8163b13f8d455e3f1c7654467936fa4da55fd0b4de242eb6677557896239f140da1bd41156f4328
+  data.tar.gz: 7e911a2e55a093cfd2dd73945d31df73d2504aa5cd88bb1a06f5778d234e5803a039856597595468c408b8ee6b864f6752d575f5753e499a19793dcf3a57166f

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,48 @@
+<!-- These sections are meant as guidance for you, to help you give the kind of information we'll need to help with your issue. If a section  doesn't seem to fit, just skip it.
+
+In general: Please provide as much information as you can to help us solving your problem -->
+
+## Summary
+
+<!--- Provide a general summary description of the issue -->
+
+## Expected Behavior
+
+<!--- If you're describing a bug, tell us what should happen -->
+<!--- If you're suggesting a change/improvement, tell us how it should work -->
+<!--- Feel free to use Given / Then / Then if that helps, but please add some plain-language context too -->
+
+## Current Behavior
+
+<!--- If describing a bug, tell us what happens instead of the expected behavior -->
+<!--- If suggesting a change/improvement, explain the difference from current behavior -->
+
+<!--- If you have got some output place it in the code block below. Otherwise remove it. -->
+~~~
+~~~
+
+## Possible Solution
+
+<!--- Not obligatory, but suggest a fix/reason for the bug, -->
+<!--- or ideas how to implement the addition or change -->
+
+## Steps to Reproduce (for bugs)
+
+<!--- Provide a link to a live example, or an unambiguous set of steps to -->
+<!--- reproduce this bug. Include code to reproduce, if relevant -->
+1.
+2.
+3.
+4.
+
+## Context & Motivation
+
+<!--- How has this issue affected you? What are you trying to accomplish? -->
+<!--- Providing context helps us come up with a solution that is most useful in the real world -->
+
+## Your Environment
+
+<!--- If you're reporting a bug, include as many relevant details about the environment you experienced the bug in -->
+* Version used:
+* Operating System and version:
+* Link to your project:

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,39 @@
+<!-- These sections are meant as guidance for you. If something doesn't fit, you can just skip it. -->
+
+## Summary
+
+<!--- Provide a general summary description of your changes -->
+
+## Details
+
+<!--- Describe your changes in detail -->
+
+## Motivation and Context
+
+<!--- Why is this change required? What problem does it solve? -->
+<!--- If it fixes an open issue, please link to the issue here. -->
+
+## How Has This Been Tested?
+
+<!--- Please add tests for changes to the code, otherwise we probably won't merge it -->
+
+<!--- Please describe in detail how you tested your changes. -->
+<!--- Include details of your testing environment, tests ran to see how -->
+<!--- your change affects other areas of the code, etc. -->
+
+## Screenshots (if appropriate):
+
+## Types of changes
+
+<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+
+## Checklist:
+
+<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
+<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+- [ ] I've added tests for my code
+- [ ] My change requires a change to the documentation.
+- [ ] I have updated the documentation accordingly.

data/.travis.yml

@@ -1,17 +1,16 @@
 sudo: false
 
 rvm:
+  - 2.3.0
   - 2.2
   - 2.1
   - 2.0.0
-  - 1.9.3
-  - jruby
+  - jruby-9.0.5.0
 
 # whitelist
 branches:
   only:
     - master
-    - v1.x-bugfix
 
 notifications:
   email:

data/HISTORY.md

@@ -1,9 +1,20 @@
-## [In Git](https://github.com/cucumber/cucumber-ruby-core/compare/v1.5.0...v1.x-bugfix)
+## [In Git](https://github.com/cucumber/cucumber-ruby-core/compare/v1.5.0...master)
 
 ### New Features
 
+ * Implement equality for test cases ([#111](https://github.com/cucumber/cucumber-ruby-core/pull/111) @mattwynne)
+ * Implement an event bus (moved from Cucumber-Ruby) ([#106](https://github.com/cucumber/cucumber-ruby-core/pull/106) @mattwynne)
+ * Use frozen string literals ([#105](https://github.com/cucumber/cucumber-ruby-core/pull/105) @twalpole)
+
 ### Bugfixes
 
+* Handle incomplete examples to scenario outlines. ([109](https://github.com/cucumber/cucumber-ruby-core/pull/109) @brasmusson)
+* Add with_filtered_backtrace method to unknown result ([107](https://github.com/cucumber/cucumber-ruby-core/pull/107) @danascheider)
+
+### Removed Features
+
+* Remove support for Ruby v1.9.3. ([112](https://github.com/cucumber/cucumber-ruby-core/pull/112) @brasmusson)
+
 ## [v1.5.0](https://github.com/cucumber/cucumber-ruby-core/compare/v1.4.0...v1.5.0)
 
 ### New Features

data/README.md

@@ -1,4 +1,4 @@
-# cucumber-core
+#cucumber-core
 
 [![Chat with us](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-core.svg)](http://travis-ci.org/cucumber/cucumber-ruby-core)
@@ -10,61 +10,59 @@ Cucumber Core is the [inner hexagon](http://alistair.cockburn.us/Hexagonal+archi
 
 It contains the core domain logic to execute Cucumber features. It has no user interface, just a Ruby API. If you're interested in how Cucumber works, or in building other tools that work with Gherkin documents, you've come to the right place.
 
-## An overview
+##An overview
 
-The entry-point is a single method on the module `Cucumber::Core` called [`#execute`](http://rubydoc.info/gems/cucumber-core/Cucumber/Core#execute-instance_method). Here's what it does:
+The entry-point is a single method on the module [`Cucumber::Core`](Cucumber/Core.html) called [`#execute`](Cucumber/Core.html#execute-instance_method). Here's what it does:
 
 1. Parses the plain-text Gherkin documents into an **AST**
 2. Compiles the AST down to **test cases**
-3. Passes the activated test cases through any **filters**
-4. Executes the test cases, calling back to the **report**
+3. Passes the test cases through any **filters**
+4. Executes the test cases, emitting **events** as it goes
 
 We've introduced a number of concepts here, so let's go through them in detail.
 
-### The AST
+###The AST
 
-The Abstract Syntax Tree or [AST](http://rubydoc.info/gems/cucumber-core/Cucumber/Core/Ast) is an object graph that represents the Gherkin documents you've passed into the core. Things like [Feature](http://rubydoc.info/gems/cucumber-core/Cucumber/Core/Ast/Feature), [Scenario](http://rubydoc.info/gems/cucumber-core/Cucumber/Core/Ast/Scenario) and [ExamplesTable](ExamplesTable).
+The Abstract Syntax Tree or [AST](Cucumber/Core/Ast.html) is an object graph that represents the Gherkin documents you've passed into the core. Things like [Feature](Cucumber/Core/Ast/Feature.html), [Scenario](Cucumber/Core/Ast/Scenario.html) and [ExamplesTable](Cucumber/Core/Ast/ExamplesTable.html).
 
 These are immutable value objects.
 
-### Test cases
+###Test cases
 
 Your gherkin might contain scenarios, as well as examples from tables beneath a scenario outline.
 
-Test cases represent the general case of both of these. We compile the AST down to instances of [`Cucumber::Core::Test::Case`](http://rubydoc.info/gems/cucumber-core/Cucumber/Core/Test/Case), each containing a number of instances of [`Cucumber::Core::Test::Step`](http://rubydoc.info/gems/cucumber-core/Cucumber/Core/Test/Step). It's these that are then filtered and executed.
+Test cases represent the general case of both of these. We compile the AST down to instances of [`Cucumber::Core::Test::Case`](Cucumber/Core/Test/Case.html), each containing a number of instances of [`Cucumber::Core::Test::Step`](Cucumber/Core/Test/Step.html). It's these that are then filtered and executed.
 
 Test cases and their test steps are also immutable value objects.
 
-### Filters
+###Filters
 
 Once we have the test cases, and they've been activated by the mappings, you may want to pass them through a filter or two. Filters can be used to do things like activate, sort, replace or remove some of the test cases or their steps before they're executed.
 
-### Report
+###Events
 
-A report is how you find out what is happening during your test run. As the test cases and steps are executed, messages are sent to the report.
+Events are how you find out what is happening during your test run. As the test cases and steps are executed, the runner emits events to signal what's going on.
 
-A report needs to respond to the following methods:
+The following events are emitted during a run:
 
-* `before_test_case(test_case)`
-* `after_test_case(test_case, result)`
-* `before_test_step(test_step)`
-* `after_test_step(test_test, result)`
-* `done`
+- [`TestCaseStarting`](Cucumber/Core/Events/TestCaseStarting.html)
+- [`TestStepStarting`](Cucumber/Core/Events/TestStepStarting.html)
+- [`TestStepFinished`](Cucumber/Core/Events/TestStepFinished.html)
+- [`TestCaseFinished`](Cucumber/Core/Events/TestCaseFinished.html)
 
 That's probably best illustrated with an example.
 
-## Example
+##Example
 
-Here's an example of how you might use [`Cucumber::Core#execute`](http://rubydoc.info/gems/cucumber-core/Cucumber/Core#execute-instance_method)
+Here's an example of how you might use [`Cucumber::Core#execute`](Cucumber/Core#execute-instance_method)
 
 ```ruby
 require 'cucumber/core'
 require 'cucumber/core/filter'
 
-class MyRunner
-  include Cucumber::Core
-end
-
+# This is the most complex part of the example. The filter takes test cases as input,
+# activates each step with an action block, then passes a new test case with those activated
+# steps in it on to the next filter in the chain.
 class ActivateSteps < Cucumber::Core::Filter.new
   def test_case(test_case)
     test_steps = test_case.test_steps.map do |step|
@@ -75,6 +73,7 @@ class ActivateSteps < Cucumber::Core::Filter.new
   end
 
   private
+
   def activate(step)
     case step.name
     when /fail/
@@ -87,24 +86,7 @@ class ActivateSteps < Cucumber::Core::Filter.new
   end
 end
 
-class Report
-  def before_test_step(test_step)
-  end
-
-  def after_test_step(test_step, result)
-    puts "#{test_step.name} #{result}"
-  end
-
-  def before_test_case(test_case)
-  end
-
-  def after_test_case(test_case, result)
-  end
-
-  def done
-  end
-end
-
+# Create a Gherkin document to run
 feature = Cucumber::Core::Gherkin::Document.new(__FILE__, <<-GHERKIN)
 Feature:
   Scenario:
@@ -113,7 +95,19 @@ Feature:
     And undefined
 GHERKIN
 
-MyRunner.new.execute([feature], Report.new, [ActivateSteps.new])
+# Create a runner class that uses the Core's DSL
+class MyRunner
+  include Cucumber::Core
+end
+
+# Now execute the feature, using the filter we built, and subscribing to
+# an event so we can print the output.
+MyRunner.new.execute([feature], [ActivateSteps.new]) do |events|
+  events.on(:test_step_finished) do |event|
+    test_step, result = event.test_step, event.result
+    puts "#{test_step.name} #{result}"
+  end
+end
 ```
 
 If you run this little Ruby script, you should see the following output:

data/cucumber-core.gemspec

@@ -15,12 +15,14 @@ Gem::Specification.new do |s|
   s.required_ruby_version = ">= 1.9.3"
 
   s.add_dependency 'gherkin', '~> 4.0'
+  s.add_dependency 'backports', '~> 3.6'
 
   s.add_development_dependency 'bundler',   '>= 1.3.5'
   s.add_development_dependency 'rake',      '>= 0.9.2'
   s.add_development_dependency 'rspec',     '~> 3'
   s.add_development_dependency 'unindent',  '>= 1.0'
   s.add_development_dependency 'kramdown',  '~> 1.4.2'
+  s.add_development_dependency 'yard'
 
   # For coverage reports
   s.add_development_dependency 'coveralls', '~> 0.7'

data/lib/cucumber/core.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+require 'cucumber/core/event_bus'
 require 'cucumber/core/gherkin/parser'
 require 'cucumber/core/gherkin/document'
 require 'cucumber/core/compiler'
@@ -6,8 +8,9 @@ require 'cucumber/core/test/runner'
 module Cucumber
   module Core
 
-    def execute(gherkin_documents, report, filters = [])
-      receiver = Test::Runner.new(report)
+    def execute(gherkin_documents, filters = [], event_bus = EventBus.new)
+      yield event_bus if block_given?
+      receiver = Test::Runner.new(event_bus)
       compile gherkin_documents, receiver, filters
       self
     end

data/lib/cucumber/core/ast.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/core/ast/comment'
 require 'cucumber/core/ast/tag'
 require 'cucumber/core/ast/feature'

data/lib/cucumber/core/ast/background.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/core/ast/names'
 require 'cucumber/core/ast/location'
 require 'cucumber/core/ast/describes_itself'

data/lib/cucumber/core/ast/comment.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/core/ast/location'
 
 module Cucumber

data/lib/cucumber/core/ast/data_table.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/core/ast/describes_itself'
 require 'cucumber/core/ast/location'
 

data/lib/cucumber/core/ast/describes_itself.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   module Core
     module Ast

data/lib/cucumber/core/ast/doc_string.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/core/ast/describes_itself'
 require 'delegate'
 module Cucumber

data/lib/cucumber/core/ast/empty_background.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   module Core
     module Ast

data/lib/cucumber/core/ast/empty_multiline_argument.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   module Core
     module Ast

data/lib/cucumber/core/ast/examples_table.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/core/ast/describes_itself'
 require 'cucumber/core/ast/location'
 require 'cucumber/core/ast/names'

data/lib/cucumber/core/ast/feature.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/core/ast/describes_itself'
 require 'cucumber/core/ast/names'
 require 'cucumber/core/ast/location'

data/lib/cucumber/core/ast/location.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'forwardable'
 require 'cucumber/core/platform'
 module Cucumber

data/lib/cucumber/core/ast/names.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   module Core
     module Ast

data/lib/cucumber/core/ast/outline_step.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/core/ast/location'
 require 'cucumber/core/ast/describes_itself'
 require 'cucumber/core/ast/step'

data/lib/cucumber/core/ast/scenario.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/core/ast/describes_itself'
 require 'cucumber/core/ast/names'
 require 'cucumber/core/ast/empty_background'

data/lib/cucumber/core/ast/scenario_outline.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/core/ast/names'
 require 'cucumber/core/ast/location'
 require 'cucumber/core/ast/describes_itself'

data/lib/cucumber/core/ast/step.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/core/ast/describes_itself'
 require 'cucumber/core/ast/location'
 

data/lib/cucumber/core/ast/tag.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   module Core
     module Ast

data/lib/cucumber/core/compiler.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/core/test/case'
 require 'cucumber/core/test/step'
 

data/lib/cucumber/core/event.rb

@@ -0,0 +1,63 @@
+require 'backports/2.1.0/array/to_h'
+
+module Cucumber
+  module Core
+    class Event
+
+      # Macro to generate new sub-classes of {Event} with
+      # attribute readers.
+      def self.new(*attributes)
+        # Use normal constructor for subclasses of Event
+        return super if self.ancestors.index(Event) > 0
+
+        Class.new(Event) do
+          attr_reader(*attributes)
+
+          define_method(:initialize) do |*args|
+            attributes.zip(args) do |name, value|
+              instance_variable_set "@#{name}".to_sym, value
+            end
+          end
+
+          define_method(:attributes) do
+            attributes.map { |attribute| self.send(attribute) }
+          end
+
+          define_method(:to_h) do
+            attributes.reduce({}) { |result, attribute| 
+              value = self.send(attribute)
+              result[attribute] = value
+              result
+            }
+          end
+
+          define_method(:event_id) do
+            self.class.event_id
+          end
+        end
+      end
+
+
+      class << self
+
+        # @return [Symbol] the underscored name of the class to be used
+        #                  as the key in an event registry.
+        def event_id
+          underscore(self.name.split("::").last).to_sym
+        end
+
+        private
+
+        def underscore(string)
+          string.to_s.gsub(/::/, '/').
+          gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+          gsub(/([a-z\d])([A-Z])/,'\1_\2').
+          tr("-", "_").
+          downcase
+        end
+
+      end
+
+    end
+  end
+end