strictly_fake 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 12c67d1493c17fbe736895b8fa5bf60bd96959e16290a8e38b35a82fc0c21013
+  data.tar.gz: '0088588b7626d8aeee1f80f0171f828aca5e8c558a28538a2321ba9bc7ca1d41'
+SHA512:
+  metadata.gz: 347ae7e5cdec81ab141f47c98b93b59cd272344bcc5ef7246468bab280977d215e050ccf8815de613992457f97ba15d1ddc9a82ca4a0f2d796daac290a6003cc
+  data.tar.gz: 7febf5c8242d3144924297de781d1e2cc6fff1ea31cd873f42b0029e90343233668726a06a418daf3d8d98367306821370545d7fd2fc79aa7f851b866d9fb38a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.rspec_status

data/.travis.yml

@@ -0,0 +1,10 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 2.1.4
+install: bundle
+script:
+  - bundle exec rubocop
+  - COVERAGE=1 bundle exec rspec

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in strictly_fake.gemspec
+gemspec
+
+gem 'awesome_print'
+gem 'minitest'
+gem 'rake'
+gem 'rspec'
+gem 'rubocop'
+gem 'simplecov'

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    strict_fake (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    awesome_print (1.8.0)
+    diff-lcs (1.4.4)
+    docile (1.3.2)
+    minitest (5.14.2)
+    parallel (1.19.2)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    regexp_parser (1.8.2)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (1.1.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 1.0.1)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.1.0)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.10.1)
+    simplecov (0.19.1)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.3)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  minitest
+  rake
+  rspec
+  rubocop
+  simplecov
+  strict_fake!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Featurist
+
+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,86 @@
+# StrictlyFake [![Build Status](https://travis-ci.org/featurist/strictly_fake.svg?branch=master)](https://travis-ci.org/featurist/strictly_fake)
+
+Sometimes fakes are a good choice. But the price is high. In particular, they make changing code harder. You rename a method, but all tests that stub the previous version _keep_ passing. It would be nice if those started to fail so that when they're green again, you can be certain that everything that had to be updated was updated. Well, now you can.
+
+To be fair, you already can in Rspec with their [verifying double](https://relishapp.com/rspec/rspec-mocks/v/3-9/docs/verifying-doubles). But what about Minitest? And there are still differences. Unlike verifying double:
+
+- here you need to supply real objects to create fakes. That's controversial - as it goes against the idea of testing in isolation - but realistically, at least in Rails, everything is loaded anyway, so that's a moot point;
+- strictly_fake is aware of autogenerated methods (e.g. ActiveRecord model accessors);
+- strictly_fake does not stub constants (e.g. classes). You can, of course, create a fake of a class, but it'll need to be explicitely "injected" into the consumer code;
+- strictly_fake performs a full parameter check, comparing required, optional and keyword arguments (veryfing double only checks arity).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'strictly_fake'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+```ruby
+require 'strictly_fake'
+
+# Given we don't want to actually pay in tests
+class PaymentGateway
+  def pay(recipient, amount, reference = nil);
+    # calls remote payment provider...
+  end
+end
+
+# We can use a fake instead
+payment_gateway = StrictlyFake.new(PaymentGateway.new)
+
+# Let's stub a method that isn't defined in PaymentGateway:
+payment_gateway.stub(:bar)
+# => throws "Can't stub non-existent method PaymentGateway#bar (StrictlyFake::Error)"
+
+# Let's stub an existing method, but with a wrong signature: 
+payment_gateway.stub(:pay) { |amount| }
+# => throws "Expected PaymentGateway#pay stub to accept (req, req, opt=), but was (req) (StrictlyFake::Error)"
+
+# All good now!
+payment_gateway.stub(:pay) { |recipient, amount, reference = nil| 'Success!' }
+
+payment_gateway.pay('Dave', 10)
+# => 'Success!'
+
+# Makeshift mock
+invoked = false
+payment_gateway.stub(:pay) do |recipient, amount, reference = nil|
+  # Further arguments check
+  assert(amount.is_a?(Money))
+  invoked = true
+end
+
+payment_gateway.pay('Dave', Money.new(10))
+assert(invoked)
+
+# Stubbing class methods is no different
+time = StrictlyFake.new(Time)
+
+time.stub(:now) { 'XYZ' }
+time.now
+# => 'XYZ'
+```
+
+Note: Minitest is required for `assert*` to work.
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/featurist/strictly_fake.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'strictly_fake'
+
+# 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/lib/strictly_fake.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require_relative './strictly_fake/version'
+
+# StrictlyFake - verifying fake
+class StrictlyFake
+  class Error < StandardError; end
+
+  # Actual fake
+  class Fake
+    begin
+      require 'minitest'
+      include Minitest::Assertions
+    rescue LoadError
+      # wtf rubocop
+    end
+
+    attr_accessor :assertions
+
+    def initialize
+      @assertions = 0
+    end
+  end
+
+  def initialize(real)
+    @real = real
+    @fake = Fake.new
+  end
+
+  def stub(meth, &block)
+    raise Error, "Can't stub #stub" if meth.to_s == 'stub'
+
+    assert_method_defined(meth)
+
+    expected_parameters = @real.method(meth).parameters
+    actual_parameters = convert_to_lambda(&block).parameters
+
+    assert_method_signature_match(meth, expected_parameters, actual_parameters)
+
+    stub_method(meth, &block)
+  end
+
+  # rubocop:disable Lint/MissingSuper
+  def method_missing(meth, *args)
+    @fake.send(meth, *args)
+  end
+  # rubocop:enable Lint/MissingSuper
+
+  def respond_to_missing?(meth, *_args)
+    @fake.respond_to?(meth) || super
+  end
+
+  private
+
+  def stub_method(meth, &block)
+    if respond_to?(meth)
+      (class << self; self; end).class_eval do
+        undef_method meth
+      end
+    end
+
+    (class << @fake; self; end).class_eval do
+      define_method(meth, &block)
+    end
+  end
+
+  def real_class_name
+    @real.is_a?(Class) ? @real.name : @real.class.name
+  end
+
+  def assert_method_defined(meth)
+    return if @real.respond_to?(meth)
+
+    method_type = @real.is_a?(Class) ? '.' : '#'
+    raise Error, "Can't stub non-existent method #{real_class_name}#{method_type}#{meth}"
+  end
+
+  def assert_method_signature_match(meth, expected_parameters, actual_parameters)
+    return if method_signatures_match?(expected_parameters, actual_parameters)
+
+    method_type = @real.is_a?(Class) ? '.' : '#'
+
+    raise Error, "Expected #{real_class_name}#{method_type}#{meth} stub to "\
+      "accept (#{format_parametes(expected_parameters)}), but was (#{format_parametes(actual_parameters)})"
+  end
+
+  def format_parametes(parameters)
+    parameters.map do |(type, name)|
+      {
+        req: 'req',
+        opt: 'opt=',
+        rest: '*rest',
+        key: ":#{name}",
+        keyreq: ":#{name}",
+        keyrest: '**keyrest'
+      }.fetch(type)
+    end.join(', ')
+  end
+
+  def method_signatures_match?(expected_parameters, actual_parameters)
+    expected_keyword_parameters, expected_positional_parameters = split_parameters_by_type(expected_parameters)
+    actual_keyword_parameters, actual_positional_parameters = split_parameters_by_type(actual_parameters)
+
+    positional_arguments_match = expected_positional_parameters == actual_positional_parameters
+    keyword_arguments_match = expected_keyword_parameters == actual_keyword_parameters
+
+    positional_arguments_match && keyword_arguments_match
+  end
+
+  def split_parameters_by_type(parameters)
+    keyword_parameters, positional_parameters = parameters.partition { |(arg_type)| arg_type.to_s =~ /^key/ }
+    keyrest = pop_keyrest(keyword_parameters)
+
+    [
+      keyword_parameters.map(&:last).sort + (keyrest ? [:keyrest] : []),
+      positional_parameters.map(&:first).reject { |p| p == :block }
+    ]
+  end
+
+  def pop_keyrest(keyword_parameters)
+    return unless keyword_parameters.last && keyword_parameters.last.first == :keyrest
+
+    keyword_parameters.pop
+  end
+
+  # Procs don't have `req` parameters, but lambdas do
+  def convert_to_lambda(&block)
+    obj = Object.new
+    obj.define_singleton_method(:_, &block)
+    obj.method(:_).to_proc
+  end
+end

data/lib/strictly_fake/version.rb

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

data/strictly_fake.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative 'lib/strictly_fake/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'strictly_fake'
+  spec.version       = StrictlyFake::VERSION
+  spec.authors       = ['artemave']
+  spec.email         = ['artemave@gmail.com']
+
+  spec.summary       = 'Stub that automatically verifies that stubbed methods exist and the signatures match the original.'
+  spec.description   = "This is similar to Rspec's Veryfing Double, but standalone. So can be used in Minitest."
+  spec.homepage      = 'https://github.com/featurist/strictly_fake'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  # 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(__dir__)) do
+    `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']
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: strictly_fake
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- artemave
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-11-24 00:00:00.000000000 Z
+dependencies: []
+description: This is similar to Rspec's Veryfing Double, but standalone. So can be
+  used in Minitest.
+email:
+- artemave@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- lib/strictly_fake.rb
+- lib/strictly_fake/version.rb
+- strictly_fake.gemspec
+homepage: https://github.com/featurist/strictly_fake
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/featurist/strictly_fake
+  source_code_uri: https://github.com/featurist/strictly_fake
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Stub that automatically verifies that stubbed methods exist and the signatures
+  match the original.
+test_files: []