mocoso 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 582dde2452597ff29ecf14f4b3b980ca5d53a02a
+  data.tar.gz: c95e557a539ddf097439ac91f4af19c273e1b47e
+SHA512:
+  metadata.gz: 0f6f811c7c9a6c057e2d6b517062504ab60a04ea04addf464f73d361c41be07415a781946e330a71730193837c6819c01f82641188c017ae3008a3a69e92c689
+  data.tar.gz: 0235d2b34437f476e9e8989512d038c1db485345df46d2cc5bb053df1e6a6f437c743858da28955a200de503d8fb50d3f8d51ef87d59a2d42321eabe86f176ac

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Francesco Rodríguez
+
+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 @@
+Mocoso [![Build Status](https://travis-ci.org/frodsan/mocoso.png)](https://travis-ci.org/frodsan/mocoso)
+======
+
+Yet Another Simple Stub & Mock library. This is inspired by tools such as
+[Minitest::Mock][minitest], [Override][override] and [Mocha][mocha].
+
+Motivation
+----------
+
+**tl;dr: Il mío capriccio**
+
+Yes, there are a lot of good libraries out there, but I wanted one that
+meets the following criteria:
+
+* Provides features to restore stubbed methods to their original implementations.
+* Doesn't allow to stub or mock undefined methods.
+* Doesn't monkey-patch any class or object.
+* Test-framework agnostic (Doesn't need integration code).
+
+And the most important: simplicity.
+
+Installation
+------------
+
+    $ gem install mocoso
+
+Usage
+-----
+
+A quick example (uses [Cutest][cutest]):
+
+    require 'cutest'
+    require 'mocoso'
+
+    include Mocoso
+
+    test 'mocking a class method' do
+      user = User.new
+      expect User, :find, with: [1], return: user
+      assert_equal user, User.find(1)
+    end
+
+    test 'stubbing an instance method' do
+      user = User.new
+      stub user, valid?: true
+      assert user.valid?
+    end
+
+Check [Official Documentation][docs] for more details.
+
+License
+-------
+
+Copyright (c) 2013 Francesco Rodríguez
+
+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.
+
+[docs]: http://rubydoc.info/github/frodsan/mocoso/
+[cutest]: https://github.com/djanowski/cutest/
+[override]: https://github.com/soveran/override/
+[minitest]: https://github.com/seattlerb/minitest/
+[mocha]: https://github.com/freerange/mocha/

data/lib/mocoso.rb

@@ -0,0 +1,194 @@
+# Yet Another Simple Stub & Mock library, that also:
+#
+#   - Provides features to restore stubbed methods to their original implementations.
+#   - Doesn't allow to stub or mock undefined methods.
+#   - Doesn't monkey-patch any class or object.
+#   - Test-framework agnostic (Doesn't need integration code).
+#
+# == Setup
+#
+# Execute:
+#
+#   gem install mocoso
+#
+# == Usage
+#
+# Quick start:
+#
+#     require 'cutest'
+#     require 'mocoso'
+#
+#     include Mocoso
+#
+#     test 'mocking a class method' do
+#       user = User.new
+#       expect User, :find, with: [1], return: user
+#       assert_equal user, User.find(1)
+#     end
+#
+#     test 'stubbing an instance method' do
+#       user = User.new
+#       stub user, valid?: true
+#       assert user.valid?
+#     end
+#
+# Note: this example uses the test framework Cutest[1]:
+#
+# Mocoso is inspired in Override[2], Minitest::Mock[3] and Mocha[4].
+#
+# * [1]: https://github.com/djanowski/cutest/
+# * [2]: https://github.com/soveran/override/
+# * [3]: https://github.com/seattlerb/minitest/
+# * [4]: https://github.com/freerange/mocha/
+#
+module Mocoso
+  # Raised by #expect when a expectation is not fulfilled.
+  #
+  #   Mocoso.expect object, :method, with: 'argument', returns: nil
+  #
+  #   object.method 'unexpected argument'
+  #   # => Mocoso::ExpectationError: Expected ["argument"], got ["unexpected argument"]
+  #
+  ExpectationError = Class.new StandardError
+
+  # Rewrites each method from `methods` and defined in +object+. `methods` is a
+  # Hash that represents stubbed method name symbols as keys and corresponding
+  # return values as values.
+  #
+  #   signup = SignupForm.new params[:user]
+  #
+  #   signup.valid? # => false
+  #   signup.save   # => false
+  #
+  #   Mocoso.stub signup, valid?: true, signup: true
+  #
+  #   signup.valid? # => true
+  #   signup.save   # => true
+  #
+  # You can pass a callable object (responds to +call+) as a value:
+  #
+  #   Mocoso.stub subject, foo: -> { "foo" }, bar: ->(value) { value }
+  #
+  #   subject.foo        # => "foo"
+  #   subject.bar('foo') # => "foo"
+  #
+  # If you try to stub a method that is not defined by the +object+,
+  # it raises an error.
+  #
+  #   Mocoso.stub Object.new, undefined: nil
+  #   # => NameError: undefined method `undefined' for class `Object'
+  #
+  # Note that it will rewrite the method(s) in +object+. If you want to stub a
+  # method without side effects, you should pass a block.
+  #
+  #   User.all.length
+  #   # => 5
+  #
+  #   Mocoso.stub User, all: [] do
+  #     User.all.length
+  #     # => 0
+  #   end
+  #
+  #   User.all.length
+  #   # => 5
+  #
+  def stub object, methods
+    metaclass = object.singleton_class
+
+    methods.each do |method, result|
+      metaclass.send :alias_method, stub_method_name(method), method
+      metaclass.send :define_method, method do |*args|
+        result.respond_to?(:call) ? result.call(*args) : result
+      end
+    end
+
+    if block_given?
+      begin
+        yield
+      ensure
+        unstub object, methods.keys
+      end
+    end
+  end
+
+  # Removes the specified stubbed +methods+ (added by calls to #stub or #expect) and
+  # restores the original behaviour of the methods before they were stubbed.
+  #
+  #   object.foo # => "foo"
+  #
+  #   Mocoso.stub object, foo: 'new foo'
+  #   object.foo # => "new foo"
+  #
+  #   Mocoso.unstub object, [:foo]
+  #   object.foo #=> "foo"
+  #
+  # I personally use a block on #stub or #expect to avoid side effects, because if
+  # you #unstub a method which still has unsatisfied expectations, you may be
+  # removing the only way those expectations can be satisfied. Use it on your
+  # own responsibility.
+  #
+  # This method was born as a helper for #stub.
+  #
+  def unstub object, methods
+    metaclass = object.singleton_class
+
+    methods.each do |method|
+      metaclass.send :undef_method, method
+      metaclass.send :alias_method, method, stub_method_name(method)
+      metaclass.send :undef_method, stub_method_name(method)
+    end
+  end
+
+  def stub_method_name name
+    "__mocoso_#{name}"
+  end
+  private :stub_method_name
+
+  # Expect that method +method+ is called with the arguments specified in the
+  # +:with+ option (defaults to +[]+ if it's not given) and returns the value
+  # specified in the +:return+ option. If expectations are not met, it raises
+  # Mocoso::ExpectationError error.
+  #
+  #   class User < Model
+  #   end
+  #
+  #   user = User[1]
+  #
+  #   Mocoso.expect user, :update, with: [{ name: 'new name' }], returns: true
+  #
+  #   subject.update unexpected: nil
+  #   # => Mocoso::ExpectationError: Expected [{:name=>"new name"}], got [{:unexpected=>nil}]
+  #
+  #   user.update name: 'new name'
+  #   # => true
+  #
+  # Note that it will rewrite the method in +object+. If you want to set an
+  # expectation without side effects, you should pass a block.
+  #
+  #   User.exists? 1
+  #   # => false
+  #
+  #   Mocoso.expect User, :exists?, with: [1], returns: true do
+  #     User.exists? 1
+  #     # => true
+  #   end
+  #
+  #   User.exists? 1
+  #   # => false
+  #
+  def expect object, method, options
+    expectation = -> *params {
+      with = options.fetch(:with) { [] }
+
+      raise ExpectationError, "Expected #{with}, got #{params}" if params != with
+
+      options[:return]
+    }
+
+    if block_given?
+      stub object, method => expectation, &proc
+    else
+      stub object, method => expectation
+    end
+  end
+end

data/mocoso.gemspec

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+Gem::Specification.new do |s|
+  s.name        = 'mocoso'
+  s.version     = '0.0.1'
+  s.summary     = 'A simple stub & mock library'
+  s.description = s.summary
+  s.authors     = ['Francesco Rodríguez']
+  s.email       = ['lrodriguezsanc@gmail.com']
+  s.homepage    = 'https://github.com/frodsan/mocoso'
+  s.license     = 'MIT'
+
+  s.files = Dir[
+    'LICENSE',
+    'README.md',
+    'lib/**/*.rb',
+    '*.gemspec',
+    'test/*.*'
+  ]
+
+  s.add_development_dependency 'cutest'
+end

data/test/scary_mocks_and_nice_stubs.rb

@@ -0,0 +1,119 @@
+require 'cutest'
+require_relative '../lib/mocoso'
+
+class Subject
+  def foo; 'foo'; end
+  def bar; 'bar'; end
+  def baz(value); value; end
+
+  def self.foo
+    'foo'
+  end
+end
+
+include Mocoso
+
+setup do
+  Subject.new
+end
+
+test 'raises error if object not respond to the given method' do |subject|
+  assert_raise { stub(subject, nan: nil, undefined: nil) }
+end
+
+test 'stubs methods and return new values' do |subject|
+  before_foo = subject.foo
+  before_bar = subject.bar
+
+  stub subject, foo: 'new foo', bar: 'new bar'
+
+  assert subject.foo != before_foo
+  assert subject.bar != before_bar
+end
+
+test 'stubs method with a callable object' do |subject|
+  before = subject.foo
+
+  stub subject, foo: -> { 'new foo' }
+
+  assert subject.foo != before
+  assert subject.foo == 'new foo'
+end
+
+test 'stubs method with a callable object with arguments' do |subject|
+  before = subject.foo
+
+  stub subject, foo: ->(a) { "new #{a}" }
+
+  assert subject.foo('foo') != before
+end
+
+test 'stubs method without side effects if a block is given' do
+  before = Subject.foo
+
+  stub Subject, foo: 'new foo' do
+    assert before != Subject.foo
+  end
+
+  assert_equal before, Subject.foo
+end
+
+test 'succeeds if expectations are met' do |subject|
+  expect subject, :baz, with: ['value'], return: 'result'
+
+  assert_equal 'result', subject.baz('value')
+end
+
+test 'raises an error if expectation are not met' do |subject|
+  expect subject, :baz, with: ['value'], return: 'result'
+
+  assert_raise(Mocoso::ExpectationError) { subject.baz('another') }
+end
+
+test 'expectation without side effects if a block is given' do |subject|
+  expect subject, :baz, with: ['value'], return: 'mocked' do
+    assert_equal 'mocked', subject.baz('value')
+  end
+
+  assert_equal 'original', subject.baz('original')
+end
+
+test 'expectation without arguments' do |subject|
+  expect subject, :foo, return: 'new foo'
+
+  assert_equal 'new foo', subject.foo
+end
+
+test 'expectation with multiple arguments' do |subject|
+  expect subject, :foo, with: ['new foo', { optional: true }], return: 'new foo'
+
+  assert_equal 'new foo', subject.foo('new foo', optional: true)
+end
+
+test 'unstub removes specified stubbed methods' do |subject|
+  before_foo = subject.foo
+  before_bar = subject.bar
+
+  stub subject, foo: 'new foo', bar: 'new bar', baz: 'new baz'
+
+  assert before_foo != subject.foo
+  assert before_bar != subject.bar
+
+  unstub subject, [:foo, :bar]
+
+  assert_equal before_foo, subject.foo
+  assert_equal before_bar, subject.bar
+  assert_equal 'new baz', subject.baz
+end
+
+test 'unstub removes specified expectations' do
+  before = Subject.foo
+
+  expect Subject, :foo, return: 'new foo'
+
+  assert_equal 'new foo', Subject.foo
+
+  unstub Subject, [:foo]
+
+  assert_equal before, Subject.foo
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: mocoso
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Francesco Rodríguez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cutest
+  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: A simple stub & mock library
+email:
+- lrodriguezsanc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/mocoso.rb
+- mocoso.gemspec
+- test/scary_mocks_and_nice_stubs.rb
+homepage: https://github.com/frodsan/mocoso
+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.2.0.preview.1
+signing_key: 
+specification_version: 4
+summary: A simple stub & mock library
+test_files: []