mimic-rb 0.1.1

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/.rspec

@@ -0,0 +1 @@
+--color --format doc

data/.travis.yml

@@ -0,0 +1,4 @@
+langauge: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## v0.0.1
+
+* initial release
+
+## v0.1.0
+* adding arguement validation
+* initial Gem Release

data/Gemfile

@@ -0,0 +1,7 @@
+source :rubygems
+
+gem 'rake'
+gem 'rspec'
+gem 'guard-rspec'
+gem 'rb-fsevent', '~> 0.9.1'
+gem 'pry'

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Justin Herrick
+
+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,109 @@
+#Mimic [![Build Status](https://secure.travis-ci.org/jah2488/mimic.png?branch=master)](https://travis-ci.org/jah2488/mimic)
+
+##Rspec style mocking and stubbing for NullObjects, Fakes, and more!##
+
+Inspired by [r00k's](http://www.twitter.com/r00k) talk at [magicruby](http://magic-ruby.com/), I decided to work on a minimalistic library for mocking and stubbing full classes. The original purpose would be to have a NullObject consistently stay in sync with its real object equivelant with minimal effort.
+
+## Installing ##
+
+````sh
+gem install mimic
+````
+or
+
+````ruby
+#Gemfile
+gem 'mimic'
+````
+
+````sh
+bundle install
+````
+
+## Usages ##
+
+Given we have an awesome class
+````ruby
+class NameResponder
+
+  def hello
+    "hi"
+  end
+
+  def name
+    "John"
+  end
+
+  def full_name(first, last)
+    "#{first} #{last}"
+  end
+
+  def self.reverse(name)
+    name.reverse
+  end
+
+end
+````
+
+Then in our NullObject / Fake / Mimic we simply need to include it and use it.
+````ruby
+class FakeResponder
+  include Mimic
+  mocks NameResponder
+
+  stubs(:name) { "None" }
+
+  class_stubs(:reverse) { "no name" }
+end
+````
+
+Then anywhere we would use `NameResponder` we can use `FakeResponder` and it will respond to all calls. The default return value for all methods is simply `nil`, but with the `stubs(:method) { result }` method you can specify what you want to be returned.
+
+````ruby
+
+responder = NameResponder.new
+fake      = FakeResponder.new
+
+responder.hello #=> "hi"
+fake.hello      #=> nil
+
+responder.name  #=> "John"
+fake.name       #=> "None"
+
+responder.full_name "Jane", "Doe" #=> "Jane Doe"
+fake.full_name "Avdi", "Burnhart" #=> nil
+
+NameResponder.reverse "Ryan" #=> "nayR"
+FakeResponder.reverse "Ryan" #=> "no name"
+
+````
+
+## Error Handling ##
+To keep you from stubbing methods that don't exist and thus getting your fake out of sync with your base class, Mimic throws two custom exceptions based on what travesty you committed. 
+
+If you try to stub an instance method that does not belong on the base class, you will get `InstanceMethodNotDefined` Error.
+
+If you try to stub a class method that does not belong on the base class, you will get `ClassMethodNotDefined` Error.
+
+Pretty self explanatory. These are simply here as a gentle reminder that will help keep your fake in sync with your base class before you get in production and start chasing nil and NoMethod errors.
+
+
+
+## Developing for Mimic ##
+If you have any feature requests or bug fixes, I actively encourage you to try out integrating those changes yourself and making a pull request.
+
+First fork the repo
+````sh
+git clone [GITHUB GIT URL]
+bundle
+rspec
+````
+Check all the tests and then from there have fun!
+
+
+## TODO ##
+
+    * Test that setters and getters are also properly mocked/stubbed
+    * See if it'd be a horrible idea to mix this into ruby's class so you don't have to `include Mimic` in your mimic classes
+    * Module Stubbing/Mocking
+    * Strict Parameter checking. **Currently all mocked methods allow n arguments.**

data/Rakefile

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

data/lib/mimic.rb

@@ -0,0 +1,80 @@
+class MethodNotDefined < StandardError
+end
+
+class InstanceMethodNotDefined < MethodNotDefined
+end
+
+class ClassMethodNotDefined < MethodNotDefined
+end
+
+module Mimic
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    #To have a file strictly adhere to the implementation of another file, call <tt>mimics</tt> in
+    #any class followed by the class name as an attribute.
+    #
+    #     class NullUser
+    #       include Mimic
+    #       mimics User
+    #     end
+    #
+    #This will add all the class and instance level methods to your class that are defined in the class
+    #being mimicked. All methods will default to returning nil when called. Please keep this in mind.
+    def mimics(class_name)
+      class_name.instance_methods(false).map do |method_name|
+        params = class_name.instance_method(method_name).parameters.map(&:last)
+        define_method(method_name) do |*args|
+          raise ArgumentError unless args.count.eql? params.count
+        end
+      end
+      class_name.methods(false).map do |method_name|
+        params = class_name.method(method_name).parameters.map(&:last)
+        define_singleton_method(method_name) do |*args|
+          raise ArgumentError unless args.count.eql? params.count
+        end
+      end
+    end
+
+    #If you want to override the default behavior of returning nil for methods on the original class
+    #simply call <tt>stubs</tt> followed by the method name and a block with the return value desired.
+    #
+    #    class NullUser
+    #      include mimic
+    #      mimics User
+    #
+    #      stubs(:name) { "No Name" }
+    #    end
+    #
+    def stubs(method_name, &block)
+      raise InstanceMethodNotDefined, error_msg(method_name)  unless method_defined?(method_name)
+      define_method(method_name) { |*args| yield }
+    end
+
+    #If you want to override the default behavior of returning nil for class methods on the original class
+    #simply call <tt>class_stubs</tt> followed by the method name and a block with the return value desired.
+    #
+    #   class NullUser
+    #     include mimic
+    #     mimics User
+    #
+    #     class_stubs(:age_for) { 10 }
+    #   end
+    #
+    def class_stubs(method_name, &block)
+      raise ClassMethodNotDefined, error_msg(method_name) unless methods(false).include?(method_name)
+      define_singleton_method(method_name) { |*args| yield }
+    end
+
+    def arg_error_msg(args, params)
+      "Wrong Number of Arguements for Method. (#{args.count}) of (#{params.count})"
+    end
+
+    def error_msg(method_name)
+      "Method: #{method_name} Isn't Defined on Base Class"
+    end
+  end
+end

data/lib/mimic/version.rb

@@ -0,0 +1,3 @@
+module Mimic
+  VERSION = "0.1.1"
+end

data/mimic-rb.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/mimic/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Justin Herrick"]
+  gem.email         = ["justin@justinherrick.com"]
+  gem.description   = %q{Minimalistic Library for Mocking, Stubbing, and Faking Classes}
+  gem.summary       = %q{Rspec Style Mocking and Stubbing for creating Null Objects and Faking Classes with error handling to keep your Fake's in sync}
+  gem.homepage      = "https://github.com/jah2488/mimic"
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "mimic-rb"
+  gem.require_paths = ["lib"]
+  gem.version       = Mimic::VERSION
+end

data/spec/mimic_spec.rb

@@ -0,0 +1,93 @@
+require 'mimic'
+
+class MyNode
+  def hello
+    "hi"
+  end
+  def johnny
+    "bill"
+  end
+  def add(first, second)
+    first + second
+  end
+  def self.used
+    "u called me"
+  end
+  def self.holla
+    "back"
+  end
+end
+
+class MyFakeNode
+  include Mimic
+  mimics MyNode
+  stubs(:add)  { "five" }
+  class_stubs(:used) {  1000  }
+end
+
+
+describe Mimic do
+
+  it "mocks all methods on fake class" do
+    MyFakeNode.instance_methods(false).should == MyNode.instance_methods(false)
+  end
+  it "mocks all class methods on fake class" do
+    MyFakeNode.methods(false).should == MyNode.methods(false)
+  end
+
+  it "returns nil for instance method calls" do
+    a = MyFakeNode.new
+    a.hello.should  be_nil
+    a.johnny.should be_nil
+  end
+
+  it "returns nil for class method calls" do
+    MyFakeNode.holla.should be_nil
+  end
+
+  it "should let you stub a class method" do
+    MyFakeNode.used.should == 1000
+  end
+
+  it "returns the stubbed response for a given methods" do
+    a = MyFakeNode.new
+    a.add.should ==  "five"
+  end
+
+  it "will return the stubbed response even when the method is given parameters" do
+    a = MyFakeNode.new
+    a.add(2,5).should == "five"
+  end
+
+  it "should raise exception if method is not defined on base class" do
+    lambda {
+      a = class MyNullObject
+        include Mimic
+        mimics MyNode
+        stubs(:subtract) { "10"}
+      end
+    }.should raise_error InstanceMethodNotDefined
+  end
+
+  it "should raise exception if method is not defined on base class" do
+    lambda {
+      a = class MyNullObject
+        include Mimic
+        mimics MyNode
+        class_stubs(:subtract) { "10" }
+      end
+    }.should raise_error ClassMethodNotDefined
+  end
+
+  it "should raise exceptions on methods being called with wrong amount of arguements" do
+    lambda {
+      class MyNullObject
+        include Mimic
+        mimics MyNode
+      end
+      a = MyNullObject.new
+      a.hello(10)
+    }.should raise_error ArgumentError
+  end
+
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: mimic-rb
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Justin Herrick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Minimalistic Library for Mocking, Stubbing, and Faking Classes
+email:
+- justin@justinherrick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/mimic.rb
+- lib/mimic/version.rb
+- mimic-rb.gemspec
+- spec/mimic_spec.rb
+homepage: https://github.com/jah2488/mimic
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.22
+signing_key: 
+specification_version: 3
+summary: Rspec Style Mocking and Stubbing for creating Null Objects and Faking Classes
+  with error handling to keep your Fake's in sync
+test_files:
+- spec/mimic_spec.rb
+has_rdoc: