acts_as_method_cacheable 0.1.0 → 0.1.2

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - "1.8.7"
+  - "1.9.3"
+script: bundle exec rspec spec

data/Gemfile

@@ -1,5 +1,5 @@
-#source 'https://rubygems.org'
-source 'http://ruby.taobao.org'
+source 'https://rubygems.org'
+#source 'http://ruby.taobao.org'
 
 # Specify your gem's dependencies in acts_as_method_cacheable.gemspec
 gemspec

data/README.md

@@ -1,46 +1,64 @@
 ## acts_as_method_cacheable
 
-Instead of writing def expensive { @cached_expensive ||= original_expensive }, now you can write instance.cache_method(:expensive) instead. Also support nested cache method for associations.
-*This gem depend on ActiveSupport/ActiveRecord*
+[![Gem Version](https://badge.fury.io/rb/acts_as_method_cacheable.png)](http://badge.fury.io/rb/acts_as_method_cacheable)
+[![Build Status](https://travis-ci.org/bencao/acts_as_method_cacheable.png)](https://travis-ci.org/bencao/acts_as_method_cacheable)
+[![Code Climate](https://codeclimate.com/repos/520482e556b10239110072c6/badges/5d7096d9ed502ba874ac/gpa.png)](https://codeclimate.com/repos/520482e556b10239110072c6/feed)
 
-## Currernt Limitation
-*ONLY support method with no params*
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'acts_as_method_cacheable'
-
-And then execute:
+Instead of writing
+```ruby
+class Post < ActiveRecord::Base
+  def expensive_method
+    @cached_expensive ||= _expensive_method
+  end
 
-    $ bundle
+  def _expensive_method
+    sleep 10
+    # blablabla
+  end
+end
+```
+now you can write
+```ruby
+class Post < ActiveRecord::Base
+  def expensive_method
+    sleep 10
+    # blablabla
+  end
 
-Or install it yourself as:
+  acts_as_method_cacheable :methods => [:expensive_method]
+end
+```
+or cache method for an instance of Post only
+```ruby
+post = Post.find xxx
+post.cache_method(:expensive_method)
+# post has_many comments
+post.cache_method(:comments => :comment_expensive_method)
+```
 
-    $ gem install acts_as_method_cacheable
+*This gem depends on ActiveSupport/ActiveRecord*
 
 ## Usage
 
 ### cache method in class level, all instances will have the method cached
-*NOTE!! MUST put acts_as_method_cacheable in the last of the class file*
+**NOTE!! MUST put acts_as_method_cacheable in the last of the class file**
 ```ruby
 class Post < ActiveRecord::Base
   def expensive_method
     # balababa
   end
-  acts_as_method_cacheable :methods => :expensive_method
+  acts_as_method_cacheable :methods => [:expensive_method]
 end
 ```
 
-### cache methods for a instance only
+### cache methods for an instance only
 ```ruby
 post = Post.find(xxx)
 post.cache_method(:expensive_method)
 post.cache_method([:expensive_method1, :expensive_method2])
 ```
 
-### cache methods for a instance and its associations
+### cache methods for an instance and its associations
 ```ruby
 post = Post.find(xxx)
 post.cache_method([:expensive_method3, :comments => :comment_expensive_method])
@@ -65,3 +83,44 @@ post.expensive_method  # cheap!
 post.reset_cache(:expensive_method)
 post.expensive_method  # expensive
 ```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'acts_as_method_cacheable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install acts_as_method_cacheable
+
+## Current Limitation
+**ONLY support method with no params**
+
+## Contribute
+
+You're highly welcome to improve this gem.
+
+### Checkout source code to local
+say you git clone the source code to /tmp/acts_as_method_cacheable
+
+### Install dev bundle
+```bash
+$ cd /tmp/acts_as_method_cacheable
+$ bundle install
+```
+
+### Do some changes
+```bash
+$ vi lib/acts_as_method_cacheable.rb
+```
+
+### Run test
+```bash
+$ bundle exec rspec spec
+```
+

data/lib/acts_as_method_cacheable.rb

@@ -5,21 +5,12 @@ module ActsAsMethodCacheable
 
   included do
     def self.acts_as_method_cacheable(opts = {})
-      unless class_variable_defined?(:@@cached_methods)
-        cattr_accessor :cached_methods
-        self.cached_methods = []
-
-        attr_accessor :instance_cache_methods
-
-        define_method "reload_with_cacheable" do |*params|
-          cached_methods.each { |method| reset_cache(method) }
-          self.instance_cache_methods && self.instance_cache_methods.each { |method| reset_cache(method) }
-          reload_without_cacheable(params)
-        end
-
-        alias_method_chain :reload, :cacheable
-
+      unless class_variable_defined?(:@@class_level_cached_methods)
         include Internal
+        cattr_accessor :class_level_cached_methods
+        self.class_level_cached_methods = []
+        attr_accessor :instance_level_cached_methods
+        extend_reload_with_cacheable_support
       end
       [opts[:methods]].compact.flatten.each do |method|
         cache_method(method)
@@ -31,89 +22,71 @@ module ActsAsMethodCacheable
     extend ActiveSupport::Concern
 
     module ClassMethods
-      # cache_method :expensive_method
-      #
       # currently don't support method with params, it's complex to serialize params as a key
       # no param method covers most of our use cases
       private
       def cache_method(method)
-        raise "#{method} not defined in class #{self.to_s}" unless method_defined?(method)
-        raise "method with params is not supported by acts_as_method_cacheable yet!" unless self.new.method(method.to_sym).arity === 0
-
-        return if self.cached_methods.include?(method)
-
-        self.cached_methods.push(method)
-
+        return unless self.new.before_cache_method(method, true)
         define_method "#{method}_with_cacheable" do
-          unless cache_var_defined?(method)
-            cache_var_set(method, send("#{method}_without_cacheable".to_sym))
-          end
+          cache_var_set(method, send("#{method}_without_cacheable".to_sym)) unless cache_var_defined?(method)
           cache_var_get(method)
         end
         alias_method_chain method, :cacheable
       end
 
+      def extend_reload_with_cacheable_support
+        define_method "reload_with_cacheable" do |*params|
+          class_level_cached_methods.each { |method| reset_cache(method) }
+          self.instance_level_cached_methods && self.instance_level_cached_methods.each { |method| reset_cache(method) }
+          reload_without_cacheable(params)
+        end
+        alias_method_chain :reload, :cacheable
+      end
     end
 
     def reset_cache(method)
       remove_instance_variable(cache_var_name(method)) if cache_var_defined?(method)
     end
 
-    # instance version cache_method
-    # cache_method(:expensive_method)
-    # cache_method([:expensive_method, :expensive_method2])
-    # cache_method([:expensive_method, :expensive_method2])
-    # cache_method([:expensive_method, :sub_associations => :expensive_method2])
-    def cache_method(args)
-      normalized_args = args.is_a?(Array) ? args : [args]
-
-      self_items = normalized_args.select{ |item| item.is_a?(Symbol) }
-      self_items.each { |self_item| _cache_method(self_item) }
-
-      children_items = normalized_args.select{ |item| item.is_a?(Hash) }
-      children_items.each do |child_item|
-        child, child_args = child_item.keys.first, child_item.values.first
-        child_instances = send(child)
-        child_instances = [child_instances] unless child_instances.respond_to?(:each)
-        child_instances.each do |instance|
-          instance.cache_method(child_args)
-        end
+    def cache_method(params)
+      normalize_cachable_params(params) do |self_methods, association_methods|
+        self_methods.each { |method| _cache_method(method) }
+        association_methods.each{ |pair| cache_association_method(*pair.shift) }
       end
       self
     end
 
-    private
-
-    def cache_var_name(method)
-      "@cached_var_for_method_#{method}".to_sym
+    def before_cache_method(method, class_level=false)
+      raise "#{method} not defined in class #{self.class.to_s}" unless self.class.method_defined?(method)
+      raise "method with params is not supported by acts_as_method_cacheable yet!" unless method(method.to_sym).arity === 0
+      self.instance_level_cached_methods ||= []
+      return false if class_level_cached_methods.include?(method)
+      return false if self.instance_level_cached_methods.include?(method)
+      (class_level ? class_level_cached_methods : self.instance_level_cached_methods).push(method)
+      true
     end
 
-    def cache_var_set(method, value)
-      instance_variable_set(cache_var_name(method), value)
-    end
+    private
 
-    def cache_var_get(method)
-      instance_variable_get(cache_var_name(method))
+    def normalize_cachable_params(params, &block)
+      normalized_params = params.is_a?(Array) ? params : [params]
+      self_methods = normalized_params.select{ |item| item.is_a?(Symbol) }
+      association_methods = normalized_params.select{ |item| item.is_a?(Hash) }
+      yield self_methods, association_methods
     end
 
-    def cache_var_defined?(method)
-      instance_variable_defined?(cache_var_name(method))
+    def cache_association_method(association, association_params)
+      instances = send(association)
+      (instances.respond_to?(:each) ? instances : [instances]).each do |instance|
+        instance.cache_method(association_params)
+      end
     end
 
     # method which only accept a symbol as parameter
     def _cache_method(method)
-      raise "#{method} not defined in class #{self.class.to_s}" unless self.class.method_defined?(method)
-      raise "method with params is not supported by acts_as_method_cacheable yet!" unless method(method.to_sym).arity === 0
+      return unless before_cache_method(method)
 
-      return if cached_methods.include?(method)
-
-      self.instance_cache_methods ||= []
-
-      return if self.instance_cache_methods.include?(method)
-
-      self.instance_cache_methods.push(method)
-
-      self.instance_eval <<-CACHEEND, __FILE__, __LINE__ + 1
+      instance_eval <<-CACHEEND, __FILE__, __LINE__ + 1
         class << self
           def #{method}
             unless cache_var_defined?(:#{method})
@@ -124,8 +97,23 @@ module ActsAsMethodCacheable
         end
       CACHEEND
     end
-  end
 
+    def cache_var_name(method)
+      "@cached_var_for_method_#{method}".to_sym
+    end
+
+    def cache_var_set(method, value)
+      instance_variable_set(cache_var_name(method), value)
+    end
+
+    def cache_var_get(method)
+      instance_variable_get(cache_var_name(method))
+    end
+
+    def cache_var_defined?(method)
+      instance_variable_defined?(cache_var_name(method))
+    end
+  end
 end
 
 ActiveRecord::Base.send(:include, ActsAsMethodCacheable)

data/lib/acts_as_method_cacheable/version.rb

@@ -1,3 +1,3 @@
 module ActsAsMethodCacheable
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/spec/acts_as_method_cacheable_spec.rb

@@ -14,10 +14,9 @@ class Schema < ActiveRecord::Migration
       t.references :post
     end
   end
+
 end
-schema = Schema.new
-schema.down
-schema.up
+Schema.new.change
 
 require 'acts_as_method_cacheable'
 
@@ -194,6 +193,24 @@ describe ActsAsMethodCacheable do
       post.comment_signatures
     end
 
+    it "should clear cached after reset cache" do
+      post = Post.find(@post.id)
+      post.cache_method([:comment_dates, {:comments => :signature}])
+
+      comment1, comment2 = post.comments.to_a
+
+      comment1.expects(:date).once
+      post.comment_dates
+
+      comment1.expects(:date).never
+      post.comment_dates
+
+      post.reset_cache(:comment_dates)
+
+      comment1.expects(:date).once
+      post.comment_dates
+    end
+
     it "should raise exception when trying to cache a non-existing method" do
       expect {
         post = Post.find(@post.id)

data/spec/spec_helper.rb

@@ -3,7 +3,10 @@ require 'active_record'
 require 'sqlite3'
 require 'pry'
 
-ActiveRecord::Base.configurations = YAML::load(IO.read('db/database.yml'))
+db_config = YAML::load(IO.read('db/database.yml'))
+db_file = db_config['development']['database']
+File.delete(db_file) if File.exists?(db_file)
+ActiveRecord::Base.configurations = db_config
 ActiveRecord::Base.establish_connection('development')
 
 RSpec.configure do |config|

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_method_cacheable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
+  prerelease: 
 platform: ruby
 authors:
 - Ben Cao
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-09 00:00:00.000000000 Z
+date: 2013-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -20,6 +22,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -27,6 +30,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -34,6 +38,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -41,6 +46,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -48,6 +54,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -55,6 +62,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,6 +70,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -69,6 +78,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -76,6 +86,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -83,48 +94,55 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-theme
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-nav
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -132,6 +150,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -139,6 +158,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -146,6 +166,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -158,6 +179,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -171,26 +193,27 @@ files:
 homepage: https://github.com/bencao/acts_as_method_cacheable
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0.rc.2
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Instead of writing def expensive { @cached_expensive ||= original_expensive
   }, now you can write instance.cache_method(:expensive) instead. Also support nested
   cache method for associations.

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: f01e9ffdf60462d98a0e9d5455058695747e9868
-  data.tar.gz: 0aeeb3f23e738298155f413a5db56f35f6a027d6
-SHA512:
-  metadata.gz: 450aa54f8f59e259f089ae21b5284efde4190ad6113df9f2f6f6a4514e4eba18c0df5f0e41631c181ea32924c00672303694772c2d429a87985d7ff93e69fcfc
-  data.tar.gz: dd58518b62a70508fe5512b1281112533e467df3abba958d553143dd2769862fcfdcad20775ad086e5b0a1c09dcd6c59d32cab2871136dc353488d8343f8af45