stubberry 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76a44be83df94f95993dad5da5a540ec3b5f7d6a3334b45fb9f19d64f11445bd
-  data.tar.gz: 7644abf117453f0635e8f14899d400f515c3a3ed763a3fff3737aa3ebb24408a
+  metadata.gz: 84ce1669272b052fded99ad9ba06ff354ef8dec1891a47e288140b554f159bdc
+  data.tar.gz: e113462e1d879af411a08b81dac5f77ce9d5f9341c700b6b4a2559c72dae5368
 SHA512:
-  metadata.gz: 7c205abde785d061fab126fe889aa87cf611dc9851697aca91ba3e1ddd3c1d2dcac7ce2e1226f4aa6298027ba521913177547db185382ff77b9d85566e88d003
-  data.tar.gz: '0579be30cd4c3e44e492f3262417105feeff44fdf48cbaa0ebfffd3b56e8337571051bc6eb50f8dbdf53e433e82e8c0a33bf7fc48ec3a6d38a48b071a320fdb2'
+  metadata.gz: dd67bcee9b9ef05fe6fc89c5223fa59560ea2229b3835517463e88543256623fc2568277732e38317e95ee8d2573c4d1da4ad72136da2cd0ba639071a9ddd6cc
+  data.tar.gz: 7db15cd29b4d85cbc03a20a701aa693c57c5f11ad8c2d81c1298c0753b84282a639f279f0fa3753e295d40b9a70539dc2631676654d36f34c54e9afe7531a4af

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/.idea/

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# 0.1.1
+* initial gem release
+* Stubberry::Object module with stub_must, stub_must_not, stub_must_all, stub_if_* methods
+* Stubberry::ActiveRecord easy id based stubbing active record objects inside some actions flow 

data/README.md

@@ -1,8 +1,8 @@
 # Stubberry
+Pay attention it has 2Bs and 2Rs in naming :)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/stubberry`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This gem is planned to be a ultimate sweet collection of stubbing methods for all kinds of testing.
+Feel free to provide any enrichment suggestions.
 
 ## Installation
 
@@ -22,7 +22,95 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Version 0.1 of this gem has two cool sets of stub methods Stubberry::Object and Stubberry::ActiveRecord
+
+
+### Stubberry::Object
+
+Set of stubbing methods added to an Object class hence available for any class or its instances. 
+
+```ruby
+
+# a copy/paste of an Objects stub method enriched with
+# raise error functionality whenever stubbed method wasn't called
+# stub_must( name, val_or_callable, *block_args )
+
+test 'check call params with a call must happened' do 
+  class_or_obj.stub_must(:run, -> ( param ) {
+    # Now you can be sure: either you have an expected param, OR 
+    # if call didn't happened you will see a StandardError raised 
+    assert_equal( param, 1 )
+  } ) { class_or_obj.run(1) }
+end
+
+```
+
+Rem: I know about Mock object, but I don't like it. You may consider approach with mock/verify better or more object oriented e.t.c. 
+But I do like an error to be aligned to the check, running mock.verify some place after check did happened, feels unnatural and uncomfortable to me
+
+```ruby
+# the reverse method of stub_must -- will raise an issue whenever method
+# was called inside a stubbing block, ensures that flow didn't reach given method 
+# stub_must_not( name, message = nil ) 
+test 'call must not happened' do
+  class_or_obj.stub_must_not(:run) { class_or_obj.call(1) }
+end
+
+# just for fun multiple stub_must in one call 
+# stub_must_all( name_to_var_or_callable, &block )
+test 'all calls should happened' do
+  class_or_obj.stub_must_all(
+    run: true,
+    call: -> (param) { assert_equal(param, 1) }
+  ) do 
+    class_or_obj.call(1)
+    class_or_obj.run(args)
+  end
+end
+
+# stub only if respond_to otherwise just execute block. 
+# It's a really rare case, I used only once for incompatible gems versions test 
+# 
+# stub_if_def(name, val_or_callable, *block_args, &block)
+test 'all calls should happened' do
+  class_or_obj.stub_if_def( :not_def, -> (param) { assert_equal(param, :param) } ) do
+    # when there is nothing to stub, just yield
+    :just_yield_this_without_stubbing
+  end
+end
+
+# stub_must_if_def(name, val_or_callable, *block_args, &block)
+# same as above but with stub_must under the hood
+```
+
+### Stubberry::ActiveRecord
+
+Easy stubbing for ActiveRecord objects, you just need the id and Stubberry will do the rest.
+The cool stuff about these stubbing methods is an independence from the way object retrieved. 
+You can get object via find, where or any relation, it doesn't matter.
+Stubbing is based on after_find callback, so whenever object instantiated 
+it will be properly stubbed.
+
+```ruby
+# you can stub active record object attributes with stub_orm_attr
+
+test 'object attributes will be stubbed in relations' do 
+  Comment.stub_orm_attr(1, {body: 'ola!'} ) do 
+    assert_equal( 'ola!', User.first.comments.where(id: 1).take.body )
+    assert_equal( 'ola!', Comment.find(1).body )
+  end
+end
+
+# you can stub active record object method with stub_orm_method
+test 'object with a given id got method stubbed' do
+  Comment.stub_orm_method(1, join: -> ( other ) {
+    assert_equal( other.id, 2 )
+  } ) do
+    User.first.comments.where(id: 1).each{ _1.join( Comment.find(2) ) }
+  end
+end
+```
+
 
 ## Development
 
@@ -32,7 +120,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/stubberry. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/stubberry/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/alekseyl/stubberry. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/stubberry/blob/master/CODE_OF_CONDUCT.md).
 
 
 ## License

data/lib/stubberry/active_record.rb

@@ -0,0 +1,84 @@
+# 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.
+#
+# i.e. alternative way of dealing with any record with id could be stub of
+# the specific method like where or find with a given set of params e.t.c.
+# 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
+
+  # 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
+
+    # 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
+      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, making
+    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
+      end
+    ensure
+      undef_all(id, method)
+    end
+
+    private_class_method
+
+    def define_stub_method( object, method, val_or_callable, *block_args )
+      old_method = stub_method_name(method, obj: object)
+      object.singleton_class.send :alias_method, old_method, 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
+        end
+      end
+      stubbed_objects(old_method) << object
+    end
+
+    def stub_method_name( method, obj: nil, id: nil)
+      # __stub_class_method_id
+      "__stub_#{to_s}_#{method}_#{obj&.id || id}"
+    end
+
+    def undef_all(id, method)
+      old_method = stub_method_name( method, id: id)
+      stubbed_objects(old_method).map(&:singleton_class).each do |metaclass|
+        metaclass.send :undef_method, method
+        metaclass.send :alias_method, method, old_method
+        metaclass.send :undef_method, old_method
+      end
+    end
+
+    def stubbed_objects(method_name)
+      (@@extended_obj ||= {})[method_name] ||= []
+    end
+
+    def extend_any(_obj); :do_nothing end
+  end
+end if defined?(ActiveSupport::Concern)

data/lib/stubberry/object.rb

@@ -0,0 +1,84 @@
+module Stubberry::Object
+  # a copy/paste of an Objects stub method enriched with
+  # raise error functionality whenever stubbed method wasn't called
+  def stub_must( name, val_or_callable, *block_args )
+    new_name = "__minitest_stub__#{name}"
+    call_happened_method_name = "__#{name}_call_happened"
+
+    metaclass = class << self; self; end
+
+    if respond_to? name and not methods.map(&:to_s).include? name.to_s then
+      metaclass.send :define_method, name do |*args|
+        super(*args)
+      end
+    end
+
+    metaclass.send :alias_method, new_name, name
+
+    # this will make a closure without spoiling class with any instance vars and so
+    call_happened = []
+    metaclass.send :define_method, call_happened_method_name do
+      call_happened << true
+    end
+
+    metaclass.send :define_method, name do |*args, &blk|
+      __send__(call_happened_method_name)
+
+      if val_or_callable.respond_to? :call then
+        val_or_callable.call(*args, &blk)
+      else
+        blk.call(*block_args) if blk
+        val_or_callable
+      end
+    end
+
+    (yield self).tap do
+      raise  "#{name} wasn't called" if call_happened.length == 0
+    end
+  ensure
+    metaclass.send :undef_method, name
+    metaclass.send :alias_method, name, new_name
+    metaclass.send :undef_method, new_name
+    metaclass.send :undef_method, call_happened_method_name
+  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 )
+    new_name = "__minitest_stub__#{name}"
+
+    metaclass = class << self; self; end
+
+    if respond_to?(name) && !methods.map(&:to_s).include?( name.to_s )
+      metaclass.define_method( name ) { | *args | super(*args) }
+    end
+
+    metaclass.alias_method( new_name, name )
+    metaclass.define_method( name ) { |*| raise message || "#{name} was called!" }
+
+    yield self
+  ensure
+    metaclass.undef_method( name )
+    metaclass.alias_method( name, new_name )
+    metaclass.undef_method( new_name )
+  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_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
+end
+
+Object.include(Stubberry::Object)

data/lib/stubberry/version.rb

@@ -1,3 +1,3 @@
 module Stubberry
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/stubberry.rb

@@ -1,4 +1,6 @@
 require "stubberry/version"
+require "stubberry/object"
+require "stubberry/active_record"
 
 module Stubberry
   class Error < StandardError; end

data/stubberry.gemspec

@@ -6,8 +6,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["alekseyl"]
   spec.email         = ["leshchuk@gmail.com"]
 
-  spec.summary       = %q{This a small set of stub extensions to Object interface.}
-  spec.description   = %q{This a small set of stub extensions to Object interface. There will be stub_must, stub_must_not, stub_if_def, stub_any_ar methods on it }
+  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.homepage      = "https://github.com/alekseyl/stubberry"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
@@ -26,4 +26,15 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.4'
+  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 "ruby_jard"
 end

metadata

@@ -1,17 +1,102 @@
 --- !ruby/object:Gem::Specification
 name: stubberry
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - alekseyl
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-02 00:00:00.000000000 Z
-dependencies: []
-description: 'This a small set of stub extensions to Object interface. There will
-  be stub_must, stub_must_not, stub_if_def, stub_any_ar methods on it '
+date: 2021-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !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: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby_jard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+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 '
 email:
 - leshchuk@gmail.com
 executables: []
@@ -19,9 +104,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".idea/inspectionProfiles/profiles_settings.xml"
-- ".idea/workspace.xml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -30,6 +114,8 @@ files:
 - bin/console
 - bin/setup
 - lib/stubberry.rb
+- lib/stubberry/active_record.rb
+- lib/stubberry/object.rb
 - lib/stubberry/version.rb
 - stubberry.gemspec
 homepage: https://github.com/alekseyl/stubberry
@@ -48,7 +134,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -58,5 +144,5 @@ requirements: []
 rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
-summary: This a small set of stub extensions to Object interface.
+summary: Ultimate collection of sweet stub methods for ruby test suits. Lets stub!
 test_files: []

data/.idea/inspectionProfiles/profiles_settings.xml

@@ -1,5 +0,0 @@
-<component name="InspectionProjectProfileManager">
-  <settings>
-    <option name="PROJECT_PROFILE" />
-  </settings>
-</component>

data/.idea/workspace.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="PropertiesComponent">
-    <property name="nodejs_interpreter_path.stuck_in_default_project" value="undefined stuck path" />
-    <property name="nodejs_npm_path_reset_for_default_project" value="true" />
-    <property name="settings.editor.selected.configurable" value="org.jetbrains.plugins.ruby.settings.RubyActiveModuleSdkConfigurable" />
-  </component>
-</project>