aruba 2.2.0 → 2.3.0

data/lib/aruba/cucumber/hooks.rb

@@ -1,6 +1,8 @@
-require "aruba/aruba_path"
-require "aruba/api"
-require "aruba/platform"
+# frozen_string_literal: true
+
+require 'aruba/aruba_path'
+require 'aruba/api'
+require 'aruba/platform'
 World(Aruba::Api)
 
 Around do |_, block|
@@ -10,10 +12,10 @@ end
 Before do
   # ... so every change needs to be done later
   prepend_environment_variable(
-    "PATH",
+    'PATH',
     aruba.config.command_search_paths.join(File::PATH_SEPARATOR) + File::PATH_SEPARATOR
   )
-  set_environment_variable "HOME", aruba.config.home_directory
+  set_environment_variable 'HOME', aruba.config.home_directory
 end
 
 After do
@@ -21,68 +23,68 @@ After do
   aruba.command_monitor.clear
 end
 
-Before("@no-clobber") do
+Before('@no-clobber') do
   setup_aruba(false)
 end
 
-Before("~@no-clobber") do
+Before('~@no-clobber') do
   setup_aruba
 end
 
-Before("@puts") do
+Before('@puts') do
   aruba.announcer.mode = :puts
 end
 
-Before("@announce-command") do
+Before('@announce-command') do
   aruba.announcer.activate :command
 end
 
-Before("@announce-command-content") do
+Before('@announce-command-content') do
   aruba.announcer.activate :command_content
 end
 
-Before("@announce-command-filesystem-status") do
+Before('@announce-command-filesystem-status') do
   aruba.announcer.activate :command_filesystem_status
 end
 
-Before("@announce-output") do
+Before('@announce-output') do
   aruba.announcer.activate :stdout
   aruba.announcer.activate :stderr
 end
 
-Before("@announce-stdout") do
+Before('@announce-stdout') do
   aruba.announcer.activate :stdout
 end
 
-Before("@announce-stderr") do
+Before('@announce-stderr') do
   aruba.announcer.activate :stderr
 end
 
-Before("@announce-directory") do
+Before('@announce-directory') do
   aruba.announcer.activate :directory
 end
 
-Before("@announce-stop-signal") do
+Before('@announce-stop-signal') do
   aruba.announcer.activate :stop_signal
 end
 
-Before("@announce-full-environment") do
+Before('@announce-full-environment') do
   aruba.announcer.activate :full_environment
 end
 
-Before("@announce-changed-environment") do
+Before('@announce-changed-environment') do
   aruba.announcer.activate :changed_environment
 end
 
-Before("@announce-timeout") do
+Before('@announce-timeout') do
   aruba.announcer.activate :timeout
 end
 
-Before("@announce-wait-time") do
+Before('@announce-wait-time') do
   aruba.announcer.activate :wait_time
 end
 
-Before("@announce") do
+Before('@announce') do
   aruba.announcer.activate :changed_environment
   aruba.announcer.activate :command
   aruba.announcer.activate :directory
@@ -98,30 +100,30 @@ Before("@announce") do
   aruba.announcer.activate :command_filesystem_status
 end
 
-Before("@keep-ansi-escape-sequences") do
+Before('@keep-ansi-escape-sequences') do
   aruba.config.remove_ansi_escape_sequences = false
 end
 
-Before "@mocked-home-directory" do
-  set_environment_variable "HOME", expand_path(".")
+Before '@mocked-home-directory' do
+  set_environment_variable 'HOME', expand_path('.')
 end
 
-Before("@disable-bundler") do
+Before('@disable-bundler') do
   unset_bundler_env_vars
 end
 
-Before("@debug") do
+Before('@debug') do
   aruba.config.command_launcher = :debug
 end
 
-Before("@command-launcher-spawn") do
+Before('@command-launcher-spawn') do
   aruba.config.command_launcher = :spawn
 end
 
-Before("@command-launcher-in-process") do
+Before('@command-launcher-in-process') do
   aruba.config.command_launcher = :in_process
 end
 
-Before("@command-launcher-debug") do
+Before('@command-launcher-debug') do
   aruba.config.command_launcher = :debug
 end

data/lib/aruba/cucumber/parameter_types.rb

@@ -1 +1,4 @@
-ParameterType(name: "channel", regexp: "output|stderr|stdout", transformer: ->(name) { name })
+# frozen_string_literal: true
+
+ParameterType(name: 'channel', regexp: 'output|stderr|stdout', transformer: ->(name) { name })
+ParameterType(name: 'command', regexp: '`([^`]*)`', transformer: ->(name) { name })

data/lib/aruba/cucumber/testing_frameworks.rb

@@ -1,25 +1,27 @@
+# frozen_string_literal: true
+
 # Cucumber
 Then(/^the feature(?:s)? should not(?: all)? pass$/) do
   step 'the output should contain " failed)"'
-  step "the exit status should be 1"
+  step 'the exit status should be 1'
 end
 
 # Cucumber
 Then(/^the feature(?:s)? should(?: all)? pass$/) do
   step 'the output should not contain " failed)"'
   step 'the output should not contain " undefined)"'
-  step "the exit status should be 0"
+  step 'the exit status should be 0'
 end
 
 # Cucumber
 Then(/^the feature(?:s)? should not(?: all)? pass with( regex)?:$/) do |regex, string|
   step 'the output should contain " failed)"'
-  step "the exit status should be 1"
+  step 'the exit status should be 1'
 
   if regex
     step "the output should match %r<#{string}>"
   else
-    step "the output should contain:", string
+    step 'the output should contain:', string
   end
 end
 
@@ -27,12 +29,12 @@ end
 Then(/^the feature(?:s)? should(?: all)? pass with( regex)?:$/) do |regex, string|
   step 'the output should not contain " failed)"'
   step 'the output should not contain " undefined)"'
-  step "the exit status should be 0"
+  step 'the exit status should be 0'
 
   if regex
     step "the output should match %r<#{string}>"
   else
-    step "the output should contain:", string
+    step 'the output should contain:', string
   end
 end
 
@@ -45,36 +47,36 @@ Then(/^the spec(?:s)? should not(?: all)? pass(?: with (\d+) failures?)?$/) \
     step %(the output should contain "#{count_failures} failures")
   end
 
-  step "the exit status should be 1"
+  step 'the exit status should be 1'
 end
 
 # RSpec
 Then(/^the spec(?:s)? should all pass$/) do
   step 'the output should contain "0 failures"'
-  step "the exit status should be 0"
+  step 'the exit status should be 0'
 end
 
 # RSpec
 Then(/^the spec(?:s)? should not(?: all)? pass with( regex)?:$/) do |regex, string|
   step 'the output should not contain "0 failures"'
-  step "the exit status should be 1"
+  step 'the exit status should be 1'
 
   if regex
     step "the output should match %r<#{string}>"
   else
-    step "the output should contain:", string
+    step 'the output should contain:', string
   end
 end
 
 # RSpec
 Then(/^the spec(?:s)? should(?: all)? pass with( regex)?:$/) do |regex, string|
   step 'the output should contain "0 failures"'
-  step "the exit status should be 0"
+  step 'the exit status should be 0'
 
   if regex
     step "the output should match %r<#{string}>"
   else
-    step "the output should contain:", string
+    step 'the output should contain:', string
   end
 end
 
@@ -87,35 +89,35 @@ Then(/^the tests(?:s)? should not(?: all)? pass(?: with (\d+) failures?)?$/) \
     step %(the output should contain "#{count_failures} errors")
   end
 
-  step "the exit status should be 1"
+  step 'the exit status should be 1'
 end
 
 # Minitest
 Then(/^the tests(?:s)? should all pass$/) do
   step 'the output should contain "0 errors"'
-  step "the exit status should be 0"
+  step 'the exit status should be 0'
 end
 
 # Minitest
 Then(/^the test(?:s)? should not(?: all)? pass with( regex)?:$/) do |regex, string|
   step 'the output should contain "0 errors"'
-  step "the exit status should be 1"
+  step 'the exit status should be 1'
 
   if regex
     step "the output should match %r<#{string}>"
   else
-    step "the output should contain:", string
+    step 'the output should contain:', string
   end
 end
 
 # Minitest
 Then(/^the test(?:s)? should(?: all)? pass with( regex)?:$/) do |regex, string|
   step 'the output should not contain "0 errors"'
-  step "the exit status should be 0"
+  step 'the exit status should be 0'
 
   if regex
     step "the output should match %r<#{string}>"
   else
-    step "the output should contain:", string
+    step 'the output should contain:', string
   end
 end

data/lib/aruba/cucumber.rb

@@ -1,9 +1,11 @@
-require "aruba/version"
+# frozen_string_literal: true
 
-require "aruba/api"
-require "aruba/cucumber/hooks"
-require "aruba/cucumber/parameter_types"
-require "aruba/cucumber/command"
-require "aruba/cucumber/environment"
-require "aruba/cucumber/file"
-require "aruba/cucumber/testing_frameworks"
+require 'aruba/version'
+
+require 'aruba/api'
+require 'aruba/cucumber/hooks'
+require 'aruba/cucumber/parameter_types'
+require 'aruba/cucumber/command'
+require 'aruba/cucumber/environment'
+require 'aruba/cucumber/file'
+require 'aruba/cucumber/testing_frameworks'

data/lib/aruba/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Aruba
   # Standard error
   class Error < StandardError; end
@@ -28,10 +30,4 @@ module Aruba
   # Raised if command was already started, otherwise aruba forgets about the
   # previous pid and you've got hidden commands run
   class CommandAlreadyStartedError < Error; end
-
-  # Raised if an event name cannot be resolved
-  class EventNameResolveError < StandardError; end
-
-  # Raised if given object is not an event
-  class NoEventError < StandardError; end
 end

data/lib/aruba/event_bus.rb

@@ -1,5 +1,6 @@
-require "aruba/event_bus/name_resolver"
-require "aruba/errors"
+# frozen_string_literal: true
+
+require 'cucumber/core/event_bus'
 
 module Aruba
   # Event bus
@@ -7,55 +8,15 @@ module Aruba
   # Implements and in-process pub-sub events broadcaster allowing multiple observers
   # to subscribe to different events that fire as your tests are executed.
   #
-  class EventBus
-    # Create EventBus
-    #
-    # @param [#transform] resolver
-    #   A resolver which transforms Symbol, String, Class into an event Class.
-    def initialize(resolver)
-      @resolver = resolver
-      @handlers = Hash.new { |h, k| h[k] = [] }
-    end
-
-    # Register for an event
-    #
-    # @param [String, Symbol, Class, Array] event_ids
-    #   If Array, register multiple events witht the same handler. If String,
-    #   Symbol, Class register handler for given event.
-    #
-    # @param [#call] handler_object
-    #   The handler object, needs to have method `#call`. Either
-    #   `handler_object` or `block` can be defined. The handler object gets the
-    #   event passed to `#call`.
-    #
-    # @yield
-    #   Handler block which gets the event passed as parameter.
-    def register(event_ids, handler_object = nil, &handler_proc)
-      handler = handler_proc || handler_object
-
-      if handler.nil? || !handler.respond_to?(:call)
-        raise ArgumentError, "Please pass either an object#call or a handler block"
+  class EventBus < Cucumber::Core::EventBus
+    def register(ids, handler_object = nil, &handler_proc)
+      Array(ids).each do |event_id|
+        on(event_id, handler_object, &handler_proc)
       end
-
-      Array(event_ids).flatten.each do |id|
-        @handlers[
-          @resolver.transform(id).to_s
-        ] << handler
-      end
-
-      nil
     end
 
-    # Broadcast an event
-    #
-    # @param [Object] event
-    #   An object of registered event class. This object is passed to the event
-    #   handler.
-    #
     def notify(event)
-      raise NoEventError, "Please pass an event object, not a class" if event.is_a?(Class)
-
-      @handlers[event.class.to_s].each { |handler| handler.call(event) }
+      broadcast(event)
     end
   end
 end

data/lib/aruba/events.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require 'cucumber/core/event'
+
 # Aruba
 module Aruba
   # Events
@@ -8,13 +12,7 @@ module Aruba
     # inherited by normal events
     #
     # @private
-    class BasicEvent
-      attr_reader :entity
-
-      def initialize(entity)
-        @entity = entity
-      end
-    end
+    class BasicEvent < Cucumber::Core::Event.new(:entity); end
 
     # Command was stopped
     class CommandStopped < BasicEvent; end
@@ -36,5 +34,15 @@ module Aruba
 
     # The configuration was changed
     class ChangedConfiguration < BasicEvent; end
+
+    def self.registry
+      [CommandStarted,
+       CommandStopped,
+       AddedEnvironmentVariable,
+       ChangedEnvironmentVariable,
+       DeletedEnvironmentVariable,
+       ChangedWorkingDirectory,
+       ChangedConfiguration].to_h { |klass| [klass.event_id, klass] }
+    end
   end
 end

data/lib/aruba/file_size.rb

@@ -1,4 +1,6 @@
-require "delegate"
+# frozen_string_literal: true
+
+require 'delegate'
 
 # Aruba
 module Aruba

data/lib/aruba/generators/script_file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Aruba
 module Aruba
   # Generate script files on command line
@@ -23,7 +25,7 @@ module Aruba
 
     def header
       if script_starts_with_shebang?
-        ""
+        ''
       elsif interpreter_is_absolute_path?
         format("#!%s\n", interpreter)
       elsif interpreter_is_just_the_name_of_shell?
@@ -40,7 +42,7 @@ module Aruba
     end
 
     def script_starts_with_shebang?
-      content.start_with? "#!"
+      content.start_with? '#!'
     end
   end
 end

data/lib/aruba/hooks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Aruba
 module Aruba
   # Aruba Hooks

data/lib/aruba/in_config_wrapper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Aruba
 module Aruba
   # In config wrapper
@@ -16,7 +18,7 @@ module Aruba
 
     def method_missing(name, *args)
       if config.key? name
-        raise ArgumentError, "Options take no argument" if args.any?
+        raise ArgumentError, 'Options take no argument' if args.any?
 
         config[name]
       else

data/lib/aruba/initializer.rb

@@ -1,5 +1,7 @@
-require "thor/group"
-require "thor/actions"
+# frozen_string_literal: true
+
+require 'thor/group'
+require 'thor/actions'
 
 # Aruba
 module Aruba
@@ -7,6 +9,7 @@ module Aruba
   #
   # Initialize project with aruba configuration files
   module Initializers
+    #
     # Common initializer
     #
     # @private
@@ -15,7 +18,7 @@ module Aruba
 
       # Add gem to gemfile
       def add_gem
-        file = "Gemfile"
+        file = 'Gemfile'
         creator = if File.exist? file
                     :append_to_file
                   else
@@ -24,9 +27,9 @@ module Aruba
 
         content = if File.exist? file
                     file_ends_with_carriage_return =
-                      File.open(file, "r").readlines.last.match(/.*\n$/)
+                      File.open(file, 'r').readlines.last.match(/.*\n$/)
 
-                    prefix = file_ends_with_carriage_return ? "" : "\n"
+                    prefix = file_ends_with_carriage_return ? '' : "\n"
 
                     %(#{prefix}gem 'aruba', '~> #{Aruba::VERSION}')
                   else
@@ -35,14 +38,9 @@ module Aruba
         send creator, file, content
       end
     end
-  end
-end
 
-# Aruba
-module Aruba
-  # Initializers
-  module Initializers
-    # Default Initializer
+    #
+    # Failing Initializer
     #
     # This handles invalid values for initializer.
     #
@@ -59,14 +57,8 @@ module Aruba
         end
       end
     end
-  end
-end
 
-# Aruba
-module Aruba
-  # Initializer
-  module Initializers
-    # Add aruba + rspec to project
+    # RSpec Initializer. Adds aruba + rspec to project
     #
     # @private
     class RSpecInitializer < Thor::Group
@@ -79,7 +71,7 @@ module Aruba
       end
 
       def create_helper
-        file = "spec/spec_helper.rb"
+        file = 'spec/spec_helper.rb'
         creator = if File.exist? file
                     :append_to_file
                   else
@@ -95,19 +87,14 @@ module Aruba
       end
 
       def create_support_file
-        create_file "spec/support/aruba.rb", <<~EOS
+        create_file 'spec/support/aruba.rb', <<~EOS
           require 'aruba/rspec'
         EOS
       end
     end
-  end
-end
 
-# Aruba
-module Aruba
-  # Initializer
-  module Initializers
-    # Add aruba + aruba to project
+    #
+    # Cucumber Initializer. Adds Aruba + Cucumber to project
     #
     # @private
     class CucumberInitializer < Thor::Group
@@ -120,19 +107,14 @@ module Aruba
       end
 
       def create_support_file
-        create_file "features/support/aruba.rb", <<~EOS
+        create_file 'features/support/aruba.rb', <<~EOS
           require 'aruba/cucumber'
         EOS
       end
     end
-  end
-end
 
-# Aruba
-module Aruba
-  # Initializer
-  module Initializers
-    # Add aruba + minitest to project
+    #
+    # Minitest Initializer. Adds Aruba + Minitest to project
     #
     # @private
     class MiniTestInitializer < Thor::Group
@@ -145,7 +127,7 @@ module Aruba
       end
 
       def create_helper
-        file =  "test/test_helper.rb"
+        file =  'test/test_helper.rb'
         creator = if File.exist? file
                     :append_to_file
                   else
@@ -161,7 +143,7 @@ module Aruba
       end
 
       def create_example
-        create_file "test/use_aruba_with_minitest.rb", <<~EOS
+        create_file 'test/use_aruba_with_minitest.rb', <<~EOS
           $LOAD_PATH.unshift File.expand_path('../test', __FILE__)
 
           require 'test_helper'
@@ -172,17 +154,18 @@ module Aruba
             include Aruba::Api
 
             def setup
-              aruba_setup
+              setup_aruba
+            end
+
+            def test_dummy
+              skip "Add some real tests here"
             end
           end
         EOS
       end
     end
   end
-end
 
-# Aruba
-module Aruba
   # The whole initializer
   #
   # This one uses the specific initializers to generate the needed files.

data/lib/aruba/matchers/base/message_indenter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Aruba
   module Matchers
     module Base
@@ -8,7 +10,7 @@ module Aruba
         module_function
 
         def indent_multiline_message(message)
-          message = message.sub(/\n+\z/, "")
+          message = message.sub(/\n+\z/, '')
           message.lines.map do |line|
             /\S/.match?(line) ? "   #{line}" : line
           end.join