method_cacher 0.0.2 → 0.0.3

data/.travis.yml

@@ -0,0 +1,2 @@
+rvm:
+  - 1.9.2

data/CHANGELOG.md

@@ -6,3 +6,8 @@
 
 + Added more details to the gemspec.
 
+## v0.0.3
+
++ Added documentation to README.md.
++ Fixed some specs.
+

data/README.md

@@ -1,4 +1,4 @@
-# Method Cacher
+# Method Cacher [![Build Status](https://secure.travis-ci.org/yaronw/method_cacher.png)](http://travis-ci.org/yaronw/method_cacher)
 
 Wraps specified methods with a mechanism that caches the return values.
 
@@ -13,7 +13,8 @@ __Features:__
 
 ## Installation
 
-Add the `method_cacher` gem your Gemfile and run the `bundle` command to install it.
+Run the command `gem install method_cacher`, or if used in a Rails project,
+add the `method_cacher` gem your Gemfile and run the `bundle` command to install it.
 
 ```ruby
 gem 'method_cacher'
@@ -23,11 +24,31 @@ __Requires Ruby 1.9.2 or later.__
 
 ## Configuration
 
-...
+Before utilized, method_cacher needs to be configured with a cache store for its use.
+The cache store needs to be compatible with ActiveSupport::Cache.
+
+Two styles of configuration are possible:
+
+```ruby
+MethodCacher.configure do |c|
+    c.caching_strategy = the_cache_store # Example: ActiveSupport::Cache.lookup_store(:memory_store)
+end
+```
+
+and
+
+```ruby
+MethodCacher.configure do
+    config.caching_strategy = the_cache_store # Example: ActiveSupport::Cache.lookup_store(:memory_store)
+end
+```
+
+If used with Rails and no cache store is specified, method_cacher automatically uses the cache store configured with rails
+through a call to `Rails.cache`.
 
 ## Usage
 
-Include the method cacher module in the class whose methods you wish to cache.
+Include the `MethodCacher::Base` module in the class whose methods you wish to cache.
 
 ```ruby
 include MethodCacher::Base
@@ -47,13 +68,13 @@ __Options:__
 
 + :singleton - Singleton methods to be cached are specified in an array of symbols passed through this option.
 + :obj\_key - A _proc_ that accepts the cached object as a single parameter.  This _proc_ should return a value identifying this object.
-    If this option is not specified, the object key defaults to the value returned by a method named _id_, which is convenient for usage
+    If this option is not specified, the object key defaults to the value returned by an instance method named _id_, which is convenient for usage
     with ActiveRecord objects.
 
 `cache_method` can take any number of instance or singleton methods at once.
 
 Subsequent calls to `cache_method` are possible in order to specify additional methods to be cached.
-Specifying :obj\_id multiple times results in the last one being used for the class.
+Specifying `:obj_id` multiple times results in the last one being used for the class.
 
 `cache_method` can be called _before_ or _after_ the specified methods are defined.
 

data/lib/method_cacher/version.rb

@@ -1,3 +1,3 @@
 module MethodCacher
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/method_cacher.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = MethodCacher::VERSION
 
+  gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'supermodel'
   gem.add_development_dependency 'activesupport'

data/spec/method_cacher/base_spec.rb

@@ -72,7 +72,6 @@ describe MethodCacher::Base do
 
       it "should cache protected INSTANCE methods" do
         obj = EighthClass.new
-        debugger
         lambda { obj.send(:foo1) }.should be_twice_the_same
       end
 

data/spec/method_cacher/base_test_helper.rb

@@ -260,5 +260,5 @@ class EighthClass
     Dummy.function
   end
 
-  #caches_method :foo2, :foo4
+  caches_method :foo2, :foo4
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: method_cacher
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-22 00:00:00.000000000Z
+date: 2011-12-23 00:00:00.000000000Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2152739300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152739300
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2168539020 !ruby/object:Gem::Requirement
+  requirement: &2152738880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168539020
+  version_requirements: *2152738880
 - !ruby/object:Gem::Dependency
   name: supermodel
-  requirement: &2168538600 !ruby/object:Gem::Requirement
+  requirement: &2152738460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168538600
+  version_requirements: *2152738460
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2168538180 !ruby/object:Gem::Requirement
+  requirement: &2152738040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168538180
+  version_requirements: *2152738040
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &2168537760 !ruby/object:Gem::Requirement
+  requirement: &2152737620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168537760
+  version_requirements: *2152737620
 description: Easily cache instance and singleton (i.e. class) methods of ActiveRecord
   or any object.
 email:
@@ -66,6 +77,7 @@ files:
 - .gitignore
 - .rspec
 - .rvmrc
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock