cucumber-core 1.5.0 → 2.0.0

data/lib/cucumber/core/version.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 module Cucumber
   module Core
     class Version
       def self.to_s
-        "1.5.0"
+        "2.0.0"
       end
     end
   end

data/spec/capture_warnings.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # With thanks to @myronmarston
 # https://github.com/vcr/vcr/blob/master/spec/capture_warnings.rb
 
@@ -22,7 +23,7 @@ module CaptureWarnings
     end
 
     if project_warnings.any?
-      puts "#{ project_warnings.count } cucumber-core warnings detected" 
+      puts "#{ project_warnings.count } cucumber-core warnings detected"
       print_warnings('cucumber-core', project_warnings)
       fail "Please remove all cucumber-core warnings."
     end
@@ -34,7 +35,7 @@ module CaptureWarnings
     old_stderr = STDERR.clone
     pipe_r, pipe_w = IO.pipe
     pipe_r.sync    = true
-    error         = ""
+    error         = String.new
     reader = Thread.new do
       begin
         loop do

data/spec/coverage.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'simplecov'
 formatters = [ SimpleCov::Formatter::HTMLFormatter ]
 

data/spec/cucumber/core/ast/background_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/core/ast/background'
 module Cucumber::Core::Ast
   describe Background do

data/spec/cucumber/core/ast/data_table_spec.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 require 'cucumber/core/ast/data_table'
 
 module Cucumber

data/spec/cucumber/core/ast/doc_string_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/core/ast/location'
 require 'cucumber/core/ast/doc_string'
 require 'unindent'
@@ -68,7 +69,7 @@ module Cucumber
         end
 
         context 'quacking like a String' do
-          let(:content) { 'content' }
+          let(:content) { String.new('content') }
           let(:content_type) { 'text/plain' }
 
           it 'delegates #encoding to the content string' do

data/spec/cucumber/core/ast/empty_multiline_argument_spec.rb

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

data/spec/cucumber/core/ast/examples_table_spec.rb

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

data/spec/cucumber/core/ast/location_spec.rb

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

data/spec/cucumber/core/ast/outline_step_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/core/ast/outline_step'
 require 'cucumber/core/ast/examples_table'
 require 'cucumber/core/ast/data_table'

data/spec/cucumber/core/ast/step_spec.rb

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

data/spec/cucumber/core/compiler_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/core'
 require 'cucumber/core/compiler'
 require 'cucumber/core/gherkin/writer'

data/spec/cucumber/core/event_bus_spec.rb

@@ -0,0 +1,151 @@
+require "cucumber/core/event_bus"
+
+module Cucumber
+  module Core
+    module Events
+
+      class TestEvent < Core::Event.new(:some_attribute)
+      end
+
+      AnotherTestEvent = Core::Event.new
+
+      UnregisteredEvent = Core::Event.new
+    end
+
+    describe EventBus do
+      let(:event_bus) { EventBus.new(registry) }
+      let(:registry) { { test_event: Events::TestEvent, another_test_event: Events::AnotherTestEvent } }
+
+      context "broadcasting events" do
+
+        it "can broadcast by calling a method named after the event ID" do
+          called = false
+          event_bus.on(:test_event) {called = true }
+          event_bus.test_event
+          expect(called).to be true
+        end
+
+        it "can broadcast by calling the `broadcast` method with an instance of the event type" do
+          called = false
+          event_bus.on(:test_event) {called = true }
+          event_bus.broadcast(Events::TestEvent.new(:some_attribute))
+          expect(called).to be true
+        end
+
+        it "calls a subscriber for an event, passing details of the event" do
+          received_payload = nil
+          event_bus.on :test_event do |event|
+            received_payload = event
+          end
+
+          event_bus.test_event :some_attribute
+
+          expect(received_payload.some_attribute).to eq(:some_attribute)
+        end
+
+        it "does not call subscribers for other events" do
+          handler_called = false
+          event_bus.on :test_event do
+            handler_called = true
+          end
+
+          event_bus.another_test_event
+
+          expect(handler_called).to eq(false)
+        end
+
+        it "broadcasts to multiple subscribers" do
+          received_events = []
+          event_bus.on :test_event do
+            received_events << :event
+          end
+          event_bus.on :test_event do
+            received_events << :event
+          end
+
+          event_bus.test_event(:some_attribute)
+
+          expect(received_events.length).to eq 2
+        end
+
+        it "raises an error when given an event to broadcast that it doesn't recognise" do
+          expect { event_bus.some_unknown_event }.to raise_error(NameError)
+        end
+
+        context "#broadcast method" do
+          it "must be passed an instance of a registered event type" do
+            expect { 
+              event_bus.broadcast Events::UnregisteredEvent
+            }.to raise_error(ArgumentError)
+          end
+        end
+
+      end
+
+      context "subscribing to events" do
+        it "allows subscription by symbol (Event ID)" do
+          received_payload = nil
+          event_bus.on(:test_event) do |event|
+            received_payload = event
+          end
+
+          event_bus.test_event :some_attribute
+
+          expect(received_payload.some_attribute).to eq(:some_attribute)
+        end
+
+        it "raises an error if you use an unknown Event ID" do
+          expect { 
+            event_bus.on(:some_unknown_event) { :whatever }
+          }.to raise_error(ArgumentError)
+        end
+
+        it "allows handlers that are objects with a `call` method" do
+          class MyHandler
+            attr_reader :received_payload
+
+            def call(event)
+              @received_payload = event
+            end
+          end
+
+          handler = MyHandler.new
+          event_bus.on(:test_event, handler)
+
+          event_bus.test_event :some_attribute
+
+          expect(handler.received_payload.some_attribute).to eq :some_attribute
+        end
+
+        it "allows handlers that are procs" do
+          class MyProccyHandler
+            attr_reader :received_payload
+
+            def initialize(event_bus)
+              event_bus.on :test_event, &method(:on_test_event)
+            end
+
+            def on_test_event(event)
+              @received_payload = event
+            end
+          end
+
+          handler = MyProccyHandler.new(event_bus)
+
+          event_bus.test_event :some_attribute
+          expect(handler.received_payload.some_attribute).to eq :some_attribute
+        end
+
+      end
+
+      it "will let you inspect the registry" do
+        expect(event_bus.event_types[:test_event]).to eq Events::TestEvent
+      end
+
+      it "won't let you modify the registry" do
+        expect { event_bus.event_types[:foo] = :bar }.to raise_error(RuntimeError)
+      end
+
+    end
+  end
+end

data/spec/cucumber/core/event_spec.rb

@@ -0,0 +1,40 @@
+require 'cucumber/core/event'
+
+module Cucumber
+  module Core
+    describe Event do
+
+      describe ".new" do
+        it "generates new types of events" do
+          my_event_type = Event.new
+          my_event = my_event_type.new
+          expect(my_event).to be_kind_of(Core::Event)
+        end
+
+        it "generates events with attributes" do
+          my_event_type = Event.new(:foo, :bar)
+          my_event = my_event_type.new(1,2)
+          expect(my_event.attributes).to eq [1, 2]
+          expect(my_event.foo).to eq 1
+          expect(my_event.bar).to eq 2
+        end
+      end
+
+      describe "a generated event" do
+        class MyEventType < Event.new(:foo, :bar)
+        end
+
+        it "can be converted to a hash" do
+          my_event = MyEventType.new(1,2)
+          expect(my_event.to_h).to eq foo: 1, bar: 2
+        end
+
+        it "has an event_id" do
+          expect(MyEventType.event_id).to eq :my_event_type
+          expect(MyEventType.new(1,2).event_id).to eq :my_event_type
+        end
+      end
+    end
+
+  end
+end

data/spec/cucumber/core/filter_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/core/gherkin/writer'
 require 'cucumber/core'
 require 'cucumber/core/filter'

data/spec/cucumber/core/gherkin/parser_spec.rb

@@ -1,4 +1,5 @@
 # -*- encoding: utf-8 -*-
+# frozen_string_literal: true
 require 'cucumber/core/gherkin/parser'
 require 'cucumber/core/gherkin/writer'
 
@@ -223,6 +224,29 @@ module Cucumber
 
         end
 
+        context "a Scenario Outline with an empty examples table" do
+          source do
+            feature do
+              scenario_outline 'outline name' do
+                step 'passing <arg>'
+
+                examples do
+                end
+              end
+            end
+          end
+
+          it "creates an examples table node but no example table rows" do
+            allow( visitor ).to receive(:feature).and_yield(visitor)
+            allow( visitor ).to receive(:scenario_outline).and_yield(visitor)
+            allow( visitor ).to receive(:outline_step)
+            expect( visitor ).to receive(:examples_table).and_yield(visitor)
+            expect( visitor ).to receive(:examples_table_row).exactly(0).times
+            feature.describe_to(visitor)
+          end
+
+        end
+
         context "a Scenario Outline with no Examples" do
           source do
             feature(language: 'not-a-language')

data/spec/cucumber/core/gherkin/writer_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/core/gherkin/writer'
 require 'unindent'
 

data/spec/cucumber/core/report/summary_spec.rb

@@ -0,0 +1,127 @@
+# -*- encoding: utf-8 -*-
+require 'cucumber/core/event_bus'
+require 'cucumber/core/events'
+require 'cucumber/core/report/summary'
+require 'cucumber/core/test/result'
+
+module Cucumber::Core::Report
+  describe Summary do
+    let(:event_bus) { ::Cucumber::Core::EventBus.new(registry) }
+    let(:registry) { ::Cucumber::Core::Events.registry }
+    let(:passed_result) { ::Cucumber::Core::Test::Result::Passed.new(duration) }
+    let(:failed_result) { ::Cucumber::Core::Test::Result::Failed.new(duration, exception) }
+    let(:pending_result) { ::Cucumber::Core::Test::Result::Pending.new(duration) }
+    let(:skipped_result) { ::Cucumber::Core::Test::Result::Skipped.new(duration) }
+    let(:undefined_result) { ::Cucumber::Core::Test::Result::Undefined.new(duration) }
+    let(:duration) { double }
+    let(:exception) { double }
+
+    before(:each) { @summary = Summary.new(event_bus) }
+
+    context "test case summary" do
+      let(:test_case) { double }
+
+      it "counts passed test cases" do
+        event_bus.send(:test_case_finished, test_case, passed_result)
+
+        expect( @summary.test_cases.total(:passed) ).to eq(1)
+        expect( @summary.test_cases.total ).to eq(1)
+      end
+
+      it "counts failed test cases" do
+        event_bus.send(:test_case_finished, test_case, failed_result)
+
+        expect( @summary.test_cases.total(:failed) ).to eq(1)
+        expect( @summary.test_cases.total ).to eq(1)
+      end
+
+      it "counts pending test cases" do
+        event_bus.send(:test_case_finished, test_case, pending_result)
+
+        expect( @summary.test_cases.total(:pending) ).to eq(1)
+        expect( @summary.test_cases.total ).to eq(1)
+      end
+
+      it "counts skipped test cases" do
+        event_bus.send(:test_case_finished, test_case, skipped_result)
+
+        expect( @summary.test_cases.total(:skipped) ).to eq(1)
+        expect( @summary.test_cases.total ).to eq(1)
+      end
+
+      it "counts undefined test cases" do
+        event_bus.send(:test_case_finished, test_case, undefined_result)
+
+        expect( @summary.test_cases.total(:undefined) ).to eq(1)
+        expect( @summary.test_cases.total ).to eq(1)
+      end
+    end
+
+    context "test step summary" do
+      context "with test steps from gherkin steps" do
+        let(:test_step) { double }
+
+        before(:each) do 
+          step = double
+          expect( step ).to receive(:describe_to) do |visitor|
+            visitor.step
+          end
+          expect( test_step ).to receive(:source).and_return([step])
+        end
+
+        it "counts passed test steps" do
+          event_bus.send(:test_step_finished, test_step, passed_result)
+
+          expect( @summary.test_steps.total(:passed) ).to eq(1)
+          expect( @summary.test_steps.total ).to eq(1)
+        end
+
+        it "counts failed test cases" do
+          event_bus.send(:test_step_finished, test_step, failed_result)
+
+          expect( @summary.test_steps.total(:failed) ).to eq(1)
+          expect( @summary.test_steps.total ).to eq(1)
+        end
+
+        it "counts pending test cases" do
+          event_bus.send(:test_step_finished, test_step, pending_result)
+
+          expect( @summary.test_steps.total(:pending) ).to eq(1)
+          expect( @summary.test_steps.total ).to eq(1)
+        end
+
+        it "counts skipped test cases" do
+          event_bus.send(:test_step_finished, test_step, skipped_result)
+
+          expect( @summary.test_steps.total(:skipped) ).to eq(1)
+          expect( @summary.test_steps.total ).to eq(1)
+        end
+
+        it "counts undefined test cases" do
+          event_bus.send(:test_step_finished, test_step, undefined_result)
+
+          expect( @summary.test_steps.total(:undefined) ).to eq(1)
+          expect( @summary.test_steps.total ).to eq(1)
+        end
+      end
+
+      context "with test steps not from gherkin steps" do
+        let(:test_step) { double }
+
+        before(:each) do 
+          step = double
+          expect( step ).to receive(:describe_to) do |visitor|
+            visitor.not_step
+          end
+          expect( test_step ).to receive(:source).and_return([step])
+        end
+
+        it "ignores test steps not defined by gherkin steps" do
+          event_bus.send(:test_step_finished, test_step, passed_result)
+
+          expect( @summary.test_steps.total ).to eq(0)
+        end
+      end
+    end
+  end
+end