rspec-sleeping_king_studios 2.2.1 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a624525849f4ac71e4e9379c06485922a45ebcf3
-  data.tar.gz: d0f25ed5326bf5622fbe7f6ecf5b34876137795b
+  metadata.gz: 27bca27d749c25c4832b3d37afd538134f0ee912
+  data.tar.gz: f6f3b0722eadb234a5aa816e2aac941690c25dc3
 SHA512:
-  metadata.gz: a074ea75dd5cb71099993b2f973e1d597a64e8383a36e57b781524ee4c57c7b3ef961a59a5f16bd296c658e10a8b22eed05f424b8642d0a08d9d5a7e1dd3575f
-  data.tar.gz: 6523220cde82b00c49377c75f529953f2ff4b92414bf5ba7395e3724a2ec27bdb62c2640e6ac2e78650b6f1aa1629afd00a230c64c4e64517427e366fbe859b8
+  metadata.gz: 6e989536954b97e1e936ec60fcb7351d5234dcf0ad7ee12e07cbd3495ba0075f42c474e0119d59e0b1491c017056a1868bd2bf6b993c575616b138a35de8c17c
+  data.tar.gz: 8730519c5e59a2a59cd22e30a9aee251cf63330ad17d16f57ae3d7cda414f51fe94cfd32b78eac54e7f567511320573fab3cf313b6de89e22a70983a878046ba

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 2.2.2
+
+Added configuration option to catch empty #include matchers.
+
 ## 2.2.1
 
 Fixed dependency on a pre-release SleepingKingStudios::Tools.

data/DEVELOPMENT.md

@@ -1,10 +1,11 @@
 # Development Notes
 
-## Version 2.2.1
+## Version 2.3
 
 ### Features
 
 - Alias `have_constant` as `define_constant`.
+  - Alias #immutable as #frozen.
   - Also alias shared examples.
 - Implement RespondToMatcher#with_at_least(N).arguments, equivalent to with(N).arguments.and_unlimited_arguments.
 - Revisit failure messages for #respond_to, #be_constructible - see #received/#have_received for example?
@@ -15,8 +16,14 @@
 - Resolve Aruba deprecation warnings.
 - Run each file individually as CI step.
 
+### Bug Fixes
+
+- false negative on #alias_method?
+  - compare via Method#source_location equality and Method#original_name is expected?
+
 ### Features
 
+- let?(:name) { } # Defines a memoized helper, but only if one is not already defined.
 - Add spy+matcher for expect(my_object, :my_method).to have_changed ?
 - Add 'should have class reader/writer/property' shared examples.
 - Add 'should have private reader/writer/property' shared examples.

data/README.md

@@ -66,6 +66,20 @@ This option is used with the RSpec matcher examples (see Examples, below), and d
 
 #### Matchers
 
+##### Allow Empty Include Matchers
+
+    RSpec.configure do |config|
+      config.sleeping_king_studios do |config|
+        config.matchers do |config|
+          config.allow_empty_include_matchers = false
+        end # config
+      end # config
+    end # config
+
+This option is used with the IncludeMatcher (see `#include`, below). If this option is set to false, an ArgumentError will be raised when attempting to instantiate an IncludeMatcher without any expectations.
+
+This prevents an insidious bug when using the `do..end` block syntax to create a block expectation while the matcher macro is itself an argument to another function, such as ExpectationTarget#to. This bug causes the block to be silently ignored and any enumerable object to match against the matcher, even an empty object.
+
 ##### Strict Predicate Matching
 
     RSpec.configure do |config|

data/lib/rspec/sleeping_king_studios/configuration.rb

@@ -69,6 +69,35 @@ module RSpec::SleepingKingStudios
 
     # Configuration options for RSpec::SleepingKingStudios::Matchers.
     class Matchers
+      # Checks whether the #include matcher can be instantiated without an
+      # expectation object or block.
+      #
+      # @return [Boolean] True if the empty include matchers are permitted,
+      #   otherwise false.
+      def allow_empty_include_matchers
+        value = @allow_empty_include_matchers
+
+        value.nil? ? true : value
+      end # method allow_empty_include_matchers
+      alias_method :allow_empty_include_matchers?, :allow_empty_include_matchers
+
+      # Sets whether the #include matcher can be instantiated without an
+      # expectation object or block. If this option is set to false, an
+      # ArgumentError will be raised when attempting to instantiate an
+      # IncludeMatcher without any expectations.
+      #
+      # This prevents an insidious bug when using the do..end block syntax to
+      # create a block expectation while the matcher macro is itself an argument
+      # to another function, such as ExpectationTarget#to. This bug causes the
+      # block to be silently ignored and any enumerable object to match against
+      # the matcher, even an empty object.
+      #
+      # @return [Boolean] True if the empty include matchers are permitted,
+      #   otherwise false.
+      def allow_empty_include_matchers= value
+        @allow_empty_include_matchers = !!value
+      end # method allow_empty_include_matchers
+
       # Checks whether predicates are matched "strictly", meaning that they must
       # return either true or false.
       #
@@ -77,6 +106,7 @@ module RSpec::SleepingKingStudios
       def strict_predicate_matching
         @strict_predicate_matching ||= false
       end # method strict_predicate_matching
+      alias_method :strict_predicate_matching?, :strict_predicate_matching
 
       # Sets whether predicates are matched "strictly", meaning that they must
       # return either true or false.

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

@@ -19,6 +19,12 @@ module RSpec::SleepingKingStudios::Matchers::BuiltIn
     def initialize *expected, &block
       expected << block if block_given?
 
+      if expected.empty? && !allow_empty_matcher?
+        raise ArgumentError,
+          'must specify an item expectation',
+          caller
+      end # if
+
       super *expected
     end # constructor
 
@@ -81,6 +87,10 @@ module RSpec::SleepingKingStudios::Matchers::BuiltIn
       end # if-else
     end # method actual_matches_proc?
 
+    def allow_empty_matcher?
+      RSpec.configure { |config| config.sleeping_king_studios.matchers }.allow_empty_include_matchers?
+    end # method strict_matching?
+
     def comparing_proc? expected_item
       expected_item.is_a?(Proc)
     end # method comparing_proc?

data/lib/rspec/sleeping_king_studios/version.rb

@@ -13,7 +13,7 @@ module RSpec
       # Minor version.
       MINOR = 2
       # 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.2.1
+  version: 2.2.2
 platform: ruby
 authors:
 - Rob "Merlin" Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-08 00:00:00.000000000 Z
+date: 2016-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec