cross-stub 0.1.4 → 0.2.0

data/HISTORY.txt

@@ -1,3 +1,15 @@
+=== 0.2.0 2010-07-16
+
+= New Features
+* added support for cross-stubbing instances [#liangzan]
+* added support for alternative cache stores :memcache & :redis [#ngty]
+* officially support MRI-1.8.7, MRI-1.9.1, JRUBY-1.5.1 & REE-1.8.7 [#ngty]
+
+= House-Keeping
+
+* dropped ParseTree dependency, use RubyParser instead [#ngty]
+* complete rewrite to have cleaner implementation (hopefully) [#ngty]
+
 === 0.1.4 2010-04-03
 
 = Bugfixes

data/README.rdoc

@@ -2,7 +2,7 @@
 
 == Introduction
 
-Existing mocking/stubbing frameworks support only stubbing in the current process. This is OK most of the time. However, when running cucumber integration test suite in non-webrat mode, these in-process stubbing frameworks simply doesn't help. Eg. I want Time.now to always return a timing that should be a Sunday, how do I do that when running cucumber in selenium, culerity, steam, blah, blah mode? It doesn't seem straight-forward me.
+Existing mocking/stubbing frameworks support only stubbing in the current process. This is OK most of the time. However, when running cucumber integration test suite in another process, these in-process stubbing frameworks simply doesn't help. Eg. I want Time.now to always return a timing that should be a Sunday, how do I do that when running cucumber using selenium, culerity, steam, blah, blah driver? It doesn't seem straight-forward me.
 
 (Let's not argue whether stubbing should be encouraged. It is an itch, the poor itch needs to be scratched.)
 
@@ -14,77 +14,133 @@ It's hosted on gemcutter.org.
 
 == Setting Up
 
-#1. If you are using rails, you are in luck:
+=== #1. Rails:
 
   $ ./script/generate cucumber
   $ ./script/generate cross_stub
 
-#2. Even if you are using something else, no worries:
+=== #2. Others (back to basics):
 
   # In the test setup method:
-  CrossStub.setup :file => <CACHE_FILE_PATH>
+  CrossStub.setup :file => <CACHE_FILE>
 
   # In the test teardown method:
   CrossStub.clear
 
   # Find an entry point in your target application, eg. in a server, the
   # point where all request handling starts:
-  CrossStub.refresh :file => <CACHE_FILE_PATH>
+  CrossStub.refresh :file => <CACHE_FILE>
+
+For a full list of available cache stores, scroll down to take a look at the 'Cache Stores' section.
 
 == Using It
 
-Using cross-stub is simple:
+Cross-stubbing is simple:
+
+=== #1. Simple returning of nil or non-nil value:
 
-#1. Simple returning of nil or non-nil value:
+==== #1.1. Class method:
 
   class Someone
-    def self.laugh
-      'HaHa'
+    def self.say
+      'hello'
     end
   end
 
-  Someone.xstub(:laugh)
-  Someone.laugh # yields: nil
+  Someone.xstub(:say)
+  Someone.say # yields: nil
+
+  Someone.xstub(:say => 'HELLO')
+  Someone.say # yields: 'HELLO'
+
+==== #1.2. Instance method:
+
+  Someone.xstub(:say, :instance => true)
+  Someone.new.say # yields: nil
+
+  Someone.xstub({:say => 'HELLO'}, :instance => true)
+  Someone.new.say # yields: 'HELLO'
 
-  Someone.xstub(:laugh, 'HoHo')
-  Someone.laugh # yields: 'HoHo'
+=== #2. If a stubbed method requires argument, pass xstub a proc:
 
-#2. If a stubbed method requires argument, pass :xstub a proc:
+==== #2.1. Class method:
 
   Someone.xstub do
-    def loves(other)
-      "I love #{other}"
+    def say(something)
+      'saying "%s"' % something
     end
   end
 
-  Someone.loves('you') # yields: 'I love you'
+  Someone.say('HELLO') # yields: 'saying "HELLO"'
+
+==== #2.2. Instance method:
+
+  Someone.xstub(:instance => true) do
+    def say(something)
+      'saying "%s"' % something
+    end
+  end
+
+  Someone.new.say('HELLO') # yields: 'saying "HELLO"'
+
+IMPORTANT: Since switching from ParseTree to RubyParser, dynamic code analysis is no longer possible. When defining methods in the proc, fanciful coding is strongly discouraged, pls follow the conservative style suggested above.
 
-#3. Something more complicated:
+=== #3. Something more complicated:
 
   something = 'hello'
   Someone.xstub do
-    def do_action(who, action)
-      %\#{who} #{action} #{something}\
+    def say
+      'saying "%s"' % something
     end
   end
 
-  Someone.do_action('i', 'say') # failure !!
+  Someone.say # failure !!
 
 The above fails as a result of undefined variable/method 'something', to workaround we can have:
 
-  Someone.xstub(:something => 'hello') do
-    def do_action(who, action)
-      %\#{who} #{action} #{something}\
+  Someone.xstub(:something => 'HELLO') do
+    def say
+      'saying "%s"' % something
     end
   end
 
-  Someone.do_action('i', 'say') # yields: 'i say hello'
+  Someone.say # yields: 'saying "HELLO"'
+
+== Cache Stores
+
+Cache stores are needed to allow stubs to be made available for different processes. The following describes all cache stores available:
+
+=== #1. File
+
+  # Setting up (current process)
+  CrossStub.setup :file => '<CACHE_FILE>'
+
+  # Refreshing (other process)
+  CrossStub.refresh :file => '<CACHE_FILE>'
+
+=== #2. Memcache (requires memcache-client gem)
+
+  # Setting up (current process)
+  CrossStub.setup :memcache => 'localhost:11211/<CACHE_ID>'
+
+  # Refreshing (other process)
+  CrossStub.refresh :memcache => 'localhost:11211/<CACHE_ID>'
+
+=== #3. Redis (requires redis gem)
+
+  # Setting up (current process)
+  CrossStub.setup :redis => 'localhost:6379/<CACHE_ID>'
+
+  # Refreshing (other process)
+  CrossStub.refresh :redis => 'localhost:6379/<CACHE_ID>'
+
+Adding new store is super easy (w.r.t testing & actual implementation), let me know if u need more :]
 
 == Caveats
 
 #1. Cross-stub uses ruby's Marshal class to dump & load the stubs, thus it has the same limitations as Marshal
 
-#2. Cross-stub only supports stubbing of class methods, since it makes no sense to do cross process stubbing of instances
+#2. Having switched from ParseTree to RubyParser, dynamic code analysis is no longer available, the proc taken by xstub no longer supports fanciful coding, pls follow the conservative style suggested in this README.
 
 == TODO(s)
 
@@ -92,10 +148,10 @@ The above fails as a result of undefined variable/method 'something', to workaro
 
 == Contacts
 
-Written 2009 by:
+Written since 2009 by:
 
-#1. NgTzeYang, contact ngty77[at]gmail.com or http://github.com/ngty
+#1. NgTzeYang, contact ngty77[at]gmail[dot]com or http://github.com/ngty
 
-#2. WongLiangZan, contact liangzan[at]gmail.com or http://github.com/liangzan
+#2. WongLiangZan, contact liangzan[at]gmail[dot]com or http://github.com/liangzan
 
 Released under the MIT license

data/Rakefile

@@ -12,9 +12,16 @@ begin
     gem.authors = ["NgTzeYang"]
     gem.add_development_dependency "bacon", ">= 0.0.0"
     gem.add_development_dependency "eventmachine", ">= 0.0.0"
-    gem.add_dependency "ParseTree", "= 3.0.4"
     gem.add_dependency "ruby2ruby", "= 1.2.4"
+    gem.add_dependency "ruby_parser", "= 2.0.4"
+    gem.required_ruby_version = '>= 1.8.7'
+    # ##
+    # TODO: How do we declare the following optional dependencies ??
+    # 1. gem.add_dependency "memcache-client", "= 1.8.5"
+    # 2. gem.add_dependency "redis", "= 2.0.3"
+    # ##
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+    #
   end
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.2.0

data/cross-stub.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cross-stub}
-  s.version = "0.1.4"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["NgTzeYang"]
-  s.date = %q{2010-04-03}
+  s.date = %q{2010-07-16}
   s.description = %q{}
   s.email = %q{ngty77@gmail.com}
   s.extra_rdoc_files = [
@@ -26,31 +26,49 @@ Gem::Specification.new do |s|
      "VERSION",
      "cross-stub.gemspec",
      "lib/cross-stub.rb",
-     "lib/cross-stub/cache_helpers.rb",
-     "lib/cross-stub/pseudo_class.rb",
-     "lib/cross-stub/setup_helpers.rb",
-     "lib/cross-stub/stub_helpers.rb",
+     "lib/cross-stub/arguments.rb",
+     "lib/cross-stub/arguments/array.rb",
+     "lib/cross-stub/arguments/hash.rb",
+     "lib/cross-stub/arguments/proc.rb",
+     "lib/cross-stub/cache.rb",
+     "lib/cross-stub/stores.rb",
+     "lib/cross-stub/stores/base.rb",
+     "lib/cross-stub/stores/file.rb",
+     "lib/cross-stub/stores/memcache.rb",
+     "lib/cross-stub/stores/redis.rb",
+     "lib/cross-stub/stubber.rb",
      "rails_generators/cross_stub/cross_stub_generator.rb",
      "rails_generators/cross_stub/templates/config/initializers/cross-stub.rb",
      "rails_generators/cross_stub/templates/features/support/cross-stub.rb",
      "spec/.bacon",
-     "spec/cross-stub/clearing_stubs_spec.rb",
-     "spec/cross-stub/creating_stubs_spec.rb",
-     "spec/cross-stub/stubbing_error_spec.rb",
-     "spec/helpers.rb",
+     "spec/arguments/proc_spec.rb",
+     "spec/includes.rb",
+     "spec/integration/clearing_instance_stubs_spec.rb",
+     "spec/integration/clearing_stubs_spec.rb",
+     "spec/integration/creating_instance_stubs_spec.rb",
+     "spec/integration/creating_stubs_spec.rb",
+     "spec/integration/shared_spec.rb",
+     "spec/integration/stubbing_error_spec.rb",
+     "spec/service.rb",
      "spec/spec_helper.rb",
      "tmp/.dummy"
   ]
   s.homepage = %q{http://github.com/ngty/cross-stub}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.required_ruby_version = Gem::Requirement.new(">= 1.8.7")
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Simple cross process stubbing}
   s.test_files = [
-    "spec/helpers.rb",
-     "spec/cross-stub/stubbing_error_spec.rb",
-     "spec/cross-stub/clearing_stubs_spec.rb",
-     "spec/cross-stub/creating_stubs_spec.rb",
+    "spec/includes.rb",
+     "spec/arguments/proc_spec.rb",
+     "spec/service.rb",
+     "spec/integration/stubbing_error_spec.rb",
+     "spec/integration/creating_instance_stubs_spec.rb",
+     "spec/integration/shared_spec.rb",
+     "spec/integration/clearing_stubs_spec.rb",
+     "spec/integration/creating_stubs_spec.rb",
+     "spec/integration/clearing_instance_stubs_spec.rb",
      "spec/spec_helper.rb"
   ]
 
@@ -58,22 +76,22 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<bacon>, [">= 0.0.0"])
       s.add_development_dependency(%q<eventmachine>, [">= 0.0.0"])
-      s.add_runtime_dependency(%q<ParseTree>, ["= 3.0.4"])
       s.add_runtime_dependency(%q<ruby2ruby>, ["= 1.2.4"])
+      s.add_runtime_dependency(%q<ruby_parser>, ["= 2.0.4"])
     else
       s.add_dependency(%q<bacon>, [">= 0.0.0"])
       s.add_dependency(%q<eventmachine>, [">= 0.0.0"])
-      s.add_dependency(%q<ParseTree>, ["= 3.0.4"])
       s.add_dependency(%q<ruby2ruby>, ["= 1.2.4"])
+      s.add_dependency(%q<ruby_parser>, ["= 2.0.4"])
     end
   else
     s.add_dependency(%q<bacon>, [">= 0.0.0"])
     s.add_dependency(%q<eventmachine>, [">= 0.0.0"])
-    s.add_dependency(%q<ParseTree>, ["= 3.0.4"])
     s.add_dependency(%q<ruby2ruby>, ["= 1.2.4"])
+    s.add_dependency(%q<ruby_parser>, ["= 2.0.4"])
   end
 end
 

data/lib/cross-stub.rb

@@ -1,47 +1,81 @@
 require 'rubygems'
-require 'parse_tree'
+require 'base64'
 require 'ruby2ruby'
-require 'cross-stub/stub_helpers'
-require 'cross-stub/setup_helpers'
-require 'cross-stub/cache_helpers'
-require 'cross-stub/pseudo_class'
+require 'ruby_parser'
+require 'forwardable'
+require 'cross-stub/cache'
+require 'cross-stub/stubber'
+require 'cross-stub/arguments'
+require 'cross-stub/stores'
 
 module CrossStub
 
   class Error < Exception ; end
   class CannotStubInstanceError < Error ; end
+  class ModuleCannotBeInstantiatedError < Error ; end
 
   class << self
 
-    include CacheHelpers
-    include SetupHelpers
-    include StubHelpers
+    extend Forwardable
+    def_delegator :'CrossStub::Cache', :setup
 
-    attr_reader :options
-
-    def setup(opts)
-      @options = opts
-      setup_for_current_process
+    def refresh(opts)
+      Cache.refresh(opts)
+      [[:previous, :unapply], [:current, :apply]].each do |(mode, method)|
+        Cache.get(mode).map do |cache_key, stubs|
+          type, thing = stubbable(cache_key)
+          Stubber.send(method, type, thing, stubs)
+        end
+      end
     end
 
     def clear
-      clear_stubs_for_current_process
+      Cache.get.map do |cache_key, stubs|
+        type, thing = stubbable(cache_key)
+        Stubber.unapply(type, thing, stubs)
+      end
+      Cache.clear
     end
 
-    def apply(*args, &blk)
-      apply_stubs_for_current_process(*args, &blk)
+    def apply(type, thing, cache_key, args, &block)
+      Cache.set(Cache.get.merge(
+        cache_key => Stubber.apply(type, thing, Arguments.parse(args, &block))
+      ))
     end
 
-    def refresh(opts)
-      @options = opts
-      apply_or_unapply_stubs_for_other_process
+    def stubbable(str)
+      [
+        str.end_with?(suffix = '#instance') ? :instance : :class,
+        klassify(str.sub(suffix,''))
+      ]
+    end
+
+    def klassify(str)
+      str.split('::').inject(Object){|klass, const| klass.const_get(const) }
     end
 
   end
 
   module ClassMethods
-    def xstub(*args, &blk)
-      CrossStub.apply(self, args, &blk)
+    def xstub(*args, &block)
+      if args[-1].is_a?(::Hash) && args[-1][:instance]
+        raise ModuleCannotBeInstantiatedError if self.class == Module
+        CrossStub.apply(
+          :instance,                      # stubbing for instance
+          self,                           # the class to action on
+          '%s#instance' % self,           # cache key (storing of stubbing info for other process)
+          args.size>1 ? args[0..-2] : [], # stubbing arguments
+          &block                          # any other more complex stubbing arguments
+        )
+      else
+        CrossStub.apply(
+          :class,    # stubbing for class/module
+          self,      # the class to action on
+          "#{self}", # cache key (storing of stubbing info for other process)
+          args,      # stubbing arguments
+          &block     # any other more complex stubbing arguments
+        )
+      end
     end
   end
 
@@ -53,6 +87,11 @@ module CrossStub
 
 end
 
-Object.send(:extend, CrossStub::ClassMethods)
-Object.send(:include, CrossStub::InstanceMethods)
-Module.send(:include, CrossStub::ClassMethods)
+Object.class_eval do
+  extend CrossStub::ClassMethods
+  include CrossStub::InstanceMethods
+end
+
+Module.class_eval do
+  include CrossStub::ClassMethods
+end

data/lib/cross-stub/arguments.rb

@@ -0,0 +1,21 @@
+require 'cross-stub/arguments/hash'
+require 'cross-stub/arguments/array'
+require 'cross-stub/arguments/proc'
+
+module CrossStub
+  module Arguments #:nodoc:
+    class << self
+
+      def parse(args, &block)
+        (
+          case args[0]
+          when ::Hash then Hash.parse(args[0])
+          when ::Symbol then Array.parse(args)
+          else {}
+          end
+        ).merge(block_given? ? Proc.parse(&block) : {})
+      end
+
+    end
+  end
+end