method_cachable 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MGIyMmYxNmQyOGI0ZGUxYWNhNDA5YzYyY2M1YzUxN2NmMTZhOTI5Zg==
+  data.tar.gz: !binary |-
+    ZjQ0OTFlYmU4ZTQwMDZlMjE0NWEyYTdmZmIxNjBlZDdhZmZlMTA4NA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NjdkNWI2MjEwN2YzOTAwMjRhZjM1NWJmMDJjOTdjNWRlYjFhYmMyZTg3MzI3
+    Mzg5OTdhMmI3ZTM5ZWYwZGY2MDU4YmY4NGY5ZWYwMzM1YmYwMzIwYzUwZDc1
+    ODJhZWMyODNmMGFjMDFiZDhlNDFlNGQyOTA1NmI4MDdmOTU5YzM=
+  data.tar.gz: !binary |-
+    MDMxYjNjNWEyMWE4Mzc0YmI1ZGYyNmNkYmNhYjc3Y2I1MmYwNzUwOTM0Zjc0
+    NzA3ZGU5N2IxMzIyOWExYWIwZjJhZmQ1NzNjNjMyNTgwYTkyMmU5NWJjODlm
+    ZmI3NjY5NWE5Zjc4NjBjMGZjZjNiYjY0NjRhNDQyMjk2OTg3YWI=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in method_cachable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 sergio1990
+
+MIT License
+
+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,80 @@
+# MethodCachable
+
+Provides setting specific methods list that must be cached and clearing cache on CRUD operations.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'method_cachable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install method_cachable
+
+## Usage
+
+### Basic configuration
+
+```ruby
+class Post < ActiveRecord::Base
+	include MethodCachable
+
+	belongs_to :menu_item
+
+	# Add this line for callbacks working
+	acts_as_cachable
+
+	# You want to cache association calling...
+	def menu_item_title
+		self.menu_item.title
+	end
+
+	# ...or maybe some evaluations
+	def some_evaluations
+		# There must be your code
+	end
+
+	# Specify list of cachable methods.
+	cached_methods :menu_item_title, :some_evaluations
+end
+```
+
+**_PLEASE NOTE_**: after save/touch/destroy cache will expire automatically.
+
+### Cache storage
+
+For storing cached methods gem using *Rails.cache*. Therefore you must set in rails application config file *cache_store* option. I highly recommend using the couple of *memcached*+*dalli* because they work very quickly. For this, you must add gem dalli to your Gemfile:
+
+```ruby
+gem 'dalli'
+```
+
+And then configurate it in *production.rb*:
+
+```ruby
+YourApp::Application.configure do
+	config.cache_store = :dalli_store, { namespace: :world_try, expires_in: 2.hours, compress: true }
+	# Rest of configuration
+end
+```
+
+**_PLEASE NOTE_**: you don't need to configurate cache_store in development mode because for convenient development caching is off and method is called directly.
+
+## Future developing
+
+Now you may to cache only instance methods but caching class methods gem doesn't allow. In future, I will implement this functionality.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/method_cachable/helper.rb

@@ -0,0 +1,32 @@
+module MethodCachable
+  module Helper
+
+    def createsig(body)
+      Digest::MD5.hexdigest( sigflat body )
+    end
+
+    def sigflat(body)
+      res = nil
+      if body.class == Hash
+        arr = []
+        body.each do |key, value|
+          arr << "#{sigflat key}=>#{sigflat value}"
+        end
+        res = arr
+      end
+      if body.class == Array
+        str = ''
+        res = body.map do |value|
+          sigflat value
+        end.sort!.each do |value|
+          str << value
+        end
+      end
+      if body.class != String
+        res = body.to_s << body.class.to_s
+      end
+      res || body
+    end
+
+  end
+end

data/lib/method_cachable/version.rb

@@ -0,0 +1,3 @@
+module MethodCachable
+  VERSION = "0.0.1"
+end

data/lib/method_cachable.rb

@@ -0,0 +1,71 @@
+require "method_cachable/version"
+require "method_cachable/helper"
+
+module MethodCachable
+
+	include MethodCachable::Helper
+
+  extend ActiveSupport::Concern
+
+  included do
+    def clear_cache
+      flush_cache cache_list_key
+      flush_cache "cache_list_key:#{self.class.name}"
+      flush_cache "cache_list_key:#{self.class.superclass.name}"
+    end
+
+    def cache_list_key
+      "cache_list_key:#{self.class.name}:#{self.id}"
+    end
+  end
+
+  module ClassMethods
+
+    def acts_as_cachable
+      klass = self
+      [:after_touch, :before_destroy, :after_save].each { |callback| klass.send(callback, :clear_cache) }
+    end
+
+    def cached_methods(*methods)
+      name = self.name
+      eval_string = ""
+      methods.each do |method|
+        method = method.to_s
+        eval_string += "
+          alias_method :old_#{method}, :#{method}
+
+          def #{method}(*args)
+            sig = createsig(args || self.id)
+            with_env \"#{name}:#{method}:\#{self.id}:\#{sig}\", cache_list_key do
+              old_#{method}(*args)
+            end
+          end
+        "
+      end
+      class_eval(eval_string)
+    end
+
+  end
+
+  def with_env(key, saving_key = nil, &block)
+    if Rails.env.production?
+    	unless saving_key.nil?
+    		lst = Rails.cache.fetch saving_key do; [] end
+    		lst << key unless lst.include?(saving_key)
+    		Rails.cache.write saving_key, lst, expires_in: 24.hours
+    	end
+      Rails.cache.fetch key, expires_in: 2.hours, &block
+    else
+      yield
+    end
+  end
+
+  def flush_cache(saving_key)
+  	lst = Rails.cache.fetch saving_key do; [] end
+  	lst.each {|key| flush_key(key) }
+  end
+
+  def flush_key(key)
+    Rails.cache.delete key
+  end
+end

data/method_cachable.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'method_cachable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "method_cachable"
+  spec.version       = MethodCachable::VERSION
+  spec.authors       = ["Sergey Gernyak"]
+  spec.email         = ["sergeg1990@gmail.com"]
+  spec.description   = %q{Intelligent method caching}
+  spec.summary       = %q{Provides setting specific methods list that must be cached and clearing cache on CRUD operations}
+  spec.homepage      = "http://github.com/sergio1990/method_cachable"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activerecord'
+  spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: method_cachable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sergey Gernyak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  name: activerecord
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  name: activesupport
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Intelligent method caching
+email:
+- sergeg1990@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/method_cachable.rb
+- lib/method_cachable/helper.rb
+- lib/method_cachable/version.rb
+- method_cachable.gemspec
+homepage: http://github.com/sergio1990/method_cachable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Provides setting specific methods list that must be cached and clearing cache
+  on CRUD operations
+test_files: []