rspec-sleeping_king_studios 1.0.0.rc.2

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

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

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

@@ -0,0 +1,41 @@
+# 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'
+
+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
+    # 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_for_should
+    def failure_message_for_should
+      "expected #{@actual.inspect} to be true or false"
+    end # method failure_message_for_should
+
+    # @see BaseMatcher#failure_message_for_should_not
+    def failure_message_for_should_not
+      "expected #{@actual.inspect} not to be true or false"
+    end # method failure_message_for_should_not
+  end # class
+end # module
+
+module RSpec::SleepingKingStudios::Matchers
+  # @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
+end # module

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

@@ -0,0 +1,138 @@
+# 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/shared/match_parameters'
+
+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
+
+    # 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
+      @actual = actual
+      @failing_method_reasons = {}
+      @actual.respond_to?(:new) &&
+        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
+    def with count = nil, *keywords
+      @expected_arity    = count unless count.nil?
+      @expected_keywords = keywords
+      self
+    end # method with
+
+    # Convenience method for more fluent specs. Does nothing and returns self.
+    # 
+    # @return [ConstructMatcher] self
+    def arguments
+      self
+    end # method arguments
+
+    # @see BaseMatcher#failure_message_for_should
+    def failure_message_for_should
+      message = "expected #{@actual.inspect} to construct"
+      message << " with arguments:\n#{format_errors}" if @actual.respond_to?(:new)
+      message
+    end # method failure_message_for_should
+
+    # @see BaseMatcher#failure_message_for_should_not
+    def failure_message_for_should_not
+      message = "expected #{@actual.inspect} not to construct"
+      unless (formatted = format_expected_arguments).empty?
+        message << " with #{formatted}" 
+      end # unless
+      message
+    end # method failure_message_for_should_not
+
+    private
+
+    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
+      end # if
+
+      true
+    end # method matches_arity?
+
+    def matches_keywords? actual
+      return true unless @expected_keywords
+
+      if result = check_method_keywords(actual.allocate.method(:initialize), @expected_keywords)
+        @failing_method_reasons.update result
+        return false
+      end # if
+
+      true
+    end # method matches_keywords?
+
+    def format_expected_arguments
+      messages = []
+
+      if !@expected_arity.nil?
+        messages << "#{@expected_arity.inspect} argument#{1 == @expected_arity ? "" : "s"}"
+      end # if
+
+      if !(@expected_keywords.nil? || @expected_keywords.empty?)
+        messages << "keywords #{@expected_keywords.map(&:inspect).join(", ")}"
+      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
+    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)
+        messages << "  expected at most #{hsh[:count]} arguments, but received #{hsh[:arity]}"
+      end # if-elsif
+
+      if ary = reasons.fetch(:unexpected_keywords, false)
+        messages << "  unexpected keywords #{ary.map(&:inspect).join(", ")}"
+      end # if
+
+      messages.join "\n"
+    end # method format_errors
+  end # class
+end # module
+
+module RSpec::SleepingKingStudios::Matchers
+  # @see RSpec::SleepingKingStudios::Matchers::Core::ConstructMatcher#matches?
+  def construct
+    RSpec::SleepingKingStudios::Matchers::Core::ConstructMatcher.new
+  end # method construct
+end # module

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

@@ -0,0 +1,84 @@
+# 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'
+
+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
+    # @param [String, Symbol] expected the property to check for on the actual
+    #   object
+    def initialize expected
+      super
+      @expected = expected.intern
+    end # method initialize
+
+    # 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.
+    # 
+    # @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
+    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.
+    # 
+    # @params [Object] value the value to set and then compare
+    # 
+    # @return [HavePropertyMatcher] self
+    def with value
+      @value = value
+      @value_set = true
+      self
+    end # method with
+
+    # @see BaseMatcher#failure_message_for_should
+    def failure_message_for_should
+      methods = []
+      methods << ":#{@expected}"  unless @match_reader
+      methods << ":#{@expected}=" unless @match_writer
+
+      return "expected #{@actual.inspect} to respond to #{methods.join " and "}" unless methods.empty?
+
+      "unexpected value for #{@actual.inspect}\##{@expected}" +
+        "\n  expected: #{@value.inspect}" +
+        "\n       got: #{@actual.send(@expected).inspect}"
+    end # failure_message_for_should
+
+    # @see BaseMatcher#failure_message_for_should_not
+    def failure_message_for_should_not
+      message = "expected #{@actual.inspect} not to respond to :#{@expected} or :#{@expected}="
+      message << " with value #{@value.inspect}" if @value_set
+      message
+    end # failure_message_for_should_not
+  end # class
+end # module
+
+module RSpec::SleepingKingStudios::Matchers
+  # @see RSpec::SleepingKingStudios::Matchers::Core::HavePropertyMatcher#matches?
+  def have_property expected
+    RSpec::SleepingKingStudios::Matchers::Core::HavePropertyMatcher.new expected
+  end # method have_property
+end # module

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

@@ -0,0 +1,76 @@
+# 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'
+
+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
+    # @param [String, Symbol] expected the property to check for on the actual
+    #   object
+    def initialize expected
+      super
+      @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
+
+      return false unless @match_reader = @actual.respond_to?(@expected)
+
+      if @value_set
+        return false unless @match_value = @actual.send(@expected) == @value
+      end # if
+      
+      true
+    end # method matches?
+
+    # Sets a value expectation. The matcher will compare the value from
+    # :property with the specified value.
+    # 
+    # @params [Object] value the value to compare
+    # 
+    # @return [HaveReaderMatcher] self
+    def with value
+      @value = value
+      @value_set = true
+      self
+    end # method with
+
+    # @see BaseMatcher#failure_message_for_should
+    def failure_message_for_should
+      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}"
+    end # method failure_message_for_should
+
+    # @see BaseMatcher#failure_message_for_should_not
+    def failure_message_for_should_not
+      message = "expected #{@actual} not to respond to #{@expected.inspect}"
+      message << " with value #{@value.inspect}" if @value_set
+      message
+    end # method failure_message_for_should
+  end # class
+end # module
+
+module RSpec::SleepingKingStudios::Matchers
+  # @see RSpec::SleepingKingStudios::Matchers::Core::HaveReaderMatcher#matches?
+  def have_reader expected
+    RSpec::SleepingKingStudios::Matchers::Core::HaveReaderMatcher.new expected
+  end # method have_reader
+end # module

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

@@ -0,0 +1,101 @@
+# lib/rspec/sleeping_king_studios/matchers/core/have_mutator.rb
+
+require 'rspec/sleeping_king_studios/matchers/base_matcher'
+require 'rspec/sleeping_king_studios/matchers/core/require'
+
+module RSpec::SleepingKingStudios::Matchers::Core
+  # Matcher for testing whether an object has a specific property writer, e.g.
+  # responds to :property= and updates the state.
+  # 
+  # @since 1.0.0
+  class HaveWriterMatcher < RSpec::SleepingKingStudios::Matchers::BaseMatcher
+    # @param [String, Symbol] expected the property to check for on the actual
+    #   object
+    def initialize expected
+      super
+      @expected = expected.to_s.gsub(/=$/,'').intern
+    end # method initialize
+
+    # Checks if the object responds to :expected=. Additionally, if a value
+    # expectation is set, assigns the value via :expected= and compares the
+    # subsequent value to the specified value using :expected or the block
+    # provided to #with.
+    # 
+    # @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_writer = @actual.respond_to?(:"#{@expected}=")
+
+      if @value_set
+        @actual.send :"#{@expected}=", @value
+
+        if @value_block.respond_to?(:call)
+          return false unless @value == (@actual_value = @actual.instance_eval(&@value_block))
+        elsif @actual.respond_to?(@expected)
+          return false unless @value == (@actual_value = @actual.send(@expected))
+        else
+          return false
+        end # if-elsif
+      end # if
+      
+      true
+    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. If a block is provided, the actual object
+    # evaluates the block and the value is compared to the specified value
+    # instead of using :property.
+    # 
+    # @params [Object] value the value to compare
+    # 
+    # @yield if a block is provided, the block is used to check the value after
+    #   setting :property= instead of using :property.
+    # 
+    # @example Using :property to check the value
+    #   expect(instance).to have_writer(:foo).with(42)
+    # 
+    # @example Using a block to check the valuye
+    #   expect(instance).to have_writer(:bar).with(42) { self.getBar() }
+    # 
+    # @return [HaveWriterMatcher] self
+    def with value, &block
+      @value       = value
+      @value_set   = true
+      @value_block = block
+      self
+    end # method with
+
+    # @see BaseMatcher#failure_message_for_should
+    def failure_message_for_should
+      return "expected #{@actual.inspect} to respond to #{@expected.inspect}=" unless @match_writer
+
+      unless @actual.respond_to?(@expected) || @value_block.respond_to?(:call)
+        return "unable to test #{@expected.inspect}= because #{@actual} does " +
+          "not respond to #{@expected.inspect}; try adding a test block to #with"
+      end # unless
+
+      return "unexpected value for #{@actual.inspect}#foo=\n" +
+        "  expected: #{@value.inspect}\n" +
+        "       got: #{@actual_value.inspect}"
+    end # method failure_message_for_should
+
+    # @see BaseMatcher#failure_message_for_should_not
+    def failure_message_for_should_not
+      message = "expected #{@actual} not to respond to #{@expected.inspect}="
+      message << " with value #{@value.inspect}" if @value_set && @match_writer
+      message
+    end # method failure_message_for_should
+  end # class
+end # module
+
+module RSpec::SleepingKingStudios::Matchers
+  # @see RSpec::SleepingKingStudios::Matchers::Core::HaveWriterMatcher#matches?
+  def have_writer expected
+    RSpec::SleepingKingStudios::Matchers::Core::HaveWriterMatcher.new expected
+  end # method have_writer
+end # module