mocktail 0.0.1

data/lib/mocktail/verifies_call/raises_verification_error.rb

@@ -0,0 +1,63 @@
+require_relative "raises_verification_error/gathers_calls_of_method"
+require_relative "raises_verification_error/stringifies_call"
+
+module Mocktail
+  class RaisesVerificationError
+    def initialize
+      @gathers_calls_of_method = GathersCallsOfMethod.new
+      @stringifies_call = StringifiesCall.new
+    end
+
+    def raise(recording, verifiable_calls, demo_config)
+      Kernel.raise VerificationError.new <<~MSG
+        Expected mocktail of #{recording.original_type.name}##{recording.method} to be called like:
+
+          #{@stringifies_call.stringify(recording)}#{[
+            (" [#{demo_config.times} #{pl("time", demo_config.times)}]" unless demo_config.times.nil?),
+            (" [ignoring extra args]" if demo_config.ignore_extra_args),
+            (" [ignoring blocks]" if demo_config.ignore_block)
+          ].compact.join(" ")}
+
+        #{[
+          describe_verifiable_times_called(demo_config, verifiable_calls.size),
+          describe_other_calls(recording, verifiable_calls, demo_config)
+        ].compact.join("\n\n")}
+      MSG
+    end
+
+    private
+
+    def describe_verifiable_times_called(demo_config, count)
+      return if demo_config.times.nil?
+
+      if count == 0
+        "But it was never called this way."
+      else
+        "But it was actually called this way #{count} #{pl("time", count)}."
+      end
+    end
+
+    def describe_other_calls(recording, verifiable_calls, demo_config)
+      calls_of_method = @gathers_calls_of_method.gather(recording) - verifiable_calls
+      if calls_of_method.size == 0
+        if demo_config.times.nil?
+          "But it was never called."
+        end
+      else
+        <<~MSG
+          It was called differently #{calls_of_method.size} #{pl("time", calls_of_method.size)}:
+
+          #{calls_of_method.map { |call| "  " + @stringifies_call.stringify(call) }.join("\n\n")}
+        MSG
+      end
+    end
+
+    def pl(s, count)
+      if count == 1
+        s
+      else
+        s + "s"
+      end
+    end
+  end
+end

data/lib/mocktail/verifies_call.rb

@@ -0,0 +1,29 @@
+require_relative "records_demonstration"
+require_relative "verifies_call/finds_verifiable_calls"
+require_relative "verifies_call/raises_verification_error"
+
+module Mocktail
+  class VerifiesCall
+    def initialize
+      @records_demonstration = RecordsDemonstration.new
+      @finds_verifiable_calls = FindsVerifiableCalls.new
+      @raises_verification_error = RaisesVerificationError.new
+    end
+
+    def verify(demo, demo_config)
+      recording = @records_demonstration.record(demo, demo_config)
+      verifiable_calls = @finds_verifiable_calls.find(recording, demo_config)
+
+      unless verification_satisfied?(verifiable_calls.size, demo_config)
+        @raises_verification_error.raise(recording, verifiable_calls, demo_config)
+      end
+    end
+
+    private
+
+    def verification_satisfied?(verifiable_call_count, demo_config)
+      (demo_config.times.nil? && verifiable_call_count > 0) ||
+        (demo_config.times == verifiable_call_count)
+    end
+  end
+end

data/lib/mocktail/version.rb

@@ -0,0 +1,3 @@
+module Mocktail
+  VERSION = "0.0.1"
+end

data/lib/mocktail.rb

@@ -0,0 +1,63 @@
+require_relative "mocktail/dsl"
+require_relative "mocktail/errors"
+require_relative "mocktail/handles_dry_call"
+require_relative "mocktail/handles_dry_new_call"
+require_relative "mocktail/imitates_type"
+require_relative "mocktail/initializes_mocktail"
+require_relative "mocktail/matcher_presentation"
+require_relative "mocktail/matchers"
+require_relative "mocktail/registers_matcher"
+require_relative "mocktail/registers_stubbing"
+require_relative "mocktail/replaces_next"
+require_relative "mocktail/replaces_type"
+require_relative "mocktail/resets_state"
+require_relative "mocktail/value"
+require_relative "mocktail/verifies_call"
+require_relative "mocktail/version"
+
+module Mocktail
+  # Returns an instance of `type` whose implementation is mocked out
+  def self.of(type)
+    ImitatesType.new.imitate(type)
+  end
+
+  # Returns an instance of `klass` whose implementation is mocked out AND
+  # stubs its constructor to return that fake the next time klass.new is called
+  def self.of_next(type, count: 1)
+    ReplacesNext.new.replace(type, count)
+  end
+
+  # See lib/mocktail/dsl.rb
+  define_singleton_method :stubs, DSL.instance_method(:stubs)
+  define_singleton_method :verify, DSL.instance_method(:verify)
+
+  def self.matchers
+    MatcherPresentation.new
+  end
+
+  def self.captor
+    Matchers::Captor.new
+  end
+
+  def self.register_matcher(matcher)
+    RegistersMatcher.new.register(matcher)
+  end
+
+  # Replaces every singleton method on `type` with a fake, and when instantiated
+  # or included will also fake instance methods
+  def self.replace(type)
+    ReplacesType.new.replace(type)
+    nil
+  end
+
+  def self.reset
+    ResetsState.new.reset
+  end
+
+  # Stores most transactional state about calls & stubbing configurations
+  def self.cabinet
+    Thread.current[:mocktail_store] ||= Cabinet.new
+  end
+end
+
+Mocktail::InitializesMocktail.new.init

data/mocktail.gemspec

@@ -0,0 +1,31 @@
+require_relative "lib/mocktail/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "mocktail"
+  spec.version = Mocktail::VERSION
+  spec.authors = ["Justin Searls"]
+  spec.email = ["searls@gmail.com"]
+
+  spec.summary = "your objects, less potency"
+  spec.homepage = "https://github.com/testdouble/mocktail"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  # 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{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: mocktail
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Justin Searls
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-09-22 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- searls@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".standard.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mocktail.rb
+- lib/mocktail/dsl.rb
+- lib/mocktail/errors.rb
+- lib/mocktail/handles_dry_call.rb
+- lib/mocktail/handles_dry_call/fulfills_stubbing.rb
+- lib/mocktail/handles_dry_call/fulfills_stubbing/finds_satisfaction.rb
+- lib/mocktail/handles_dry_call/logs_call.rb
+- lib/mocktail/handles_dry_call/validates_arguments.rb
+- lib/mocktail/handles_dry_new_call.rb
+- lib/mocktail/imitates_type.rb
+- lib/mocktail/imitates_type/ensures_imitation_support.rb
+- lib/mocktail/imitates_type/makes_double.rb
+- lib/mocktail/imitates_type/makes_double/declares_dry_class.rb
+- lib/mocktail/initializes_mocktail.rb
+- lib/mocktail/matcher_presentation.rb
+- lib/mocktail/matchers.rb
+- lib/mocktail/matchers/any.rb
+- lib/mocktail/matchers/base.rb
+- lib/mocktail/matchers/captor.rb
+- lib/mocktail/matchers/includes.rb
+- lib/mocktail/matchers/is_a.rb
+- lib/mocktail/matchers/matches.rb
+- lib/mocktail/matchers/not.rb
+- lib/mocktail/matchers/numeric.rb
+- lib/mocktail/matchers/that.rb
+- lib/mocktail/records_demonstration.rb
+- lib/mocktail/registers_matcher.rb
+- lib/mocktail/registers_stubbing.rb
+- lib/mocktail/replaces_next.rb
+- lib/mocktail/replaces_type.rb
+- lib/mocktail/replaces_type/redefines_new.rb
+- lib/mocktail/replaces_type/redefines_singleton_methods.rb
+- lib/mocktail/resets_state.rb
+- lib/mocktail/share/determines_matching_calls.rb
+- lib/mocktail/share/simulates_argument_error.rb
+- lib/mocktail/value.rb
+- lib/mocktail/value/cabinet.rb
+- lib/mocktail/value/call.rb
+- lib/mocktail/value/demo_config.rb
+- lib/mocktail/value/double.rb
+- lib/mocktail/value/matcher_registry.rb
+- lib/mocktail/value/stubbing.rb
+- lib/mocktail/value/top_shelf.rb
+- lib/mocktail/value/type_replacement.rb
+- lib/mocktail/verifies_call.rb
+- lib/mocktail/verifies_call/finds_verifiable_calls.rb
+- lib/mocktail/verifies_call/raises_verification_error.rb
+- lib/mocktail/verifies_call/raises_verification_error/gathers_calls_of_method.rb
+- lib/mocktail/verifies_call/raises_verification_error/stringifies_call.rb
+- lib/mocktail/version.rb
+- mocktail.gemspec
+homepage: https://github.com/testdouble/mocktail
+licenses: []
+metadata:
+  homepage_uri: https://github.com/testdouble/mocktail
+  source_code_uri: https://github.com/testdouble/mocktail
+  changelog_uri: https://github.com/testdouble/mocktail/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: your objects, less potency
+test_files: []