simple_stub 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f41c5fa17fb28bc656a40b36da9dfc56bb481d9f08105b61da41ba82ea5be698
+  data.tar.gz: c1e85f87feb9e7433ce90cc1abcc8c2a87fe6e75f098e531bfaebeed94c5f078
+SHA512:
+  metadata.gz: c5e3d3c3f4d181124a982c986b9055c3c2c23973f10ff45995b9c769e58521e10357766fecc983015e51f13ed333cb8a89dfeb28ce63618958c73ca70e9144db
+  data.tar.gz: 027d8dc539cbf1e1f301e653eb6e4ff32cab626a87bd0fe298df93740669e8e6696672e765f978cf436f9d68f0aa03bea12889bcf47c39e893ab72b66bcc65d5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at iwaki@i3-systems.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in simple_stub.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 YusukeIwaki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+# SimpleStub
+
+Defining simple scoped stub with apply/reset interface
+
+```ruby
+fixed_time = Time.now
+stub_time_now = SimpleStub.for_singleton_method(Time, :now) { fixed_time }
+
+stub_time_now.apply!
+# Time.now is fixed here
+stub_time_now.reset!
+```
+
+## Installation
+
+```ruby
+gem 'simple_stub'
+```
+
+then `bundle install`.
+
+## Usage
+
+For stubbing a singleton method (or class method), use `SimpleStub.for_singleton_method`.
+
+```ruby
+fixed_time = Time.now
+stub_time_now = SimpleStub.for_singleton_method(Time, :now) { fixed_time }
+
+stub_time_now.apply!
+# Time.now is fixed here
+stub_time_now.reset!
+```
+
+For stubbing an instance method (which affects to all of the instances), use `SimpleStub.for_instance_method`.
+
+```ruby
+class Dog
+  def hello
+    'Hello!'
+  end
+end
+
+stub_dog_hello = SimpleStub.for_instance_method(Dog, :hello) { 'Bow' }
+dog1 = Dog.new
+stub_dog1_hello = SimpleStub.for_singleton_method(dog1, :hello) { ">> #{super()} <<" }
+
+stub_dog_hello.apply!
+Dog.new.hello # => 'Bow'
+dog1.hello # => 'Bow'
+stub_dog1_hello.apply!
+dog1.hello # => '>> Bow <<'
+```
+
+Since SimpleStub doesn't store any state in the instance, we can use it separatedly.
+
+```ruby
+class SomethingSetup
+  def call
+    # All username becomes John Doe
+    SimpleStub.for_instance_method(User, :name) { 'John Doe' }.apply
+  end
+end
+
+class SomethingTeardown
+  def call
+    SimpleStub.for_instance_method(User, :name).reset
+  end
+end
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SimpleStub project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/simple_stub/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/test_*.rb']
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'simple_stub'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/simple_stub/already_applied_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module SimpleStub
+  class AlreadyAppliedError < StandardError
+  end
+end

data/lib/simple_stub/for_instance_method.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require 'digest'
+
+module SimpleStub
+  # Stub for instance methods, without any alias_method.
+  # This class internally prepends a module into the target class.
+  # {#apply} adds a method into the prepended module.
+  # {#reset} removes a method from the prepended module.
+  #
+  # This class must be stateless for the usecase that
+  # the caller of {#apply} and the caller of {#reset} can be different.
+  # Both
+  #
+  #   @stub_user_name = SimpleStub::ForInstanceMethod(User, :name) { 'YusukeIwaki' }
+  #   @stub_user_name.apply!
+  #   # Any username is YusukeIwaki here
+  #   @stub_user_name.reset!
+  #
+  # and
+  #
+  #   stub_user_name = SimpleStub::ForInstanceMethod(User, :name) { 'YusukeIwaki' }
+  #   stub_user_name.apply!
+  #   # Any username is YusukeIwaki here
+  #   stub_user_name = SimpleStub::ForInstanceMethod(User, :name) { 'YusukeIwaki' }
+  #   stub_user_name.reset!
+  #
+  # should work.
+  #
+  class ForInstanceMethod
+    # @param klass [Class]
+    # @param method_name [Symbol]
+    def initialize(klass, method_name, &impl)
+      raise ArgumentError, "klass must be a Class. #{klass.class} specified." unless klass.is_a?(Class)
+      raise ArgumentError, 'method name must be a Symbol.' unless method_name.is_a?(Symbol)
+
+      @klass = klass
+      @method_name = method_name
+      @impl = impl
+    end
+
+    # Safer version of {#apply!}
+    # Nothing happens when the stub is already applied.
+    def apply
+      return if stub_defined?
+
+      apply_stub
+    end
+
+    # Apply the stub. If the stub is already applied, raises error.
+    def apply!
+      raise AlreadyAppliedError, "The stub for #{@klass}##{@method_name} is already applied" if stub_defined?
+
+      apply_stub
+    end
+
+    # Safer version of {#reset!}.
+    # Nothing happens when the stub is already applied.
+    def reset
+      return unless stub_defined?
+
+      reset_stub
+    end
+
+    # Remove the stub and revert to the original implementation. If the stub is not applied or already reset, raise error.
+    def reset!
+      raise NotAppliedError, "The stub for #{@klass}##{@method_name} is already applied" unless stub_defined?
+
+      reset_stub
+    end
+
+    private
+
+    def apply_stub
+      raise ArgumentError, 'Block must be given for applying stub' unless @impl
+
+      # define_method is private on Ruby <= 2.4
+      impl_module.send(:define_method, @method_name, &@impl)
+    end
+
+    def reset_stub
+      # remove_method is private on Ruby <= 2.4
+      impl_module.send(:remove_method, @method_name)
+    end
+
+    def impl_module
+      impl_module_or_nil || create_and_apply_impl_module
+    end
+
+    def impl_module_or_nil
+      ForInstanceMethod.const_get(impl_module_name) if ForInstanceMethod.const_defined?(impl_module_name)
+    end
+
+    def create_and_apply_impl_module
+      Module.new.tap do |mod|
+        # Name the module here
+        ForInstanceMethod.const_set(impl_module_name, mod)
+
+        @klass.prepend(mod)
+      end
+    end
+
+    def klass_digest
+      @klass_digest ||= Digest::SHA256.hexdigest(@klass.to_s)
+    end
+
+    def impl_module_name
+      @impl_module_name ||= "StubImpl#{klass_digest}"
+    end
+
+    def stub_defined?
+      # Avoid creating module just in asking if stub exists.
+      impl_module_or_nil&.method_defined?(@method_name)
+    end
+  end
+end

data/lib/simple_stub/not_applied_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module SimpleStub
+  class NotAppliedError < StandardError
+  end
+end

data/lib/simple_stub/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SimpleStub
+  VERSION = '0.1.0'
+end

data/lib/simple_stub.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'simple_stub/version'
+require 'simple_stub/already_applied_error'
+require 'simple_stub/for_instance_method'
+require 'simple_stub/not_applied_error'
+
+module SimpleStub
+  # Stubs instance method.
+  # This affect to any instance of the target class.
+  #
+  #   class Dog
+  #     def hello
+  #       'Hello!'
+  #     end
+  #   end
+  #
+  #   dog1 = Dog.new
+  #   stub_dog_hello = SimpleStub.for_singleton_method(Dog, :hello) { 'Bow' }
+  #   stub_dog_hello.apply!
+  #   dog1.hello # => 'Bow'
+  #   Dog.new.hello # => 'Bow'
+  #   stub_dog_hello.reset!
+  #   dog1.hello # => 'Hello!'
+  #   Dog.new.hello # => 'Hello!'
+  #
+  # @param klass [Class]
+  # @param method_name [Symbol]
+  def for_instance_method(klass, method_name, &impl)
+    ForInstanceMethod.new(klass, method_name, &impl)
+  end
+
+  # Create a definition for stubbing singleton method.
+  # This can be used to stub class method like:
+  #
+  #   fixed_time = Time.now
+  #   stub_time_now = SimpleStub.for_singleton_method(Time, :now) { fixed_time }
+  #   stub_time_now.apply!
+  #   # Time.now returns fixed_time here.
+  #   stub_time_now.reset!
+  #
+  # And also can be used for stubbing method of an object instance.
+  #
+  #   class Dog
+  #     def hello
+  #       'Hello!'
+  #     end
+  #   end
+  #
+  #   dog1 = Dog.new
+  #   stub_dog1 = SimpleStub.for_singleton_method(dog1, :hello) { 'Bow' }
+  #   stub_dog1.apply!
+  #   dog1.hello # => 'Bow'
+  #   Dog.new.hello # => 'Hello!'
+  #
+  # @param receiver [Class|Object]
+  # @param method_name [Symbol]
+  def for_singleton_method(receiver, method_name, &impl)
+    ForInstanceMethod.new(receiver.singleton_class, method_name, &impl)
+  end
+
+  module_function :for_instance_method, :for_singleton_method
+end

data/simple_stub.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_stub/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'simple_stub'
+  spec.version       = SimpleStub::VERSION
+  spec.authors       = ['YusukeIwaki']
+  spec.email         = ['q7w8e9w8q7w8e9@yahoo.co.jp']
+
+  spec.summary       = 'Defining simple scoped stub with apply/reset interface'
+  spec.homepage      = 'https://github.com/YusukeIwaki/simple_stub'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/}) || f.include?('.git')
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.3'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: simple_stub
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- YusukeIwaki
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: rake
+  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: 
+email:
+- q7w8e9w8q7w8e9@yahoo.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simple_stub.rb
+- lib/simple_stub/already_applied_error.rb
+- lib/simple_stub/for_instance_method.rb
+- lib/simple_stub/not_applied_error.rb
+- lib/simple_stub/version.rb
+- simple_stub.gemspec
+homepage: https://github.com/YusukeIwaki/simple_stub
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key: 
+specification_version: 4
+summary: Defining simple scoped stub with apply/reset interface
+test_files: []