cross-stub 0.1.1 → 0.1.2

data/.gitignore

@@ -19,3 +19,4 @@ rdoc
 pkg
 
 ## PROJECT::SPECIFIC
+tmp

data/README.rdoc

@@ -14,11 +14,23 @@ It's hosted on gemcutter.org.
 
 == Setting Up
 
-If you are using rails, you are in luck:
+#1. If you are using rails, you are in luck:
 
   $ ./script/generate cucumber
   $ ./script/generate cross_stub
 
+#2. Even if you are using something else, no worries:
+
+  # In the test setup method:
+  CrossStub.setup :file => <CACHE_FILE_PATH>
+
+  # 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>
+
 == Using It
 
 Using cross-stub is simple:
@@ -70,16 +82,20 @@ The above fails as a result of undefined variable/method 'something', to workaro
 
 == Caveats
 
-1. Cross-stub uses ruby's Marshal class to dump & load the stubs, thus it has the same limitations as Marshal
+#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
+
+== TODO(s)
 
-2. Cross-stub only supports stubbing of class methods, since it makes no sense to do cross process stubbing of instances
+#1. We can possibly use Hijack (http://github.com/ileitch/hijack) within the current test process to trigger refreshing of stubs in the other process, thus using cross-stub no longer requires changing of any existing application code to insert CrossStub.refresh(...). This has in fact been our original intended strategy, however, we have not been able to do so as Hijack currently hangs on starting up on our development machines.
 
 == Contacts
 
 Written 2009 by:
 
-1. NgTzeYang, contact ngty77[at]gmail.com or http://github.com/ngty
+#1. NgTzeYang, contact ngty77[at]gmail.com or http://github.com/ngty
 
-2. WongLiangZan, contact liangzan[at]gmail.com or http://github.com/liangzan
+#2. WongLiangZan, contact liangzan[at]gmail.com or http://github.com/liangzan
 
 Released under the MIT license

data/Rakefile

@@ -10,7 +10,8 @@ begin
     gem.email = "ngty77@gmail.com"
     gem.homepage = "http://github.com/ngty/cross-stub"
     gem.authors = ["NgTzeYang"]
-    gem.add_development_dependency "bacon", ">= 0"
+    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 is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
@@ -41,6 +42,31 @@ end
 
 task :spec => :check_dependencies
 
+begin
+  require 'reek/adapters/rake_task'
+  Reek::RakeTask.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
+
+begin
+  require 'roodi'
+  require 'roodi_task'
+  RoodiTask.new do |t|
+    t.verbose = false
+  end
+rescue LoadError
+  task :roodi do
+    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
+  end
+end
+
 task :default => :spec
 
 require 'rake/rdoctask'

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/cross-stub.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cross-stub}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["NgTzeYang"]
-  s.date = %q{2009-12-07}
+  s.date = %q{2009-12-16}
   s.description = %q{}
   s.email = %q{ngty77@gmail.com}
   s.extra_rdoc_files = [
@@ -37,7 +37,8 @@ Gem::Specification.new do |s|
      "spec/cross-stub/creating_stubs_spec.rb",
      "spec/cross-stub/stubbing_error_spec.rb",
      "spec/helpers.rb",
-     "spec/spec_helper.rb"
+     "spec/spec_helper.rb",
+     "tmp/.dummy"
   ]
   s.homepage = %q{http://github.com/ngty/cross-stub}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -46,6 +47,7 @@ Gem::Specification.new do |s|
   s.summary = %q{Simple cross process stubbing}
   s.test_files = [
     "spec/spec_helper.rb",
+     "spec/cross-stub/getting_along_with_mocha_spec.rb",
      "spec/cross-stub/clearing_stubs_spec.rb",
      "spec/cross-stub/stubbing_error_spec.rb",
      "spec/cross-stub/creating_stubs_spec.rb",
@@ -57,16 +59,19 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<bacon>, [">= 0"])
+      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"])
     else
-      s.add_dependency(%q<bacon>, [">= 0"])
+      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"])
     end
   else
-    s.add_dependency(%q<bacon>, [">= 0"])
+    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"])
   end

data/lib/cross-stub/pseudo_class.rb

@@ -23,11 +23,27 @@ module CrossStub
     end
 
     def replace_method(method, value_or_code)
-      old_method_code = method_code(method)
-      new_method_code = "#{value_or_code}" =~ /^def / ?  value_or_code :
-        %\def #{method}; Marshal.load(%|#{Marshal.dump(value_or_code)}|) ; end\
-      @klass.instance_eval(new_method_code)
-      old_method_code
+      status = backup_method(method)
+      @klass.instance_eval \
+        "#{value_or_code}" =~ /^def / ? value_or_code :
+          %\def #{method}; Marshal.load(%|#{Marshal.dump(value_or_code)}|) ; end\
+      status
+    end
+
+    def revert_method(method)
+      new_name = before_stubbing_method_name(method)
+      @metaclass.instance_eval("alias_method :#{method}, :#{new_name}") rescue nil
+      remove_method(new_name)
+    end
+
+    def backup_method(method)
+      if @klass.respond_to?(method)
+        !@klass.respond_to?(new_name = before_stubbing_method_name(method)) &&
+          @metaclass.instance_eval("alias_method :#{new_name}, :#{method}")
+        true
+      else
+        false
+      end
     end
 
     def remove_method(method)
@@ -37,11 +53,15 @@ module CrossStub
     def replace_methods(&blk)
       (tmp = BlankObject.new).__instance_eval__(&blk)
       methods_in_block = tmp.__methods__ - BlankObject.new.__methods__
-      original_method_codes = methods_in_block.inject({}) do |memo, method|
-        memo.merge(method => method_code(method))
+      is_method_implemented_flags = methods_in_block.inject({}) do |memo, method|
+        memo.merge(method => backup_method(method))
       end
       @klass.instance_eval(&blk)
-      original_method_codes
+      is_method_implemented_flags
+    end
+
+    def before_stubbing_method_name(method)
+      :"__#{method}_before_xstubbing"
     end
 
   end

data/lib/cross-stub/stub_helpers.rb

@@ -36,7 +36,7 @@ module CrossStub
       cache.each do |klass, hash|
         pk = PseudoClass.new(klass)
         hash.each do |method, codes|
-          codes[:before] ? pk.replace_method(method, codes[:before]) : pk.remove_method(method)
+          codes[:before] ? pk.revert_method(method) : pk.remove_method(method)
         end
       end
     end
@@ -44,8 +44,8 @@ module CrossStub
     def create_stub_from_hash(pk, cache, hash)
       hash.inject(cache) do |cache, args|
         method, value = args
-        original_method_code = pk.replace_method(method, value)
-        cache[method] ||= {:before => original_method_code}
+        is_method_implemented = pk.replace_method(method, value)
+        cache[method] ||= {:before => is_method_implemented}
         cache[method][:after] = pk.method_code(method)
         cache
       end
@@ -53,8 +53,8 @@ module CrossStub
 
     def create_stub_from_block(pk, cache, &blk)
       pk.replace_methods(&blk).inject(cache) do |cache, args|
-        method, original_method_code = args
-        cache[method] ||= {:before => original_method_code}
+        method, is_method_implemented = args
+        cache[method] ||= {:before => is_method_implemented}
         cache[method][:after] = pk.method_code(method)
         cache
       end

data/rails_generators/cross_stub/cross_stub_generator.rb

@@ -4,7 +4,7 @@ class CrossStubGenerator < Rails::Generator::Base
     record do |m|
       m.file 'config/initializers/cross-stub.rb', 'config/initializers/cross-stub.rb'
       m.file 'features/support/cross-stub.rb', 'features/support/cross-stub.rb'
-      m.gsub_file 'config/environments/cucumber.rb', /\z/, "config.gem 'cross-stub', :version => '>=0.1.0'\n"
+      m.gsub_file 'config/environments/cucumber.rb', /\z/, "config.gem 'cross-stub', :version => '>=0.1.2'\n"
     end
   end
 

data/spec/cross-stub/clearing_stubs_spec.rb

@@ -93,6 +93,14 @@ describe 'Clearing Stubs' do
       should.raise(NoMethodError) { @get_value['AnyClass.say_hello'] }
     end
 
+    it "should clear for method not implemented in ruby and return original value for #{mode} process" do
+      Time.xstub(:now => 'abc')
+      CrossStub.clear
+      value = nil
+      should.not.raise(NoMethodError) { value = @get_value['Time.now'] }
+      value.should.not.equal 'abc'
+    end
+
   end
 
 end

data/spec/cross-stub/creating_stubs_spec.rb

@@ -72,6 +72,12 @@ describe 'Creating Stubs' do
       @get_value['AnyClass.do_action.i.say'].should.equal 'i say hello'
     end
 
+    it "should create for method not implemented in ruby for #{mode} process" do
+      now = Time.now - 365*60*60*24
+      Time.xstub(:now => now)
+      @get_value['Time.now'].should.equal now
+    end
+
 #    it "should create with block that takes argument(s) for #{mode} process" do
 #      # a, b = 1, 2
 #      # AnyClass.xstub do |a, b|

data/spec/cross-stub/getting_along_with_mocha_spec.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe 'Getting Along with MOCHA' do
+
+  behaves_like 'has standard setup'
+
+  %w{current other}.each do |mode|
+
+    behaves_like "has #{mode} process setup"
+
+    it "should work for :stubbing_instance_methods_on_real_objects in #{mode} process" do
+      AnyClass.xstub(:something => stub(:to_s => 'hello')) do
+        def say_hello ; %\i say #{something}\ ; end
+      end
+      @get_value['AnyClass.say_hello'].should.equal 'i say hello'
+    end
+
+#    it "should work for :traditional_mocking in #{mode} process" do
+#    end
+#
+#    it "should work for :shortcuts in #{mode} process" do
+#    end
+
+  end
+
+end
+

data/spec/helpers.rb

@@ -1,7 +1,9 @@
 require 'rubygems'
 require 'eventmachine'
 
-$cache_file = '/tmp/crossstub.cache'
+$cache_file = File.join(File.dirname(__FILE__), '..', 'tmp', 'stubbing.cache')
+$log_file = File.join(File.dirname(__FILE__), '..', 'tmp', 'echoserver.log')
+$sleep_time = 1.5  # may need to increase this depending on ur machine's prowess
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'cross-stub'
@@ -28,9 +30,9 @@ module EchoClient
       address, port = EchoServer::ADDRESS, EchoServer::PORT
       EventMachine::run do
         (EventMachine::connect(address, port, EM)).
-          execute(klass_and_method) {|data| self.result = data }
+          execute(klass_and_method) {|data| self.result = Marshal.load(data) }
       end
-      (self.result == '<NIL>') ? nil : self.result
+      self.result
     end
 
   end
@@ -63,7 +65,7 @@ module EchoServer
     def start(other_process=false)
       unless other_process
         @process = IO.popen("ruby #{__FILE__}")
-        sleep 1
+        sleep $sleep_time
       else
         EventMachine::run { EventMachine::start_server(ADDRESS, PORT, EM) }
       end
@@ -79,18 +81,34 @@ module EchoServer
 
     module EM
       def receive_data(klass_and_method)
+        log "(1) EchoServer::EM#receive_data ... receives: #{klass_and_method}"
         CrossStub.refresh(:file => $cache_file)
+        log "(2) EchoServer::EM#receive_data ... completes stubs refresh"
         klass, method, *args = klass_and_method.split('.')
-        value =
-          if args.empty?
-            Object.const_get(klass).send(method) rescue $!
-          else
-            Object.const_get(klass).send(method, *args) rescue $!
-          end
-        send_data(value.nil? ? '<NIL>' : value)
+        log "(3) EchoServer::EM#receive_data ... parses arguments to:",
+            "    * klass  ... #{klass}",
+            "    * method ... #{method}",
+            "    * args   ... #{args.inspect}"
+        value = args.empty? ? Object.const_get(klass).send(method) :
+          Object.const_get(klass).send(method, *args) rescue $!.message
+        log "(4) EchoServer::EM#receive_data ... returns: #{value.inspect}"
+        send_data(Marshal.dump(value))
+        log "(5) EchoServer::EM#receive_data ... end"
+      end
+
+      def log(*msg)
+        $logger << [msg, ""].flatten.join("\n")
       end
     end
 
 end
 
-EchoServer.start(true) if ($0 == __FILE__)
+if $0 == __FILE__
+  begin
+    require 'logger'
+    $logger = Logger.new($log_file)
+    EchoServer.start(true)
+  ensure
+    $logger.close
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'bacon'
+require 'mocha'
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'helpers'
@@ -27,14 +28,14 @@ end
 
 shared 'has other process setup' do
   before do
-    EchoServer.start
+    EchoServer.start unless ENV['ECHO_SERVER'] == 'false'
     @get_value = lambda do |klass_and_method_and_args|
       (value = EchoClient.get(klass_and_method_and_args)) !~ /^undefined method/ ? value :
         Object.we_just_wanna_trigger_a_no_method_error_with_this_very_long_and_weird_method!
     end
   end
   after do
-    EchoServer.stop
+    EchoServer.stop unless ENV['ECHO_SERVER'] == 'false'
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cross-stub
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - NgTzeYang
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-07 00:00:00 +08:00
+date: 2009-12-16 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,17 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 0.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
     version: 
 - !ruby/object:Gem::Dependency 
   name: ParseTree
@@ -73,6 +83,7 @@ files:
 - spec/cross-stub/stubbing_error_spec.rb
 - spec/helpers.rb
 - spec/spec_helper.rb
+- tmp/.dummy
 has_rdoc: true
 homepage: http://github.com/ngty/cross-stub
 licenses: []
@@ -103,6 +114,7 @@ specification_version: 3
 summary: Simple cross process stubbing
 test_files: 
 - spec/spec_helper.rb
+- spec/cross-stub/getting_along_with_mocha_spec.rb
 - spec/cross-stub/clearing_stubs_spec.rb
 - spec/cross-stub/stubbing_error_spec.rb
 - spec/cross-stub/creating_stubs_spec.rb