motion-stump 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+
+# Specify your gem's dependencies in bubble-wrap.gemspec
+gemspec

data/History.txt

@@ -0,0 +1,3 @@
+== 0.1.0
+
+* motion-stump: initial release

data/License.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Francis Chong
+
+Copyright (c) 2008 Jeremy McAnally
+
+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,93 @@
+# motion-stump
+
+Stubbing and mocking for RubyMotion. Based on Jeremy McAnally's [stump](https://github.com/jm/stump) library.
+
+## Features
+
+### Stubbing right on the object
+
+```ruby
+# Returns 'hey!'
+MyClass.stub!(:thing, :return => "hey!")
+# Returns nil
+your_object.stub!(:hello)
+```
+
+### Pure stub objects
+```ruby
+my_stub = stub(:thing, :return => "dude, a thing!")
+my_stub.thing   # => "dude, a thing!"
+```
+
+### Mocking right on the object
+
+```ruby
+my_object = "things are fun"
+my_object.mock!(:fancy, :return => "ooo fancy!")
+my_object.fancy # => "ooo fancy!"
+my_object.mock!(:tancy, :return => "ooo fancy!")
+
+# if my_object.tancy is not called, it will fail the spec
+```
+
+### Pure mock objects
+```ruby
+my_mock = mock(:hello, :return => "what fun is this?")
+my_mock.hello   # => "what fun is this?"
+```
+
+
+### Proxying objects
+
+```ruby
+class Greeting
+  def bonjour
+    "Bonjour!"
+  end
+end
+
+greet_me = Greeting.new
+greet_me.proxy!(:bonjour)
+greet_me.bonjour  # => "Bonjour!"
+
+greet_you = Greeting.new
+greet_you.proxy!(:bonjour)
+
+# finish test...
+# ! Unmet expectations: #<Greeting:0x371d24> expected bonjour
+```
+
+## Installation
+
+```ruby
+gem install 'motion-stump'
+```
+
+### Usage
+
+Add following lines in your motion Rakefile
+
+```ruby
+$:.unshift("/Library/RubyMotion/lib")
+require 'motion/project'
+require 'rubygems'
+require 'motion-stump'
+
+Motion::Project::App.setup do |app|
+  app.name = 'motion-stump'
+end
+```
+
+## License
+
+(The MIT License)
+
+Copyright © 2012 Francis Chong
+
+Copyright © 2008 Jeremy McAnally
+
+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/Rakefile

@@ -0,0 +1,18 @@
+# -*- coding: utf-8 -*-
+require "bundler/gem_tasks"
+
+$:.unshift("/Library/RubyMotion/lib")
+require 'motion/project'
+require 'bundler'
+Bundler.require :default, :development
+
+Motion::Project::App.setup do |app|
+  app.name = 'motion-stump'
+end
+
+desc "Build the gem"
+task :gem do
+  sh "bundle exec gem build motion-stump.gemspec"
+  sh "mkdir -p pkg"
+  sh "mv *.gem pkg/"
+end

data/app/app_delegate.rb

@@ -0,0 +1,5 @@
+class AppDelegate
+  def application(application, didFinishLaunchingWithOptions:launchOptions)
+    true
+  end
+end

data/lib/motion-stump.rb

@@ -0,0 +1,32 @@
+unless defined?(Motion::Project::Config)
+  raise "This file must be required within a RubyMotion project Rakefile."
+end
+
+## Extend Motion config to include our spec helper
+module Motion; module Project;
+  class Config
+    alias_method :spec_files_before_stump, :spec_files
+    def spec_files
+      core = Dir.chdir(motiondir + '/lib/motion') { (['spec.rb'] + Dir.glob(File.join('spec', 'helpers', '*.rb'))).map { |x| File.expand_path(x) } }
+      (core + [File.join(File.dirname(__FILE__), 'stump/stump_spec_helper.rb')] + spec_files_before_stump).uniq
+    end
+  end
+end; end
+
+
+## Include stump in dev mode
+Motion::Project::App.setup do |app|
+  app.development do
+     [
+      File.join(File.dirname(__FILE__), 'stump/version.rb'),
+      File.join(File.dirname(__FILE__), 'stump/metaid.rb'),
+      File.join(File.dirname(__FILE__), 'stump/stub.rb'),
+      File.join(File.dirname(__FILE__), 'stump/mocks.rb'),
+      File.join(File.dirname(__FILE__), 'stump/mock.rb'),
+      File.join(File.dirname(__FILE__), 'stump/proxy.rb')
+    ].reverse.each {|f| app.files.unshift(f) }
+  end
+end
+
+## Include supports for define_method
+require 'motion-define-method'

data/lib/stump/metaid.rb

@@ -0,0 +1,17 @@
+# thanks _why
+# http://whytheluckystiff.net/articles/seeingMetaclassesClearly.html
+class Object
+  # The hidden singleton lurks behind everyone
+  def metaclass; class << self; self; end; end
+  def meta_eval &blk; metaclass.instance_eval &blk; end
+
+  # Adds methods to a metaclass
+  def meta_def name, &blk
+    meta_eval { define_method name, &blk }
+  end
+
+  # Defines an instance method within a class
+  def class_def name, &blk
+    class_eval { define_method name, &blk }
+  end
+end

data/lib/stump/mock.rb

@@ -0,0 +1,51 @@
+class Object
+  # Create a mock method on an object.  A mock object will place an expectation
+  # on behavior and cause a test failure if it's not fulfilled.
+  # 
+  # ==== Examples
+  #
+  #    my_string = "a wooden rabbit"
+  #    my_string.mock!(:retreat!, :return => "run away!  run away!")
+  #    my_string.mock!(:question, :return => "what is the airspeed velocity of an unladen sparrow?")
+  #    
+  #    # test/your_test.rb
+  #    my_string.retreat!    # => "run away!  run away!"
+  #    # If we let the test case end at this point, it fails with:
+  #    # Unmet expectation: #<Sparrow:1ee7> expected question
+  #
+  def mock!(method, options = {}, &block)    
+    Stump::Mocks.add([self, method])
+    
+    behavior =  if block_given?
+                  lambda do |*args| 
+                    raise ArgumentError if block.arity >= 0 && args.length != block.arity
+                    
+                    Stump::Mocks.verify([self, method])
+                    block.call(*args)
+                  end
+                else
+                  lambda do |*args|                     
+                    Stump::Mocks.verify([self, method])
+                    return options[:return]
+                  end
+                end
+
+    meta_def method, &behavior
+  end
+end
+
+module Kernel
+  # Create a pure mock object rather than mocking specific methods on an object.
+  #
+  # ==== Examples
+  # 
+  #     my_mock = mock(:thing, :return => "whee!")
+  #     my_mock.thing    # => "whee"
+  #
+  def mock(method, options = {}, &block)
+    mock_object = Object.new
+    mock_object.mock!(method, options, &block)
+    mock_object
+  end
+end
+

data/lib/stump/mocks.rb

@@ -0,0 +1,27 @@
+module Stump
+  # A class to track the mocks and proxies that have been satisfied
+  class Mocks
+    class <<self
+      def size
+        @mocks ? 0 : @mocks.size 
+      end
+
+      def add(mock)
+        @mocks ||= []
+        @mocks << mock
+      end
+      
+      def verify(mock)
+        @mocks.delete(mock)
+      end
+      
+      def failures
+        @mocks
+      end
+      
+      def clear!
+        @mocks = []
+      end
+    end
+  end
+end

data/lib/stump/proxy.rb

@@ -0,0 +1,117 @@
+class Object
+  # Creates a proxy method on an object.  In this setup, it places an expectation on an object (like a mock)
+  # but still calls the original method.  So if you want to make sure the method is called and still return
+  # its value, or simply want to invoke the side effects of a method and return a stubbed value, then you can
+  # do that.
+  #
+  # ==== Examples
+  #
+  #     class Parrot
+  #       def speak!
+  #         puts @words
+  #       end
+  #
+  #       def say_this(words)
+  #         @words = words
+  #         "I shall say #{words}!"
+  #       end
+  #     end
+  #
+  #     # => test/your_test.rb
+  #     sqawky = Parrot.new
+  #     sqawky.proxy!(:say_this)
+  #     # Proxy method still calls original method...
+  #     sqawky.say_this("hey")   # => "I shall say hey!"
+  #     sqawky.speak!            # => "hey"
+  #
+  #     sqawky.proxy!(:say_this, "herro!")
+  #     # Even though we return a stubbed value...
+  #     sqawky.say_this("these words")   # => "herro!"
+  #     # ...the side effects are still there.
+  #     sqawky.speak!                    # => "these words"
+  #
+  # TODO: This implementation is still very rough.  Needs refactoring and refining.  Won't 
+  # work on ActiveRecord attributes, for example.
+  #
+  def proxy!(method, options = {}, &block)
+    Stump::Mocks.add([self, method])
+    
+    if respond_to?(method)
+      proxy_existing_method(method, options, &block)
+    else
+      proxy_missing_method(method, options, &block)
+    end
+  end
+  
+  protected
+  def proxy_existing_method(method, options = {}, &block)
+    method_alias = "__old_#{method}".to_sym
+    
+    meta_eval do
+      module_eval do
+        alias_method method_alias, method
+      end
+    end
+    
+    check_arity = Proc.new do |args|
+      arity = method(method_alias.to_sym).arity
+      if ((arity >= 0) ?
+          (args.length != arity) :
+          (args.length < ~arity))
+        # Negative arity means some params are optional, so we check
+        # for the minimum required.  Sadly, we can't tell what the
+        # maximum is.
+        raise ArgumentError
+      end
+    end
+    
+    behavior = if options[:return]
+                  lambda do |*args| 
+                    check_arity.call(args)
+                    
+                    Stump::Mocks.verify([self, method])
+
+                    if method(method_alias.to_sym).arity == 0
+                      send(method_alias)
+                    else
+                      send(method_alias, *args)
+                    end
+
+                    return options[:return]
+                  end
+                else
+                  lambda do |*args| 
+                    check_arity.call(args)
+
+                    Stump::Mocks.verify([self, method])
+                    
+                    if method(method_alias.to_sym).arity == 0
+                      return send(method_alias)
+                    else
+                      return send(method_alias, *args)
+                    end
+                  end
+                end
+
+    meta_def method, &behavior
+  end
+  
+  def proxy_missing_method(method, options = {}, &block)
+    behavior = if options[:return]
+                  lambda do |*args|
+                    Stump::Mocks.verify([self, method])
+                    
+                    method_missing(method, args)
+                    return options[:return]
+                  end
+                else
+                  lambda do |*args|
+                    Stump::Mocks.verify([self, method])
+      
+                    method_missing(method, args)
+                  end
+                end
+    
+    meta_def method, &behavior
+  end
+end

data/lib/stump/stub.rb

@@ -0,0 +1,34 @@
+class Object
+  # Create a stub method on an object.  Simply returns a value for a method call on
+  # an object.
+  # 
+  # ==== Examples
+  #
+  #    my_string = "a wooden rabbit"
+  #    my_string.stub!(:retreat!, :return => "run away!  run away!")
+  #    
+  #    # test/your_test.rb
+  #    my_string.retreat!    # => "run away!  run away!"
+  #
+  def stub!(method, options = {}, &block)
+    behavior = (block_given? ? block : proc { return options[:return] })
+
+    meta_def method, &behavior
+  end
+end
+
+module Kernel
+  # Create a pure stub object.
+  #
+  # ==== Examples
+  # 
+  #     stubbalicious = stub(:failure, "wat u say?")
+  #     stubbalicious.failure     # => "wat u say?"
+  #
+  def stub(method, options = {}, &block)
+    stub_object = Object.new
+    stub_object.stub!(method, options, &block)
+    
+    stub_object
+  end
+end

data/lib/stump/stump_spec_helper.rb

@@ -0,0 +1,32 @@
+module Stump
+  module Baconize
+    module ContextExtensions
+      def self.included(base)
+        base.class_eval do
+          alias_method :it_without_mock_verification, :it
+          alias_method :it, :it_with_mock_verification
+        end
+      end
+
+      def verify_mocks
+        if !Stump::Mocks.failures.nil? && !Stump::Mocks.failures.empty?
+          fails = Stump::Mocks.failures.map {|object, method| "#{object.inspect} expected #{method}"}.join(", ")
+          should.flunk "Unmet expectations: #{fails}"
+        end
+      end
+
+      def it_with_mock_verification(description, &block)
+        @after << proc { verify_mocks }
+        it_without_mock_verification(description, &block)
+      ensure
+        Stump::Mocks.clear!
+      end
+    end
+  end
+end
+
+begin
+  Bacon::Context.class_eval { include Stump::Baconize::ContextExtensions }
+rescue LoadError
+  puts 'Bacon is not available.'
+end

data/lib/stump/version.rb

@@ -0,0 +1,3 @@
+module Stump
+  VERSION = "0.1.0"
+end

data/motion-stump.gemspec

@@ -0,0 +1,19 @@
+require File.expand_path('../lib/stump/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors = ["Francis Chong"]
+  gem.email = ["francis@ignition.hk"]
+  gem.description = "Stubbing and mocking for RubyMotion"
+  gem.summary = "Stubbing and mocking for RubyMotion"
+  gem.homepage = "https://github.com/siuying/motion-stump"
+
+  gem.files = `git ls-files`.split($\)
+  gem.test_files = gem.files.grep(%r{^(test|spec|lib_spec|features)/})
+  gem.name = "motion-stump"
+  gem.require_paths = ["lib"]
+  gem.version = Stump::VERSION
+
+  gem.add_dependency 'motion-define-method', '~> 0.1.2'
+  gem.add_development_dependency 'motion-redgreen'
+  gem.add_development_dependency 'rake'
+end

data/spec/main_spec.rb

@@ -0,0 +1,44 @@
+describe "Application 'stump-test'" do
+  class Hello
+  end
+
+  it "stub on object" do 
+    Hello.stub!(:thing, :return => "hey!")
+    Hello.should.not.be.nil
+    Hello.thing.should == "hey!"
+
+    my_obj = Object.new
+    my_obj.stub!(:hello)
+    my_obj.hello.should.be.nil
+  end
+
+  it "should create pure stub" do 
+    my_stub = stub(:thing, :return => "dude, a thing!")
+    my_stub.thing.should == "dude, a thing!"
+  end
+
+  it "should mock object" do
+    my_object = "things are fun"
+    my_object.mock!(:fancy, :return => "ooo fancy!")
+    my_object.mock!(:tancy, :return => "ooo tancy!")
+    my_object.fancy.should == 'ooo fancy!'
+  end
+
+  # it "should create pure mock" do 
+  #   my_mock = mock(:hello, :return => "what fun is this?")
+  #   my_mock.hello.should == "what fun is this?"
+  # end
+
+  # class Greeting
+  #   def bonjour
+  #     "Bonjour!"
+  #   end
+  # end
+
+  # it "should use proxy objects" do 
+  #   greet_me = Greeting.new
+  #   greet_me.proxy!(:bonjour)
+  #   greet_me.bonjour  # => "Bonjour!"
+  # end
+
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: motion-stump
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Francis Chong
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: motion-define-method
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: motion-redgreen
+  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: 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'
+description: Stubbing and mocking for RubyMotion
+email:
+- francis@ignition.hk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- History.txt
+- License.txt
+- README.md
+- Rakefile
+- app/app_delegate.rb
+- lib/motion-stump.rb
+- lib/stump/metaid.rb
+- lib/stump/mock.rb
+- lib/stump/mocks.rb
+- lib/stump/proxy.rb
+- lib/stump/stub.rb
+- lib/stump/stump_spec_helper.rb
+- lib/stump/version.rb
+- motion-stump.gemspec
+- spec/main_spec.rb
+homepage: https://github.com/siuying/motion-stump
+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'
+      segments:
+      - 0
+      hash: 731758381242350488
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 731758381242350488
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Stubbing and mocking for RubyMotion
+test_files:
+- spec/main_spec.rb