rspec-sleeping_king_studios 1.0.0.rc.2

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

@@ -0,0 +1,7 @@
+# lib/rspec/sleeping_king_studios/matchers/core/require.rb
+
+require 'rspec/sleeping_king_studios/matchers/require'
+
+module RSpec::SleepingKingStudios::Matchers
+  module Core; end
+end # module

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

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

data/lib/rspec/sleeping_king_studios/matchers/meta/fail_with_actual.rb

@@ -0,0 +1,142 @@
+# lib/rspec/sleeping_king_studios/matchers/rspec/fail_with_actual.rb
+
+require 'rspec/sleeping_king_studios/matchers/base_matcher'
+require 'rspec/sleeping_king_studios/matchers/meta/require'
+
+module RSpec::SleepingKingStudios::Matchers::Meta
+  # Matcher for testing whether an RSpec matcher will fail with a given actual
+  # object, and return the specified failure message if the matcher is called
+  # via expect#to.
+  # 
+  # @note Do not use this matcher with expect#not_to to verify that a matcher
+  #   will pass with a given actual object; use the #pass_with_actual matcher
+  #   instead.
+  # 
+  # @see RSpec::SleepingKingStudios::Matchers::Meta::PassWithActualMatcher
+  # 
+  # @since 1.0.0
+  class FailWithActualMatcher < RSpec::SleepingKingStudios::Matchers::BaseMatcher
+    # @param [Object] expected the actual object to check the matcher against
+    def initialize expected
+      super
+      @expected = expected
+    end # method initialize
+
+    # Checks if the matcher evaluates to false with the expected object. If a
+    # message expectation is set, checks the value of
+    # #failure_message_for_should against the expected message.
+    # 
+    # @param [Object] actual the RSpec matcher to check; should respond to
+    #   :matches? and :failure_message_for_should, as a minimum
+    # 
+    # @return [Boolean] true if the matcher evaluates to false and the
+    #   matcher's #failure_message_for_should matches the expected message
+    #   (if any); otherwise false
+    def matches? actual
+      super
+      return false if @matches = @actual.matches?(@expected)
+
+      if @message.is_a? Regexp
+        !!(@actual.failure_message_for_should =~ @message)
+      elsif @message
+        @actual.failure_message_for_should == @message.to_s
+      else
+        true
+      end # if-elsif-else
+    end # method matches?
+
+    def failure_message_for_should
+      if @matches
+        "expected #{@actual} not to match #{@expected}"
+      else
+        message_text = @message.is_a?(Regexp) ? @message.inspect : @message.to_s
+
+        "expected message#{@message.is_a?(Regexp) ? " matching" : ""}:\n#{
+          message_text.lines.map { |line| "#{" " * 2}#{line}" }.join
+        }\nreceived message:\n#{
+          @actual.failure_message_for_should.lines.map { |line| "#{" " * 2}#{line}" }.join
+        }"
+      end # if-else
+    end # method failure_message_for_should
+
+    # @see BaseMatcher#failure_message_for_should_not
+    def failure_message_for_should_not
+      "failure: testing positive condition with negative matcher\n~>  use the :pass_with_actual matcher instead"
+    end # method failure_message_for_should_not
+
+    # The expected failure message for should when the matcher is called via
+    # expect#to.
+    # 
+    # @return [String, nil] the expected message if one has been defined;
+    #   otherwise nil
+    attr_reader :message
+
+    # Sets up a message expectation. When the matcher is called with the
+    # provided actual object, the matcher's failure_message_for_should
+    # message is compared to the provided message.
+    # 
+    # @param [String, Regexp] message the message to compare
+    # 
+    # @return [FailWithActualMatcher] self
+    def with_message message
+      @message = message
+      self
+    end # method with_message
+  end # class
+end # module
+
+module RSpec::SleepingKingStudios::Matchers
+  # @see RSpec::SleepingKingStudios::Matchers::Meta::FailWithActualMatcher#matches?
+  def fail_with_actual expected
+    Meta::FailWithActualMatcher.new expected
+  end # method fail_with_actual
+end # module
+
+=begin
+RSpec::Matchers.define :fail_with_actual do |actual|
+  match do |matcher|
+    @matcher = matcher
+    @actual  = actual
+    
+    next false if @matches = @matcher.matches?(@actual)
+    
+    text = @matcher.failure_message_for_should
+    if @message.is_a? Regexp
+      !!(text =~ @message)
+    elsif @message
+      text == @message.to_s
+    else
+      true
+    end # if-elsif-else
+  end # match
+  
+  failure_message_for_should do
+    if @matches = @matcher.matches?(@actual)
+      "expected #{@matcher} not to match #{@actual}"
+    else
+      message_text = @message.is_a?(Regexp) ? @message.inspect : @message.to_s
+
+      "expected message#{@message.is_a?(Regexp) ? " matching" : ""}:\n#{
+        message_text.lines.map { |line| "#{" " * 2}#{line}" }.join
+      }\nreceived message:\n#{
+        @matcher.failure_message_for_should.lines.map { |line| "#{" " * 2}#{line}" }.join
+      }"
+    end # if-else
+  end # method failure_message_for_should
+  
+  failure_message_for_should_not do
+    "failure: testing positive condition with negative matcher\n~>  use the :pass_with_actual matcher instead"
+  end # method failure_message_for_should_not
+
+  def message
+    @message
+  end # reader message
+
+  # The text of the tested matcher's :failure_message_for_should, when the
+  # tested matcher correctly fails to match the actual object.
+  def with_message message
+    @message = message
+    self
+  end # method with_message
+end # matcher pass
+=end

data/lib/rspec/sleeping_king_studios/matchers/meta/pass_with_actual.rb

@@ -0,0 +1,96 @@
+# lib/rspec/sleeping_king_studios/matchers/meta/pass_with_actual.rb
+
+require 'rspec/sleeping_king_studios/matchers/base_matcher'
+require 'rspec/sleeping_king_studios/matchers/meta/require'
+
+module RSpec::SleepingKingStudios::Matchers::Meta
+  # Matcher for testing whether an RSpec matcher will pass with a given actual
+  # object, and return the specified failure message if the matcher is called
+  # via expect#not_to.
+  # 
+  # @note Do not use this matcher with expect#not_to to verify that a matcher
+  #   will fail with a given actual object; use the #fail_with_actual matcher
+  #   instead.
+  # 
+  # @see RSpec::SleepingKingStudios::Matchers::Meta::FailWithActualMatcher
+  # 
+  # @since 1.0.0
+  class PassWithActualMatcher < RSpec::SleepingKingStudios::Matchers::BaseMatcher
+    # @param [Object] expected the actual object to check the matcher against
+    def initialize expected
+      super
+      @expected = expected
+    end # method initialize
+
+    # Checks if the matcher evaluates to true with the expected object. If a
+    # message expectation is set, checks the value of
+    # #failure_message_for_should_not against the expected message.
+    # 
+    # @param [Object] actual the RSpec matcher to check; should respond to
+    #   :matches? and :failure_message_for_should_not, as a minimum
+    # 
+    # @return [Boolean] true if the matcher evaluates to true and the matcher's
+    #   #failure_message_for_should_not matches the expected message (if any);
+    #   otherwise false
+    def matches? actual
+      super
+      return false unless @matches = @actual.matches?(@expected)
+
+      if @message.is_a? Regexp
+        !!(@actual.failure_message_for_should_not =~ @message)
+      elsif @message
+        @actual.failure_message_for_should_not == @message.to_s
+      else
+        true
+      end # if-elsif-else
+    end # method matches?
+
+    # @see BaseMatcher#failure_message_for_should_not
+    def failure_message_for_should
+      if @matches
+        message_text = @message.is_a?(Regexp) ? @message.inspect : @message.to_s
+
+        "expected message#{@message.is_a?(Regexp) ? " matching" : ""}:\n#{
+          message_text.lines.map { |line| "#{" " * 2}#{line}" }.join
+        }\nreceived message:\n#{
+          @actual.failure_message_for_should_not.lines.map { |line| "#{" " * 2}#{line}" }.join
+        }"
+      else
+        failure_message = @actual.failure_message_for_should
+        failure_message = failure_message.lines.map { |line| "#{" " * 4}#{line}" }.join("\n")
+        "expected #{@actual} to match #{@expected}\n  message:\n#{failure_message}"
+      end # if-else
+    end # method failure_message_for_should
+    
+    # @see BaseMatcher#failure_message_for_should_not
+    def failure_message_for_should_not
+      "failure: testing negative condition with positive matcher\n~>  use the :fail_with_actual matcher instead"
+    end # method failure_message_for_should_not
+
+    # The expected failure message for should_not when the matcher is called
+    # via expect#not_to.
+    # 
+    # @return [String, nil] the expected message if one has been defined;
+    #   otherwise nil
+    attr_reader :message
+
+    # Sets up a message expectation. When the matcher is called with the
+    # provided actual object, the matcher's failure_message_for_should_not
+    # message is compared to the provided message.
+    # 
+    # @param [String, Regexp] message the message to compare
+    # 
+    # @return [PassWithActualMatcher] self
+    def with_message message
+      @message = message
+      self
+    end # method with_message
+  end # class
+end # module
+
+module RSpec::SleepingKingStudios::Matchers
+  # @see RSpec::SleepingKingStudios::Matchers::Meta::PassWithActualMatcher#matches?
+  def pass_with_actual expected
+    Meta::PassWithActualMatcher.new expected
+  end # method pass_with_actual
+end # module

data/lib/rspec/sleeping_king_studios/matchers/meta/require.rb

@@ -0,0 +1,7 @@
+# lib/rspec/sleeping_king_studios/matchers/meta/require.rb
+
+require 'rspec/sleeping_king_studios/matchers/require'
+
+module RSpec::SleepingKingStudios::Matchers
+  module Meta; end
+end # module

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

@@ -0,0 +1,12 @@
+# lib/rspec/sleeping_king_studios/matchers/require.rb
+
+require 'rspec/sleeping_king_studios/require'
+
+module RSpec::SleepingKingStudios
+  # Custom matchers for use with RSpec::Expectations.
+  module Matchers; end
+end # module
+
+RSpec.configure do |config|
+  config.include RSpec::SleepingKingStudios::Matchers
+end # configuration

data/lib/rspec/sleeping_king_studios/matchers/shared/match_parameters.rb

@@ -0,0 +1,69 @@
+# lib/rspec/sleeping_king_studios/matchers/shared/parameters_matcher.rb
+
+require 'rspec/sleeping_king_studios/matchers/shared/require'
+
+module RSpec::SleepingKingStudios::Matchers::Shared
+  # Helper methods for checking the parameters and keywords (Ruby 2.0 only) of
+  # a method.
+  module MatchParameters
+    # Checks whether the method accepts the specified number or range of
+    # arguments.
+    # 
+    # @param [Method] method the method to check
+    # @param [Integer, Range] arity the expected number or range of parameters
+    # 
+    # @return [Boolean] true if the method accepts the specified number or both
+    #   the specified minimum and maximum number of parameters; otherwise false
+    def check_method_arity method, arity
+      parameters = method.parameters
+      required   = parameters.count { |type, | :req  == type }
+      optional   = parameters.count { |type, | :opt  == type }
+      variadic   = parameters.count { |type, | :rest == type }
+
+      min, max = arity.is_a?(Range) ?
+        [arity.begin, arity.end] :
+        [arity,       arity]
+
+      if min < required
+        return { :not_enough_args => { arity: min, count: required } }
+      elsif 0 == variadic && max > required + optional
+        return { :too_many_args   => { arity: max, count: required + optional } }
+      end # if
+
+      nil
+    end # method check_method_arity
+
+    # Checks whether the method accepts the specified keywords.
+    # 
+    # @param [Method] method the method to check
+    # @param [Array<String, Symbol>] keywords the expected keywords
+    # 
+    # @return [Boolean] true if the method accepts the specified keywords;
+    #   otherwise false
+    def check_method_keywords method, keywords
+      return nil unless RUBY_VERSION >= "2.0.0"
+
+      parameters = method.parameters
+      return nil if 0 < parameters.count { |type, _| :keyrest == type }
+
+      mismatch = []
+      keywords.each do |keyword|
+        mismatch << keyword unless parameters.include?([:key, keyword])
+      end # each
+
+      mismatch.empty? ? nil : { :unexpected_keywords => mismatch }
+    end # method check_method_keywords
+
+    # Checks whether the method expects a block.
+    # 
+    # @param [Method] method the method to check
+    # 
+    # @return [Boolean] true if the method expects a block argument; otherwise
+    #   false
+    def check_method_block method
+      0 == method.parameters.count { |type, | :block == type } ? { :expected_block => true } : nil
+    end # method check_method_block
+
+    private :check_method_arity, :check_method_block, :check_method_keywords
+  end # module
+end # module

data/lib/rspec/sleeping_king_studios/matchers/shared/require.rb

@@ -0,0 +1,7 @@
+# lib/rspec/sleeping_king_studios/matchers/shared/require.rb
+
+require 'rspec/sleeping_king_studios/matchers/require'
+
+module RSpec::SleepingKingStudios::Matchers
+  module Shared; end
+end # module

data/lib/rspec/sleeping_king_studios/mocks/custom_double.rb

@@ -0,0 +1,13 @@
+# lib/rspec/sleeping_king_studios/mocks/custom_double.rb
+
+module RSpec
+  module Mocks
+    module ExampleMethods
+      def custom_double(*args, &block)
+        args << {} unless Hash === args.last
+        args.last[:__declared_as] = "Custom Double"
+        Class.new(&block).new.tap { |obj| RSpec::Mocks::TestDouble.extend_onto obj, *args }
+      end # method
+    end # module
+  end # module
+end # module

data/lib/rspec/sleeping_king_studios/require.rb

@@ -0,0 +1,7 @@
+# lib/rspec/sleeping_king_studios/require.rb
+
+require 'rspec/core'
+
+module RSpec
+  module SleepingKingStudios; end
+end # module

data/lib/rspec/sleeping_king_studios/version.rb

@@ -0,0 +1,7 @@
+# lib/rspec/sleeping_king_studios/version.rb
+
+module RSpec
+  module SleepingKingStudios
+    VERSION = '1.0.0.rc.2'
+  end # module
+end # module

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: rspec-sleeping_king_studios
+version: !ruby/object:Gem::Version
+  version: 1.0.0.rc.2
+platform: ruby
+authors:
+- Rob "Merlin" Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      A collection of RSpec patches and custom matchers. The features can be
+      included individually or by category. For more information, check out the
+      README.
+email:
+- merlin@sleepingkingstudios.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rspec/sleeping_king_studios/matchers/active_model/have_errors/error_expectation.rb
+- lib/rspec/sleeping_king_studios/matchers/active_model/have_errors/message_expectation.rb
+- lib/rspec/sleeping_king_studios/matchers/active_model/have_errors/require.rb
+- lib/rspec/sleeping_king_studios/matchers/active_model/have_errors.rb
+- lib/rspec/sleeping_king_studios/matchers/active_model/require.rb
+- lib/rspec/sleeping_king_studios/matchers/active_model.rb
+- lib/rspec/sleeping_king_studios/matchers/base_matcher.rb
+- lib/rspec/sleeping_king_studios/matchers/built_in/be_kind_of.rb
+- lib/rspec/sleeping_king_studios/matchers/built_in/include.rb
+- lib/rspec/sleeping_king_studios/matchers/built_in/require.rb
+- lib/rspec/sleeping_king_studios/matchers/built_in/respond_to.rb
+- lib/rspec/sleeping_king_studios/matchers/built_in.rb
+- lib/rspec/sleeping_king_studios/matchers/core/be_boolean.rb
+- lib/rspec/sleeping_king_studios/matchers/core/construct.rb
+- lib/rspec/sleeping_king_studios/matchers/core/have_property.rb
+- lib/rspec/sleeping_king_studios/matchers/core/have_reader.rb
+- lib/rspec/sleeping_king_studios/matchers/core/have_writer.rb
+- lib/rspec/sleeping_king_studios/matchers/core/require.rb
+- lib/rspec/sleeping_king_studios/matchers/core.rb
+- lib/rspec/sleeping_king_studios/matchers/meta/fail_with_actual.rb
+- lib/rspec/sleeping_king_studios/matchers/meta/pass_with_actual.rb
+- lib/rspec/sleeping_king_studios/matchers/meta/require.rb
+- lib/rspec/sleeping_king_studios/matchers/meta.rb
+- lib/rspec/sleeping_king_studios/matchers/require.rb
+- lib/rspec/sleeping_king_studios/matchers/shared/match_parameters.rb
+- lib/rspec/sleeping_king_studios/matchers/shared/require.rb
+- lib/rspec/sleeping_king_studios/matchers.rb
+- lib/rspec/sleeping_king_studios/mocks/custom_double.rb
+- lib/rspec/sleeping_king_studios/require.rb
+- lib/rspec/sleeping_king_studios/version.rb
+- lib/rspec/sleeping_king_studios.rb
+- LICENSE
+- README.md
+homepage: http://sleepingkingstudios.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A collection of RSpec patches and custom matchers.
+test_files: []
+has_rdoc: