stubberry 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5548414865196ce42a7b4bd38b5692e40f9d7eeda451bb0482bc839dc6e59291
-  data.tar.gz: a52fe5153a697cf2239178a250f40c4f1e19a37d78fccaabca71ed1fb6b084a0
+  metadata.gz: ee7c2b90c9dd5e32707924b85ad8e2b88d40fc3617d1404ee839227b21ebf414
+  data.tar.gz: 43760ddf930c7d4a3a0a582c6f705ea39d218b3e84619345785e58df68461312
 SHA512:
-  metadata.gz: 1c0049bda0ce93dcdf6291d0cdc378f7280ddaed71cdef7fcc48fb61f5bbd5560a5fa8afd8223c7b70a267c7fae9acbd35801abf8382f27dcdef78f9beb659ee
-  data.tar.gz: da8c024937350a5d9ba2961e749e579b248d10533f87c67e98aea39ed999d52d1005c54b4167ad77978057e0d54100181a09ad7f80e0c6f80dba2ca3e24fe02f
+  metadata.gz: 5a89ea231eb74516a8b1e3cfdad53fcb9efabc11d10cd31e5fd954441ef76ffe4caf75581b226e2cdcae7c1b09fed9cfe72cb80e10ea951e33dda15f373bc934
+  data.tar.gz: 6fb0d51c8f5ecf01ba4b670e4e50fb5456d63159c396166f27be21f63e793849f22a077704c2522716a510ad1168cb255d612c2fc2d633da10578789a0ea7279

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_gem:
+  rubocop-shopify: rubocop.yml

data/CHANGELOG.md

@@ -1,4 +1,11 @@
-# 0.2.1
+# 0.3.0
+* rubocop-shopify added as a base linter
+* assertion for method called rewritten to use stub_must under the hood
+* DRYied some methods to Stubberry module methods
+* introduced ruby 3.0 kwargs compatible signatures 
+
+
+# 0.2.0
 * new module with assertion methods added 
 * assert_method_called added, this is a flow assertion, you can check the params, and you can check that method was called inside the block, 
   without stubbing objects and interfering with the original flow 
@@ -6,7 +13,6 @@
 * singleton_classes is now properly cleared after, see PR: https://github.com/seattlerb/minitest/pull/891
 * some methods got '__' prefixes, just to prevent naming collisions  
   
-  
 
 # 0.1.1
 * initial gem release

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in stubberry.gemspec

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rake/testtask"
 
@@ -7,4 +9,4 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task :default => :test
+task default: :test

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "stubberry"

data/lib/stubberry/active_record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # this module provide two methods for active record classes
 # to easily stub any record attributes and methods disregarding the way
 # record was obtained inside the yielding block, you just need an id.
@@ -7,90 +9,82 @@
 # that's a very error prone approach, with stub_orm_* methods we
 # do not care about the way object was obtained as long as after_find
 # callback was executed
-module Stubberry::ActiveRecord
-  extend ActiveSupport::Concern
+module Stubberry
+  module ActiveRecord
+    extend ActiveSupport::Concern
 
-  # for any active record object for classes included Stubberry::ActiveRecord
-  # we adding after_find callback extending object with self.class.extend_any
-  # default implementation of self.class.extend_any does nothing
-  included do
-    after_find {|obj| self.class.__extend_any(obj) }
-  end
+    # for any active record object for classes included Stubberry::ActiveRecord
+    # we adding after_find callback extending object with self.class.extend_any
+    # default implementation of self.class.extend_any does nothing
+    included do
+      after_find { |obj| self.class.__extend_any(obj) }
+    end
 
-  module ClassMethods
+    module ClassMethods
+      # This method could be used whenever there is a need for stubbing
+      # the exact ActiveRecord object attributes inside some execution flow
+      # __WITHOUT__!!  underlying record change
+      def stub_orm_attr(id, obj_or_attributes, &block)
+        stub(:__extend_any, ->(obj) {
+          return unless obj.id == id && obj.is_a?(self)
 
-    # This method could be used whenever there is a need for stubbing
-    # the exact ActiveRecord object attributes inside some execution flow
-    # __WITHOUT__!!  underlying record change
-    def stub_orm_attr(id, obj_or_attributes )
-      stub(:__extend_any, -> (obj) {
-        return unless obj.id == id && obj.is_a?( self )
-        obj.assign_attributes( obj_or_attributes.try(:attributes) || obj_or_attributes )
-      }) do
-        yield
+          obj.assign_attributes(obj_or_attributes.try(:attributes) || obj_or_attributes)
+        }, &block)
       end
-    end
 
-    # This method could be used whenever there is a need for stubbing
-    # the specific Active Record object's methods inside some flow piece
-    # with ANY way of object retrieval
-    def stub_orm_method(id, method, val_or_callable, *block_args  )
-      stub(:__extend_any, -> (obj) {
-        return unless obj.id == id && obj.is_a?( self )
-        __define_stub_method(obj, method, val_or_callable, *block_args )
-      }) do
-        yield
+      # This method could be used whenever there is a need for stubbing
+      # the specific Active Record object's methods inside some flow piece
+      # with ANY way of object retrieval
+      def stub_orm_method(id, method, val_or_callable, *block_args, **block_kwargs, &block)
+        stub(:__extend_any, ->(obj) {
+          return unless obj.id == id && obj.is_a?(self)
+
+          __define_stub_method(obj, method, val_or_callable, *block_args, **block_kwargs)
+        }, &block)
+      ensure
+        __revert_all_methods(id, method)
       end
-    ensure
-      __revert_all_methods(id, method)
-    end
 
-    private_class_method
+      def __define_stub_method(object, method, val_or_callable, *block_args, **block_kwargs)
+        method_new_name = __stub_method_name(method, obj: object)
 
-    def __define_stub_method(object, method, val_or_callable, *block_args )
-      method_new_name = __stub_method_name(method, obj: object)
+        Stubberry.__define_method_mimic_replacement(object, method)
 
-      __define_dynamic_method_replacement( object, method )
+        object.singleton_class.alias_method(method_new_name, method)
 
-      object.singleton_class.alias_method( method_new_name, method )
-      
-      object.define_singleton_method method do |*args, &blk|
-        if val_or_callable.respond_to? :call
-          val_or_callable.call(*args, &blk)
-        else
-          blk.call(*block_args) if blk
-          val_or_callable
+        object.define_singleton_method(method) do |*args, **kwargs, &blk|
+          if val_or_callable.respond_to?(:call)
+            val_or_callable.call(*args, **kwargs, &blk)
+          else
+            blk&.call(*block_args, **block_kwargs)
+            val_or_callable
+          end
         end
+        __stubbed_objects(method_new_name) << object
       end
-      __stubbed_objects(method_new_name) << object
-    end
-
-    def __define_dynamic_method_replacement( object, method )
-      # this means method is dynamic 
-      return unless object.respond_to?( method ) && !object.methods.map(&:to_s).include?( method.to_s )
 
-      object.define_singleton_method( method ) { | *args, **kargs, &block | super(*args, **kargs, &block) }
-    end
+      def __stub_method_name(method, obj: nil, id: nil)
+        # __stub_class_method_id
+        "__stub_#{self}_#{method}_#{obj&.id || id}"
+      end
 
-    def __stub_method_name(method, obj: nil, id: nil)
-      # __stub_class_method_id
-      "__stub_#{to_s}_#{method}_#{obj&.id || id}"
-    end
+      def __revert_all_methods(id, method)
+        method_new_name = __stub_method_name(method, id: id)
 
-    def __revert_all_methods(id, method)
-      method_new_name = __stub_method_name(method, id: id)
+        __stubbed_objects(method_new_name).map(&:singleton_class).each do |metaclass|
+          metaclass.send(:undef_method, method)
+          metaclass.send(:alias_method, method, method_new_name)
+          metaclass.send(:undef_method, method_new_name)
+        end
+      end
 
-      __stubbed_objects(method_new_name).map(&:singleton_class).each do |metaclass|
-        metaclass.send :undef_method, method
-        metaclass.send :alias_method, method, method_new_name
-        metaclass.send :undef_method, method_new_name
+      def __stubbed_objects(method_name)
+        (@@__extended_objects ||= {})[method_name] ||= [] # rubocop:disable Style/ClassVars
       end
-    end
 
-    def __stubbed_objects(method_name)
-      (@@__extended_objects ||= {})[method_name] ||= []
+      def __extend_any(_obj)
+        :do_nothing
+      end
     end
-
-    def __extend_any(_obj); :do_nothing end
   end
-end if defined?(ActiveRecord)
+end if defined?(ActiveRecord)

data/lib/stubberry/assertions.rb

@@ -1,34 +1,14 @@
-module Stubberry::Assertions
-
-  # it close to Object stub definition except its not
-  # stubbing the original method instead its just controlling the flow
-  # with minimum side effects
-  def assert_method_called( object, method, inspect_params_callable = nil )
-    base_method_new_name = "__old_#{method}_method"
-    metaclass = object.singleton_class
-
-    singleton_has_stubbing_method = object.singleton_methods.map(&:to_s).include?( method.to_s )
-
-    # dynamic methods should be explicitly defined
-    if object.respond_to?( method ) && !object.methods.map(&:to_s).include?( method.to_s )
-      metaclass.define_method( method ) { |*args, **kargs, &block| super(*args, **kargs, &block) }
+# frozen_string_literal: true
+
+module Stubberry
+  module Assertions
+    # controlling the flow with minimum side effects
+    def assert_method_called(object, method, inspect_params_callable = nil, &block)
+      object_unbound_method = object.method(method.to_sym).unbind
+      object.stub_must(method, ->(*args, **kwargs, &blk) {
+        inspect_params_callable&.call(*args, **kwargs)
+        object_unbound_method.bind(object).call(*args, **kwargs, &blk)
+      }, &block)
     end
-
-    metaclass.alias_method base_method_new_name, method
-
-    call_happened = []
-
-    metaclass.define_method( method ) do |*args, **kargs, &blk|
-      inspect_params_callable.call(*args, **kargs) if inspect_params_callable
-      call_happened << true
-      send(base_method_new_name, *args, **kargs, &blk)
-    end
-
-    yield.tap { raise "#{method} wasn't called" if call_happened.length == 0 }
-
-  ensure
-    metaclass.__stbr_clear_singleton_class( method, base_method_new_name, singleton_has_stubbing_method )
   end
-
 end
-

data/lib/stubberry/object.rb

@@ -1,80 +1,82 @@
-module Stubberry::Object
-  # this is an enrichment of an original stub method from the minitest/mock
-  def stub_must( name, val_or_callable, *block_args )
-    method_new_name = "__minitest_stub__#{name}"
+# frozen_string_literal: true
 
-    singleton_has_stubbing_method = singleton_methods.map(&:to_s).include?( name.to_s )
+module Stubberry
+  module Object
+    # this is an enrichment of an original stub method from the minitest/mock
+    def stub_must(name, val_or_callable, *block_args, **block_kwargs)
+      method_new_name = "__minitest_stub__#{name}"
 
-    if respond_to?( name ) && !methods.map(&:to_s).include?( name.to_s )
-      singleton_class.define_method( name ) { |*args, **kargs, &block| super(*args, **kargs, &block) }
-    end
+      singleton_has_stubbing_method = singleton_methods.map(&:to_s).include?(name.to_s)
 
-    singleton_class.alias_method( method_new_name, name )
+      Stubberry.__define_method_mimic_replacement(self, name)
 
-    call_happened = []
+      singleton_class.alias_method(method_new_name, name)
 
-    singleton_class.define_method( name ) do |*args, &blk|
-      call_happened << true
+      call_happened = []
 
-      if val_or_callable.respond_to?( :call )
-        val_or_callable.call(*args, &blk)
-      else
-        blk.call(*block_args) if blk
-        val_or_callable
+      singleton_class.define_method(name) do |*args, **kwargs, &blk|
+        call_happened << true
+
+        if val_or_callable.respond_to?(:call)
+          val_or_callable.call(*args, **kwargs, &blk)
+        else
+          blk&.call(*block_args, **block_kwargs)
+          val_or_callable
+        end
       end
-    end
 
-    (yield self).tap do
-      raise "#{name} wasn't called" if call_happened.length == 0
+      (yield self).tap do
+        raise "#{name} wasn't called" if call_happened.empty?
+      end
+    ensure
+      singleton_class.__stbr_clear_singleton_class(name, method_new_name, singleton_has_stubbing_method)
     end
-  ensure
-    singleton_class.__stbr_clear_singleton_class( name, method_new_name, singleton_has_stubbing_method )
-  end
 
-  # the reverse method of stub_must -- will raise an issue whenever method
-  # was called inside a stubbing block
-  def stub_must_not( name, message = nil )
-    method_new_name = "__minitest_stub__#{name}"
-    singleton_has_stubbing_method = singleton_methods.map(&:to_s).include?( name.to_s )
+    # the reverse method of stub_must -- will raise an issue whenever method
+    # was called inside a stubbing block
+    def stub_must_not(name, message = nil)
+      method_new_name = "__minitest_stub__#{name}"
+      singleton_has_stubbing_method = singleton_methods.map(&:to_s).include?(name.to_s)
 
-    metaclass = class << self; self; end
+      Stubberry.__define_method_mimic_replacement(self, name)
 
-    if respond_to?(name) && !methods.map(&:to_s).include?( name.to_s )
-      metaclass.define_method( name ) { | *args, **kargs, &block | super(*args, **kargs, &block) }
-    end
+      singleton_class.alias_method(method_new_name, name)
 
-    metaclass.alias_method( method_new_name, name )
+      singleton_class.define_method(name) { |*| raise message || "#{name} was called!" }
 
-    metaclass.define_method( name ) { |*| raise message || "#{name} was called!" }
+      yield self
+    ensure
+      singleton_class.__stbr_clear_singleton_class(name, method_new_name, singleton_has_stubbing_method)
+    end
 
-    yield self
-  ensure
-    metaclass.__stbr_clear_singleton_class( name, method_new_name, singleton_has_stubbing_method )
-  end
+    # just for fun multiple stub_must in one call
+    def stub_must_all(name_to_var_or_callable, &block)
+      if name_to_var_or_callable.length == 1
+        stub_must(*name_to_var_or_callable.shift, &block)
+      else
+        stub_must(*name_to_var_or_callable.shift) { stub_must_all(name_to_var_or_callable, &block) }
+      end
+    end
 
-  # just for fun multiple stub_must in one call
-  def stub_must_all( name_to_var_or_callable, &block )
-    name_to_var_or_callable.length == 1 ? stub_must( *name_to_var_or_callable.shift, &block )
-      : stub_must( *name_to_var_or_callable.shift ) { stub_must_all(name_to_var_or_callable, &block ) }
-  end
+    # stub only if respond otherwise just execute
+    def stub_if_def(name, val_or_callable, *block_args, &block)
+      respond_to?(name) ? stub(name, val_or_callable, *block_args, &block) : yield
+    end
 
-  # stub only if respond otherwise just execute
-  def stub_if_def(name, val_or_callable, *block_args, &block)
-    respond_to?( name ) ? stub(name, val_or_callable, *block_args, &block) : yield
-  end
+    # stub_must only if respond otherwise just execute
+    def stub_must_if_def(name, val_or_callable, *block_args, &block)
+      # stub only if respond otherwise just execute
+      respond_to?(name) ? stub_must(name, val_or_callable, *block_args, &block) : yield
+    end
 
-  # stub_must only if respond otherwise just execute
-  def stub_must_if_def(name, val_or_callable, *block_args, &block)
-    # stub only if respond otherwise just execute
-    respond_to?( name ) ? stub_must(name, val_or_callable, *block_args, &block) : yield
-  end
+    def __stbr_clear_singleton_class(name, new_name, had_method_before)
+      raise Stubberry::Error, "This is a singleton_class methods only!" unless singleton_class?
 
-  def __stbr_clear_singleton_class( name, new_name, had_method_before)
-    raise Stubberry::Error.new('This is a singleton_class methods only!') unless singleton_class?
-    remove_method( name )
-    alias_method( name, new_name ) if had_method_before
-    remove_method( new_name )
+      remove_method(name)
+      alias_method(name, new_name) if had_method_before
+      remove_method(new_name)
+    end
   end
 end
 
-Object.include(Stubberry::Object)
+Object.include(Stubberry::Object)

data/lib/stubberry/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stubberry
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/stubberry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "stubberry/version"
 require "stubberry/object"
 require "stubberry/active_record"
@@ -5,4 +7,16 @@ require "stubberry/assertions"
 
 module Stubberry
   class Error < StandardError; end
+
+  def self.__define_method_mimic_replacement(object, method)
+    return unless __is_a_method_mimic?(object, method)
+
+    object.define_singleton_method(method) { |*args, **kargs, &block| super(*args, **kargs, &block) }
+  end
+
+  # object responds to 'method' but, the are no such method among methods,
+  # i.e. it's run through a method_missing
+  def self.__is_a_method_mimic?(object, method)
+    object.respond_to?(method) && !object.methods.map(&:to_s).include?(method.to_s)
+  end
 end

data/stubberry.gemspec

@@ -1,4 +1,6 @@
-require_relative 'lib/stubberry/version'
+# frozen_string_literal: true
+
+require_relative "lib/stubberry/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "stubberry"
@@ -6,11 +8,12 @@ Gem::Specification.new do |spec|
   spec.authors       = ["alekseyl"]
   spec.email         = ["leshchuk@gmail.com"]
 
-  spec.summary       = %q{Ultimate collection of sweet stub methods for ruby test suits. Lets stub! }
-  spec.description   = %q{This a ultimate set of stub extensions. Suggest any reasonable subbing and I'll try to merge it. It will start with: stub_must, stub_must_not, stub_if_def and many more }
+  spec.summary       = "Ultimate collection of sweet stub methods for ruby test suits. Lets stub! "
+  spec.description   = "This a ultimate set of stub extensions. Suggest any reasonable subbing and I'll try to "\
+    "merge it. It will start with: stub_must, stub_must_not, stub_if_def and many more "
   spec.homepage      = "https://github.com/alekseyl/stubberry"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = ">= 2.5"
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
@@ -20,21 +23,20 @@ Gem::Specification.new do |spec|
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.5'
-  spec.add_development_dependency "activerecord", ">= 6.1"
-
-  spec.add_development_dependency "bundler", ">= 1"
-  spec.add_development_dependency "rake", ">= 12.3.3"
-  spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency("activerecord", ">= 6.1")
 
+  spec.add_development_dependency("bundler", ">= 1")
+  spec.add_development_dependency("minitest", "~> 5.0")
+  spec.add_development_dependency("rake", ">= 12.3.3")
+  spec.add_development_dependency("sqlite3")
 
-  spec.add_development_dependency "ruby_jard"
+  spec.add_development_dependency("rubocop-shopify")
+  spec.add_development_dependency("ruby_jard")
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stubberry
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - alekseyl
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-18 00:00:00.000000000 Z
+date: 2022-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -53,21 +67,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 12.3.3
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rubocop-shopify
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -104,6 +118,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -142,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: Ultimate collection of sweet stub methods for ruby test suits. Lets stub!