act_as_cached 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 ddl1st
+
+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,68 @@
+# ActAsCached
+
+[![Gem Version](https://badge.fury.io/rb/act_as_cached.png)](http://badge.fury.io/rb/act_as_cached)
+[![Dependency Status](https://gemnasium.com/ddl1st/act_as_cached.png)](https://gemnasium.com/ddl1st/act_as_cached)
+[![Build Status](https://travis-ci.org/ddl1st/act_as_cached.png?branch=master)](https://travis-ci.org/ddl1st/act_as_cached)
+[![Code Climate](https://codeclimate.com/github/ddl1st/act_as_cached.png)](https://codeclimate.com/github/ddl1st/act_as_cached)
+
+
+<tt>ActAsCached</tt> provides a lightweight seconds cached.
+
+----------------------
+
+## Install
+
+    gem "act_as_cached", "0.0.1"
+
+----------------------
+
+### Options:
+
+* <tt>:prefix</tt> - Default is +aac+ .
+* <tt>:cache_store</tt> - Customize cache store.
+* <tt>:expires_time</tt> - Set cache expiration time.
+* <tt>:logger</tt> - Set outout file with log, default is +Rails.logger+ .
+
+----------------------
+
+## Usage
+
+```ruby
+    class Account < ActiveRecord::Base
+      act_as_cached
+      has_many :users
+    end
+
+    Account.find 1  # Account Load (0.5ms)  SELECT `accounts`.* FROM `accounts` WHERE `accounts`.`id` = 1 LIMIT 1
+    Account.find 1  # NO SQL OUTPUT
+
+    Account.find(1).users # Account Load (0.5ms)   SELECT `users`.* FROM `users` INNER JOIN `accounts_users` ON `users`.`id` = `accounts_users`.`user_id` WHERE `accounts_users`.`account_id` = 1
+    Account.find(1).users # NO SQL OUTPUT
+    
+```
+
+----------------------
+
+
+## Noties
+
+* Currently not supported <tt>ActiveRecord::Relation#find</tt> , If you wrote the +default_scope+ in your class, cache won't be enable.
+
+----------------------
+
+## TODO LIST
+
+* Expires cache
+  * Add cache key rules
+
+----------------------
+
+## Contributors
+
+* [ddl1st](https://github.com/ddl1st)
+
+----------------------
+
+## License
+
+MIT License

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActAsCached'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/act_as_cached/active_record/actobserver.rb

@@ -0,0 +1,22 @@
+require 'active_record/observer'
+module ActAsCached
+  module ActiveRecord
+    class Actobserver < ::ActiveRecord::Observer
+      cattr_accessor :observed_classes
+      @@observed_classes = []
+
+      def after_commit(object)
+        expire_cache(object)
+      end
+
+      private
+      def expire_cache(object)
+        object.cache_store.delete_matched(%r(#{match_keys(object)}),namespace: object.cache_prefix)
+      end
+
+      def match_keys(object)
+        ["all","first","last",nil].collect{|x| [object.cache_name,x].compact.join("/")}.join("|") << "$"
+      end
+    end
+  end
+end

data/lib/act_as_cached/active_record/association.rb

@@ -0,0 +1,15 @@
+module ActAsCached
+  module ActiveRecord
+    module Association
+      def self.included(klass)
+        klass.class_eval do
+          delegate :write_cache,:read_cache,:fetch_cache,:enabled_cache?,:cache_mod,to: :owner
+        end
+      end
+
+      def cache_path
+        [cache_mod.name,owner.to_param,reflection.class_name].join('/')
+      end
+    end
+  end
+end

data/lib/act_as_cached/active_record/association_reflection.rb

@@ -0,0 +1,13 @@
+module ActAsCached
+  module ActiveRecord
+    module AssociationReflection
+      def path
+        klass.reflections
+      end
+
+      def reflections_path
+        reflections.map(&:path)
+      end
+    end
+  end
+end

data/lib/act_as_cached/active_record/collection_association.rb

@@ -0,0 +1,18 @@
+module ActAsCached
+  module ActiveRecord
+    module CollectionAssociation
+
+      def self.included(klass)
+        klass.class_eval do
+          alias_method_chain :find_target,:act_as_cache
+        end
+      end
+
+      def find_target_with_act_as_cache
+        enabled_cache? ?
+        fetch_cache(cache_path) { find_target_without_act_as_cache } :
+        find_target_without_act_as_cache
+      end
+    end
+  end
+end

data/lib/act_as_cached/active_record/finder_methods.rb

@@ -0,0 +1,28 @@
+module ActAsCached
+  module ActiveRecord
+    module FinderMethods
+      def self.included(base)
+        base.class_eval do
+          alias_method_chain :find,:act_as_cached
+        end
+      end
+
+      # Only support find with primary_key are currently supported.
+      def find_with_act_as_cached(*args)
+        options = args.extract_options!
+        if args.length == 1 && enabled_cache? && where_values.blank?
+          # TODO
+          path = [cache_mod.name,args[0]].join('/')
+          cache_mod.fetch_cache(path) { find_without_act_as_cached(args[0]) }
+        else
+          args << options
+          find_without_act_as_cached(*args)
+        end
+      end
+
+      def cache_mod
+        klass.cache_mod
+      end
+    end
+  end
+end

data/lib/act_as_cached/active_record/has_many_through_association.rb

@@ -0,0 +1,17 @@
+module ActAsCached
+  module ActiveRecord
+    module HasManyThroughAssociation
+      def self.included(klass)
+        klass.class_eval do
+          alias_method_chain :find_target,:act_as_cache
+        end
+      end
+
+      def find_target_with_act_as_cache
+        enabled_cache? ?
+        fetch_cache(cache_path) { find_target_without_act_as_cache } :
+        find_target_without_act_as_cache
+      end
+    end
+  end
+end

data/lib/act_as_cached/active_record/singular_association.rb

@@ -0,0 +1,17 @@
+module ActAsCached
+  module ActiveRecord
+    module SingularAssociation
+      def self.included(klass)
+        klass.class_eval do
+          alias_method_chain :find_target,:act_as_cache
+        end
+      end
+
+      def find_target_with_act_as_cache
+        enabled_cache? ?
+        fetch_cache(cache_path) { find_target_without_act_as_cache } :
+        find_target_without_act_as_cache
+      end
+    end
+  end
+end

data/lib/act_as_cached/active_record.rb

@@ -0,0 +1,15 @@
+module ActAsCached
+  module ActiveRecord
+    extend ActiveSupport::Autoload
+    autoload :Association
+    autoload :CollectionAssociation
+    autoload :HasManyThroughAssociation
+    autoload :SingularAssociation
+    autoload :FinderMethods
+  end
+end
+ActiveRecord::Associations::CollectionAssociation.send(:include,ActAsCached::ActiveRecord::CollectionAssociation)
+ActiveRecord::Associations::HasManyThroughAssociation.send(:include,ActAsCached::ActiveRecord::HasManyThroughAssociation)
+ActiveRecord::Associations::SingularAssociation.send(:include,ActAsCached::ActiveRecord::SingularAssociation)
+ActiveRecord::Associations::Association.send(:include,ActAsCached::ActiveRecord::Association)
+ActiveRecord::FinderMethods.send(:include,ActAsCached::ActiveRecord::FinderMethods)

data/lib/act_as_cached/cache_options.rb

@@ -0,0 +1,33 @@
+module ActAsCached
+  module CacheOptions
+    def self.included(klass)
+      klass.send(:extend,ClassMethods)
+    end
+
+    module ClassMethods
+      def options
+        @options ||= cache_options.extract_options!
+      end
+
+      def name
+        @name ||= klass.name
+      end
+
+      def prefix
+        options[:prefix] || ActAsCached.prefix
+      end
+
+      def store
+        options[:cache_store] || ActAsCached.cache_store
+      end
+
+      def logger
+        options[:logger] || ActAsCached.logger
+      end
+
+      def time
+        options[:expires_time] || ActAsCached.expires_time
+      end
+    end
+  end
+end

data/lib/act_as_cached/configurable.rb

@@ -0,0 +1,15 @@
+module ActAsCached
+  module Configurable
+    mattr_accessor :logger,:expires_time,:cache_store,:prefix
+
+    def configure(&block)
+      yield config
+    end
+
+    def config
+      self
+    end
+
+    module_function :config
+  end
+end

data/lib/act_as_cached/helpers.rb

@@ -0,0 +1,20 @@
+module ActAsCached
+  module Helpers
+    def write_cache(name)
+      store.write(name,yield,expires_in: time,namespace: prefix)
+      read_cache(name)
+    end
+
+    def read_cache(name)
+      store.read(name,namespace: prefix)
+    end
+
+    def fetch_cache(name,&block)
+      read_cache(name) || write_cache(name) { yield }
+    end
+
+    def enabled_cache?
+      true
+    end
+  end
+end

data/lib/act_as_cached/mixin.rb

@@ -0,0 +1,78 @@
+module ActAsCached
+  module Mixin
+    def self.included(klass)
+      klass.send(:extend,ClassMethods)
+    end
+
+    module ClassMethods
+      # Enable cache, in the current class.
+      #
+      # === Example
+      #
+      # class Blog < ActiveRecord::Base
+      #   act_as_cached expires_time: 1.day
+      #   has_many :comments
+      #   belongs_to :user
+      # end
+      # Topic.find(1)
+      #   Topic Load (0.5ms)  SELECT `topics`.* FROM `topics` WHERE `topics`.`id` = 1 LIMIT 1
+      # => #<Topic id: 1 title: 'foo'>
+      # Topic.find(1)
+      # => #<Topic id: 1 title: 'foo'>
+      # Topic.find(1).comments
+      #   Comment Load (1.1ms)  SELECT `comments`.* FROM `comments` WHERE `comments`.`topic_id` = 1
+      # => [#<Comment id: 1, content: 'xxxx'>,#<Comment id: 2, content: "ooooooo">]
+      # Topic.find(1).comments
+      # => [#<Comment id: 1, content: 'xxxx'>,#<Comment id: 2, content: "ooooooo">]
+      # Topic.find(1).save
+      # Topic.find(1)
+      #   Topic Load (0.5ms)  SELECT `topics`.* FROM `topics` WHERE `topics`.`id` = 1 LIMIT 1
+      # => #<Topic id: 1 title: 'foo'>
+      # Topic.find(1)
+      # => #<Topic id: 1 title: 'foo'>
+      #
+      # === Options
+      # [:prefix]
+      #   Namespace with act_as_cached, default is <tt>aac</tt>
+      # [:cache_store]
+      #   Storage engine with act_as_cached
+      # [:logger]
+      #   Logger with act_as_cached
+      # [:expires_time]
+      #   Set cache expires time with activerecord associations and <tt>ActiveRecord::Query#find</tt> of current class.
+      def act_as_cached(*args)
+        observer.send(:add_observer!,klass = self)
+        @cache_mod = Module.new do
+          mattr_accessor :cache_options,:klass
+          self.cache_options = args
+          self.klass         = klass
+          extend ActAsCached::Helpers
+        end
+        @cache_mod.send(:include,ActAsCached::CacheOptions)
+
+        delegate :options,:name,:prefix,:store,:logger,:time, to: :cache_mod , prefix: "cache"
+        delegate :write_cache,:read_cache,:fetch_cache,to: :cache_mod
+      end
+
+      def cache_mod
+        @cache_mod
+      end
+
+      def enabled_cache?
+        !cache_mod.nil?
+      end
+
+      def observer
+        ActAsCached::ActiveRecord::Actobserver.instance
+      end
+    end
+
+    def cache_mod
+      self.class.cache_mod
+    end
+
+    def enabled_cache?
+      self.class.enabled_cache?
+    end
+  end
+end

data/lib/act_as_cached/rails.rb

@@ -0,0 +1,28 @@
+module ActAsCached
+  def self.hook_config!
+    ActAsCached.configure do
+      config.logger       ||= ::Rails.logger
+      config.cache_store  ||= ::Rails.cache
+      config.expires_time ||= 1.week
+      config.prefix       ||= 'aac'
+    end
+  end
+  
+  def self.hook_rails!
+    if defined?(::ActiveRecord)
+      require 'act_as_cached/active_record'
+      ::ActiveRecord::Base.send(:include,Mixin)
+    end
+  end
+
+  class Rails < ::Rails::Engine
+    config.active_record.observers = "act_as_cached/active_record/actobserver"
+    config.act_as_cache = ActAsCached
+    
+    config.after_initialize do
+      ActAsCached.hook_config!
+      ActAsCached.hook_rails!
+    end
+    
+  end if defined?(::Rails)
+end

data/lib/act_as_cached/version.rb

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

data/lib/act_as_cached.rb

@@ -0,0 +1,15 @@
+require 'act_as_cached/configurable'
+module ActAsCached
+  extend Configurable
+
+  extend ActiveSupport::Autoload
+  autoload :CacheOptions
+  autoload :Mixin
+  autoload :Helpers
+  autoload :ActiveRecord
+
+  module ActiveRecord
+    autoload :Actobserver
+  end
+end
+require 'act_as_cached/rails' if defined?(::Rails::Engine)

data/lib/tasks/act_as_cached_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :act_as_cached do
+#   # Task goes here
+# end

data/test/act_as_cached_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class ActAsCachedTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, ActAsCached
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+require "rails/test_help"
+
+Rails.backtrace_cleaner.remove_silencers!
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+# Load fixtures from the engine
+if ActiveSupport::TestCase.method_defined?(:fixture_path=)
+  ActiveSupport::TestCase.fixture_path = File.expand_path("../fixtures", __FILE__)
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: act_as_cached
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- ddl1st
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Friendly cache with ActiveRecord.
+email:
+- looooooooooooooooooooooooooops@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/act_as_cached/active_record/actobserver.rb
+- lib/act_as_cached/active_record/association.rb
+- lib/act_as_cached/active_record/association_reflection.rb
+- lib/act_as_cached/active_record/collection_association.rb
+- lib/act_as_cached/active_record/finder_methods.rb
+- lib/act_as_cached/active_record/has_many_through_association.rb
+- lib/act_as_cached/active_record/singular_association.rb
+- lib/act_as_cached/active_record.rb
+- lib/act_as_cached/cache_options.rb
+- lib/act_as_cached/configurable.rb
+- lib/act_as_cached/helpers.rb
+- lib/act_as_cached/mixin.rb
+- lib/act_as_cached/rails.rb
+- lib/act_as_cached/version.rb
+- lib/act_as_cached.rb
+- lib/tasks/act_as_cached_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+- test/act_as_cached_test.rb
+- test/test_helper.rb
+homepage: https://github.com/ddl1st/act_as_cached
+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'
+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: Friendly cache with ActiveRecord.
+test_files:
+- test/act_as_cached_test.rb
+- test/test_helper.rb
+has_rdoc: