method_caching 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec"
+  gem "rdoc"
+  gem "bundler"
+  gem "jeweler", "~> 1.8.7"
+end

data/Gemfile.lock

@@ -0,0 +1,63 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    builder (3.2.2)
+    diff-lcs (1.2.4)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.20)
+    httpauth (0.2.0)
+    jeweler (1.8.8)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    multi_json (1.8.2)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.1.0)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.6)
+    rspec-expectations (2.14.3)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  jeweler (~> 1.8.7)
+  rdoc
+  rspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 HuyHa
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# method_caching
+
+method_caching is a simple Ruby library for caching instance method of a class (using Rails.cache as cache store)
+
+## Installation
+
+```bash
+  gem install method_caching
+```
+
+or add to Gemfile
+
+```bash
+  gem "method_caching"
+```
+
+## Usage
+
+```ruby
+class User < ActiveRecord::Base
+  method_caching
+
+  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
+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
+
+```ruby
+class User < ActiveRecord::Base
+  method_caching :custom_identifier
+end
+```
+
+## Contributing to method_caching
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2013 Huy Ha. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "method_caching"
+  gem.homepage = "http://github.com/huyha85/method_caching"
+  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.authors = ["HuyHa"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "method_caching #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/method_caching.rb

@@ -0,0 +1,48 @@
+module MethodCaching
+  module ClassMethods
+    def method_caching(identifier_attr = :id)
+      @identifier = identifier_attr.to_sym
+      self.send(:include, InstanceMethods)
+    end
+
+    def cache_method(method)
+      old = "_#{method}".to_sym
+      alias_method old, method
+      define_method method do |*args|
+        Rails.cache.fetch(cache_key_name(method)) do
+          send(old, *args)
+        end
+      end
+    end
+
+    def cache_method_clear_on(clear_method, cache_method)
+      original_method = "_cache_method_clear_on_#{clear_method}"
+      alias_method original_method, clear_method
+
+      define_method clear_method do |*args, &blk|
+        self.clear_cache_on cache_method
+        send(original_method, *args, &blk)
+      end
+    end
+
+    def identifier
+      @identifier
+    end
+  end
+
+  module InstanceMethods
+    def clear_cache_on(method)
+      Rails.cache.delete(cache_key_name(method))
+    end
+
+    def cache_key_name(method)
+      identifier_method = self.class.send(:identifier)
+      "#{self.class.to_s}_#{self.send(identifier_method)}_#{method.to_s}"
+    end
+  end
+end
+
+if defined?(ActiveRecord)
+  ActiveRecord::Base.send(:include, MethodCaching::InstanceMethods)
+  ActiveRecord::Base.send(:extend, MethodCaching::ClassMethods)
+end

data/spec/method_caching_spec.rb

@@ -0,0 +1,82 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class TestClass
+  extend MethodCaching::ClassMethods
+  include MethodCaching::InstanceMethods
+  method_caching :identifier
+
+  def method_to_be_cleared; end
+
+  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
+
+  def identifier
+    "id"
+  end
+
+  def calculate(x)
+    x
+  end
+end
+
+class Rails
+  def self.cache
+    RailsCache.new
+  end
+end
+
+class RailsCache
+  @@cache_hash = {}
+  def fetch(key, &block)
+    if @@cache_hash[key]
+      @@cache_hash[key]
+    else
+      @@cache_hash[key] = *block.call
+      @@cache_hash[key]
+    end
+  end
+
+  def delete(key)
+    @@cache_hash[key] = nil
+  end
+
+  def clear
+    @@cache_hash = {}
+  end
+end
+
+describe "MethodCaching" do
+  let(:test_class) { TestClass.new }
+  before do
+    Rails.cache.clear
+  end
+  describe "#cache_method" do
+    context "call cached method for multiple times" do
+      it "should actually call the method once" do
+        test_class.should_receive(:calculate).once
+        2.times { test_class.method_to_be_cached }
+      end
+    end
+  end
+
+  describe "#clear_cache_on" do
+    it "should clear cache for method on object" do
+      test_class.should_receive(:calculate).twice
+      test_class.method_to_be_cached
+      test_class.clear_cache_on :method_to_be_cached
+      test_class.method_to_be_cached
+    end
+  end
+
+  describe "#cache_method_clear_on" do
+    it "should clear cache when calling clear_method" do
+      test_class.should_receive(:calculate).twice
+      test_class.method_to_be_cached
+      test_class.method_to_be_cleared
+      test_class.method_to_be_cached
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'method_caching'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: method_caching
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- HuyHa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rdoc
+  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: bundler
+  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: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+  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
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/method_caching.rb
+- spec/method_caching_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/huyha85/method_caching
+licenses:
+- MIT
+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
+signing_key: 
+specification_version: 3
+summary: Simple Ruby library for caching instance method of a class
+test_files: []