rspec-sleeping_king_studios 2.5.1 → 2.6.0.rc.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '096c6d91e990581772d795cedab4356ac8b07f84712d2a52e61fd715d47bfbc2'
-  data.tar.gz: b2f7d0d162e1678be6a8ed0886ec1a9670321bbe64abc6a4f58a30b58e479725
+  metadata.gz: 8dd0e24014dae4f35a224e0c8d244b7e20d827d22c88ddf966f7ae201b1e148e
+  data.tar.gz: c3658bf3b7261942c9e166df38b7fdf5639688a074ca3a4cfb70992ae2698c8e
 SHA512:
-  metadata.gz: c6bd478d39bd8ec15b23b12440ca82b839e652376cfb761b2fa56c1e6228c6ebfd0658156bc886c5ab58a31547801dc581e732be98392280f913beb240ee4b49
-  data.tar.gz: ccc88ee28086629ab456961cdc746a8647c0c285d1d0e1734000abae8ece56532324f36e9568a64e00156186e4c5c0eeab1912f5029b7315ad717e855170447b
+  metadata.gz: 8fb97318df347582c4204f6a7f61e359d87069952f24ef72e928514e97d84fd82372d77300c7e1f01669fea239526ea6021d28be151f49177939ad0760755667
+  data.tar.gz: 2e1da21ffdd79e55c5891dd3a7f10247bb5aed761454ee1f7898275788cc77022ac3d0deefe3ac4a7470b0696d0ee6accb94809794b72f19a410bcd16dc4f787

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 2.6.0
+
+Deprecated the DelegateMethod matcher. Use `rspec-mocks` expectations instead.
+
+Deprecated the Include matcher with a block. Use the `satisfy` matcher instead.
+
+### Matchers
+
+Updated RespondToMatcher to check the arity of `#initialize` when matching against a class and the method name is `:new`.
+
 ## 2.5.1
 
 Fixed a compatibility issue with Rails 6 configuration objects.

data/DEVELOPMENT.md

@@ -2,25 +2,12 @@
 
 ## Version 2.6
 
-### Features - Matchers
-
-- RespondToMatcher: |
-    update to match core respond_to matcher
-    - uses the signature from initialize to validate checks for new
-    - see https://github.com/rspec/rspec-expectations/blob/master/Changelog.md
-  subclass BeConstructibleMatcher from RespondTo ?
-
-## Version 2.6+
-
-- DeepMatcher: |
-  - indifferent - symbol/string keys
-  - ordered - pre-sort arrays?
-    - only homogenous arrays?
-    - odd results unless equality comparison
+- Deprecate `delegate_method` matcher, `include` matcher with block.
 
 ## Version 3.0
 
 - Extract out Rails-specific matchers to RSpec::SleepingKingStudios::Rails.
+  - Drop Rails 3 support.
 - Refactor property, constant matchers to Define$1Matcher.
   - HaveConstantMatcher, HaveReaderMatcher, HavePredicateMatcher, HavePropertyMatcher, HaveWriterMatcher.
   - Designate define_* macros as primary, have_* as aliases.
@@ -31,6 +18,12 @@
 
 ## Future Tasks
 
+- DeepMatcher: |
+  - indifferent - symbol/string keys
+  - ordered - pre-sort arrays?
+    - only homogenous arrays?
+    - odd results unless equality comparison
+
 ### Bug Fixes
 
 - false negative on #alias_method?

data/README.md

@@ -322,7 +322,166 @@ A simplified syntax for re-using shared context or examples without having to ex
 
 (also `::xwrap_context`) A shortcut for wrapping the context or examples in an automatically-skipped `describe` block, similar to the built-in `xit` and `xdescribe` methods.
 
-## Custom Matchers
+## Contracts
+
+```ruby
+require 'rspec/sleepingkingstudios/contract'
+```
+
+A Contract encapsulates a set of RSpec expectations, which can then be used when defining a spec.
+
+```ruby
+module GreetContract
+  extend RSpec::SleepingKingStudios::Contract
+
+  describe '#greet' do
+    it { expect(subject).to respond_to(:greet).with(1).argument }
+
+    it { expect(subject.greet 'programs').to be == 'Greetings, programs!' }
+  end
+end
+
+RSpec.describe Greeter do
+  include GreetContract
+end
+```
+
+Using a contract allows for examples to be shared between different specs, or even between projects.
+
+### Contract Methods
+
+Not all RSpec methods are defined in a Contract. Only methods that define an example (`it`) or an example group (`context` or `describe`) can be used at the top level of a Contract. However, all RSpec methods (including methods that modify the current scope, such as `let` and the `before`/`around`/`after` filters) can be used inside an example group as normal.
+
+#### `::context`
+
+Defines an example group inside the contract. This example group will be defined on all specs that include the contract.
+
+```ruby
+module TransformationContract
+  extend RSpec::SleepingKingStudios::Contract
+
+  context 'when the moon is full' do
+    let(:moon_phase) { :full }
+
+    it { expect(werewolf).to be_transformed }
+  end
+end
+```
+
+#### `::describe`
+
+Defines an example group inside the contract. This example group will be defined on all specs that include the contract.
+
+```ruby
+module SilverContract
+  extend RSpec::SleepingKingStudios::Contract
+
+  describe 'with a silver weapon' do
+    before(:example) do
+      weapon.material = 'silver'
+    end
+
+    it 'should kill the werewolf' do
+      expect(attack(werewolf, weapon)).to change(werewolf, :alive?).to be false
+    end
+  end
+end
+```
+
+#### `::it`
+
+Defines an example inside the contract.
+
+```ruby
+module HowlingContract
+  extend RSpec::SleepingKingStudios::Contract
+
+  it { expect(werewolf).to respond_to(:howl) }
+end
+```
+
+#### `::shared_context`
+
+Defines a shared example group.
+
+```ruby
+module MoonContract
+  extend RSpec::SleepingKingStudios::Contract
+
+  shared_context 'when the moon is full' do
+    before(:example) { moon.phase = :full }
+  end
+end
+```
+
+**Note:** When the `Contract` is included in an RSpec example group, any shared example groups defined at the top level of a contract are also included in that example group, even outside of the contract itself. This may cause namespace collisions with shared example groups defined elsewhere in the example group or by other included contracts.
+
+#### `::shared_examples`
+
+Defines a shared example group.
+
+```ruby
+module HairContract
+  extend RSpec::SleepingKingStudios::Contract
+
+  shared_examples 'should be hairy' do
+    describe '#hairy?' do
+      it { expect(werewolf.hairy?).to be true }
+    end
+  end
+end
+```
+
+**Note:** When the `Contract` is included in an RSpec example group, any shared example groups defined at the top level of a contract are also included in that example group, even outside of the contract itself. This may cause namespace collisions with shared example groups defined elsewhere in the example group or by other included contracts.
+
+### Developing Contracts
+
+```ruby
+module VampireContract
+  extend RSpec::SleepingKingStudios::Contract
+  extend RSpec::SleepingKingStudios::Contracts::Development
+
+  fdescribe '#drink' do
+    it { expect(drink 'blood').to be true }
+
+    xit { expect(drink 'holy water').to be false }
+  end
+
+  pending
+end
+```
+
+The `RSpec::SleepingKingStudios::Contracts::Development` module provides methods for defining focused or pending examples and example groups. These are intended for use when developing a contract, and should not be included in the final version. Having skipped or focused example groups in a shared contract can have unexpected effects when the contract is included by the end user.
+
+#### `::fcontext`
+
+Defines a focused example group inside the contract.
+
+#### `::fdescribe`
+
+Defines a focused example group inside the contract.
+
+#### `::fit`
+
+Defines a focused example inside the contract.
+
+#### `::pending`
+
+Marks the contract as pending.
+
+#### `::xcontext`
+
+Defines a skipped example group inside the contract.
+
+#### `::xdescribe`
+
+Defines a skipped example group inside the contract.
+
+#### `::xit`
+
+Defines a skipped example inside the contract.
+
+## Matchers
 
 To enable a custom matcher, simply require the associated file. Matchers can be required individually or by category:
 

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

@@ -17,7 +17,12 @@ module RSpec::SleepingKingStudios::Matchers::BuiltIn
     #   should return true if and only if the item matches the desired
     #   predicate.
     def initialize *expected, &block
-      expected << block if block_given?
+      if block_given?
+        SleepingKingStudios::Tools::CoreTools
+          .deprecate('IncludeMatcher with a block')
+
+          expected << block
+      end
 
       if expected.empty? && !allow_empty_matcher?
         raise ArgumentError,

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

@@ -87,18 +87,18 @@ module RSpec::SleepingKingStudios::Matchers::BuiltIn
 
         method =
           begin
-            actual.method(method_name)
+            if actual.is_a?(Class) && method_name.intern == :new
+              actual.instance_method(:initialize)
+            else
+              actual.method(method_name)
+            end
           rescue NameError
-            nil
-          end # unless
+            @failing_method_reasons[method_name] = {
+              :is_not_a_method => true
+            } # end hash
 
-        unless method.is_a?(Method)
-          @failing_method_reasons[method_name] = {
-            :is_not_a_method => true
-          } # end hash
-
-          next false
-        end # unless
+            next false
+          end
 
         next true unless method_signature_expectation?
 

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

@@ -125,6 +125,8 @@ module RSpec::SleepingKingStudios::Matchers::Core
 
     # (see BaseMatcher#matches?)
     def matches? actual
+      SleepingKingStudios::Tools::CoreTools.deprecate('DelegateMethodMatcher')
+
       super
 
       raise ArgumentError.new('must specify a target') if @target.nil?
@@ -187,14 +189,22 @@ module RSpec::SleepingKingStudios::Matchers::Core
 
     private
 
-    def call_method arguments, expected_return = DEFAULT_EXPECTED_RETURN
+    def call_method(arguments:, keywords:, expected_return: DEFAULT_EXPECTED_RETURN)
       if @expected_block
         @received_block = false
         block           = ->(*args, **kwargs, &block) {}
 
-        return_value = @actual.send(@expected, *arguments, &block)
+        if keywords.empty?
+          return_value = @actual.send(@expected, *arguments, &block)
+        else
+          return_value = @actual.send(@expected, *arguments, **keywords, &block)
+        end
       else
-        return_value = @actual.send(@expected, *arguments)
+        if keywords.empty?
+          return_value = @actual.send(@expected, *arguments)
+        else
+          return_value = @actual.send(@expected, *arguments, **keywords)
+        end
       end
 
       @received_return_values << return_value
@@ -215,19 +225,22 @@ module RSpec::SleepingKingStudios::Matchers::Core
     def delegates_method?
       stub_target!
 
-      args = @expected_arguments.dup
-      args << @expected_keywords unless @expected_keywords.empty?
-
       if @expected_return_values.empty?
-        call_method(args)
+        call_method(arguments: @expected_arguments, keywords: @expected_keywords)
       else
         @expected_return_values.each do |return_value|
-          call_method(args, return_value)
+          call_method(arguments: @expected_arguments, keywords: @expected_keywords, expected_return: return_value)
         end # each
       end # if-else
 
       matcher = RSpec::Mocks::Matchers::HaveReceived.new(@expected)
-      matcher = matcher.with(*args) unless args.empty?
+      if !@expected_arguments.empty? && !@expected_keywords.empty?
+        matcher = matcher.with(*@expected_arguments, **@expected_keywords)
+      elsif !@expected_arguments.empty?
+        matcher = matcher.with(*@expected_arguments)
+      elsif !@expected_keywords.empty?
+        matcher = matcher.with(**@expected_keywords)
+      end
 
       unless @expected_return_values.empty?
         matcher = matcher.exactly(@expected_return_values.count).times

data/lib/rspec/sleeping_king_studios/version.rb

@@ -11,13 +11,13 @@ module RSpec
       # Major version.
       MAJOR = 2
       # Minor version.
-      MINOR = 5
+      MINOR = 6
       # Patch version.
-      PATCH = 1
+      PATCH = 0
       # Prerelease version.
-      PRERELEASE = nil
+      PRERELEASE = :rc
       # Build metadata.
-      BUILD = nil
+      BUILD = 0
 
       # Generates the gem version string from the Version constants.
       #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-sleeping_king_studios
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.6.0.rc.0
 platform: ruby
 authors:
 - Rob "Merlin" Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-16 00:00:00.000000000 Z
+date: 2021-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashdiff
@@ -42,16 +42,22 @@ dependencies:
   name: sleeping_king_studios-tools
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 0.8.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -98,36 +104,42 @@ dependencies:
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.19.4
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.20'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.19.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.19.4
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.20'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.19.4
 - !ruby/object:Gem::Dependency
   name: sleeping_king_studios-tasks
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
@@ -165,7 +177,7 @@ dependencies:
         version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -175,7 +187,7 @@ dependencies:
         version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.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
@@ -265,7 +277,9 @@ files:
 homepage: http://sleepingkingstudios.com
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/sleepingkingstudios/rspec-sleeping_king_studios/issues
+  source_code_uri: https://github.com/sleepingkingstudios/rspec-sleeping_king_studios
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -277,11 +291,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A collection of RSpec patches and custom matchers.