rspec-forward 0.1.6 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60586a2b506f34e4fe653293535ece8b206d47923a3fef6b0c2adfa5b82005ce
-  data.tar.gz: 6c3384494e394a33996bc1580f15d3a3ae6d7a1976b196e98fd2ad1f73672c2a
+  metadata.gz: 6b4f8c6e7d8124ea73c31bf830dd1ee274b381e402f9f72075d42c605705dc1e
+  data.tar.gz: a222768f7062e6e05cfcbe3bf8cc23914a7e5f6f5a57457a7f56f89848604791
 SHA512:
-  metadata.gz: 39019b0a6c054365e0f5e26d39f3081e07d91db3a42bcbf60d57f3907cd92761cf530e905916227f5919c2959a6e3f7c984960e3fc068ddc216159a2f324a6b2
-  data.tar.gz: 46d07febe0734cc50532a5cf8c3772541153c47e98391c7f8a2b30f9b97670a8e98c633d02e22edacda53ace9b828f80cf6a4b243e5f2c14f703b66b3d479408
+  metadata.gz: 373959bf21c98b2788d98a10974b612c3ef0e625771329b97ba7d4097fc48f0c99a89220ec509beb135b5f3c513d0f0a90ecc1a6162f5274438791fb3fe4ad43
+  data.tar.gz: 9e4a8d5afa6d5d94f278e7613094ed2bf6a04f72297ca84fbf415e8e44cc29433cf3f86be3fd44bf340a485a1d664e25705589f3e35c79fd840c34c0b4054816

data/.ruby-version

@@ -1 +1 @@
-3.0.0
+3.1.2

data/Gemfile

@@ -3,5 +3,5 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in rspec-forward.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
+gem "rake"
 gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -1,23 +1,23 @@
 PATH
   remote: .
   specs:
-    rspec-forward (0.1.6)
-      rspec-mocks (~> 3.9)
+    rspec-forward (0.3.1)
+      rspec-mocks (~> 3)
 
 GEM
   remote: https://rubygems.org/
   specs:
     coderay (1.1.3)
-    diff-lcs (1.4.4)
-    ffi (1.15.3)
-    formatador (0.3.0)
-    guard (2.17.0)
+    diff-lcs (1.5.0)
+    ffi (1.15.5)
+    formatador (1.1.0)
+    guard (2.18.0)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
       lumberjack (>= 1.0.12, < 2.0)
       nenv (~> 0.1)
       notiffany (~> 0.0)
-      pry (>= 0.9.12)
+      pry (>= 0.13.0)
       shellany (~> 0.0)
       thor (>= 0.18.1)
     guard-compat (1.2.1)
@@ -25,7 +25,7 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    listen (3.5.1)
+    listen (3.7.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     lumberjack (1.2.8)
@@ -37,25 +37,25 @@ GEM
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    rake (12.3.3)
-    rb-fsevent (0.11.0)
+    rake (13.0.6)
+    rb-fsevent (0.11.1)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
     shellany (0.0.1)
-    thor (1.1.0)
+    thor (1.2.1)
 
 PLATFORMS
   ruby
@@ -63,9 +63,9 @@ PLATFORMS
 DEPENDENCIES
   guard (~> 2.16)
   guard-rspec (~> 4.7)
-  rake (~> 12.0)
+  rake
   rspec (~> 3.0)
   rspec-forward!
 
 BUNDLED WITH
-   2.2.3
+   2.3.20

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 Aleksander Długopolski
+Copyright (c) 2022 Marz Drel
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -37,6 +37,8 @@ complete: `spring stop`.
 
 ## Usage
 
+### Forwarding from class method to instance of the same class
+
 Assume you have a Method Object with `#call` method defined like this:
 
 ```ruby
@@ -75,42 +77,54 @@ RSpec.describe Add do
   end
 
   describe ".call" do
-    subject { described_class }
+    let(:klass) { described_class }
 
-    it { should forward_to_instance(:call).with_2_args }
+    it "passes arguments to instance" do
+      expect(klass)
+        .to forward_to_instance(:call)
+        .with_2_args
+    end
   end
 end
 ```
 
-If you would rather not use the old, deprecated
-`should` syntax in RSpec, replace the above exaple with the following:
+Possible calls to the matcher include the following:
 
 ```ruby
-describe ".call" do
-  let(:klass) { described_class }
+it { is_expected.to forward_to_instance(:call).with_no_args }
+it { is_expected.to forward_to_instance(:call).with_1_arg }
+it { is_expected.to forward_to_instance(:call).with_2_args }
+it { is_expected.to forward_to_instance(:call).with_3_args }
+it { is_expected.to forward_to_instance(:call).with_named(:foo, :bar) }
+it { is_expected.to forward_to_instance(:call).with_1_arg_and_named(:foo) }
+it { is_expected.to forward_to_instance(:call).with_2_args_and_named(:foo) }
+it { is_expected.to forward_to_instance(:call).with_3_args_and_named(:foo, :bar) }
+```
 
-  it "passes arguments to instance" do
-    expect(klass)
-      .to forward_to_instance(:call)
-      .with_2_args
+**TODO**: Explain `forward_to_instance_build(...)`
+
+### Forwarding from method to another class
+
+Assume you have a method which just passes all args to another class.
+
+```ruby
+class Add
+  def self.call(addend1, addend2)
+    @addend1 + @addend2
   end
 end
-```
 
-Possible calls to the matcher include the following:
+class Other
+  def add(...)
+    Add.call(...)
+  end
+end
 
-```ruby
-it { should forward_to_instance(:call).with_no_args }
-it { should forward_to_instance(:call).with_1_arg }
-it { should forward_to_instance(:call).with_2_args }
-it { should forward_to_instance(:call).with_3_args }
-it { should forward_to_instance(:call).with_named(:foo, :bar) }
-it { should forward_to_instance(:call).with_1_arg_and_named(:foo) }
-it { should forward_to_instance(:call).with_2_args_and_named(:foo) }
-it { should forward_to_instance(:call).with_3_args_and_named(:foo, :bar) }
+Add.call(3, 5) # => 8
 ```
+[...]
 
-**TODO**: Explain `forward_to_instance_build(...)`
+**TODO**: Explain usage.
 
 ## Development
 

data/lib/rspec/forward/core_extensions.rb

@@ -0,0 +1,21 @@
+module ::RSpec
+  module Forward
+    module CoreExtensions
+      refine String do
+        def camelize(uppercase_first_letter = true)
+          string = self
+
+          if uppercase_first_letter
+            string = string.sub(/^[a-z\d]*/, &:capitalize)
+          else
+            string = string.sub(/^(?:(?=\b|[A-Z_])|\w)/, &:downcase)
+          end
+
+          string
+            .gsub(/(?:_|(\/))([a-z\d]*)/) { "#{$1}#{$2.capitalize}" }
+            .gsub("/", "::")
+        end
+      end
+    end
+  end
+end

data/lib/rspec/forward/forward_methods.rb

@@ -12,7 +12,8 @@ module ::RSpec
 
         define_method name do |*kwargs|
           @args = Array.new(index, :arg)
-          @kwargs = Hash[kwargs.map { [_1, _1] }]
+          @kwargs = Hash[kwargs.map { |name| [name, name] }]
+
           self
         end
       end
@@ -22,7 +23,11 @@ module ::RSpec
       end
 
       def with_1_arg_and_named(*args, **kwargs)
-        with_1_args_and_named(*args, **kwargs)
+        if kwargs.empty?
+          with_1_args_and_named(*args)
+        else
+          with_1_args_and_named(*args, **kwargs)
+        end
       end
 
       def with_no_args
@@ -37,7 +42,7 @@ module ::RSpec
 
       def with_named(*kwargs)
         @args = []
-        @kwargs = Hash[kwargs.map { [_1, _1] }]
+        @kwargs = Hash[kwargs.map { |name| [name, name] }]
         self
       end
 
@@ -73,16 +78,29 @@ module ::RSpec
       def matches_for?(actual, return_value)
         assign_actual(actual)
 
-        allow(@actual)
-          .to receive(:new)
-          .with(*exp_args, **@kwargs)
-          .and_return(instance)
+        if @kwargs.any?
+          allow(@actual)
+            .to receive(:new)
+            .with(*exp_args, **@kwargs)
+            .and_return(instance)
 
-        result = @actual.send(@expected, *@args, **@kwargs) == return_value
+          result = @actual.send(@expected, *@args, **@kwargs) == return_value
 
-        expect(@actual)
-          .to have_received(:new)
-          .with(*exp_args, **@kwargs)
+          expect(@actual)
+            .to have_received(:new)
+            .with(*exp_args, **@kwargs)
+        else
+          allow(@actual)
+            .to receive(:new)
+            .with(*exp_args)
+            .and_return(instance)
+
+          result = @actual.send(@expected, *@args) == return_value
+
+          expect(@actual)
+            .to have_received(:new)
+            .with(*exp_args)
+        end
 
         result
       end

data/lib/rspec/forward/forward_scope_methods.rb

@@ -0,0 +1,77 @@
+module ::RSpec
+  module Forward
+    module ForwardScopeMethods
+      using CoreExtensions
+
+      def exp_args(actual)
+        return [actual, *@args] if @with_parent_arg
+        return [no_args] if @args.size.zero? && @kwargs.size.zero?
+
+        @args
+      end
+
+      def find_actual(klass_or_instance)
+        if klass_or_instance.is_a? Class
+          klass_or_instance
+        else
+          klass_or_instance.class
+        end
+      end
+
+      def matches_for?(klass_or_instance)
+        actual = find_actual(klass_or_instance)
+
+        method_name = @expected
+        base_klass = format("%<method>s_scope", method: method_name.to_s).camelize
+        @scope_klass_name ||= format("%s::%s", actual.to_s, base_klass)
+
+
+        begin
+          @scope_klass = Object.const_get(@scope_klass_name)
+        rescue NameError => e
+          failure_scope_klass_name_not_defined(@scope_klass_name)
+          return false
+        end
+
+        allow(@scope_klass)
+          .to receive(@target_method_name)
+          .and_return(:result)
+
+        if @kwargs.any?
+          result = klass_or_instance.public_send(method_name, *@args, **@kwargs) == :result
+
+          expect(@scope_klass)
+            .to have_received(@target_method_name)
+            .with(*exp_args(actual), **@kwargs)
+        else
+          result = klass_or_instance.public_send(method_name, *@args) == :result
+
+          expect(@scope_klass)
+            .to have_received(@target_method_name)
+            .with(*exp_args(actual))
+        end
+
+        result
+      end
+
+      def failure_scope_klass_name_not_defined(name)
+        @failure_message = "#{name} should be defined"
+        @failure_message_when_negated = "#{name} should be defined"
+      end
+
+      def failure_message
+        @failure_message ||
+          %Q(expected "#{@target}.call" to be invoked)
+      end
+
+      def failure_message_when_negated
+        @failure_message_when_negated ||
+          %Q(expected "#{@target}.call" not to be invoked)
+      end
+
+      def self.included(base)
+        private :matches_for?, :find_actual
+      end
+    end
+  end
+end

data/lib/rspec/forward/forward_scope_parent_methods.rb

@@ -0,0 +1,32 @@
+module ::RSpec
+  module Forward
+    module ForwardScopeParentMethods
+      using CoreExtensions
+
+      def using_method(target_method_name)
+        @target_method_name = target_method_name
+        self
+      end
+
+      def using_class_name(target_class_name)
+        @scope_klass_name = target_class_name
+        self
+      end
+
+      def using_method_args(*args, **kwargs)
+        @args = args
+        @kwargs = kwargs
+        self
+      end
+
+      def with_parent_arg
+        # Name of the parent class is not available here if the default
+        # class is used, because defaualt class needs the "actual"
+        # parameter from matchers_for?(actual)
+
+        @with_parent_arg = true
+        self
+      end
+    end
+  end
+end

data/lib/rspec/forward/forward_to_scope.rb

@@ -0,0 +1,27 @@
+module ::RSpec
+  module Forward
+    class ForwardToScope
+      include ForwardScopeMethods
+      include ForwardScopeParentMethods
+      include Mocks::ExampleMethods
+
+      def initialize(expected)
+        @expected = expected
+        @kwargs ||= {}
+        @args ||= []
+        @target_method_name ||= :call
+      end
+
+      def matches?(actual)
+        matches_for?(actual)
+      end
+
+      def description
+        <<~TXT.gsub(/\n+/, " ")
+          to pass the arguments to the constructor of instance and return
+          the value returned by the instance method
+        TXT
+      end
+    end
+  end
+end

data/lib/rspec/forward/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module Forward
-    VERSION = "0.1.6"
+    VERSION = "0.3.1"
   end
 end

data/lib/rspec/forward.rb

@@ -1,9 +1,13 @@
 require "rspec"
 require "rspec/mocks"
 require "rspec/forward/version"
+require "rspec/forward/core_extensions"
 require "rspec/forward/forward_methods"
+require "rspec/forward/forward_scope_methods"
+require "rspec/forward/forward_scope_parent_methods"
 require "rspec/forward/forward_to_instance"
 require "rspec/forward/forward_to_instance_build"
+require "rspec/forward/forward_to_scope"
 
 module RSpec
   module Forward
@@ -16,6 +20,10 @@ module RSpec
     def forward_to_instance_build(expected)
       ForwardToInstanceBuild.new(expected)
     end
+
+    def forward_to_scope(expected)
+      ForwardToScope.new(expected)
+    end
   end
 end
 

data/rspec-forward.gemspec

@@ -40,7 +40,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "rspec-mocks", "~> 3.9"
+  spec.add_runtime_dependency "rspec-mocks", "~> 3"
   spec.add_development_dependency "guard", "~> 2.16"
   spec.add_development_dependency "guard-rspec", "~> 4.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-forward
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.3.1
 platform: ruby
 authors:
 - Marz Drel
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-20 00:00:00.000000000 Z
+date: 2022-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-mocks
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -73,9 +73,13 @@ files:
 - bin/console
 - bin/setup
 - lib/rspec/forward.rb
+- lib/rspec/forward/core_extensions.rb
 - lib/rspec/forward/forward_methods.rb
+- lib/rspec/forward/forward_scope_methods.rb
+- lib/rspec/forward/forward_scope_parent_methods.rb
 - lib/rspec/forward/forward_to_instance.rb
 - lib/rspec/forward/forward_to_instance_build.rb
+- lib/rspec/forward/forward_to_scope.rb
 - lib/rspec/forward/version.rb
 - rspec-forward.gemspec
 homepage:
@@ -99,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Set of RSpec matchers for checking class method to instance method forwarding.