rspec-sleeping_king_studios 2.1.1 → 2.2.0.rc.1

data/lib/rspec/sleeping_king_studios/matchers/built_in/respond_to.rb

@@ -1,264 +1,9 @@
 # lib/rspec/sleeping_king_studios/matchers/built_in/respond_to.rb
 
-require 'rspec/sleeping_king_studios/matchers/base_matcher'
-require 'rspec/sleeping_king_studios/matchers/built_in'
-require 'rspec/sleeping_king_studios/matchers/shared/match_parameters'
-require 'sleeping_king_studios/tools/enumerable_tools'
-require 'sleeping_king_studios/tools/string_tools'
+require 'rspec/sleeping_king_studios/matchers/built_in/respond_to_matcher'
+require 'rspec/sleeping_king_studios/matchers/macros'
 
-module RSpec::SleepingKingStudios::Matchers::BuiltIn
-  # Extensions to the built-in RSpec #respond_to matcher.
-  class RespondToMatcher < RSpec::Matchers::BuiltIn::RespondTo
-    include RSpec::SleepingKingStudios::Matchers::Shared::MatchParameters
-    include SleepingKingStudios::Tools::EnumerableTools
-    include SleepingKingStudios::Tools::StringTools
-
-    def initialize *expected
-      @include_all = [true, false].include?(expected.last) ? expected.pop : false
-
-      super(*expected)
-    end # constructor
-
-    # (see BaseMatcher#description)
-    def description
-      expected_message = format_expected_arguments
-      "respond to #{pp_names}#{expected_message.empty? ? '' : " with #{expected_message}"}"
-    end # method description
-
-    # Adds a parameter count expectation and/or one or more keyword
-    # expectations.
-    #
-    # @overload with count
-    #   Adds a parameter count expectation.
-    #
-    #   @param [Integer, Range, nil] count (optional) The number of expected
-    #     parameters.
-    #
-    #   @return [RespondToMatcher] self
-    # @overload with *keywords
-    #   Adds one or more keyword expectations.
-    #
-    #   @param [Array<String, Symbol>] keywords List of keyword arguments
-    #     accepted by the method.
-    #
-    #   @return [RespondToMatcher] self
-    # @overload with count, *keywords
-    #   Adds a parameter count expectation and one or more keyword
-    #   expectations.
-    #
-    #   @param [Integer, Range, nil] count (optional) The number of expected
-    #     parameters.
-    #   @param [Array<String, Symbol>] keywords List of keyword arguments
-    #     accepted by the method.
-    #
-    #   @return [RespondToMatcher] self
-    def with *keywords
-      @expected_arity = keywords.shift if Integer === keywords.first || Range === keywords.first
-
-      # TODO: Deprecate this behavior (for version 3.0?) - use the
-      # #with_keywords or #and_keywords methods instead.
-      (@expected_keywords ||= []).concat(keywords)
-
-      self
-    end # method with
-
-    # Adds an unlimited parameter count expectation, e.g. that the method
-    # supports splatted array arguments of the form *args.
-    #
-    # @return [RespondToMatcher] self
-    def with_unlimited_arguments
-      @expect_unlimited_arguments = true
-
-      self
-    end # method with_unlimited_arguments
-    alias_method :and_unlimited_arguments, :with_unlimited_arguments
-
-    # Adds one or more keyword expectations.
-    #
-    # @param [Array<String, Symbol>] keywords List of keyword arguments
-    #   accepted by the method.
-    #
-    # @return [RespondToMatcher] self
-    def with_keywords *keywords
-      (@expected_keywords ||= []).concat(keywords)
-
-      self
-    end # method with_keywords
-    alias_method :and_keywords, :with_keywords
-
-    # Adds an arbitrary keyword expectation, e.g. that the method supports
-    # any keywords with splatted hash arguments of the form **kwargs.
-    def with_arbitrary_keywords
-      @expect_arbitrary_keywords = true
-
-      self
-    end # method with_arbitrary_keywords
-    alias_method :and_arbitrary_keywords, :with_arbitrary_keywords
-    alias_method :with_any_keywords,      :with_arbitrary_keywords
-    alias_method :and_any_keywords,       :with_any_keywords
-
-    # Adds a block expectation. The actual object will only match a block
-    # expectation if it expects a parameter of the form &block.
-    #
-    # @return [RespondToMatcher] self
-    def with_a_block
-      @expected_block = true
-      self
-    end # method with_a_block
-    alias_method :and_a_block, :with_a_block
-
-    # (see BaseMatcher#failure_message)
-    def failure_message
-      @failing_method_names ||= []
-      methods, messages = @failing_method_names, []
-
-      methods.map do |method|
-        message = "expected #{@actual.inspect} to respond to #{method.inspect}"
-        if @actual.respond_to?(method, @include_all)
-          message << " with arguments:\n#{format_errors_for_method method}"
-        end # if-else
-        messages << message
-      end # method
-
-      messages.join "\n"
-    end # method failure_message
-
-    # (see BaseMatcher#failure_message_when_negated)
-    def failure_message_when_negated
-      @failing_method_names ||= []
-      methods, messages = @failing_method_names, []
-
-      methods.map do |method|
-        message = "expected #{@actual.inspect} not to respond to #{method.inspect}"
-        unless (formatted = format_expected_arguments).empty?
-          message << " with #{formatted}"
-        end # unless
-        messages << message
-      end # method
-
-      messages.join "\n"
-    end # method failure_message_when_negated
-
-    private
-
-    def find_failing_method_names actual, filter_method
-      @actual = actual
-      @failing_method_reasons = {}
-      @failing_method_names   = @names.__send__(filter_method) do |name|
-        @actual.respond_to?(name, @include_all) &&
-          matches_arity?(actual, name) &&
-          matches_keywords?(actual, name) &&
-          matches_block?(actual, name)
-      end # send
-    end # method find_failing_method_names
-
-    def matches_arity? actual, name
-      return true unless @expected_arity || @expect_unlimited_arguments
-
-      if result = check_method_arity(actual.method(name), @expected_arity, expect_unlimited_arguments: @expect_unlimited_arguments)
-        (@failing_method_reasons[name] ||= {}).update result
-        return false
-      end # if
-
-      true
-    end # method matches_arity?
-
-    def matches_keywords? actual, name
-      return true unless @expected_keywords ||
-        @expect_arbitrary_keywords ||
-        (@expected_arity && RUBY_VERSION >= "2.1.0")
-
-      if result = check_method_keywords(actual.method(name), @expected_keywords, expect_arbitrary_keywords: @expect_arbitrary_keywords)
-        (@failing_method_reasons[name] ||= {}).update result
-        return false
-      end # if
-
-      true
-    rescue NameError => error
-      if error.name == name
-        # Actual responds to name, but doesn't actually have a method defined
-        # there. Possibly using #method_missing or a test double. We obviously
-        # can't test that, so bail.
-        true
-      else
-        raise error
-      end # if-else
-    end # method matches_keywords?
-
-    def matches_block? actual, name
-      return true unless @expected_block
-
-      if result = check_method_block(@actual.method(name))
-        (@failing_method_reasons[name] ||= {}).update result
-        return false
-      end # if
-
-      true
-    end # method matches_block?
-
-    def format_expected_arguments
-      messages = []
-
-      if !@expected_arity.nil?
-        messages << "#{@expected_arity.inspect} #{pluralize @expected_arity, 'argument', 'arguments'}"
-      end # if
-
-      if @expect_unlimited_arguments
-        messages << 'unlimited arguments'
-      end # if
-
-      if !(@expected_keywords.nil? || @expected_keywords.empty?)
-        messages << "#{pluralize @expected_keywords.count, 'keyword', 'keywords'} #{humanize_list @expected_keywords.map(&:inspect)}"
-      end # if
-
-      if @expect_arbitrary_keywords
-        messages << 'arbitrary keywords'
-      end # if
-
-      if @expected_block
-        messages << "a block"
-      end # if
-
-      humanize_list messages
-    end # method format_expected_arguments
-
-    def format_errors_for_method method
-      reasons, messages = @failing_method_reasons[method], []
-
-      if hsh = reasons.fetch(:not_enough_args, false)
-        messages << "  expected at least #{hsh[:count]} arguments, but received #{hsh[:arity]}"
-      end # if
-
-      if hsh = reasons.fetch(:too_many_args, false)
-        messages << "  expected at most #{hsh[:count]} arguments, but received #{hsh[:arity]}"
-      end # if
-
-      if hsh = reasons.fetch(:expected_unlimited_arguments, false)
-        messages << "  expected at most #{hsh[:count]} arguments, but received unlimited arguments"
-      end # if
-
-      if reasons.fetch(:expected_arbitrary_keywords, false)
-        messages << "  expected arbitrary keywords"
-      end # if
-
-      if ary = reasons.fetch(:missing_keywords, false)
-        messages << "  missing #{pluralize ary.count, 'keyword', 'keywords'} #{humanize_list ary.map(&:inspect)}"
-      end # if
-
-      if ary = reasons.fetch(:unexpected_keywords, false)
-        messages << "  unexpected #{pluralize ary.count, 'keyword', 'keywords'} #{humanize_list ary.map(&:inspect)}"
-      end # if
-
-      if reasons.fetch(:expected_block, false)
-        messages << "  unexpected block"
-      end # if
-
-      messages.join "\n"
-    end # method format_errors_for_method
-  end # class
-end # module
-
-module RSpec::SleepingKingStudios::Matchers
+module RSpec::SleepingKingStudios::Matchers::Macros
   # @see RSpec::SleepingKingStudios::Matchers::BuiltIn::RespondToMatcher#matches?
   def respond_to *expected
     RSpec::SleepingKingStudios::Matchers::BuiltIn::RespondToMatcher.new *expected

data/lib/rspec/sleeping_king_studios/matchers/built_in/respond_to_matcher.rb

@@ -0,0 +1,116 @@
+# lib/rspec/sleeping_king_studios/matchers/built_in/respond_to_matcher.rb
+
+require 'rspec/sleeping_king_studios/matchers/base_matcher'
+require 'rspec/sleeping_king_studios/matchers/built_in'
+require 'rspec/sleeping_king_studios/matchers/shared/match_parameters'
+
+module RSpec::SleepingKingStudios::Matchers::BuiltIn
+  # Extensions to the built-in RSpec #respond_to matcher.
+  class RespondToMatcher < RSpec::Matchers::BuiltIn::RespondTo
+    include RSpec::SleepingKingStudios::Matchers::Shared::MatchParameters
+
+    def initialize *expected
+      @include_all = [true, false].include?(expected.last) ? expected.pop : false
+
+      super(*expected)
+    end # constructor
+
+    # (see BaseMatcher#description)
+    def description
+      message = "respond to #{pp_names}"
+
+      if method_signature_expectation?
+        message << ' ' << method_signature_expectation.description
+      end # if
+
+      message
+    end # method description
+
+    # (see BaseMatcher#failure_message)
+    def failure_message
+      method_names = @failing_method_names || []
+      messages     = []
+
+      method_names.map do |method_name|
+        message = "expected #{@actual.inspect} to respond to #{method_name.inspect}"
+        reasons = @failing_method_reasons[method_name] || {}
+
+        if reasons.key?(:does_not_respond_to_method)
+          message << ", but #{@actual.inspect} does not respond to #{method_name.inspect}"
+        elsif reasons.key?(:is_not_a_method)
+          message << ", but #{@actual.inspect} does not define a method at #{method_name.inspect}"
+        else
+          errors = @failing_method_reasons[method_name]
+
+          # TODO: Replace this with ", but received arguments did not match "\
+          # " method signature:"
+          message << " with arguments:\n" << format_errors(errors)
+        end # if-elsif-else
+
+        messages << message
+      end # method
+
+      messages.join "\n"
+    end # method failure_message
+
+    # (see BaseMatcher#failure_message_when_negated)
+    def failure_message_when_negated
+      @failing_method_names ||= []
+      methods, messages = @failing_method_names, []
+
+      methods.map do |method|
+        message = "expected #{@actual.inspect} not to respond to #{method.inspect}"
+
+        if method_signature_expectation?
+          message << ' ' << method_signature_expectation.description
+        end # if
+
+        messages << message
+      end # method
+
+      messages.join "\n"
+    end # method failure_message_when_negated
+
+    private
+
+    def find_failing_method_names actual, filter_method
+      @actual = actual
+      @failing_method_reasons = {}
+      @failing_method_names   = @names.__send__(filter_method) do |method_name|
+        unless @actual.respond_to?(method_name, @include_all)
+          @failing_method_reasons[method_name] = {
+            :does_not_respond_to_method => true
+          } # end hash
+
+          next false
+        end # unless
+
+        method =
+          begin
+            actual.method(method_name)
+          rescue NameError
+            nil
+          end # unless
+
+        unless method.is_a?(Method)
+          @failing_method_reasons[method_name] = {
+            :is_not_a_method => true
+          } # end hash
+
+          next false
+        end # unless
+
+        next true unless method_signature_expectation?
+
+        unless check_method_signature(method)
+          @failing_method_reasons[method_name] =
+            method_signature_expectation.errors
+
+          next false
+        end # unless
+
+        true
+      end # send
+    end # method find_failing_method_names
+  end # class
+end # module

data/lib/rspec/sleeping_king_studios/matchers/core/alias_method.rb

@@ -0,0 +1,11 @@
+# lib/rspec/sleeping_king_studios/matchers/core/alias_method.rb
+
+require 'rspec/sleeping_king_studios/matchers/core/alias_method_matcher'
+require 'rspec/sleeping_king_studios/matchers/macros'
+
+module RSpec::SleepingKingStudios::Matchers::Macros
+  # @see RSpec::SleepingKingStudios::Matchers::Core::AliasMethodMatcher#matches?
+  def alias_method expected
+    RSpec::SleepingKingStudios::Matchers::Core::AliasMethodMatcher.new expected
+  end # method be_boolean
+end # module

data/lib/rspec/sleeping_king_studios/matchers/core/alias_method_matcher.rb

@@ -0,0 +1,107 @@
+# lib/rspec/sleeping_king_studios/matchers/core/alias_method_matcher.rb
+
+require 'rspec/sleeping_king_studios/matchers/base_matcher'
+require 'rspec/sleeping_king_studios/matchers/core'
+
+module RSpec::SleepingKingStudios::Matchers::Core
+  # Matcher for testing whether an object aliases a specified method using the
+  # specified other method name.
+  #
+  # @since 2.2.0
+  class AliasMethodMatcher < RSpec::SleepingKingStudios::Matchers::BaseMatcher
+    # @param [String, Symbol] expected The name of the method that is expected
+    #   to be aliased.
+    def initialize expected
+      @old_method_name = @expected = expected.intern
+      @errors          = {}
+    end # method initialize
+
+    # Specifies the name of the new method.
+    #
+    # @param [String, Symbol] new_method_name The method name.
+    #
+    # @return [AliasMethodMatcher] self
+    def as new_method_name
+      @new_method_name = new_method_name
+
+      self
+    end # method as
+
+    # (see BaseMatcher#description)
+    def description
+      str = "alias :#{old_method_name}"
+
+      str << " as #{new_method_name.inspect}" if new_method_name
+
+      str
+    end # method description
+
+    # (see BaseMatcher#failure_message)
+    def failure_message
+      message = "expected #{@actual.inspect} to alias :#{old_method_name}"
+
+      message << " as #{new_method_name.inspect}" if new_method_name
+
+      if @errors[:does_not_respond_to_old_method]
+        message << ", but did not respond to :#{old_method_name}"
+
+        return message
+      end # if
+
+      if @errors[:does_not_respond_to_new_method]
+        message << ", but did not respond to :#{new_method_name}"
+
+        return message
+      end # if
+
+      if @errors[:does_not_alias_method]
+        message <<
+          ", but :#{old_method_name} and :#{new_method_name} are different "\
+          "methods"
+
+        return message
+      end # if
+
+      message
+    end # method failure_message
+
+    # (see BaseMatcher#matches?)
+    def matches? actual
+      super
+
+      raise ArgumentError.new('must specify a new method name') if new_method_name.nil?
+
+      responds_to_methods? && aliases_method?
+    end # method matches?
+
+    private
+
+    attr_reader :old_method_name, :new_method_name
+
+    def aliases_method?
+      unless @actual.method(old_method_name) == @actual.method(new_method_name)
+        @errors[:does_not_alias_method] = true
+
+        return false
+      end # unless
+
+      true
+    end # method aliases_method?
+
+    def responds_to_methods?
+      unless @actual.respond_to?(old_method_name)
+        @errors[:does_not_respond_to_old_method] = true
+
+        return false
+      end # unless
+
+      unless @actual.respond_to?(new_method_name)
+        @errors[:does_not_respond_to_new_method] = true
+
+        return false
+      end # unless
+
+      true
+    end # method responds_to_methods?
+  end # class
+end # module

data/lib/rspec/sleeping_king_studios/matchers/core/be_boolean.rb

@@ -1,46 +1,19 @@
 # lib/rspec/sleeping_king_studios/matchers/core/be_boolean.rb
 
-require 'rspec/sleeping_king_studios/matchers/base_matcher'
-require 'rspec/sleeping_king_studios/matchers/core'
+require 'rspec/sleeping_king_studios/matchers/core/be_boolean_matcher'
+require 'rspec/sleeping_king_studios/matchers/macros'
 
-module RSpec::SleepingKingStudios::Matchers::Core
-  # Matcher for testing whether an object is true or false.
-  #
-  # @since 1.0.0
-  class BeBooleanMatcher < RSpec::SleepingKingStudios::Matchers::BaseMatcher
-    # (see BaseMatcher#description)
-    def description
-      'be true or false'
-    end # method description
-
-    # Checks if the object is true or false.
-    #
-    # @param [Object] actual The object to check.
-    #
-    # @return [Boolean] True if the object is true or false, otherwise false.
-    def matches? actual
-      super
-
-      true === actual || false === actual
-    end # method matches?
-
-    # (see BaseMatcher#failure_message)
-    def failure_message
-      "expected #{@actual.inspect} to be true or false"
-    end # method failure_message
-
-    # (see BaseMatcher#failure_message_when_negated)
-    def failure_message_when_negated
-      "expected #{@actual.inspect} not to be true or false"
-    end # method failure_message_when_negated
-  end # class
-end # module
-
-module RSpec::SleepingKingStudios::Matchers
+module RSpec::SleepingKingStudios::Matchers::Macros
   # @see RSpec::SleepingKingStudios::Matchers::Core::BeBooleanMatcher#matches?
   def be_boolean
     RSpec::SleepingKingStudios::Matchers::Core::BeBooleanMatcher.new
   end # method be_boolean
 
   alias_method :be_bool, :be_boolean
+
+  # @!method a_boolean
+  #   @see RSpec::SleepingKingStudios::Matchers::Core::BeBooleanMatcher#matches?
+  alias_matcher :a_boolean, :be_boolean do |description|
+    'true or false'
+  end # alias
 end # module

data/lib/rspec/sleeping_king_studios/matchers/core/be_boolean_matcher.rb

@@ -0,0 +1,37 @@
+# lib/rspec/sleeping_king_studios/matchers/core/be_boolean_matcher.rb
+
+require 'rspec/sleeping_king_studios/matchers/base_matcher'
+require 'rspec/sleeping_king_studios/matchers/core'
+
+module RSpec::SleepingKingStudios::Matchers::Core
+  # Matcher for testing whether an object is true or false.
+  #
+  # @since 1.0.0
+  class BeBooleanMatcher < RSpec::SleepingKingStudios::Matchers::BaseMatcher
+    # (see BaseMatcher#description)
+    def description
+      'be true or false'
+    end # method description
+
+    # Checks if the object is true or false.
+    #
+    # @param [Object] actual The object to check.
+    #
+    # @return [Boolean] True if the object is true or false, otherwise false.
+    def matches? actual
+      super
+
+      true === actual || false === actual
+    end # method matches?
+
+    # (see BaseMatcher#failure_message)
+    def failure_message
+      "expected #{@actual.inspect} to be true or false"
+    end # method failure_message
+
+    # (see BaseMatcher#failure_message_when_negated)
+    def failure_message_when_negated
+      "expected #{@actual.inspect} not to be true or false"
+    end # method failure_message_when_negated
+  end # class
+end # module