cucumber-core 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0a8905410eaa2520b979eefe561fdd066e0c703
-  data.tar.gz: 882b6415e6c942bce875cbef62c3afadd5964dcc
+  metadata.gz: 53a124c933b4697ed6128b46c307617ea4399559
+  data.tar.gz: e80a381d06f95b5416035f91a004d00cbd68057e
 SHA512:
-  metadata.gz: b3f6a53c774b90832b8f6e86245a7107e4ebab450b8c7aa5d714309a7e3c367c60cbff5e06bbbfb67a6b2b8e853e2b32efbfef64f81dfe48b99d18ead9864132
-  data.tar.gz: 6e3c7953c11347def64e8fd184f3a2f11514ae24d1204c2ae9d52bb48518ab7a1fb1e6d15c3305e549c9c683af390b155d6c3888546dba970212499800ef5142
+  metadata.gz: 0b1e3a4359e8ccaeef234bfa1492e678145bf1f07320ffbf1e01814b2efd405da9ae10abb31347ac10642e49935183032b1f7a094631219c48d7a4b984c5e6cf
+  data.tar.gz: e7d0c05ae5e57937e6858c91485157175e69d32332457db403a69d1e8b44e9a99bf95cc68e2bdb1b265ad5decaa69086fbca3a0d48e6cf97ca6cf64b4b54e855

data/HISTORY.md

@@ -1,6 +1,20 @@
-## [In Git](https://github.com/cucumber/cucumber-ruby-core/compare/v1.1.3...master)
+## [In Git](https://github.com/cucumber/cucumber-ruby-core/compare/v1.2.0...master)
 
-## [v1.1.3](https://github.com/cucumber/cucumber-ruby-core/compare/v1.1.2...v1.1.2)
+...
+
+## [v1.2.0](https://github.com/cucumber/cucumber-ruby-core/compare/v1.1.3...v1.2.0)
+
+### New Features
+
+ * Enable the location of actions to be the step or hook location (@brasmusson)
+ * Add the comments to the Steps, Examples tables and Examples table rows Ast classes (@brasmusson)
+ * Expose name, description and examples_rows attributes of `Ast::ExamplesTable` (@mattwynne)
+ * Add #to_sym to Cucumber::Core::Test::Result classes ([#89](https://github.com/cucumber/cucumber-ruby-core/pull/89) @pdswan)
+ * Add #ok? to Cucumber::Core::Test::Result classes ([#92](https://github.com/cucumber/cucumber-ruby-core/pull/92) @brasmusson)
+
+### Bugfixes
+
+## [v1.1.3](https://github.com/cucumber/cucumber-ruby-core/compare/v1.1.2...v1.1.3)
 
 ### New Features
 

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

@@ -10,23 +10,22 @@ module Cucumber
         include HasLocation
         include DescribesItself
 
-        def initialize(gherkin_statement, language, location, comments, keyword, title, description, raw_steps)
+        def initialize(gherkin_statement, language, location, comments, keyword, name, description, raw_steps)
           @gherkin_statement = gherkin_statement
           @language = language
           @location = location
           @comments = comments
           @keyword = keyword
-          @title = title
+          @name = name
           @description = description
           @raw_steps = raw_steps
         end
 
-        attr_reader :language, :title, :description, :raw_steps
-        private     :language, :title, :description, :raw_steps
+        attr_reader :language, :description, :raw_steps
+        private     :language, :raw_steps
 
-        attr_accessor :feature
-        attr_accessor :comments, :keyword, :location
-        attr_reader   :gherkin_statement
+        attr_reader :comments, :keyword, :location
+        attr_reader :gherkin_statement
 
         def children
           raw_steps

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

@@ -7,7 +7,7 @@ module Cucumber
         include HasLocation
 
         attr_reader :location, :value
-        private :location, :value
+        private :value
 
         def initialize(location, value)
           @location = location

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

@@ -22,7 +22,6 @@ module Cucumber
       class DocString < SimpleDelegator
         include HasLocation
         include DescribesItself
-        attr_accessor :file
 
         attr_reader :content_type, :content
 

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

@@ -11,21 +11,20 @@ module Cucumber
         include HasLocation
         include DescribesItself
 
-        def initialize(gherkin_statement, location, comments, tags, keyword, title, description, header, example_rows)
+        def initialize(gherkin_statement, location, comments, tags, keyword, name, description, header, example_rows)
           @gherkin_statement = gherkin_statement
           @location = location
           @comments = comments
           @tags = tags
           @keyword = keyword
-          @title = title
+          @name = name
           @description = description
           @header = header
           @example_rows = example_rows
         end
 
         attr_reader :gherkin_statement, :location, :comments, :tags, :keyword,
-                    :title, :description, :header, :example_rows
-        private :title, :description, :example_rows
+                    :header, :example_rows
 
         private
 
@@ -40,17 +39,20 @@ module Cucumber
         class Header
           include HasLocation
 
-          def initialize(cells, location)
+          attr_reader :comments
+
+          def initialize(cells, location, comments)
             @cells = cells
             @location = location
+            @comments = comments
           end
 
           def values
             @cells
           end
 
-          def build_row(row_cells, number, location, language)
-            Row.new(Hash[@cells.zip(row_cells)], number, location, language)
+          def build_row(row_cells, number, location, language, comments)
+            Row.new(Hash[@cells.zip(row_cells)], number, location, language, comments)
           end
 
           def inspect
@@ -62,14 +64,15 @@ module Cucumber
           include DescribesItself
           include HasLocation
 
-          attr_reader :number, :language
+          attr_reader :number, :language, :comments
 
-          def initialize(data, number, location, language)
+          def initialize(data, number, location, language, comments)
             raise ArgumentError, data.to_s unless data.is_a?(Hash)
             @data = data
             @number = number
             @location = location
             @language = language
+            @comments = comments
           end
 
           def ==(other)

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

@@ -12,11 +12,10 @@ module Cucumber
         include DescribesItself
 
         attr_reader :gherkin_statement, :language, :location, :background,
-                    :comments, :tags, :keyword, :title, :description,
+                    :comments, :tags, :keyword, :description,
                     :feature_elements
-        private :description
 
-        def initialize(gherkin_statement, language, location, background, comments, tags, keyword, title, description, feature_elements)
+        def initialize(gherkin_statement, language, location, background, comments, tags, keyword, name, description, feature_elements)
           @gherkin_statement = gherkin_statement
           @language = language
           @location = location
@@ -24,7 +23,7 @@ module Cucumber
           @comments = comments
           @tags = tags
           @keyword = keyword
-          @title = title
+          @name = name
           @description = description
           @feature_elements = feature_elements
         end

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

@@ -2,25 +2,21 @@ module Cucumber
   module Core
     module Ast
       module Names
-        attr_reader :description
-
-        def name
-          title
-        end
+        attr_reader :description, :name
 
         def title
           warn("deprecated. Use #name")
-          @title
+          name
         end
 
         def legacy_conflated_name_and_description
-          s = @title
+          s = name
           s += "\n#{@description}" if @description != ""
           s
         end
 
         def to_s
-          @title
+          name
         end
 
         def inspect

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

@@ -10,15 +10,15 @@ module Cucumber
         include HasLocation
         include DescribesItself
 
-        attr_reader :gherkin_statement, :language, :location, :keyword, :name, :multiline_arg
+        attr_reader :gherkin_statement, :language, :location, :comments, :keyword, :name, :multiline_arg
 
-        def initialize(gherkin_statement, language, location, keyword, name, multiline_arg)
-          @gherkin_statement, @language, @location, @keyword, @name, @multiline_arg = gherkin_statement, language, location, keyword, name, multiline_arg
+        def initialize(gherkin_statement, language, location, comments, keyword, name, multiline_arg)
+          @gherkin_statement, @language, @location, @comments, @keyword, @name, @multiline_arg = gherkin_statement, language, location, comments, keyword, name, multiline_arg
           @language || raise("Language is required!")
         end
 
         def to_step(row)
-          Ast::ExpandedOutlineStep.new(self, gherkin_statement, language, row.location, keyword, row.expand(name), replace_multiline_arg(row))
+          Ast::ExpandedOutlineStep.new(self, gherkin_statement, language, row.location, comments, keyword, row.expand(name), replace_multiline_arg(row))
         end
 
         def inspect

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

@@ -12,11 +12,11 @@ module Cucumber
         include DescribesItself
 
         attr_reader :gherkin_statement, :language, :location, :background,
-                    :comments, :tags, :feature_tags, :keyword, :title,
+                    :comments, :tags, :feature_tags, :keyword,
                     :description, :raw_steps
-        private :raw_steps, :description
+        private :raw_steps
 
-        def initialize(gherkin_statement, language, location, background, comments, tags, feature_tags, keyword, title, description, raw_steps)
+        def initialize(gherkin_statement, language, location, background, comments, tags, feature_tags, keyword, name, description, raw_steps)
           @gherkin_statement = gherkin_statement
           @language          = language
           @location          = location
@@ -25,7 +25,7 @@ module Cucumber
           @tags              = tags
           @feature_tags      = feature_tags
           @keyword           = keyword
-          @title             = title
+          @name              = name
           @description       = description
           @raw_steps         = raw_steps
         end

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

@@ -14,12 +14,11 @@ module Cucumber
         MissingExamples = Class.new(StandardError)
 
         attr_reader :gherkin_statement, :language, :background, :comments,
-                    :tags, :feature_tags, :keyword, :title, :description,
+                    :tags, :feature_tags, :keyword,
                     :steps, :examples_tables, :line
-        private :language, :background, :comments, :feature_tags,
-                :line
+        private :language, :background, :feature_tags, :line
 
-        def initialize(gherkin_statement, language, location, background, comments, tags, feature_tags, keyword, title, description, steps, examples_tables)
+        def initialize(gherkin_statement, language, location, background, comments, tags, feature_tags, keyword, name, description, steps, examples_tables)
           @gherkin_statement = gherkin_statement
           @language          = language
           @location          = location
@@ -28,7 +27,7 @@ module Cucumber
           @tags              = tags
           @feature_tags      = feature_tags
           @keyword           = keyword
-          @title             = title
+          @name              = name
           @description       = description
           @steps             = steps
           @examples_tables   = examples_tables

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

@@ -8,10 +8,10 @@ module Cucumber
         include HasLocation
         include DescribesItself
 
-        attr_reader :keyword, :name, :language, :exception, :multiline_arg, :gherkin_statement
+        attr_reader :keyword, :name, :language, :comments, :exception, :multiline_arg, :gherkin_statement
 
-        def initialize(gherkin_statement, language, location, keyword, name, multiline_arg)
-          @gherkin_statement, @language, @location, @keyword, @name, @multiline_arg = gherkin_statement, language, location, keyword, name, multiline_arg
+        def initialize(gherkin_statement, language, location, comments, keyword, name, multiline_arg)
+          @gherkin_statement, @language, @location, @comments, @keyword, @name, @multiline_arg = gherkin_statement, language, location, comments, keyword, name, multiline_arg
         end
 
         def to_sexp
@@ -52,8 +52,8 @@ module Cucumber
 
       class ExpandedOutlineStep < Step
 
-        def initialize(outline_step, gherkin_statement, language, location, keyword, name, multiline_arg)
-          @outline_step, @gherkin_statement, @language, @location, @keyword, @name, @multiline_arg = outline_step, gherkin_statement, language, location, keyword, name, multiline_arg
+        def initialize(outline_step, gherkin_statement, language, location, comments, keyword, name, multiline_arg)
+          @outline_step, @gherkin_statement, @language, @location, @comments, @keyword, @name, @multiline_arg = outline_step, gherkin_statement, language, location, comments, keyword, name, multiline_arg
         end
 
         alias :self_match_locations? :match_locations?

data/lib/cucumber/core/gherkin/ast_builder.rb

@@ -215,6 +215,7 @@ module Cucumber
                 node,
                 language,
                 location,
+                comments,
                 node.keyword,
                 node.name,
                 
@@ -289,16 +290,24 @@ module Cucumber
 
             def header
               row = node.rows[0]
-              Ast::ExamplesTable::Header.new(row.cells, location)
+              Ast::ExamplesTable::Header.new(row.cells, location, row_comments(row))
             end
 
             def example_rows(language)
               _, *raw_examples = *node.rows
               raw_examples.each_with_index.map do |row, index|
-                header.build_row(row.cells, index + 1, location.on_line(row.line), language)
+                header.build_row(row.cells, index + 1, location.on_line(row.line), language, row_comments(row))
               end
             end
 
+            def row_comments(row)
+              row.comments.map do |comment|
+                Ast::Comment.new(
+                  Ast::Location.new(file, comment.line), 
+                  comment.value
+                )
+              end
+            end
           end
 
           class StepBuilder < Builder
@@ -307,6 +316,7 @@ module Cucumber
                 node,
                 language,
                 location,
+                comments,
                 node.keyword,
                 node.name,
                 MultilineArgument.from(node.doc_string || node.rows, location)

data/lib/cucumber/core/test/action.rb

@@ -7,8 +7,9 @@ module Cucumber
   module Core
     module Test
       class Action
-        def initialize(&block)
+        def initialize(location = nil, &block)
           raise ArgumentError, "Passing a block to execute the action is mandatory." unless block
+          @location = location ? location : Ast::Location.new(*block.source_location)
           @block = block
           @timer = Timer.new
         end
@@ -28,7 +29,7 @@ module Cucumber
         end
 
         def location
-          Ast::Location.new(*@block.source_location)
+          @location
         end
 
         def inspect
@@ -57,6 +58,12 @@ module Cucumber
       end
 
       class UndefinedAction
+        attr_reader :location
+
+        def initialize(source_location)
+          @location = source_location
+        end
+
         def execute(*)
           undefined
         end

data/lib/cucumber/core/test/result.rb

@@ -5,13 +5,19 @@ module Cucumber
     module Test
       module Result
 
+        # Defines to_sym on a result class for the given result type
+        #
         # Defines predicate methods on a result class with only the given one
         # returning true
-        def self.status_queries(status)
+        def self.query_methods(result_type)
           Module.new do
-            [:passed, :failed, :undefined, :unknown, :skipped, :pending].each do |possible_status|
-              define_method("#{possible_status}?") do
-                possible_status == status
+            define_method :to_sym do
+              result_type
+            end
+
+            [:passed, :failed, :undefined, :unknown, :skipped, :pending].each do |possible_result_type|
+              define_method("#{possible_result_type}?") do
+                possible_result_type == to_sym
               end
             end
           end
@@ -19,7 +25,7 @@ module Cucumber
 
         # Null object for results. Represents the state where we haven't run anything yet
         class Unknown
-          include Result.status_queries :unknown
+          include Result.query_methods :unknown
 
           def describe_to(visitor, *args)
             self
@@ -27,7 +33,7 @@ module Cucumber
         end
 
         class Passed
-          include Result.status_queries(:passed)
+          include Result.query_methods :passed
           attr_accessor :duration
 
           def initialize(duration)
@@ -44,14 +50,26 @@ module Cucumber
           def to_s
             "✓"
           end
+
+          def ok?(be_strict = false)
+            true
+          end
+
+          def with_appended_backtrace(step)
+            self
+          end
+
+          def with_filtered_backtrace(filter)
+            self
+          end
         end
 
         class Failed
-          include Result.status_queries(:failed)
+          include Result.query_methods :failed
           attr_reader :duration, :exception
 
           def initialize(duration, exception)
-            raise ArgumentError unless duration 
+            raise ArgumentError unless duration
             raise ArgumentError unless exception
             @duration = duration
             @exception = exception
@@ -68,13 +86,25 @@ module Cucumber
             "✗"
           end
 
+          def ok?(be_strict = false)
+            false
+          end
+
           def with_duration(new_duration)
             self.class.new(new_duration, exception)
           end
 
+          def with_appended_backtrace(step)
+            exception.backtrace << step.backtrace_line if step.respond_to?(:backtrace_line)
+            self
+          end
+
+          def with_filtered_backtrace(filter)
+            self.class.new(duration, filter.new(exception.dup).exception)
+          end
         end
 
-        # Base class for exceptions that can be raised in a step defintion causing 
+        # Base class for exceptions that can be raised in a step defintion causing
         # the step to have that result.
         class Raisable < StandardError
           attr_reader :message, :duration
@@ -92,10 +122,22 @@ module Cucumber
           def with_duration(new_duration)
             self.class.new(message, new_duration, backtrace)
           end
+
+          def with_appended_backtrace(step)
+            return self unless step.respond_to?(:backtrace_line)
+            set_backtrace([]) unless backtrace
+            backtrace << step.backtrace_line
+            self
+          end
+
+          def with_filtered_backtrace(filter)
+            return self unless backtrace
+            filter.new(dup).exception
+          end
         end
 
         class Undefined < Raisable
-          include Result.status_queries :undefined
+          include Result.query_methods :undefined
 
           def describe_to(visitor, *args)
             visitor.undefined(*args)
@@ -107,10 +149,13 @@ module Cucumber
             "?"
           end
 
+          def ok?(be_strict = false)
+            !be_strict
+          end
         end
 
         class Skipped < Raisable
-          include Result.status_queries :skipped
+          include Result.query_methods :skipped
 
           def describe_to(visitor, *args)
             visitor.skipped(*args)
@@ -122,10 +167,13 @@ module Cucumber
             "-"
           end
 
+          def ok?(be_strict = false)
+            true
+          end
         end
 
         class Pending < Raisable
-          include Result.status_queries :pending
+          include Result.query_methods :pending
 
           def describe_to(visitor, *args)
             visitor.pending(self, *args)
@@ -136,13 +184,17 @@ module Cucumber
           def to_s
             "P"
           end
+
+          def ok?(be_strict = false)
+            !be_strict
+          end
         end
 
         #
         # An object that responds to the description protocol from the results
         # and collects summary information.
         #
-        # e.g. 
+        # e.g.
         #     summary = Result::Summary.new
         #     Result::Passed.new(0).describe_to(summary)
         #     puts summary.total_passed