method_caching 0.0.1 → 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OWJkNTFiYjI4OWVlNWMyOWU0NTdkOWRiNTUzOGNiYWM0MjllYzJhMw==
+  data.tar.gz: !binary |-
+    NDFiZWYyNDljODM0YzA5YmI5YTU0YzVmNjY0NTlhNWRkZjdhY2JiMQ==
+SHA512:
+  metadata.gz: !binary |-
+    NmE5ZjI5ZTZmZjRkYTUwZTIwZTFkMWYxOTQ5YjkwOGZmNTEzZjFhZjY5M2I0
+    MmI5MTJjOGU2MzY5M2M3ZTUxM2M0OGJhOTZjZTZkYmVhYzc2ZjgwNjM2ODAy
+    Mzk3ZWQxNzNiYzI3MDQ0NjEyZDk3ZDkwNDZhYTdlZjI0ZDJjMTk=
+  data.tar.gz: !binary |-
+    ODRiM2I5MmZjODczODg1NjE2NDQzY2RlM2Y0MDNmMTNiNzUwZDAwNGM1YTk0
+    ZDMzZjc4ZTRkMjhmZGQwN2U5NTlmYjg1YmNkYTFmOTNjOTgwYjA5ZjdlMjIy
+    YmJiZTZkZmMyNGE1MzA1Zjg4NmNkMTE2NDYxZDE0OTQyOTM3NjI=

data/Gemfile.lock

@@ -61,3 +61,6 @@ DEPENDENCIES
   jeweler (~> 1.8.7)
   rdoc
   rspec
+
+BUNDLED WITH
+   1.10.4

data/README.md

@@ -16,6 +16,8 @@ or add to Gemfile
 
 ## Usage
 
+### With ActiveRecord
+
 ```ruby
 class User < ActiveRecord::Base
   method_caching
@@ -23,12 +25,27 @@ class User < ActiveRecord::Base
   def full_name
     "#{first_name} #{last_name}"
   end
-  cache_method :full_name
-  cache_method_clear_on :save, :full_name # Clear cache for method full_name whenever method 'save' is called
+  cache_method :full_name, clear_on: :save # Clear cache for method full_name whenever method 'save' is called
+end
+```
+
+### Without ActiveRecord (Mongoid, etc)
+
+```ruby
+class User
+  include MethodCaching::Generic
+  method_caching
+
+  def full_name
+    "#{first_name} #{last_name}"
+  end
+  cache_method :full_name, clear_on: :save # Clear cache for method full_name whenever method 'save' is called
 end
 ```
 
-method_caching will use the record's id as the default identifier to generate the cache key. You can change the default identifier by passing custom identifier
+### Custom Identifier
+
+By default, method_caching will use the record's id as the default identifier to generate the cache key. You can change the default identifier by passing custom identifier
 
 ```ruby
 class User < ActiveRecord::Base

data/Rakefile

@@ -19,7 +19,7 @@ Jeweler::Tasks.new do |gem|
   gem.license = "MIT"
   gem.summary = %Q{Simple Ruby library for caching instance method of a class}
   gem.description = %Q{Simple Ruby library for caching instance method of a class. Using Rails.cache as default caching.}
-  gem.email = "huy.ha@eastagile.com"
+  gem.email = "hhuy424@gmail.com"
   gem.authors = ["HuyHa"]
   # dependencies defined in Gemfile
 end

data/VERSION

@@ -1 +1 @@
-0.0.1
+1.0.0

data/lib/method_caching.rb

@@ -5,7 +5,7 @@ module MethodCaching
       self.send(:include, InstanceMethods)
     end
 
-    def cache_method(method)
+    def cache_method(method, options = {})
       old = "_#{method}".to_sym
       alias_method old, method
       define_method method do |*args|
@@ -13,6 +13,11 @@ module MethodCaching
           send(old, *args)
         end
       end
+
+      clear_methods = [options[:clear_on]].flatten.compact
+      clear_methods.each do |clear_method|
+        cache_method_clear_on(clear_method, method)
+      end
     end
 
     def cache_method_clear_on(clear_method, cache_method)
@@ -40,6 +45,14 @@ module MethodCaching
       "#{self.class.to_s}_#{self.send(identifier_method)}_#{method.to_s}"
     end
   end
+
+  module Generic
+    include ::MethodCaching::InstanceMethods
+
+    def self.included(klass)
+      klass.send(:extend, ::MethodCaching::ClassMethods)
+    end
+  end
 end
 
 if defined?(ActiveRecord)

data/method_caching.gemspec

@@ -0,0 +1,61 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: method_caching 1.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "method_caching"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["HuyHa"]
+  s.date = "2015-06-19"
+  s.description = "Simple Ruby library for caching instance method of a class. Using Rails.cache as default caching."
+  s.email = "hhuy424@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/method_caching.rb",
+    "method_caching.gemspec",
+    "spec/method_caching_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/huyha85/method_caching"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.6"
+  s.summary = "Simple Ruby library for caching instance method of a class"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.7"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
+  end
+end
+

data/spec/method_caching_spec.rb

@@ -1,8 +1,7 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 class TestClass
-  extend MethodCaching::ClassMethods
-  include MethodCaching::InstanceMethods
+  include MethodCaching::Generic
   method_caching :identifier
 
   def method_to_be_cleared; end
@@ -10,8 +9,7 @@ class TestClass
   def method_to_be_cached
     calculate(2)
   end
-  cache_method :method_to_be_cached
-  cache_method_clear_on :method_to_be_cleared, :method_to_be_cached
+  cache_method :method_to_be_cached, clear_on: :method_to_be_cleared
 
   def identifier
     "id"

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: method_caching
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - HuyHa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-30 00:00:00.000000000 Z
+date: 2015-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -70,14 +62,13 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.8.7
 description: Simple Ruby library for caching instance method of a class. Using Rails.cache
   as default caching.
-email: huy.ha@eastagile.com
+email: hhuy424@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -93,34 +84,31 @@ files:
 - Rakefile
 - VERSION
 - lib/method_caching.rb
+- method_caching.gemspec
 - spec/method_caching_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/huyha85/method_caching
 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'
-      segments:
-      - 0
-      hash: 3994657104755449766
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.4.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Simple Ruby library for caching instance method of a class
 test_files: []