rspec-sleeping_king_studios 2.0.0.beta.0 → 2.0.0.beta.1

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

@@ -1,46 +1,65 @@
 # 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'
+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'
 
 module RSpec::SleepingKingStudios::Matchers::BuiltIn
   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
+
+    # Generates a description of the matcher expectation.
+    #
+    # @return [String] The matcher description.
+    def description
+      expected_message = format_expected_arguments
+      "respond to #{pp_names}#{expected_message.empty? ? '' : " with #{expected_message}"}"
+    end # method description
 
     # @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 (Ruby 2.0 only).
-    # 
+    #
     #   @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 (Ruby 2.0 only).
-    # 
+    #
     #   @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
       @expected_keywords = keywords
+
       self
     end # method with
 
     # 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
@@ -50,30 +69,32 @@ module RSpec::SleepingKingStudios::Matchers::BuiltIn
     # @see BaseMatcher#failure_message
     def failure_message
       @failing_method_names ||= []
-      methods, messages = @names - @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)
+        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 = @names - @failing_method_names, []
+      methods, messages = @failing_method_names, []
 
       methods.map do |method|
-        message   = "expected #{@actual.inspect} not to respond to #{method.inspect}"
+        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
 
@@ -83,7 +104,7 @@ module RSpec::SleepingKingStudios::Matchers::BuiltIn
       @actual = actual
       @failing_method_reasons = {}
       @failing_method_names   = @names.__send__(filter_method) do |name|
-        @actual.respond_to?(name) &&
+        @actual.respond_to?(name, @include_all) &&
           matches_arity?(actual, name) &&
           matches_keywords?(actual, name) &&
           matches_block?(actual, name)
@@ -121,7 +142,7 @@ module RSpec::SleepingKingStudios::Matchers::BuiltIn
         raise error
       end # if-else
     end # method matches_keywords?
-    
+
     def matches_block? actual, name
       return true unless @expected_block
 
@@ -135,32 +156,25 @@ module RSpec::SleepingKingStudios::Matchers::BuiltIn
 
     def format_expected_arguments
       messages = []
-      
+
       if !@expected_arity.nil?
-        messages << "#{@expected_arity.inspect} argument#{1 == @expected_arity ? "" : "s"}"
+        messages << "#{@expected_arity.inspect} #{pluralize @expected_arity, 'argument', 'arguments'}"
       end # if
 
       if !(@expected_keywords.nil? || @expected_keywords.empty?)
-        messages << "keywords #{@expected_keywords.map(&:inspect).join(", ")}"
+        messages << "#{pluralize @expected_keywords.count, 'keyword', 'keywords'} #{humanize_list @expected_keywords.map(&:inspect)}"
       end # if
 
       if @expected_block
         messages << "a block"
       end # if
 
-      case messages.count
-      when 0..1
-        messages.join(", ")
-      when 2
-        "#{messages[0]} and #{messages[1]}"
-      else
-        "#{messages[1..-1].join(", ")}, and #{messages[0]}"
-      end # case
+      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]}"
       elsif hsh = reasons.fetch(:too_many_args, false)
@@ -168,11 +182,11 @@ module RSpec::SleepingKingStudios::Matchers::BuiltIn
       end # if-elsif
 
       if ary = reasons.fetch(:missing_keywords, false)
-        messages << "  missing keywords #{ary.map(&:inspect).join(", ")}"
+        messages << "  missing #{pluralize ary.count, 'keyword', 'keywords'} #{humanize_list ary.map(&:inspect)}"
       end # if
 
       if ary = reasons.fetch(:unexpected_keywords, false)
-        messages << "  unexpected keywords #{ary.map(&:inspect).join(", ")}"
+        messages << "  unexpected #{pluralize ary.count, 'keyword', 'keywords'} #{humanize_list ary.map(&:inspect)}"
       end # if
 
       if reasons.fetch(:expected_block, false)
@@ -180,13 +194,13 @@ module RSpec::SleepingKingStudios::Matchers::BuiltIn
       end # if
 
       messages.join "\n"
-    end # method format_errors_for_method  
+    end # method format_errors_for_method
   end # class
 end # module
 
 module RSpec::SleepingKingStudios::Matchers
   # @see RSpec::SleepingKingStudios::Matchers::BuiltIn::RespondToMatcher#matches?
-  def respond_to expected
-    RSpec::SleepingKingStudios::Matchers::BuiltIn::RespondToMatcher.new expected
+  def respond_to *expected
+    RSpec::SleepingKingStudios::Matchers::BuiltIn::RespondToMatcher.new *expected
   end # method respond_to
 end # module

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

@@ -1,5 +1,7 @@
 # lib/rspec/sleeping_king_studios/matchers/built_in.rb
 
-Dir[File.join File.dirname(__FILE__), 'built_in', '*.rb'].each do |file|
-  require file
-end # end each
+require 'rspec/sleeping_king_studios/matchers'
+
+module RSpec::SleepingKingStudios::Matchers
+  module BuiltIn; end
+end # module

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

@@ -0,0 +1,5 @@
+# lib/rspec/sleeping_king_studios/matchers/core/all.rb
+
+Dir[File.join File.dirname(__FILE__), '*.rb'].each do |file|
+  require file
+end # end each

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

@@ -1,17 +1,24 @@
 # 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'
+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
+    # Generates a description of the matcher expectation.
+    #
+    # @return [String] The matcher 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

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

@@ -1,24 +1,35 @@
 # spec/rspec/sleeping_king_studios/matchers/core/construct.rb
 
 require 'rspec/sleeping_king_studios/matchers/base_matcher'
-require 'rspec/sleeping_king_studios/matchers/core/require'
-
+require 'rspec/sleeping_king_studios/matchers/core'
 require 'rspec/sleeping_king_studios/matchers/shared/match_parameters'
+require 'sleeping_king_studios/tools/enumerable_tools'
+require 'sleeping_king_studios/tools/string_tools'
 
 module RSpec::SleepingKingStudios::Matchers::Core
   # Matcher for checking whether an object can be constructed via #new and
   # #initialize, and the parameters accepted by #initialize.
-  # 
+  #
   # @since 1.0.0
   class ConstructMatcher < RSpec::SleepingKingStudios::Matchers::BaseMatcher
     include RSpec::SleepingKingStudios::Matchers::Shared::MatchParameters
+    include SleepingKingStudios::Tools::EnumerableTools
+    include SleepingKingStudios::Tools::StringTools
+
+    # Generates a description of the matcher expectation.
+    #
+    # @return [String] The matcher description.
+    def description
+      expected_message = format_expected_arguments
+      "construct#{expected_message.empty? ? '' : " with #{expected_message}"}"
+    end # method description
 
     # Checks if the object responds to :new. If so, allocates an instance and
     # checks the parameters expected by #initialize against the expected
     # parameters, if any.
-    # 
+    #
     # @param [Object] actual the object to check
-    # 
+    #
     # @return [Boolean] true if the object responds to :new and accepts the
     #   specified parameters for #initialize; otherwise false
     def matches? actual
@@ -28,16 +39,33 @@ module RSpec::SleepingKingStudios::Matchers::Core
         matches_arity?(actual) &&
         matches_keywords?(actual)
     end # method matches?
-    
-    # Adds a parameter count expectation and/or one or more keyword
-    # expectations (Ruby 2.0 only).
-    # 
-    # @param [Integer, Range, nil] count the number of expected parameters; can
-    #   be an integer, a range, or nil (parameter count is ignored)
-    # @param [Array<String, Symbol>] keywords list of keyword arguments
-    #   accepted by the method
-    # 
-    # @return [ConstructMatcher] self
+
+    # @overload with(count)
+    #   Adds a parameter count expectation and removes any keyword expectations
+    #   (Ruby 2.0+ only).
+    #
+    #   @param [Integer, Range] count the number of expected parameters
+    #
+    #   @return [ConstructMatcher] self
+    #
+    # @overload with(count, *keywords)
+    #   Adds a parameter count expectation and one or more keyword expectations
+    #   (Ruby 2.0 only).
+    #
+    #   @param [Integer, Range] count the number of expected parameters
+    #   @param [Array<String, Symbol>] keywords list of keyword arguments
+    #     accepted by the method
+    #
+    #   @return [ConstructMatcher] self
+    #
+    # @overload with(*keywords)
+    #   Removes a parameter count expectation (if any) and adds one or more
+    #   keyword expectations (Ruby 2.0 only).
+    #
+    #   @param [Array<String, Symbol>] keywords list of keyword arguments
+    #     accepted by the method
+    #
+    #   @return [ConstructMatcher] self
     def with *keywords
       @expected_arity    = keywords.shift if Integer === keywords.first || Range === keywords.first
       @expected_keywords = keywords
@@ -45,11 +73,14 @@ module RSpec::SleepingKingStudios::Matchers::Core
     end # method with
 
     # Convenience method for more fluent specs. Does nothing and returns self.
-    # 
+    #
     # @return [ConstructMatcher] self
-    def arguments
+    #
+    # @since 2.0.0
+    def argument
       self
-    end # method arguments
+    end # method argument
+    alias_method :arguments, :argument
 
     # @see BaseMatcher#failure_message
     def failure_message
@@ -62,7 +93,7 @@ module RSpec::SleepingKingStudios::Matchers::Core
     def failure_message_when_negated
       message = "expected #{@actual.inspect} not to construct"
       unless (formatted = format_expected_arguments).empty?
-        message << " with #{formatted}" 
+        message << " with #{formatted}"
       end # unless
       message
     end # method failure_message_when_negated
@@ -71,7 +102,7 @@ module RSpec::SleepingKingStudios::Matchers::Core
 
     def matches_arity? actual
       return true unless @expected_arity
-      
+
       if result = check_method_arity(actual.allocate.method(:initialize), @expected_arity)
         @failing_method_reasons.update result
         return false
@@ -100,22 +131,15 @@ module RSpec::SleepingKingStudios::Matchers::Core
       end # if
 
       if !(@expected_keywords.nil? || @expected_keywords.empty?)
-        messages << "keywords #{@expected_keywords.map(&:inspect).join(", ")}"
+        messages << "#{pluralize @expected_keywords.count, 'keyword', 'keywords'} #{humanize_list @expected_keywords.map(&:inspect)}"
       end # if
 
-      case messages.count
-      when 0..1
-        messages.join(", ")
-      when 2
-        "#{messages[0]} and #{messages[1]}"
-      else
-        "#{messages[1..-1].join(", ")}, and #{messages[0]}"
-      end # case
+      humanize_list messages
     end # method format_expected_arguments
 
     def format_errors
       reasons, messages = @failing_method_reasons, []
-      
+
       if hsh = reasons.fetch(:not_enough_args, false)
         messages << "  expected at least #{hsh[:count]} arguments, but received #{hsh[:arity]}"
       elsif hsh = reasons.fetch(:too_many_args, false)
@@ -123,11 +147,11 @@ module RSpec::SleepingKingStudios::Matchers::Core
       end # if-elsif
 
       if ary = reasons.fetch(:missing_keywords, false)
-        messages << "  missing keywords #{ary.map(&:inspect).join(", ")}"
+        messages << "  missing #{pluralize ary.count, 'keyword', 'keywords'} #{humanize_list ary.map(&:inspect)}"
       end # if
 
       if ary = reasons.fetch(:unexpected_keywords, false)
-        messages << "  unexpected keywords #{ary.map(&:inspect).join(", ")}"
+        messages << "  unexpected #{pluralize ary.count, 'keyword', 'keywords'} #{humanize_list ary.map(&:inspect)}"
       end # if
 
       messages.join "\n"

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

@@ -1,77 +1,107 @@
 # lib/rspec/sleeping_king_studios/matchers/core/have_property.rb
 
 require 'rspec/sleeping_king_studios/matchers/base_matcher'
-require 'rspec/sleeping_king_studios/matchers/core/require'
+require 'rspec/sleeping_king_studios/matchers/core'
+require 'rspec/sleeping_king_studios/matchers/shared/match_property'
 
 module RSpec::SleepingKingStudios::Matchers::Core
   # Matcher for testing whether an object has a specific property, e.g.
   # responds to :property and :property= and :property= updates the value of
   # :property.
-  # 
+  #
   # @since 1.0.0
   class HavePropertyMatcher < RSpec::SleepingKingStudios::Matchers::BaseMatcher
+    include RSpec::SleepingKingStudios::Matchers::Shared::MatchProperty
+
+    # Generates a description of the matcher expectation.
+    #
+    # @return [String] The matcher description.
+    def description
+      value_message = value_to_string
+      "have property :#{@expected}#{@value_set ? " with value #{value_message}" : ''}"
+    end # method description
+
     # @param [String, Symbol] expected the property to check for on the actual
     #   object
     def initialize expected
       @expected = expected.intern
     end # method initialize
 
+    def does_not_match? actual
+      super
+
+      matches_property?(:none?)
+    end # method does_not_match?
+
     # Checks if the object responds to :expected and :expected=. Additionally,
-    # if a value expectation is set, assigns the value via :expected= and
-    # compares the subsequent value of :expected to the specified value.
-    # 
+    # if a value expectation is set, compares the result of calling :expected
+    # to the value.
+    #
     # @param [Object] actual the object to check
-    # 
+    #
     # @return [Boolean] true if the object responds to :expected and
     #   :expected= and matches the value expectation (if any); otherwise false
     def matches? actual
       super
 
-      @match_reader = @actual.respond_to? @expected
-      @match_writer = @actual.respond_to? :"#{@expected}="
-      
-      return false unless @match_reader && @match_writer
-
-      if @value_set
-        @actual.send :"#{@expected}=", @value
-        return false unless @actual.send(@expected) == @value
-      end # if
-      
-      true
+      matches_property?(:all?)
     end # method matches?
 
-    # Sets a value expectation. The matcher will set the object's value to the
-    # specified value using :property=, then compare the value from :property
-    # with the specified value.
-    # 
+    # Sets a value expectation. The matcher will compare the value to the
+    # result of calling :property.
+    #
     # @param [Object] value the value to set and then compare
-    # 
+    #
     # @return [HavePropertyMatcher] self
     def with value
       @value = value
       @value_set = true
       self
     end # method with
+    alias_method :with_value, :with
 
     # @see BaseMatcher#failure_message
     def failure_message
       methods = []
-      methods << ":#{@expected}"  unless @match_reader
-      methods << ":#{@expected}=" unless @match_writer
+      methods << ":#{@expected}"  unless @matches_reader
+      methods << ":#{@expected}=" unless @matches_writer
+
+      message = "expected #{@actual.inspect} to respond to :#{@expected} and :#{@expected}="
+      message << " and return #{value_to_string}" if @value_set
 
-      return "expected #{@actual.inspect} to respond to #{methods.join " and "}" unless methods.empty?
+      errors = []
+      errors << "did not respond to #{methods.join " or "}" unless methods.empty?
+      errors << "returned #{@actual.send(@expected).inspect}" unless @matches_reader_value || !@value_set
 
-      "unexpected value for #{@actual.inspect}\##{@expected}" +
-        "\n  expected: #{@value.inspect}" +
-        "\n       got: #{@actual.send(@expected).inspect}"
+      message << ", but #{errors.join(" and ")}"
+      message
     end # failure_message
 
     # @see BaseMatcher#failure_message_when_negated
     def failure_message_when_negated
+      methods = []
+      methods << ":#{@expected}"  if @matches_reader
+      methods << ":#{@expected}=" if @matches_writer
+
       message = "expected #{@actual.inspect} not to respond to :#{@expected} or :#{@expected}="
-      message << " with value #{@value.inspect}" if @value_set
+      message << " and return #{value_to_string}" if @value_set
+
+      errors = []
+      errors << "responded to #{methods.join " and "}" unless methods.empty?
+      errors << "returned #{@actual.send(@expected).inspect}" if @matches_reader_value
+
+      message << ", but #{errors.join(" and ")}"
       message
     end # failure_message_when_negated
+
+    private
+
+    def matches_property? filter
+      [ responds_to_reader?,
+        responds_to_writer?,
+        matches_reader_value?
+      ].send(filter) { |bool| bool }
+    end # method matches_property?
   end # class
 end # module
 

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

@@ -1,14 +1,25 @@
 # lib/rspec/sleeping_king_studios/matchers/core/have_reader.rb
 
 require 'rspec/sleeping_king_studios/matchers/base_matcher'
-require 'rspec/sleeping_king_studios/matchers/core/require'
+require 'rspec/sleeping_king_studios/matchers/core'
+require 'rspec/sleeping_king_studios/matchers/shared/match_property'
 
 module RSpec::SleepingKingStudios::Matchers::Core
   # Matcher for testing whether an object has a specific property reader, e.g.
   # responds to :property.
-  # 
+  #
   # @since 1.0.0
   class HaveReaderMatcher < RSpec::SleepingKingStudios::Matchers::BaseMatcher
+    include RSpec::SleepingKingStudios::Matchers::Shared::MatchProperty
+
+    # Generates a description of the matcher expectation.
+    #
+    # @return [String] The matcher description.
+    def description
+      value_message = value_to_string
+      "have reader :#{@expected}#{@value_set ? " with value #{value_message}" : ''}"
+    end # method description
+
     # @param [String, Symbol] expected the property to check for on the actual
     #   object
     def initialize expected
@@ -18,50 +29,48 @@ module RSpec::SleepingKingStudios::Matchers::Core
     # Checks if the object responds to :expected. Additionally, if a value
     # expectation is set, compares the value of :expected to the specified
     # value.
-    # 
+    #
     # @param [Object] actual the object to check
-    # 
+    #
     # @return [Boolean] true if the object responds to :expected and matches
     #    the value expectation (if any); otherwise false
     def matches? actual
       super
 
-      return false unless @match_reader = @actual.respond_to?(@expected)
-
-      if @value_set
-        return false unless @match_value = @actual.send(@expected) == @value
-      end # if
-      
-      true
+      responds_to_reader? && matches_reader_value?
     end # method matches?
 
     # Sets a value expectation. The matcher will compare the value from
     # :property with the specified value.
-    # 
+    #
     # @param [Object] value the value to compare
-    # 
+    #
     # @return [HaveReaderMatcher] self
     def with value
       @value = value
       @value_set = true
       self
     end # method with
+    alias_method :with_value, :with
 
     # @see BaseMatcher#failure_message
     def failure_message
-      unless @match_reader
-        return "expected #{@actual} to respond to #{@expected.inspect}"
-      end # unless
-      
-      "unexpected value for #{@actual}\##{@expected}\n" +
-          "  expected: #{@value.inspect}\n" +
-          "       got: #{@actual.send(@expected).inspect}"
+      message = "expected #{@actual} to respond to :#{@expected}"
+      message << " and return #{value_to_string}" if @value_set
+
+      if !@matches_reader
+        message << ", but did not respond to :#{@expected}"
+      elsif !@matches_reader_value
+        message << ", but returned #{@actual.send(@expected).inspect}"
+      end # if
+
+      message
     end # method failure_message
 
     # @see BaseMatcher#failure_message_when_negated
     def failure_message_when_negated
-      message = "expected #{@actual} not to respond to #{@expected.inspect}"
-      message << " with value #{@value.inspect}" if @value_set
+      message = "expected #{@actual} not to respond to :#{@expected}"
+      message << " and return #{value_to_string}" if @value_set
       message
     end # method failure_message
   end # class