method_cacheable 0.0.4 → 0.1.0

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0
+
+- Fix #3 properly use args if tmp_args not passed

data/Gemfile

@@ -1,12 +1,13 @@
 source 'http://rubygems.org'
- gem 'activesupport'
- gem 'keytar'
+
+gem 'activesupport', '>=3.0.0'
+gem 'keytar',        '>=1.5.3'
 
 group :development, :test do
   gem 'yard'
   gem 'rdiscount'
   gem 'rake', '~>0.8.7'
-  gem 'jeweler', '~>1.5.2'
+  gem 'jeweler', '>=1.5.2'
   gem "autotest-standalone"
   gem "autotest-growl"
 end

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.1.0

data/lib/method_cacheable.rb

@@ -89,6 +89,11 @@ module MethodCacheable
   class MethodCache
     attr_accessor :caller, :method, :args, :options, :cache_operation
 
+    def args=(args)
+      args  = [args] unless args.is_a? Array
+      @args = args
+    end
+
     def initialize(caller, *method_cache_args)
       self.caller          = caller
       self.cache_operation = method_cache_args.map {|x| x if x.is_a? Symbol }.compact.first||:fetch
@@ -143,8 +148,8 @@ module MethodCacheable
     #   cache.method = "foo"              # => "foo"
     #   cache.key                         # => "users:foo:263619"
     def key(tmp_method = nil, *tmp_args)
-      tmp_method  ||= method
-      tmp_args    ||= args
+      tmp_method  = method if tmp_method.blank?
+      tmp_args    = args   if tmp_args.blank?
       key_method = "#{tmp_method}_key".to_sym
       key = caller.send key_method, *tmp_args if caller.respond_to? key_method
       key ||= caller.build_key(:name => tmp_method, :args => tmp_args)

data/method_cacheable.gemspec

@@ -5,17 +5,18 @@
 
 Gem::Specification.new do |s|
   s.name = "method_cacheable"
-  s.version = "0.0.4"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Schneems"]
-  s.date = "2011-12-29"
+  s.date = "2012-12-17"
   s.description = "\n    Cache methods quickly and easily\n  "
   s.email = "richard.schneeman@gmail.com"
   s.files = [
     ".yardoc/checksums",
     ".yardoc/objects/root.dat",
     ".yardoc/proxy_types",
+    "CHANGELOG.md",
     "Gemfile",
     "Rakefile",
     "VERSION",
@@ -39,8 +40,6 @@ Gem::Specification.new do |s|
     "lib/method_cacheable.rb",
     "license.txt",
     "method_cacheable.gemspec",
-    "pkg/johnny_cache-0.0.1.gem",
-    "pkg/method_cacheable-0.0.1.gem",
     "readme.md",
     "spec/method_cacheable/method_cache_spec.rb",
     "spec/method_cacheable_spec.rb",
@@ -49,45 +48,40 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/Schnems/method_cacheable"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.10"
+  s.rubygems_version = "1.8.24"
   s.summary = "Cache methods quickly and easily."
-  s.test_files = [
-    "spec/method_cacheable/method_cache_spec.rb",
-    "spec/method_cacheable_spec.rb",
-    "spec/spec_helper.rb"
-  ]
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
-      s.add_runtime_dependency(%q<keytar>, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 3.0.0"])
+      s.add_runtime_dependency(%q<keytar>, [">= 1.5.3"])
       s.add_development_dependency(%q<yard>, [">= 0"])
       s.add_development_dependency(%q<rdiscount>, [">= 0"])
       s.add_development_dependency(%q<rake>, ["~> 0.8.7"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.5.2"])
       s.add_development_dependency(%q<autotest-standalone>, [">= 0"])
       s.add_development_dependency(%q<autotest-growl>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 0"])
     else
-      s.add_dependency(%q<activesupport>, [">= 0"])
-      s.add_dependency(%q<keytar>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 3.0.0"])
+      s.add_dependency(%q<keytar>, [">= 1.5.3"])
       s.add_dependency(%q<yard>, [">= 0"])
       s.add_dependency(%q<rdiscount>, [">= 0"])
       s.add_dependency(%q<rake>, ["~> 0.8.7"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<jeweler>, [">= 1.5.2"])
       s.add_dependency(%q<autotest-standalone>, [">= 0"])
       s.add_dependency(%q<autotest-growl>, [">= 0"])
       s.add_dependency(%q<rspec>, [">= 0"])
     end
   else
-    s.add_dependency(%q<activesupport>, [">= 0"])
-    s.add_dependency(%q<keytar>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 3.0.0"])
+    s.add_dependency(%q<keytar>, [">= 1.5.3"])
     s.add_dependency(%q<yard>, [">= 0"])
     s.add_dependency(%q<rdiscount>, [">= 0"])
     s.add_dependency(%q<rake>, ["~> 0.8.7"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<jeweler>, [">= 1.5.2"])
     s.add_dependency(%q<autotest-standalone>, [">= 0"])
     s.add_dependency(%q<autotest-growl>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 0"])

data/readme.md

@@ -1,14 +1,20 @@
-The Cache in Black
-==================
-Cache method calls and speed up your Ruby on Rails application with MethodCacheable.
-
 Method Cacheable
 ============
 
+Cache method calls and speed up your Ruby on Rails application with MethodCacheable. It's kindof like [ cache_method](https://github.com/seamusabshere/cache_method?utm_source=rubyweekly&utm_medium=email) but it's more explicit about what's being cached and how.
+
+
+## Simplicity Rules
+
+This is a very very small library wrapped around `Rails.cache` api. It's goal is to be easy to use, and flexible (can be used without Rails). Currently method_cacheable weights in at about 200 lines with documentation (not counting tests and readme)
+
+
 In your Model include `MethodCacheable`
 
 app/models/user.rb
-``` ruby
+
+```ruby
+
   class User < ActiveRecord::Base
     include MethodCacheable
 
@@ -19,6 +25,7 @@ app/models/user.rb
       return val
     end
   end
+
 ```
 
 Then use the `#cache` method to fetch results from cache when available
@@ -26,14 +33,6 @@ Then use the `#cache` method to fetch results from cache when available
 ```
   user = User.last
 
-  # Call User#expensive_method normally
-  user.expensive_method(22)
-  # => 22
-
-  # Fetch User#expensive_method from cache
-  user.cache.expensive_method(22)
-  # => 22
-
   # Call User#expensive_method normally
   Benchmark.measure { user.expensive_method(22) }.real
   # => 120.00037693977356
@@ -41,8 +40,6 @@ Then use the `#cache` method to fetch results from cache when available
   # Fetch User#expensive_method from cache
   Benchmark.measure { user.cache.expensive_method(22) }.real
   # => 0.000840902328491211
-
-  # SOOOOOOOO FAST!!
 ```
 
 
@@ -52,9 +49,28 @@ in your Gemfile
 
     gem 'method_cacheable'
 
-In an initializer tell MethodCacheable to use the Rails.cache backend. You can use any object here that responds to `#write`, `#read`, and `#fetch`
+
+You will also want to have a library for caching objects. Such as `dalli` for using memcache
+
+    gem 'dalli'
+
+Then run
+
+    bundle install
+
+
+## Set up Memcache
+
+In your `app/config/application.rb` set your Rails cache store to use `dalli`
+
+```ruby
+  config.cache_store = :dalli_store
+```
+
+In an initializer tell MethodCacheable to use the Rails.cache backend. You can use any object here that responds to `#write`, `#read`, and `#fetch`.
 
 initializers/method_cacheable.rb
+
 ```ruby
   MethodCacheable.config do |config|
     config.store = Rails.cache
@@ -65,18 +81,12 @@ then in your models
 
     include MethodCacheable
 
+Now you're good to go, just use the `cache` method in that class and you can write, read and fetch any method from cache.
+
 
 Usage
 ========
 
-Explicitly write & read methods.
-
-``` ruby
-  user.cache(:read).pictures  # => nil
-  user.cache(:write).pictures # => [<# Picture ...>, <# Picture ...>] # refreshes the cache
-  user.cache(:read).pictures  # => [<# Picture ...>, <# Picture ...>]
-```
-
 By default the `cache` method will will `:fetch` from the cache store. This means that if the key exists it will be pulled, if not the method will be called, returned, and the key will be set.
 
 ``` ruby
@@ -85,12 +95,22 @@ By default the `cache` method will will `:fetch` from the cache store. This mean
   user.cache.expensive_method("w00t")        # => "w00t" # pulls from the cache
 ```
 
-You can also call `:fetch` explicitly if you prefer (but why, thats more typing)
+You can also call `:fetch` explicitly if you prefer
 
 ``` ruby
   user.cache(:fetch).expensive_method("w00t")  # => "w00t" # pulls from the cache
 ```
 
+
+Explicitly write & read methods.
+
+``` ruby
+  user.cache(:read).pictures  # => nil
+  user.cache(:write).pictures # => [<# Picture ...>, <# Picture ...>] # refreshes the cache
+  user.cache(:read).pictures  # => [<# Picture ...>, <# Picture ...>]
+```
+
+
 Different method arguments to the method generate different cache objects. I.E. different input => different output, same input => same output
 
 ``` ruby
@@ -100,6 +120,17 @@ Different method arguments to the method generate different cache objects. I.E.
   # => "j/k lol"
 ```
 
+## Delete An Entry
+
+You can delete any cached method using `cache.delete` and passing in the name of the method and any arguements, for example:
+
+```ruby
+user.cache.expensive_method("w00t")           # => "w00t"
+
+user.cache.delete(:expensive_method, "w00t")  # => nil
+```
+
+
 Configuration
 =============
 
@@ -112,6 +143,14 @@ Any configuration options passed to the cache method will be passed to the cache
   user.cache(:read).pictures                            # => nil
 ```
 
+## Generate Keys
+
+You don't need to generate keys, we do that for you using a library called [keytar](http://github.com/schneems/keytar). If you want to see a key you can call key and pass in the name of the method and any arguments into it.
+
+
+```ruby
+  User.find(9).cache.key(:foo) # => "users:foo:9"
+```
 
 Contribution
 ============
@@ -123,6 +162,3 @@ licensed under MIT License
 Copyright (c) 2011 Schneems. See LICENSE.txt for
 further details.
 
-
-
-

data/spec/method_cacheable/method_cache_spec.rb

@@ -20,10 +20,25 @@ describe MethodCacheable::MethodCache do
 
   end
 
+  describe 'args' do
+    it 'converts non array args to array' do
+      cache = user.cache
+      cache.args = 1
+      cache.args.should == [1]
+    end
+  end
+
   describe 'key' do
     it 'returns the key' do
       user.cache.key(:foo).should == "users:foo:#{user.id}"
     end
+
+    it 'returns the key after specifying args and method' do
+      cache = user.cache
+      cache.method = "foo#{@uniq}"
+      cache.args   = [1]
+      cache.key.should == "users:foo#{@uniq}:#{user.id}:1"
+    end
   end
 
   describe 'exists?' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: method_cacheable
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,33 +9,43 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-29 00:00:00.000000000Z
+date: 2012-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70212263196980 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70212263196980
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: keytar
-  requirement: &70212263195260 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.3
   type: :runtime
   prerelease: false
-  version_requirements: *70212263195260
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.3
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70212263175320 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70212263175320
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rdiscount
-  requirement: &70212263173780 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +69,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70212263173780
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70212263171900 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,21 +85,31 @@ dependencies:
         version: 0.8.7
   type: :development
   prerelease: false
-  version_requirements: *70212263171900
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70212263170520 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.5.2
   type: :development
   prerelease: false
-  version_requirements: *70212263170520
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.2
 - !ruby/object:Gem::Dependency
   name: autotest-standalone
-  requirement: &70212263169000 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +117,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70212263169000
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: autotest-growl
-  requirement: &70212263166500 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +133,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70212263166500
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70212263164700 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,7 +149,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70212263164700
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ! "\n    Cache methods quickly and easily\n  "
 email: richard.schneeman@gmail.com
 executables: []
@@ -119,6 +164,7 @@ files:
 - .yardoc/checksums
 - .yardoc/objects/root.dat
 - .yardoc/proxy_types
+- CHANGELOG.md
 - Gemfile
 - Rakefile
 - VERSION
@@ -142,8 +188,6 @@ files:
 - lib/method_cacheable.rb
 - license.txt
 - method_cacheable.gemspec
-- pkg/johnny_cache-0.0.1.gem
-- pkg/method_cacheable-0.0.1.gem
 - readme.md
 - spec/method_cacheable/method_cache_spec.rb
 - spec/method_cacheable_spec.rb
@@ -163,7 +207,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 588910908911295363
+      hash: 1837387735007022591
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -172,11 +216,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Cache methods quickly and easily.
-test_files:
-- spec/method_cacheable/method_cache_spec.rb
-- spec/method_cacheable_spec.rb
-- spec/spec_helper.rb
+test_files: []