aruba 1.0.0.pre.alpha.2 → 1.0.1

data/lib/aruba/event_bus.rb

@@ -33,7 +33,9 @@ module Aruba
     def register(event_ids, handler_object = nil, &handler_proc)
       handler = handler_proc || handler_object
 
-      fail ArgumentError, 'Please pass either an object#call or a handler block' if handler.nil? || !handler.respond_to?(:call)
+      if handler.nil? || !handler.respond_to?(:call)
+        raise ArgumentError, 'Please pass either an object#call or a handler block'
+      end
 
       Array(event_ids).flatten.each do |id|
         @handlers[
@@ -51,7 +53,7 @@ module Aruba
     #   handler.
     #
     def notify(event)
-      fail NoEventError, 'Please pass an event object, not a class' if event.is_a?(Class)
+      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) }
     end

data/lib/aruba/event_bus/name_resolver.rb

@@ -15,11 +15,11 @@ module Aruba
 
         # Thanks ActiveSupport
         # (Only needed to support Ruby 1.9.3 and JRuby)
-        # rubocop:disable Metrics/CyclomaticComplexity
         def constantize(camel_cased_word)
           names = camel_cased_word.split('::')
 
-          # Trigger a built-in NameError exception including the ill-formed constant in the message.
+          # Trigger a built-in NameError exception including the ill-formed
+          # constant in the message.
           Object.const_get(camel_cased_word) if names.empty?
 
           # Remove the first blank element in case of '::ClassName' notation.
@@ -37,20 +37,18 @@ module Aruba
 
               # Go down the ancestors to check if it is owned directly. The check
               # stops when we reach Object or the end of ancestors tree.
-              # rubocop:disable Style/EachWithObject
               constant = constant.ancestors.inject do |const, ancestor|
                 break const    if ancestor == Object
                 break ancestor if ancestor.const_defined?(name, false)
+
                 const
               end
-              # rubocop:enable Style/EachWithObject
 
               # owner is in Object, so raise
               constant.const_get(name, false)
             end
           end
         end
-        # rubocop:enable Metrics/CyclomaticComplexity
       end
 
       # @private
@@ -121,7 +119,8 @@ module Aruba
       class FailingResolver
         class << self
           def match?(event_id)
-            fail ArgumentError, %(Input type "#{event_id.class}" of event_id "#{event_id}" is invalid)
+            raise ArgumentError,
+                  %(Input type "#{event_id.class}" of event_id "#{event_id}" is invalid)
           end
 
           def supports
@@ -148,10 +147,11 @@ module Aruba
 
       def transform(event_id)
         resolvers.find { |r| r.match? event_id }.new.transform(default_namespace, event_id)
-      rescue => e
-        # rubocop:disable Metrics/LineLength
-        raise EventNameResolveError, %(Transforming "#{event_id}" into an event class failed. Supported types are: #{@resolvers.map(&:supports).flatten.join(', ')}. #{e.message}.\n\n#{e.backtrace.join("\n")})
-        # rubocop:enable Metrics/LineLength
+      rescue StandardError => e
+        types = @resolvers.map(&:supports).flatten.join(', ')
+        message = "Transforming \"#{event_id}\" into an event class failed." \
+          " Supported types are: #{types}. #{e.message}."
+        raise EventNameResolveError, message, cause: e
       end
     end
   end

data/lib/aruba/events.rb

@@ -4,7 +4,8 @@ module Aruba
   module Events
     # Basic event
     #
-    # This is not meant for direct use - BasicEvent.new - by users. It is inherited by normal events
+    # This is not meant for direct use - BasicEvent.new - by users. It is
+    # inherited by normal events
     #
     # @private
     class BasicEvent

data/lib/aruba/hooks.rb

@@ -18,15 +18,13 @@ module Aruba
     # @param [String, Symbol] label
     #   The name of the hook
     #
-    # @para [Proc] block
+    # @param [Proc] block
     #   The block which should be run for the hook
     def append(label, block)
-      if store.key?(label.to_sym) && store[label.to_sym].respond_to?(:<<)
-        store[label.to_sym] << block
-      else
+      unless store.key?(label.to_sym) && store[label.to_sym].respond_to?(:<<)
         store[label.to_sym] = []
-        store[label.to_sym] << block
       end
+      store[label.to_sym] << block
     end
 
     # Run hook

data/lib/aruba/in_config_wrapper.rb

@@ -15,10 +15,17 @@ module Aruba
     end
 
     def method_missing(name, *args)
-      fail ArgumentError, 'Options take no argument' if args.count > 0
-      fail UnknownOptionError, %(Option "#{name}" is unknown. Please use only earlier defined options) unless config.key? name
+      if config.key? name
+        raise ArgumentError, 'Options take no argument' if args.any?
 
-      config[name]
+        config[name]
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(name, _include_private)
+      config.key? name
     end
   end
 end

data/lib/aruba/initializer.rb

@@ -23,7 +23,12 @@ module Aruba
                   end
 
         content = if File.exist? file
-                    %(gem 'aruba', '~> #{Aruba::VERSION}')
+                    file_ends_with_carriage_return =
+                      File.open(file, 'r').readlines.last.match(/.*\n$/)
+
+                    prefix = file_ends_with_carriage_return ? '' : "\n"
+
+                    %(#{prefix}gem 'aruba', '~> #{Aruba::VERSION}')
                   else
                     %(source 'https://rubygems.org'\ngem 'aruba', '~> #{Aruba::VERSION}'\n)
                   end
@@ -49,7 +54,8 @@ module Aruba
         end
 
         def start(*)
-          fail ArgumentError, %(Unknown test framework. Please use one of :rspec, :cucumber or :minitest)
+          raise ArgumentError,
+                %(Unknown test framework. Please use one of :rspec, :cucumber or :minitest)
         end
       end
     end
@@ -68,7 +74,7 @@ module Aruba
 
       no_commands do
         def self.match?(framework)
-          :rspec == framework.downcase.to_sym
+          framework.downcase.to_sym == :rspec
         end
       end
 
@@ -80,18 +86,18 @@ module Aruba
                     :create_file
                   end
 
-        send creator, file, <<-EOS
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+        send creator, file, <<~EOS
+          $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
-::Dir.glob(::File.expand_path('../support/*.rb', __FILE__)).each { |f| require_relative f }
-::Dir.glob(::File.expand_path('../support/**/*.rb', __FILE__)).each { |f| require_relative f }
-EOS
+          ::Dir.glob(::File.expand_path('../support/*.rb', __FILE__)).each { |f| require_relative f }
+          ::Dir.glob(::File.expand_path('../support/**/*.rb', __FILE__)).each { |f| require_relative f }
+        EOS
       end
 
       def create_support_file
-        create_file 'spec/support/aruba.rb', <<-EOS
-require 'aruba/rspec'
-EOS
+        create_file 'spec/support/aruba.rb', <<~EOS
+          require 'aruba/rspec'
+        EOS
       end
     end
   end
@@ -109,14 +115,14 @@ module Aruba
 
       no_commands do
         def self.match?(framework)
-          :cucumber == framework.downcase.to_sym
+          framework.downcase.to_sym == :cucumber
         end
       end
 
       def create_support_file
-        create_file 'features/support/aruba.rb', <<-EOS
-require 'aruba/cucumber'
-EOS
+        create_file 'features/support/aruba.rb', <<~EOS
+          require 'aruba/cucumber'
+        EOS
       end
     end
   end
@@ -134,7 +140,7 @@ module Aruba
 
       no_commands do
         def self.match?(framework)
-          :minitest == framework.downcase.to_sym
+          framework.downcase.to_sym == :minitest
         end
       end
 
@@ -146,30 +152,30 @@ module Aruba
                     :create_file
                   end
 
-        send creator, file, <<-EOS
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+        send creator, file, <<~EOS
+          $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
-::Dir.glob(::File.expand_path('../support/*.rb', __FILE__)).each { |f| require_relative f }
-::Dir.glob(::File.expand_path('../support/**/*.rb', __FILE__)).each { |f| require_relative f }
-EOS
+          ::Dir.glob(::File.expand_path('../support/*.rb', __FILE__)).each { |f| require_relative f }
+          ::Dir.glob(::File.expand_path('../support/**/*.rb', __FILE__)).each { |f| require_relative f }
+        EOS
       end
 
       def create_example
-        create_file 'test/use_aruba_with_minitest.rb', <<-EOS
-$LOAD_PATH.unshift File.expand_path('../test', __FILE__)
+        create_file 'test/use_aruba_with_minitest.rb', <<~EOS
+          $LOAD_PATH.unshift File.expand_path('../test', __FILE__)
 
-require 'test_helper'
-require 'minitest/autorun'
-require 'aruba/api'
+          require 'test_helper'
+          require 'minitest/autorun'
+          require 'aruba/api'
 
-class FirstRun < Minitest::Test
-  include Aruba::Api
+          class FirstRun < Minitest::Test
+            include Aruba::Api
 
-  def setup
-    aruba_setup
-  end
-end
-EOS
+            def setup
+              aruba_setup
+            end
+          end
+        EOS
       end
     end
   end
@@ -202,7 +208,7 @@ module Aruba
       begin
         initializers.find { |i| i.match? test_framework }.start [], {}
       rescue ArgumentError => e
-        $stderr.puts e.message
+        warn e.message
         exit 0
       end
 

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

@@ -33,6 +33,8 @@ module Aruba
 
       # @private
       module HashFormatting
+        module_function
+
         # `{ :a => 5, :b => 2 }.inspect` produces:
         #
         #     {:a=>5, :b=>2}
@@ -45,7 +47,6 @@ module Aruba
         def improve_hash_formatting(inspect_string)
           inspect_string.gsub(/(\S)=>(\S)/, '\1 => \2')
         end
-        module_function :improve_hash_formatting
       end
 
       include HashFormatting
@@ -70,16 +71,6 @@ module Aruba
         def failure_message_when_negated
           "expected #{description_of @actual} not to #{description}"
         end
-
-        # @private
-        # rubocop:disable Style/PredicateName
-        def self.has_default_failure_messages?(matcher)
-          matcher.method(:failure_message).owner == self &&
-            matcher.method(:failure_message_when_negated).owner == self
-        rescue NameError
-          false
-        end
-        # rubocop:enable Style/PredicateName
       end
 
       include DefaultFailureMessages

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

@@ -0,0 +1,19 @@
+module Aruba
+  module Matchers
+    module Base
+      # Provide #indent_multiline_message helper method.
+      #
+      # @api private
+      module MessageIndenter
+        module_function
+
+        def indent_multiline_message(message)
+          message = message.sub(/\n+\z/, '')
+          message.lines.map do |line|
+            /\S/.match?(line) ? '   ' + line : line
+          end.join
+        end
+      end
+    end
+  end
+end

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

@@ -12,9 +12,6 @@ module Aruba
         prepare_for_inspection(object).inspect
       end
 
-      # rubocop:disable MethodLength
-      # rubocop:disable Metrics/CyclomaticComplexity
-
       # @private
       # Prepares the provided object to be formatted by wrapping it as needed
       # in something that, when `inspect` is called on it, will produce the
@@ -47,8 +44,6 @@ module Aruba
 
         InspectableItem.new(inspection)
       end
-      # rubocop:enable Metrics/CyclomaticComplexity
-      # rubocop:enable MethodLength
 
       # @private
       def self.prepare_hash(input)
@@ -57,7 +52,7 @@ module Aruba
         end
       end
 
-      TIME_FORMAT = "%Y-%m-%d %H:%M:%S".freeze
+      TIME_FORMAT = '%Y-%m-%d %H:%M:%S'.freeze
 
       if Time.method_defined?(:nsec)
         # @private
@@ -66,7 +61,7 @@ module Aruba
         end
       end
 
-      DATE_TIME_FORMAT = "%a, %d %b %Y %H:%M:%S.%N %z".freeze
+      DATE_TIME_FORMAT = '%a, %d %b %Y %H:%M:%S.%N %z'.freeze
 
       # ActiveSupport sometimes overrides inspect. If `ActiveSupport` is
       # defined use a custom format string that includes more time precision.

data/lib/aruba/matchers/collection/include_an_object.rb

@@ -1,4 +1,5 @@
 require 'aruba/matchers/base/base_matcher'
+require 'aruba/matchers/base/message_indenter'
 
 # Aruba
 module Aruba
@@ -8,6 +9,8 @@ module Aruba
     # Provides the implementation for `include_an_object`.
     # Not intended to be instantiated directly.
     class IncludeAnObject < BaseMatcher
+      include Base::MessageIndenter
+
       protected
 
       # @private
@@ -19,19 +22,19 @@ module Aruba
 
       def initialize(matcher)
         @matcher              = matcher
-        @failed_objects       = {}
+        @failed_objects       = []
         @any_succeeded_object = false
       end
 
       # @api private
       # @return [String]
       def failure_message
-        unless iterable?
-          return "#{improve_hash_formatting(super)}, but was not iterable"
-        end
+        return "#{improve_hash_formatting(super)}, but was not iterable" unless iterable?
+
+        return failed_objects.first if failed_objects.size == 1
 
         all_messages = [improve_hash_formatting(super)]
-        failed_objects.each do |index, matcher_failure_message|
+        failed_objects.each_with_index do |matcher_failure_message, index|
           all_messages << failure_message_for_item(index, matcher_failure_message)
         end
         all_messages.join("\n\n")
@@ -86,19 +89,14 @@ module Aruba
 
       def failure_message_for_item(index, failure_message)
         failure_message = indent_multiline_message(add_new_line_if_needed(failure_message))
-        indent_multiline_message("object at index #{index} failed to match:#{failure_message}")
+        indent_multiline_message(
+          "object at index #{index} failed to match:#{failure_message}"
+        )
       end
 
       def add_new_line_if_needed(message)
         message.start_with?("\n") ? message : "\n#{message}"
       end
-
-      def indent_multiline_message(message)
-        message = message.sub(/\n+\z/, '')
-        message.lines.map do |line|
-          line =~ /\S/ ? '   ' + line : line
-        end.join
-      end
     end
   end
 end

data/lib/aruba/matchers/command/be_successfully_executed.rb

@@ -6,7 +6,7 @@ require 'aruba/matchers/command/have_finished_in_time'
 # @!method be_successfuly_executed
 #   This matchers checks if execution of <command> was successful
 #
-#   @return [TrueClass, FalseClass] The result
+#   @return [Boolean] The result
 #
 #     false:
 #     * if command was not successful
@@ -27,8 +27,12 @@ RSpec::Matchers.define :be_successfully_executed do
 
     expect(@old_actual).to have_exit_status(0)
   end
-end
 
-if RSpec::Expectations::Version::STRING >= '3.1'
-  RSpec::Matchers.define_negated_matcher :have_failed_running, :be_successfully_executed
+  failure_message do |_actual|
+    "Expected `#{@actual}` to succeed" \
+      ' but got non-zero exit status and the following output:' \
+      "\n\n#{@old_actual.output}\n"
+  end
 end
+
+RSpec::Matchers.define_negated_matcher :have_failed_running, :be_successfully_executed