rspec-sleeping_king_studios 2.1.1 → 2.2.0.rc.1

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

@@ -0,0 +1,225 @@
+# lib/rspec/sleeping_king_studios/matchers/core/have_constant_matcher.rb
+
+require 'rspec/sleeping_king_studios/matchers/base_matcher'
+require 'rspec/sleeping_king_studios/matchers/core'
+require 'sleeping_king_studios/tools/array_tools'
+
+module RSpec::SleepingKingStudios::Matchers::Core
+  # Matcher for testing whether an object has a specific constant. Includes
+  # functionality for testing the value of the constant and whether the
+  # constant is immutable.
+  #
+  # @since 2.2.0
+  class HaveConstantMatcher < RSpec::SleepingKingStudios::Matchers::BaseMatcher
+    # @param [String, Symbol] expected The name of the constant to check for on
+    #   the actual object.
+    def initialize expected
+      @expected = expected.intern
+    end # method initialize
+
+    # (see BaseMatcher#description)
+    def description
+      message =
+        "have #{@immutable ? 'immutable ' : ''}constant #{@expected.inspect}"
+
+      message << ' with value ' << value_to_string if @value_set
+
+      message
+    end # method description
+
+    # (see BaseMatcher#failure_message)
+    def failure_message
+      message = super
+
+      messages = []
+
+      if @errors[:does_not_define_constants]
+        message <<
+          ", but #{@actual.inspect} does not respond to ::const_defined?"
+
+        return message
+      end # if
+
+      if @errors[:constant_is_not_defined]
+        message <<
+          ", but #{@actual.inspect} does not define constant #{@expected.inspect}"
+
+        return message
+      end # if
+
+      if hsh = @errors[:value_does_not_match]
+        messages <<
+          "constant #{@expected.inspect} has value #{hsh[:received].inspect}"
+      end # if
+
+      if hsh = @errors[:value_is_mutable]
+        messages <<
+          "the value of #{@expected.inspect} was mutable"
+      end # if
+
+      unless messages.empty?
+        tools = ::SleepingKingStudios::Tools::ArrayTools
+
+        message << ', but ' << tools.humanize_list(messages)
+      end # unless
+
+      message
+    end # method failure_message
+
+    # (see BaseMatcher#failure_message_when_negated)
+    def failure_message_when_negated
+      message = super
+
+      message <<
+        ", but #{@actual.inspect} defines constant #{@expected.inspect} with "\
+        "value #{actual.const_get(@expected).inspect}"
+
+      message
+    end # method failure_message
+
+    # Checks if the object has a constant :expected. Additionally, if a
+    # value expectation is set, compares the value of #expected to the
+    # specified value and checks the mutability of the constant.
+    #
+    # @param [Object] actual The object to check.
+    #
+    # @return [Boolean] true If the object has a constant :expected and matches
+    #    the value and mutability expectations (if any); otherwise false.
+    def matches? actual
+      super
+
+      @errors = {}
+
+      return false unless has_constant?
+
+      matches_constant? :all?
+    end # method matches?
+
+    # (see BaseMatcher#does_not_match?)
+    def does_not_match? actual
+      super
+
+      @errors = {}
+
+      !has_constant?
+    end # method does_not_match?
+
+    # Sets a mutability expectation. The matcher will determine whether the
+    # value of the constant is mutable. Values of `nil`, `false`, `true` are
+    # always immutable, as are `Numeric` and `Symbol` primitives. `Array`
+    # values must be frozen and all array items must be immutable. `Hash`
+    # values must be frozen and all hash keys and values must be immutable.
+    #
+    # @return [HaveConstantMatcher] self
+    def immutable
+      @immutable = true
+
+      self
+    end # method immutable
+
+    # @return [Boolean] True if a mutability expectation is set, otherwise
+    #   false.
+    def immutable?
+      !!@immutable
+    end # method immutable
+
+    # Sets a value expectation. The matcher will compare the value of the
+    # constant with the specified value.
+    #
+    # @param [Object] value The value to compare.
+    #
+    # @return [HaveConstantMatcher] self
+    def with value
+      @value     = value
+      @value_set = true
+      self
+    end # method with
+    alias_method :with_value, :with
+
+    private
+
+    def has_constant?
+      unless actual.respond_to?(:const_defined?)
+        @errors[:does_not_define_constants] = true
+
+        return false
+      end # unless
+
+      unless actual.const_defined?(@expected)
+        @errors[:constant_is_not_defined] = true
+
+        return false
+      end # unless
+
+      true
+    end # method has_constant?
+
+    def immutable_value?
+      return true unless @immutable
+
+      actual_value = actual.const_get(@expected)
+
+      if mutable?(actual_value)
+        @errors[:value_is_mutable] = true
+
+        return false
+      end # if
+
+      true
+    end # method immutable_value
+
+    def matches_constant? filter
+      [ matches_constant_value?,
+        immutable_value?
+      ].send(filter) { |bool| bool }
+    end # method matches_constant?
+
+    def matches_constant_value?
+      return true unless @value_set
+
+      actual_value = actual.const_get(@expected)
+      match        = (@value.respond_to?(:matches?) && @value.respond_to?(:description)) ?
+        @value.matches?(actual_value) :
+        @value == actual_value
+
+      unless match
+        @errors[:value_does_not_match] = {
+          :expected => @value,
+          :received => actual_value
+        } # end hash
+
+        return false
+      end # unless
+
+      true
+    end # method matches_constant_value?
+
+    def mutable? value
+      case value
+      when nil, false, true, Numeric, Symbol
+        false
+      when Array
+        return true unless value.frozen?
+
+        value.reduce(false) { |memo, item| memo || mutable?(item) }
+      when Hash
+        return true unless value.frozen?
+
+        (value.keys + value.values).reduce(false) { |memo, item| memo || mutable?(item) }
+      else
+        !value.frozen?
+      end # case
+    end # method mutable?
+
+    # Formats the expected value as a human-readable string. If the value looks
+    # like an RSpec matcher (it responds to :matches? and :description), calls
+    # value#description; otherwise calls value#inspect.
+    #
+    # @return [String] the value as a human-readable string.
+    def value_to_string
+      return @value.description if @value.respond_to?(:matches?) && @value.respond_to?(:description)
+
+      @value.inspect
+    end # method value_to_string
+  end # class
+end # module

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

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

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

@@ -0,0 +1,97 @@
+# lib/rspec/sleeping_king_studios/matchers/core/have_predicate_matcher.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/shared/match_property'
+
+module RSpec::SleepingKingStudios::Matchers::Core
+  # Matcher for testing whether an object has a specific predicate, e.g.
+  # responds to :property?.
+  #
+  # @since 2.2.0
+  class HavePredicateMatcher < RSpec::SleepingKingStudios::Matchers::BaseMatcher
+    include RSpec::SleepingKingStudios::Matchers::Shared::MatchProperty
+
+    # Generates a description of the matcher expectation.
+    #
+    # @return [String] The matcher description.
+    def description
+      "have predicate :#{@expected}"
+    end # method description
+
+    # @param [String, Symbol] expected The predicate to check for on the actual
+    #   object.
+    def initialize expected
+      @expected = expected.to_s.gsub(/\?$/, '').intern
+
+      apply_boolean_expectation if strict_matching?
+    end # method initialize
+
+    # 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
+
+      responds_to_predicate? && matches_predicate_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
+      if strict_matching? && !(value === true || value === false)
+        raise ArgumentError.new 'predicate must return true or false'
+      end # if
+
+      @value = value
+      @value_set = true
+      self
+    end # method with
+    alias_method :with, :with_value
+
+    # (see BaseMatcher#failure_message)
+    def failure_message
+      message = "expected #{@actual.inspect} to respond to :#{@expected}?"
+      message << " and return #{value_to_string}" if @value_set
+
+      if !@matches_predicate
+        message << ", but did not respond to :#{@expected}?"
+      elsif !@matches_predicate_value
+        message << ", but returned #{@actual.send(:"#{@expected}?").inspect}"
+      end # if-elsif
+
+      message
+    end # method failure_message
+
+    # (see BaseMatcher#failure_message_when_negated)
+    def failure_message_when_negated
+      message = "expected #{@actual.inspect} not to respond to :#{@expected}?"
+      message << " and return #{value_to_string}" if @value_set
+      message
+    end # method failure_message
+
+    private
+
+    def apply_boolean_expectation
+      matcher = BeBooleanMatcher.new
+      aliased = RSpec::Matchers::AliasedMatcher.new matcher, ->(str) { 'true or false' }
+
+      @value     = aliased
+      @value_set = true
+    end # method apply_boolean_expectation
+
+    def strict_matching?
+      RSpec.configure { |config| config.sleeping_king_studios.matchers }.strict_predicate_matching
+    end # method strict_matching?
+  end # class
+end # module

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

@@ -1,110 +1,9 @@
 # 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 'rspec/sleeping_king_studios/matchers/shared/match_property'
+require 'rspec/sleeping_king_studios/matchers/core/have_property_matcher'
+require 'rspec/sleeping_king_studios/matchers/macros'
 
-module RSpec::SleepingKingStudios::Matchers::Core
-  # Matcher for testing whether an object has a specific property, e.g.
-  # responds to #property and #property= and has the specified value for
-  # #property.
-  #
-  # @since 1.0.0
-  class HavePropertyMatcher < RSpec::SleepingKingStudios::Matchers::BaseMatcher
-    include RSpec::SleepingKingStudios::Matchers::Shared::MatchProperty
-
-    # (see BaseMatcher#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
-
-    # (see BaseMatcher#does_not_match?)
-    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, 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
-
-      matches_property?(:all?)
-    end # method matches?
-
-    # 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 @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
-
-      errors = []
-      errors << "did not respond to #{methods.join " or "}" unless methods.empty?
-      errors << "returned #{@actual.send(@expected).inspect}" unless @matches_reader_value || !@value_set
-
-      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 << " 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
-
-module RSpec::SleepingKingStudios::Matchers
+module RSpec::SleepingKingStudios::Matchers::Macros
   # @see RSpec::SleepingKingStudios::Matchers::Core::HavePropertyMatcher#matches?
   def have_property expected
     RSpec::SleepingKingStudios::Matchers::Core::HavePropertyMatcher.new expected

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

@@ -0,0 +1,108 @@
+# lib/rspec/sleeping_king_studios/matchers/core/have_property_matcher.rb
+
+require 'rspec/sleeping_king_studios/matchers/base_matcher'
+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 has the specified value for
+  # #property.
+  #
+  # @since 1.0.0
+  class HavePropertyMatcher < RSpec::SleepingKingStudios::Matchers::BaseMatcher
+    include RSpec::SleepingKingStudios::Matchers::Shared::MatchProperty
+
+    # (see BaseMatcher#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
+
+    # (see BaseMatcher#does_not_match?)
+    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, 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
+
+      matches_property?(:all?)
+    end # method matches?
+
+    # 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 @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
+
+      errors = []
+      errors << "did not respond to #{methods.join " or "}" unless methods.empty?
+
+      if @matches_reader
+        errors << "returned #{@actual.send(@expected).inspect}" unless @matches_reader_value || !@value_set
+      end # if
+
+      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 << " 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,80 +1,9 @@
 # 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 'rspec/sleeping_king_studios/matchers/shared/match_property'
+require 'rspec/sleeping_king_studios/matchers/core/have_reader_matcher'
+require 'rspec/sleeping_king_studios/matchers/macros'
 
-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
-
-    # (see BaseMatcher#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
-      @expected = expected.intern
-    end # method initialize
-
-    # 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
-
-      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
-      message = "expected #{@actual.inspect} 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.inspect} not to respond to :#{@expected}"
-      message << " and return #{value_to_string}" if @value_set
-      message
-    end # method failure_message
-  end # class
-end # module
-
-module RSpec::SleepingKingStudios::Matchers
+module RSpec::SleepingKingStudios::Matchers::Macros
   # @see RSpec::SleepingKingStudios::Matchers::Core::HaveReaderMatcher#matches?
   def have_reader expected
     RSpec::SleepingKingStudios::Matchers::Core::HaveReaderMatcher.new expected