rspec-sleeping_king_studios 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e15c55731182411a98203f48327a37c8bfade042
-  data.tar.gz: 6ade1136197ac618a4551b2f2c7f9845b35832c7
+  metadata.gz: 001e7809e65b97646a63c8a663bcba7472df5327
+  data.tar.gz: a0309fd6b2ace7e0cceb015929d0b3449cb327df
 SHA512:
-  metadata.gz: ce9912aa7af89a8c55363d716506ce91dbbd4db7ecb4f31f0a12ddd90015800a93ab8e4b63ac6f3d8381575cc68540e0471fc80132b729cbf67a0707c34f5211
-  data.tar.gz: 3b1ee772ab9e74bdb0176988efeb1a636716f6575cec3bf84a2a73a586235a7554458b0531069ea5f7c1e973d3a3088be60c909d2ae843539e8a55bb99b82e30
+  metadata.gz: 23957e513898499443a028ed1aadbed73aa31b19a7deec654988c418710c25cc7362791ea627344a1b2ed87ff25bf4580b4b819d2a9f553f5529da4874245296
+  data.tar.gz: 4ff7d63a7da8145d064e6c7902be789332ffd6613aa52c51db8540b2639a4c16e671ce5c7322f04fa51cdea4670b46749a80f1a31bb42c04910da961b110f6a7

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 2.0.2
+
+#### `construct` and `respond_to` Matchers
+
+Added new fluent syntax for keyword expectations:
+
+    expect(my_object).to respond_to(:my_method).with(1..2).arguments.and_keywords(:foo, :bar)
+
+Also added support for expecting splatted arguments (`*args`) or keywords (`**kwargs`) using the `#with_unlimited_arguments` and `#with_arbitrary_keywords` methods.
+
+The old syntax (`respond_to(:my_method).with(1, :foo, :bar)`) will be supported through 3.0.
+
 ## 2.0.1
 
 Created suite of [Cucumber features](features) to validate and document the gem.

data/DEVELOPMENT.md

@@ -4,25 +4,26 @@
 
 ### Release Candidate
 
-### 2.0.1
+### 2.0.2
 
-- Add cucumber features
-  - Matcher features, including returned text DONE
-  - Concern features DONE
-  - Shared examples features DONE
-- Alias `construct` as `be_constructable`.
-  - Rewrite failure messages "to construct" => "to be constructable".
+- Add additional syntax option for #respond_to keywords, e.g. 'expect().to respond_to(:method).with(1).arguments.and_keywords(:foo, :bar)' DONE
+  - `expect().to respond_to().with_keywords()'
+  - `expect().to respond_to().with_arbitrary_keywords'
+- Add additional syntax (see above) to #be_constructible. DONE
 
 ### 2.1.0+
 
 - Add #wrap_context, #wrap_examples (alias encapsulate_X ?) for pattern `describe ""; include_examples "": end`
   - Configuration option 'alias_wrap_examples'?
-- Add shared examples for #belongs_to, #has_one, #has_many, #embedded_in, #embeds_one, #embeds_many.
-- Add shared examples for core ActiveModel validations.
+  - Automatically-focused #fwrap_context, #fwrap_examples?
+- Add #have_constant matcher.
+- Add shared examples for 'should not have reader/writer/property'
 
 ### 2.2.0+
 
-- Add alt doc test formatted - --format=list ? --format=documentation-list ?
+- Add shared examples for #belongs_to, #has_one, #has_many, #embedded_in, #embeds_one, #embeds_many.
+- Add shared examples for core ActiveModel validations.
+- Add alt doc test formatter - --format=list ? --format=documentation-list ?
   - Prints full expanded example name for each example
 - Add minimal test formatter - --format=smoke ? --format=librarian ?
   - Prints nothing for examples
@@ -31,3 +32,9 @@
 ### 3.0.0
 
 - Ensure behavior of `#have_reader`, `#have_writer`, `#have_property` is consistent.
+
+### Maintenance
+
+- Remove SCENARIOS from spec files.
+- Revisit failure messages for #respond_to, #be_constructible.
+- Pare down Cucumber features for matchers - repurpose as documentation/examples only.

data/README.md

@@ -158,7 +158,10 @@ Now has additional chaining functionality to validate the number of arguments ac
 **Chaining:**
 
 * **`#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`. As of 2.1.0 and required keywords, verifies that all required keywords are provided.
+* **`#with_unlimited_arguments`:** (also `and_unlimited_arguments`) No parameters. Verifies that the method accepts any number of arguments via a variadic argument of the form `*args`.
 * **`#with_a_block`:** (also `and_a_block`) No parameters. Verifies that the method requires a block argument of the form `&my_argument`. _Important note:_ A negative result _does not_ mean the method cannot accept a block, merely that it does not require one. Also, _does not_ check whether the block is called or yielded.
+* **`#with_keywords`:** (also `and_keywords`) Expects one or more String or Symbol arguments. Verifies that the method accepts each provided 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.
+* **`#with_arbitrary_keywords`:** (also `and_arbitrary_keywords`) No parameters. Verifies that the method accepts any keyword arguments via a variadic keyword of the form `**params`.
 
 ### Core
 
@@ -197,6 +200,9 @@ Verifies that the actual object can be constructed using `::new`. Can take an op
 **Chaining:**
 
 * **`#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`.  As of Ruby 2.1 and required keywords, verifies that all required keywords are provided.
+* **`#with_unlimited_arguments`:** (also `and_unlimited_arguments`) No parameters. Verifies that the class's constructor accepts any number of arguments via a variadic argument of the form `*args`.
+* **`#with_keywords`:** (also `and_keywords`) Expects one or more String or Symbol arguments. Verifies that the class's constructor accepts each provided 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.
+* **`#with_arbitrary_keywords`:** (also `and_arbitrary_keywords`) No parameters. Verifies that the class's constructor accepts any keyword arguments via a variadic keyword of the form `**params`.
 
 #### `#have_property` Matcher
 

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

@@ -53,12 +53,48 @@ module RSpec::SleepingKingStudios::Matchers::BuiltIn
     #
     #   @return [RespondToMatcher] self
     def with *keywords
-      @expected_arity    = keywords.shift if Integer === keywords.first || Range === keywords.first
-      @expected_keywords = keywords
+      @expected_arity = keywords.shift if Integer === keywords.first || Range === keywords.first
+
+      # TODO: Deprecate this behavior (for version 3.0?) - use the
+      # #with_keywords or #and_keywords methods instead.
+      (@expected_keywords ||= []).concat(keywords)
 
       self
     end # method with
 
+    # Adds an unlimited parameter count expectation, e.g. that the method
+    # supports splatted array arguments of the form *args.
+    #
+    # @return [RespondToMatcher] self
+    def with_unlimited_arguments
+      @expect_unlimited_arguments = true
+
+      self
+    end # method with_unlimited_arguments
+    alias_method :and_unlimited_arguments, :with_unlimited_arguments
+
+    # Adds one or more keyword expectations.
+    #
+    # @param [Array<String, Symbol>] keywords List of keyword arguments
+    #   accepted by the method.
+    #
+    # @return [RespondToMatcher] self
+    def with_keywords *keywords
+      (@expected_keywords ||= []).concat(keywords)
+
+      self
+    end # method with_keywords
+    alias_method :and_keywords, :with_keywords
+
+    # Adds an arbitrary keyword expectation, e.g. that the method supports
+    # any keywords with splatted hash arguments of the form **kwargs.
+    def with_arbitrary_keywords
+      @expect_arbitrary_keywords = true
+
+      self
+    end # method with_arbitrary_keywords
+    alias_method :and_arbitrary_keywords, :with_arbitrary_keywords
+
     # Adds a block expectation. The actual object will only match a block
     # expectation if it expects a parameter of the form &block.
     #
@@ -115,9 +151,9 @@ module RSpec::SleepingKingStudios::Matchers::BuiltIn
     end # method find_failing_method_names
 
     def matches_arity? actual, name
-      return true unless @expected_arity
+      return true unless @expected_arity || @expect_unlimited_arguments
 
-      if result = check_method_arity(actual.method(name), @expected_arity)
+      if result = check_method_arity(actual.method(name), @expected_arity, expect_unlimited_arguments: @expect_unlimited_arguments)
         (@failing_method_reasons[name] ||= {}).update result
         return false
       end # if
@@ -127,9 +163,10 @@ module RSpec::SleepingKingStudios::Matchers::BuiltIn
 
     def matches_keywords? actual, name
       return true unless @expected_keywords ||
+        @expect_arbitrary_keywords ||
         (@expected_arity && RUBY_VERSION >= "2.1.0")
 
-      if result = check_method_keywords(actual.method(name), @expected_keywords)
+      if result = check_method_keywords(actual.method(name), @expected_keywords, expect_arbitrary_keywords: @expect_arbitrary_keywords)
         (@failing_method_reasons[name] ||= {}).update result
         return false
       end # if
@@ -164,10 +201,18 @@ module RSpec::SleepingKingStudios::Matchers::BuiltIn
         messages << "#{@expected_arity.inspect} #{pluralize @expected_arity, 'argument', 'arguments'}"
       end # if
 
+      if @expect_unlimited_arguments
+        messages << 'unlimited arguments'
+      end # if
+
       if !(@expected_keywords.nil? || @expected_keywords.empty?)
         messages << "#{pluralize @expected_keywords.count, 'keyword', 'keywords'} #{humanize_list @expected_keywords.map(&:inspect)}"
       end # if
 
+      if @expect_arbitrary_keywords
+        messages << 'arbitrary keywords'
+      end # if
+
       if @expected_block
         messages << "a block"
       end # if
@@ -180,9 +225,19 @@ module RSpec::SleepingKingStudios::Matchers::BuiltIn
 
       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)
+      end # if
+
+      if hsh = reasons.fetch(:too_many_args, false)
         messages << "  expected at most #{hsh[:count]} arguments, but received #{hsh[:arity]}"
-      end # if-elsif
+      end # if
+
+      if hsh = reasons.fetch(:expected_unlimited_arguments, false)
+        messages << "  expected at most #{hsh[:count]} arguments, but received unlimited arguments"
+      end # if
+
+      if reasons.fetch(:expected_arbitrary_keywords, false)
+        messages << "  expected arbitrary keywords"
+      end # if
 
       if ary = reasons.fetch(:missing_keywords, false)
         messages << "  missing #{pluralize ary.count, 'keyword', 'keywords'} #{humanize_list ary.map(&:inspect)}"

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

@@ -73,6 +73,39 @@ module RSpec::SleepingKingStudios::Matchers::Core
       self
     end # method with
 
+    # Adds an unlimited parameter count expectation, e.g. that the method
+    # supports splatted array arguments of the form *args.
+    #
+    # @return [RespondToMatcher] self
+    def with_unlimited_arguments
+      @expect_unlimited_arguments = true
+
+      self
+    end # method with_unlimited_arguments
+    alias_method :and_unlimited_arguments, :with_unlimited_arguments
+
+    # Adds one or more keyword expectations.
+    #
+    # @param [Array<String, Symbol>] keywords List of keyword arguments
+    #   accepted by the method.
+    #
+    # @return [RespondToMatcher] self
+    def with_keywords *keywords
+      (@expected_keywords ||= []).concat(keywords)
+
+      self
+    end # method with_keywords
+    alias_method :and_keywords, :with_keywords
+
+    # Adds an arbitrary keyword expectation, e.g. that the method supports
+    # any keywords with splatted hash arguments of the form **kwargs.
+    def with_arbitrary_keywords
+      @expect_arbitrary_keywords = true
+
+      self
+    end # method with_arbitrary_keywords
+    alias_method :and_arbitrary_keywords, :with_arbitrary_keywords
+
     # Convenience method for more fluent specs. Does nothing and returns self.
     #
     # @return [ConstructMatcher] self
@@ -102,9 +135,9 @@ module RSpec::SleepingKingStudios::Matchers::Core
     private
 
     def matches_arity? actual
-      return true unless @expected_arity
+      return true unless @expected_arity || @expect_unlimited_arguments
 
-      if result = check_method_arity(actual.allocate.method(:initialize), @expected_arity)
+      if result = check_method_arity(actual.allocate.method(:initialize), @expected_arity, expect_unlimited_arguments: @expect_unlimited_arguments)
         @failing_method_reasons.update result
         return false
       end # if
@@ -114,9 +147,10 @@ module RSpec::SleepingKingStudios::Matchers::Core
 
     def matches_keywords? actual
       return true unless @expected_keywords ||
+        @expect_arbitrary_keywords ||
         (@expected_arity && RUBY_VERSION >= "2.1.0")
 
-      if result = check_method_keywords(actual.allocate.method(:initialize), @expected_keywords)
+      if result = check_method_keywords(actual.allocate.method(:initialize), @expected_keywords, expect_arbitrary_keywords: @expect_arbitrary_keywords)
         @failing_method_reasons.update result
         return false
       end # if
@@ -131,10 +165,18 @@ module RSpec::SleepingKingStudios::Matchers::Core
         messages << "#{@expected_arity.inspect} argument#{1 == @expected_arity ? "" : "s"}"
       end # if
 
+      if @expect_unlimited_arguments
+        messages << 'unlimited arguments'
+      end # if
+
       if !(@expected_keywords.nil? || @expected_keywords.empty?)
         messages << "#{pluralize @expected_keywords.count, 'keyword', 'keywords'} #{humanize_list @expected_keywords.map(&:inspect)}"
       end # if
 
+      if @expect_arbitrary_keywords
+        messages << 'arbitrary keywords'
+      end # if
+
       humanize_list messages
     end # method format_expected_arguments
 
@@ -147,6 +189,10 @@ module RSpec::SleepingKingStudios::Matchers::Core
         messages << "  expected at most #{hsh[:count]} arguments, but received #{hsh[:arity]}"
       end # if-elsif
 
+      if hsh = reasons.fetch(:expected_unlimited_arguments, false)
+        messages << "  expected at most #{hsh[:count]} arguments, but received unlimited arguments"
+      end # if
+
       if ary = reasons.fetch(:missing_keywords, false)
         messages << "  missing #{pluralize ary.count, 'keyword', 'keywords'} #{humanize_list ary.map(&:inspect)}"
       end # if
@@ -155,6 +201,10 @@ module RSpec::SleepingKingStudios::Matchers::Core
         messages << "  unexpected #{pluralize ary.count, 'keyword', 'keywords'} #{humanize_list ary.map(&:inspect)}"
       end # if
 
+      if reasons.fetch(:expected_arbitrary_keywords, false)
+        messages << "  expected arbitrary keywords"
+      end # if
+
       messages.join "\n"
     end # method format_errors
   end # class

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

@@ -8,39 +8,42 @@ module RSpec::SleepingKingStudios::Matchers::Shared
   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
+    def check_method_arity method, arity, expect_unlimited_arguments: false
       parameters = method.parameters
       required   = parameters.count { |type, | :req  == type }
       optional   = parameters.count { |type, | :opt  == type }
       variadic   = parameters.count { |type, | :rest == type }
+      reasons    = {}
+
+      reasons[:expected_unlimited_arguments] = { count: required + optional } if 0 == variadic && expect_unlimited_arguments
 
       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 } }
+      if min && min < required
+        reasons[:not_enough_args] = { arity: min, count: required }
+      elsif max && 0 == variadic && max > required + optional
+        reasons[:too_many_args]   = { arity: max, count: required + optional }
       end # if
 
-      nil
+      reasons.empty? ? nil : reasons
     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
+    def check_method_keywords method, keywords, expect_arbitrary_keywords: false
       keywords ||= []
       parameters = method.parameters
       reasons    = {}
@@ -51,11 +54,13 @@ module RSpec::SleepingKingStudios::Matchers::Shared
         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 }
+        reasons[:expected_arbitrary_keywords] = true if expect_arbitrary_keywords
+
         mismatch = []
         keywords.each do |keyword|
           mismatch << keyword unless
@@ -70,9 +75,9 @@ module RSpec::SleepingKingStudios::Matchers::Shared
     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

data/lib/rspec/sleeping_king_studios/version.rb

@@ -13,7 +13,7 @@ module RSpec
       # Minor version.
       MINOR = 0
       # Patch version.
-      PATCH = 1
+      PATCH = 2
       # Prerelease version.
       PRERELEASE = nil
       # Build metadata.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-sleeping_king_studios
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Rob "Merlin" Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-27 00:00:00.000000000 Z
+date: 2015-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec