cross-stub 0.2.3 → 0.2.4

data/HISTORY.txt

@@ -1,3 +1,7 @@
+=== 0.2.4 (9th Nov, 2010)
+
+* adds generator for rails-3.* [#liangzan]
+
 === 0.2.3 (Oct 16, 2010)
 
 * adds official support for MRI-1.9.2 [#ngty]

data/README.rdoc

@@ -20,12 +20,17 @@ It's hosted on gemcutter.org.
 
 == Setting Up
 
-=== #1. Rails:
+=== 1. Rails-3.*
+
+  $ rails g cucumber:install
+  $ rails g cross_stub
+
+=== 2. Rails-2.*
 
   $ ./script/generate cucumber
   $ ./script/generate cross_stub
 
-=== #2. Others (back to basics):
+=== 3. Others (back to basics)
 
   # In the test setup method:
   CrossStub.setup :file => <CACHE_FILE>
@@ -44,9 +49,9 @@ For a full list of available cache stores, scroll down to take a look at the
 
 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:
+==== 1.1. Class method:
 
   class Someone
     def self.say
@@ -60,7 +65,7 @@ Cross-stubbing is simple:
   Someone.xstub(:say => 'HELLO')
   Someone.say # yields: 'HELLO'
 
-==== #1.2. Instance method:
+==== 1.2. Instance method:
 
   Someone.xstub(:say, :instance => true)
   Someone.new.say # yields: nil
@@ -68,9 +73,9 @@ Cross-stubbing is simple:
   Someone.xstub({:say => 'HELLO'}, :instance => true)
   Someone.new.say # yields: 'HELLO'
 
-=== #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:
+==== 2.1. Class method:
 
   Someone.xstub do
     def say(something)
@@ -80,7 +85,7 @@ Cross-stubbing is simple:
 
   Someone.say('HELLO') # yields: 'saying "HELLO"'
 
-==== #2.2. Instance method:
+==== 2.2. Instance method:
 
   Someone.xstub(:instance => true) do
     def say(something)
@@ -90,7 +95,7 @@ Cross-stubbing is simple:
 
   Someone.new.say('HELLO') # yields: 'saying "HELLO"'
 
-=== #3. Something more complicated:
+=== 3. Something more complicated:
 
   something = 'hello'
   Someone.xstub do
@@ -117,7 +122,7 @@ we can have:
 Cache stores are needed to allow stubs to be made available for different processes.
 The following describes all cache stores available:
 
-=== #1. File
+=== 1. File
 
   # Setting up (current process)
   CrossStub.setup :file => '<CACHE_FILE>'
@@ -125,7 +130,7 @@ The following describes all cache stores available:
   # Refreshing (other process)
   CrossStub.refresh :file => '<CACHE_FILE>'
 
-=== #2. Memcache (requires memcache-client gem)
+=== 2. Memcache (requires memcache-client gem)
 
   # Setting up (current process)
   CrossStub.setup :memcache => 'localhost:11211/<CACHE_ID>'
@@ -133,7 +138,7 @@ The following describes all cache stores available:
   # Refreshing (other process)
   CrossStub.refresh :memcache => 'localhost:11211/<CACHE_ID>'
 
-=== #3. Redis (requires redis gem)
+=== 3. Redis (requires redis gem)
 
   # Setting up (current process)
   CrossStub.setup :redis => 'localhost:6379/<CACHE_ID>'
@@ -146,24 +151,24 @@ if u need more :]
 
 == Caveats
 
-#1. CrossStub uses ruby's Marshal class to dump & load the stubs, thus it has the
+1. CrossStub uses ruby's Marshal class to dump & load the stubs, thus it has the
 same limitations as Marshal (pls note abt a 1.9.1 specific marshal bug at
 http://redmine.ruby-lang.org/issues/show/3729)
 
-#2. Under the hood, CrossStub uses Sourcify (http://github.com/ngty/sourcify) for
+2. Under the hood, CrossStub uses Sourcify (http://github.com/ngty/sourcify) for
 extracting the methods defined within the proc, u may wish to read Sourcify's
 gotchas to avoid unnecessary headaches.
 
 == TODO(s)
 
-#1. Is there any better serialization strategy instead of the current Marshal load/dump?
+1. Is there any better serialization strategy instead of the current Marshal load/dump?
 
 == Contacts
 
 Written since 2009 by:
 
-#1. NgTzeYang, contact ngty77[at]gmail[dot]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[dot]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/VERSION

@@ -1 +1 @@
-0.2.3
+0.2.4

data/cross-stub.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cross-stub}
-  s.version = "0.2.3"
+  s.version = "0.2.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["NgTzeYang"]
-  s.date = %q{2010-10-16}
+  s.date = %q{2010-11-09}
   s.description = %q{}
   s.email = %q{ngty77@gmail.com}
   s.extra_rdoc_files = [
@@ -26,6 +26,9 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "cross-stub.gemspec",
+     "generators/cross_stub/cross_stub_generator.rb",
+     "generators/cross_stub/templates/config/initializers/cross-stub.rb",
+     "generators/cross_stub/templates/features/support/cross-stub.rb",
      "lib/cross-stub.rb",
      "lib/cross-stub/arguments.rb",
      "lib/cross-stub/arguments/array.rb",
@@ -39,9 +42,9 @@ Gem::Specification.new do |s|
      "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",
+     "lib/generators/cross_stub/cross_stub_generator.rb",
+     "lib/generators/cross_stub/templates/config/initializers/cross-stub.rb",
+     "lib/generators/cross_stub/templates/features/support/cross-stub.rb",
      "spec/.bacon",
      "spec/includes.rb",
      "spec/integration/clearing_instance_stubs_spec.rb",

data/{rails_generators → generators}/cross_stub/cross_stub_generator.rb

@@ -4,14 +4,14 @@ 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.2.0'\n"
+      m.gsub_file 'config/environments/cucumber.rb', /\z/, "config.gem 'cross-stub', :lib => false, :version => '>=0.2.4' unless File.directory?(File.join(Rails.root, 'vendor/plugins/cross-stub'))\n"
     end
   end
 
-protected
+  protected
 
-  def banner
-    "Usage: #{$0} cross_stub"
-  end
+    def banner
+     "Usage: #{$0} cross_stub"
+    end
 
 end

data/lib/generators/cross_stub/cross_stub_generator.rb

@@ -0,0 +1,8 @@
+class CrossStubGenerator < Rails::Generators::Base
+  source_root File.expand_path("../templates", __FILE__)
+
+  def generate
+    copy_file 'config/initializers/cross-stub.rb', 'config/initializers/cross-stub.rb'
+    copy_file 'features/support/cross-stub.rb', 'features/support/cross-stub.rb'
+  end
+end

data/lib/generators/cross_stub/templates/config/initializers/cross-stub.rb

@@ -0,0 +1,13 @@
+if Rails.env.test?
+  ActionDispatch::Callbacks.before do
+    # /////////////////////////////////////////////////////////////////////////////////
+    # NOTE: By default, we use file-based cache store for cross-stub. Alternatively,
+    # u may wanna try out the other cache stores. Adding new cache store support is
+    # super easy, w.r.t actual implementation & testing, just drop me a note at
+    # http://github.com/ngty/cross-stub & i'll do it for u, of course FOC lah !!
+    # /////////////////////////////////////////////////////////////////////////////////
+    #CrossStub.refresh :redis => 'localhost:6379/xstub.cache' # requires *redis* gem
+    #CrossStub.refresh :memcache => 'localhost:11211/xstub.cache' # requires *memcache-client* gem
+    CrossStub.refresh :file => Rails.root.join('tmp', 'crossstub.cache')
+  end
+end

data/lib/generators/cross_stub/templates/features/support/cross-stub.rb

@@ -0,0 +1,17 @@
+require 'cross-stub'
+
+Before do
+  # /////////////////////////////////////////////////////////////////////////////////
+  # NOTE: By default, we use file-based cache store for cross-stub. Alternatively,
+  # u may wanna try out the other cache stores. Adding new cache store support is
+  # super easy, w.r.t actual implementation & testing, just drop me a note at
+  # http://github.com/ngty/cross-stub & i'll do it for u, of course FOC lah !!
+  # /////////////////////////////////////////////////////////////////////////////////
+  #CrossStub.setup :redis => 'localhost:6379/xstub.cache' # requires *redis* gem
+  #CrossStub.setup :memcache => 'localhost:11211/xstub.cache' # requires *memcache-client* gem
+  CrossStub.setup :file => Rails.root.join('tmp', 'xstub.cache')
+end
+
+After do
+  CrossStub.clear
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cross-stub
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 2
-  - 3
-  version: 0.2.3
+  - 4
+  version: 0.2.4
 platform: ruby
 authors: 
 - NgTzeYang
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-16 00:00:00 +08:00
+date: 2010-11-09 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -117,6 +117,9 @@ files:
 - Rakefile
 - VERSION
 - cross-stub.gemspec
+- generators/cross_stub/cross_stub_generator.rb
+- generators/cross_stub/templates/config/initializers/cross-stub.rb
+- generators/cross_stub/templates/features/support/cross-stub.rb
 - lib/cross-stub.rb
 - lib/cross-stub/arguments.rb
 - lib/cross-stub/arguments/array.rb
@@ -130,9 +133,9 @@ files:
 - 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
+- lib/generators/cross_stub/cross_stub_generator.rb
+- lib/generators/cross_stub/templates/config/initializers/cross-stub.rb
+- lib/generators/cross_stub/templates/features/support/cross-stub.rb
 - spec/.bacon
 - spec/includes.rb
 - spec/integration/clearing_instance_stubs_spec.rb