ancient_mock 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b63a9acbabc8f04ce9f8be0f3168753764e4edb8
+  data.tar.gz: 32d9db7b5c7b99346865971b1516e820f56f59fc
+SHA512:
+  metadata.gz: d0a7e334dab6b0d1c32ae934b37aee04327c9f2c671919d39924517101fcfb37bca9112b89001279ffdf33abf90e26adc1ec259d1984116e29bdf62e46667f3d
+  data.tar.gz: 7e3f796694b208d65b6bb2f9066cd64d964c68d88b0f3dd3ab7cab8f000d46b0776887bfa7603a799f08d7f970aceb07dab9873a14cdf2079dfef4ed9958ae75

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ancient_mock.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Andy Lindeman
+
+MIT License
+
+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,38 @@
+# AncientMock
+
+A simple mock object library that I build on stage at [Ancient City
+Ruby](http://ancientcityruby.com).
+
+**Do not use in production!** It was an academic exercise meant to teach
+the basics of building a mock object library.
+
+* Video from the talk (not yet posted)
+* [Slides from the talk](https://docs.google.com/presentation/d/1laaQYHFyzcTJzlB9qMmEHyoHIB-S93p9B4L8SbbhoTw/edit#slide=id.p)
+
+## Installation
+
+```ruby
+# Gemfile
+gem 'ancient_mock'
+```
+
+## Usage
+
+```ruby
+warehouse = Object.new
+
+# Stub
+allow(warhouse).to receive(:full?).and_return(true)
+warehouse.full? # => true
+
+# Mock
+item_id = 1234
+expect(warehouse).to receive(:remove).with(item_id)
+# warehouse.remove(1234) must be called
+```
+
+## Tests
+
+```ruby
+bundle exec rake
+```

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/*_test.rb']
+end
+
+task :default => :test

data/ancient_mock.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ancient_mock/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ancient_mock"
+  spec.version       = AncientMock::VERSION
+  spec.authors       = ["Andy Lindeman"]
+  spec.email         = ["alindeman@gmail.com"]
+  spec.description   = %q{A simple mock object library I built on stage at Ancient City Ruby. Do not use in production!}
+  spec.summary       = %q{A simple mock object library I built on stage at Ancient City Ruby.}
+  spec.homepage      = "https://github.com/alindeman/ancient_mock"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", "~> 4.7.0"
+end

data/lib/ancient_mock.rb

@@ -0,0 +1,137 @@
+require_relative "ancient_mock/version"
+
+module AncientMock
+  ExpectationNotSatisfied = Class.new(StandardError)
+
+  class StubTarget
+    def initialize(obj)
+      @obj = obj
+    end
+
+    def to(definition)
+      Stubber.for_object(@obj).stub(definition)
+    end
+  end
+
+  class ExpectationTarget < StubTarget
+    def to(definition)
+      super
+      AncientMock.expectations << definition
+    end
+  end
+
+  class Stubber
+    def self.stubbers
+      @stubbers ||= { }
+    end
+
+    def self.for_object(obj)
+      stubbers[obj.__id__] ||= Stubber.new(obj)
+    end
+
+    def self.reset
+      stubbers.each_value(&:reset)
+      stubbers.clear
+    end
+
+    def initialize(obj)
+      @obj = obj
+      @definitions = []
+      @preserved_methods = []
+    end
+
+    def stub(definition)
+      @definitions << definition
+
+      # preserve the method if already exists
+      if @obj.singleton_class.method_defined?(definition.message)
+        @preserved_methods <<
+          @obj.singleton_class.instance_method(definition.message)
+      end
+
+      definitions = @definitions
+      @obj.define_singleton_method(definition.message) do |*arguments|
+        definitions.
+          reverse.
+          find { |d| d.matches?(definition.message, *arguments) }.
+          call
+      end
+    end
+
+    def reset
+      @definitions.each do |definition|
+        @obj.singleton_class.class_eval do
+          remove_method(definition.message) if method_defined?(definition.message)
+        end
+      end
+
+      @preserved_methods.reverse.each do |method|
+        @obj.define_singleton_method(method.name, method)
+      end
+    end
+  end
+
+  class ExpectationDefinition
+    attr_reader :message, :return_value
+
+    def initialize(message)
+      @message = message
+      @invocation_count = 0
+    end
+
+    def and_return(return_value)
+      @return_value = return_value
+      self
+    end
+
+    def with(*arguments)
+      @arguments = arguments
+      self
+    end
+
+    def matches?(message, *arguments)
+      message == @message &&
+        (@arguments.nil? || arguments == @arguments)
+    end
+
+    def call
+      @invocation_count += 1
+      @return_value
+    end
+
+    def verify
+      if @invocation_count != 1
+        raise ExpectationNotSatisfied
+      end
+    end
+  end
+
+  module TestExtensions
+    def allow(obj)
+      StubTarget.new(obj)
+    end
+
+    def expect(obj)
+      ExpectationTarget.new(obj)
+    end
+
+    def receive(message)
+      ExpectationDefinition.new(message)
+    end
+  end
+
+  def self.reset
+    expectations.each(&:verify)
+  ensure
+    expectations.clear
+    Stubber.reset
+  end
+
+  def self.expectations
+    @expectations ||= []
+  end
+end
+
+class MiniTest::Unit::TestCase
+  include AncientMock::TestExtensions
+end

data/lib/ancient_mock/version.rb

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

data/test/ancient_mock_test.rb

@@ -0,0 +1,64 @@
+require "minitest/spec"
+require "minitest/autorun"
+require_relative "../lib/ancient_mock"
+
+describe AncientMock do
+  it "allows an object to receive a message, returning a value" do
+    warehouse = Object.new
+
+    allow(warehouse).to receive(:full?).and_return(true)
+
+    warehouse.full?.must_equal true
+  end
+
+  it "removes stubbed methods after tests finish" do
+    warehouse = Object.new
+
+    allow(warehouse).to receive(:full?).and_return(true)
+
+    AncientMock.reset
+
+    assert_raises(NoMethodError) { warehouse.full? }
+  end
+
+  it "preserves methods that originally existed" do
+    warehouse = Object.new
+    def warehouse.full?; false; end
+
+    allow(warehouse).to receive(:full?).and_return(true)
+
+    AncientMock.reset
+
+    warehouse.full?.must_equal false
+  end
+
+  it "expects that a message will be received" do
+    warehouse = Object.new
+
+    expect(warehouse).to receive(:empty)
+    # warehouse.empty not called!
+
+    assert_raises(AncientMock::ExpectationNotSatisfied) do
+      AncientMock.reset
+    end
+  end
+
+  it "does not raise an error if expectations are satisfied" do
+    warehouse = Object.new
+
+    expect(warehouse).to receive(:empty)
+    warehouse.empty
+
+    AncientMock.reset
+  end
+
+  it "allows objects to receive messages with arguments" do
+    warehouse = Object.new
+
+    allow(warehouse).to receive(:include?).with(1234).and_return(true)
+    allow(warehouse).to receive(:include?).with(9876).and_return(false)
+
+    warehouse.include?(1234).must_equal true
+    warehouse.include?(9876).must_equal false
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: ancient_mock
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andy Lindeman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.7.0
+description: A simple mock object library I built on stage at Ancient City Ruby. Do
+  not use in production!
+email:
+- alindeman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ancient_mock.gemspec
+- lib/ancient_mock.rb
+- lib/ancient_mock/version.rb
+- test/ancient_mock_test.rb
+homepage: https://github.com/alindeman/ancient_mock
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: A simple mock object library I built on stage at Ancient City Ruby.
+test_files:
+- test/ancient_mock_test.rb