cucumber-core 1.0.0.beta.4 → 1.0.0

data/lib/cucumber/core/filter.rb

@@ -0,0 +1,83 @@
+module Cucumber
+  module Core
+
+    # Filters process test cases.
+    #
+    # Each filter must respond to the following protocol:
+    #
+    #   * `with_receiver(new_receiver)`
+    #   * `test_case(test_case, &describe_test_steps)`
+    #   * `done`
+    #
+    # The `with_receiver` method is used to assemble the filters into a chain. It should return a new instance of the
+    # filter with the receiver attribute set to the new receiver. The receiver will also respond to the filter protocol.
+    #
+    # When a `test_case` message is received, the filter can choose to:
+    #
+    # 1. pass the test_case directly to its receiver (no-op)
+    # 2. pass a modified copy of the test_case to its receiver
+    # 3. not pass the test_case to its receiver at all
+    #
+    # Finally, the `done` message is sent. A filter should pass this message directly to its receiver.
+    #
+    module Filter
+
+      # Utility method for quick construction of filter classes.
+      #
+      # @example Example usage:
+      #
+      #   class BlankingFilter < Filter.new(:name_to_blank, :receiver)
+      #     def test_case(test_case)
+      #       if name_to_blank == test_case.name
+      #         test_case.with_steps([]).describe_to(receiver)
+      #       else
+      #         test_case.describe_to(receiver)
+      #       end
+      #     end
+      #   end
+      #
+      # The attribute names passed to the Filter constructor will become private attributes of
+      # your filter class.
+      #
+      def self.new(*attributes, &block)
+        attributes << :receiver
+
+        result = Class.new do
+          attr_reader(*attributes)
+          private(*attributes)
+
+          define_method(:initialize) do |*args|
+            attributes.zip(args) do |name, value|
+              instance_variable_set("@#{name}".to_sym, value)
+            end
+          end
+
+          def test_case(test_case)
+            test_case.describe_to receiver
+            self
+          end
+
+          def done
+            receiver.done
+            self
+          end
+
+          define_method(:with_receiver) do |new_receiver|
+            args = attributes.map { |name|
+              instance_variable_get("@#{name}".to_sym)
+            }
+            args[-1] = new_receiver
+            self.class.new(*args)
+          end
+
+        end
+
+        if block
+          Class.new(result, &block)
+        else
+          result
+        end
+      end
+    end
+  end
+end

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

@@ -1,4 +1,3 @@
-require 'cucumber/initializer'
 require 'cucumber/core/ast'
 require 'cucumber/core/platform'
 require 'gherkin/rubify'
@@ -76,7 +75,13 @@ module Cucumber
         end
 
         class Builder
-          include Cucumber.initializer(:file, :node)
+          attr_reader :file, :node
+          private     :file, :node
+
+          def initialize(file, node)
+            @file = file
+            @node = node
+          end
 
           private
 

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

@@ -1,12 +1,15 @@
-require 'cucumber/initializer'
 
 module Cucumber
   module Core
     module Gherkin
       class Document
-        include Cucumber.initializer(:uri, :body)
         attr_reader :uri, :body
 
+        def initialize(uri, body)
+          @uri = uri
+          @body = body
+        end
+
         def to_s
           body
         end

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

@@ -7,7 +7,12 @@ module Cucumber
       ParseError = Class.new(StandardError)
 
       class Parser
-        include Cucumber.initializer(:receiver)
+        attr_reader :receiver
+        private     :receiver
+
+        def initialize(receiver)
+          @receiver = receiver
+        end
 
         def document(document)
           builder = AstBuilder.new(document.uri)

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

@@ -8,18 +8,18 @@ module Cucumber
     module Test
       class Action
         def initialize(&block)
-          raise ArgumentError, "Passing a block to execute the mapping is mandatory." unless block
+          raise ArgumentError, "Passing a block to execute the action is mandatory." unless block
           @block = block
           @timer = Timer.new
         end
 
-        def skip(last_result)
+        def skip(*)
           skipped
         end
 
-        def execute(last_result)
+        def execute(*args)
           @timer.start
-          @block.call(last_result)
+          @block.call(*args)
           passed
         rescue Result::Raisable => exception
           exception.with_duration(@timer.duration)
@@ -51,17 +51,17 @@ module Cucumber
       end
 
       class UnskippableAction < Action
-        def skip(last_result)
-          execute(last_result)
+        def skip(*args)
+          execute(*args)
         end
       end
 
       class UndefinedAction
-        def execute(last_result)
+        def execute(*)
           undefined
         end
 
-        def skip(last_result)
+        def skip(*)
           undefined
         end
 

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

@@ -0,0 +1,19 @@
+module Cucumber
+  module Core
+    module Test
+      class AroundHook
+        def initialize(&block)
+          @block = block
+        end
+
+        def describe_to(visitor, *args, &continue)
+          visitor.around_hook(self, *args, &continue)
+        end
+
+        def call(continue)
+          @block.call(continue)
+        end
+      end
+    end
+  end
+end

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

@@ -1,15 +1,17 @@
-require 'cucumber/initializer'
 require 'cucumber/core/test/result'
 
 module Cucumber
   module Core
     module Test
       class Case
-        include Cucumber.initializer(:test_steps, :source, :around_hooks)
-        attr_reader :source, :test_steps
+        attr_reader :source, :test_steps, :around_hooks
+        private     :around_hooks
 
         def initialize(test_steps, source, around_hooks = [])
-          super(test_steps, source, around_hooks)
+          raise ArgumentError.new("test_steps should be an Array but is a #{test_steps.class}") unless test_steps.kind_of?(Array)
+          @test_steps = test_steps
+          @source = source
+          @around_hooks = around_hooks
         end
 
         def step_count

data/lib/cucumber/core/test/filters/locations_filter.rb

@@ -1,8 +1,9 @@
+require 'cucumber/core/filter'
+
 module Cucumber
   module Core
     module Test
-      class LocationsFilter
-        include Cucumber.initializer(:locations, :receiver)
+      class LocationsFilter < Filter.new(:locations)
 
         def test_case(test_case)
           if test_case.match_locations?(@locations)
@@ -11,10 +12,6 @@ module Cucumber
           self
         end
 
-        def done
-          @receiver.done
-          self
-        end
       end
     end
   end

data/lib/cucumber/core/test/filters/name_filter.rb

@@ -1,8 +1,9 @@
+require 'cucumber/core/filter'
+
 module Cucumber
   module Core
     module Test
-      class NameFilter
-        include Cucumber.initializer(:name_regexps, :receiver)
+      class NameFilter < Filter.new(:name_regexps)
 
         def test_case(test_case)
           if accept?(test_case)
@@ -11,11 +12,6 @@ module Cucumber
           self
         end
 
-        def done
-          @receiver.done
-          self
-        end
-
         private
 
         def accept?(test_case)

data/lib/cucumber/core/test/filters/tag_filter.rb

@@ -1,8 +1,9 @@
+require 'cucumber/core/filter'
+
 module Cucumber
   module Core
     module Test
-      class TagFilter
-        include Cucumber.initializer(:filter_expressions, :receiver)
+      class TagFilter < Filter.new(:filter_expressions)
 
         def test_case(test_case)
           test_cases << test_case
@@ -19,6 +20,7 @@ module Cucumber
         end
 
         private
+
         def test_cases
           @test_cases ||= TestCases.new
         end

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

@@ -1,5 +1,4 @@
-# encoding: UTF-8¬
-require 'cucumber/initializer'
+# encoding: UTF-8
 
 module Cucumber
   module Core
@@ -29,12 +28,11 @@ module Cucumber
 
         class Passed
           include Result.status_queries(:passed)
-          include Cucumber.initializer(:duration)
-          attr_reader :duration
+          attr_accessor :duration
 
           def initialize(duration)
             raise ArgumentError unless duration
-            super
+            @duration = duration
           end
 
           def describe_to(visitor, *args)
@@ -50,13 +48,13 @@ module Cucumber
 
         class Failed
           include Result.status_queries(:failed)
-          include Cucumber.initializer(:duration, :exception)
           attr_reader :duration, :exception
 
           def initialize(duration, exception)
             raise ArgumentError unless duration 
             raise ArgumentError unless exception
-            super
+            @duration = duration
+            @exception = exception
           end
 
           def describe_to(visitor, *args)

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

@@ -1,11 +1,42 @@
-require 'cucumber/initializer'
 require 'cucumber/core/test/timer'
 
 module Cucumber
   module Core
     module Test
       class Runner
-        class StepRunner
+        attr_reader :report, :running_test_case
+        private :report, :running_test_case
+
+        def initialize(report)
+          @report = report
+        end
+
+        def test_case(test_case, &descend)
+          @running_test_case = RunningTestCase.new
+          report.before_test_case(test_case)
+          descend.call(self)
+          report.after_test_case(test_case, running_test_case.result)
+          self
+        end
+
+        def test_step(test_step)
+          report.before_test_step test_step
+          step_result = running_test_case.execute(test_step)
+          report.after_test_step test_step, step_result
+          self
+        end
+
+        def around_hook(hook, &continue)
+          hook.call(continue)
+          self
+        end
+
+        def done
+          report.done
+          self
+        end
+
+        class RunningTestCase
           def initialize
             @timer = Timer.new.start
             @status = Status::Unknown.new(Result::Unknown.new)
@@ -57,7 +88,12 @@ module Cucumber
 
           module Status
             class Base
-              include Cucumber.initializer(:step_result)
+              attr_reader :step_result
+              private :step_result
+
+              def initialize(step_result)
+                @step_result = step_result
+              end
 
               def execute(test_step, monitor)
                 result = test_step.execute(monitor.result)
@@ -101,43 +137,6 @@ module Cucumber
           end
         end
 
-        attr_reader :report
-        private :report
-        def initialize(report)
-          @report = report
-        end
-
-        def test_case(test_case, &descend)
-          report.before_test_case(test_case)
-          descend.call(self)
-          report.after_test_case(test_case, current_case_result)
-          @current_step_runner = nil
-        end
-
-        def test_step(test_step)
-          report.before_test_step test_step
-          step_result = current_step_runner.execute(test_step)
-          report.after_test_step test_step, step_result
-        end
-
-        def around_hook(hook, &continue)
-          hook.call(continue)
-        end
-
-        def done
-          report.done
-          self
-        end
-
-        private
-
-        def current_case_result
-          current_step_runner.result
-        end
-
-        def current_step_runner
-          @current_step_runner ||= StepRunner.new
-        end
       end
     end
   end

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

@@ -1,4 +1,3 @@
-require 'cucumber/initializer'
 require 'cucumber/core/test/result'
 require 'cucumber/core/test/action'
 
@@ -6,13 +5,11 @@ module Cucumber
   module Core
     module Test
       class Step
-        include Cucumber.initializer(:source)
         attr_reader :source
 
-        def initialize(source, mapping = Test::UndefinedAction.new)
+        def initialize(source, action = Test::UndefinedAction.new)
           raise ArgumentError if source.any?(&:nil?)
-          @mapping = mapping
-          super(source)
+          @source, @action = source, action
         end
 
         def describe_to(visitor, *args)
@@ -26,15 +23,15 @@ module Cucumber
           self
         end
 
-        def skip(last_result)
-          @mapping.skip(last_result)
+        def skip(*args)
+          @action.skip(*args)
         end
 
-        def execute(last_result)
-          @mapping.execute(last_result)
+        def execute(*args)
+          @action.execute(*args)
         end
 
-        def with_mapping(&block)
+        def with_action(&block)
           self.class.new(source, Test::Action.new(&block))
         end