rspec-sleeping_king_studios 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eacdb4f86da6d740f308ddb9a675868c24b3c755
-  data.tar.gz: f388c524d957784e5a1a2c3fc2cca4e4969f1906
+  metadata.gz: 2914760ac00f260530d026c9aa1fb0215f1942cb
+  data.tar.gz: 185f9dc20a98f638ce428af5f53c353408734913
 SHA512:
-  metadata.gz: 684e21095094b3f7acd446216787431f758ff8acc2a8d02e1a323434b589057f58034feea233fe4aafac475b5ea8abb538d986a610275c4bb5ab585bebed9ace
-  data.tar.gz: 76c148980d27ddb6c78a635eee7a3da7248a0b1e953717521c61a08fa88643607a34941807eaa9352e3fbbe20de3f50d82ce9473510388f5a237c7c036bf9ed5
+  metadata.gz: 331f73ab249d34ecb3a46f327136774a8755c74de5cd543fc8a0b709ccfd354f1d1e5f73b6286ebf28f758d604574f952ed13432591a9817877225a904f9b5ca
+  data.tar.gz: 7550a28dd849c96e717df1d1e38a4eba927116aaa0caeccefdf8a97bd2ba6d8f32f8387c841ef2f6c39464e32dfc674747a7c77e9e6852a66399e7dab68b63f7

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+## 1.0.1
+
+### New Features
+
+* The #construct and #respond_to matchers now support 2.1.0 required keyword
+  arguments, of the form def foo(bar:, baz:). If the class constructor or
+  method requires one or more keyword arguments, and one or more of those 
+  keywords are not provided when checking arguments using the #with
+  method, the matcher will fail with the message "missing keywords" and a list of the keywords that were not provided as arguments to #with.
+
+## 1.0.0
+
+* Official release.

data/README.md

@@ -2,6 +2,14 @@
 
 A collection of matchers and extensions to ease TDD/BDD using RSpec.
 
+## Supported Ruby Versions
+
+Currently, the following versions of Ruby are officially supported:
+
+* 1.9.3
+* 2.0.0
+* 2.1.0
+
 ## The Extensions
 
 To enable an extension, simply require the associated file.
@@ -126,7 +134,9 @@ Has additional functionality to support Ruby 2.0 keyword arguments.
 
 * **with:** Expects at most one Integer or Range argument, and zero or more
   Symbol arguments corresponding to optional keywords. Verifies that the method
-  accepts that keyword, or has a variadic keyword of the form \*\*params.
+  accepts that keyword, or has a variadic keyword of the form \*\*params. As 
+  of 2.1.0 and required keywords, verifies that all required keywords are 
+  provided.
 
 ### Core
 
@@ -179,12 +189,8 @@ Has additional functionality to support Ruby 2.0 keyword arguments.
 * **with:** Expects one Integer, Range, or nil argument, and zero or more
   Symbol arguments corresponding to optional keywords. Verifies that the
   class's constructor accepts that keyword, or has a variadic keyword of the
-  form \*\*params.
-
-  _Important note:_ If you do not wish to validate the number of arguments,
-  make sure to use nil as the first argument to #with; otherwise, the matcher
-  will interpret your first keyword as the number of arguments to expect. And
-  then explode.
+  form \*\*params.  As of 2.1.0 and required keywords, verifies that all 
+  required keywords are provided.
 
 #### have\_property Matcher
 

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

@@ -126,7 +126,8 @@ module RSpec::SleepingKingStudios::Matchers::BuiltIn
     end # method matches_arity?
 
     def matches_keywords? actual, name
-      return true unless @expected_keywords
+      return true unless @expected_keywords ||
+        (@expected_arity && RUBY_VERSION >= "2.1.0")
 
       if result = check_method_keywords(actual.method(name), @expected_keywords)
         (@failing_method_reasons[name] ||= {}).update result
@@ -134,6 +135,15 @@ module RSpec::SleepingKingStudios::Matchers::BuiltIn
       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
@@ -181,6 +191,10 @@ module RSpec::SleepingKingStudios::Matchers::BuiltIn
         messages << "  expected at most #{hsh[:count]} arguments, but received #{hsh[:arity]}"
       end # if-elsif
 
+      if ary = reasons.fetch(:missing_keywords, false)
+        messages << "  missing keywords #{ary.map(&:inspect).join(", ")}"
+      end # if
+
       if ary = reasons.fetch(:unexpected_keywords, false)
         messages << "  unexpected keywords #{ary.map(&:inspect).join(", ")}"
       end # if

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

@@ -38,8 +38,8 @@ module RSpec::SleepingKingStudios::Matchers::Core
     #   accepted by the method
     # 
     # @return [ConstructMatcher] self
-    def with count = nil, *keywords
-      @expected_arity    = count unless count.nil?
+    def with *keywords
+      @expected_arity    = keywords.shift if Integer === keywords.first || Range === keywords.first
       @expected_keywords = keywords
       self
     end # method with
@@ -81,7 +81,8 @@ module RSpec::SleepingKingStudios::Matchers::Core
     end # method matches_arity?
 
     def matches_keywords? actual
-      return true unless @expected_keywords
+      return true unless @expected_keywords ||
+        (@expected_arity && RUBY_VERSION >= "2.1.0")
 
       if result = check_method_keywords(actual.allocate.method(:initialize), @expected_keywords)
         @failing_method_reasons.update result
@@ -121,6 +122,10 @@ module RSpec::SleepingKingStudios::Matchers::Core
         messages << "  expected at most #{hsh[:count]} arguments, but received #{hsh[:arity]}"
       end # if-elsif
 
+      if ary = reasons.fetch(:missing_keywords, false)
+        messages << "  missing keywords #{ary.map(&:inspect).join(", ")}"
+      end # if
+
       if ary = reasons.fetch(:unexpected_keywords, false)
         messages << "  unexpected keywords #{ary.map(&:inspect).join(", ")}"
       end # if

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

@@ -43,15 +43,32 @@ module RSpec::SleepingKingStudios::Matchers::Shared
     def check_method_keywords method, keywords
       return nil unless RUBY_VERSION >= "2.0.0"
 
+      keywords ||= []
       parameters = method.parameters
-      return nil if 0 < parameters.count { |type, _| :keyrest == type }
+      reasons    = {}
 
-      mismatch = []
-      keywords.each do |keyword|
-        mismatch << keyword unless parameters.include?([:key, keyword])
-      end # each
+      # Check for missing required keywords.
+      if RUBY_VERSION >= "2.1.0"
+        missing = []
+        parameters.select { |type, _| :keyreq == type }.each do |_, keyword|
+          missing << keyword unless keywords.include?(keyword)
+        end # each
+        
+        reasons[:missing_keywords] = missing unless missing.empty?
+      end # if
+
+      unless 0 < parameters.count { |type, _| :keyrest == type }
+        mismatch = []
+        keywords.each do |keyword|
+          mismatch << keyword unless
+            parameters.include?([:key,    keyword]) ||
+            parameters.include?([:keyreq, keyword])
+        end # each
+
+        reasons[:unexpected_keywords] = mismatch unless mismatch.empty?
+      end # unless
 
-      mismatch.empty? ? nil : { :unexpected_keywords => mismatch }
+      reasons.empty? ? nil : reasons
     end # method check_method_keywords
 
     # Checks whether the method expects a block.

data/lib/rspec/sleeping_king_studios/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module SleepingKingStudios
-    VERSION = '1.0.0'
+    VERSION = '1.0.1'
   end # module
 end # module

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-sleeping_king_studios
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Rob "Merlin" Smith
@@ -56,30 +56,30 @@ dependencies:
   name: fuubar
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.1
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.12
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.12
 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
@@ -90,6 +90,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE
 - README.md
 - lib/rspec/sleeping_king_studios.rb