taggable_cache 0.3.0 → 0.4.0

data/.gitignore

@@ -15,3 +15,5 @@ pkg
 /spec/internal/log
 /spec/internal/db/*.sqlite
 /tmp
+
+/Gemfile.lock

data/.travis.yml

@@ -1,4 +1,4 @@
-lang: ruby
+language: ruby
 bundler_args: --without development
 before_install: 
   - gem install bundler --pre

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+= Taggable cache 0.4.0
+
+- Rewriten rails integration
+- Added README
+- Fix warnings
+- Redis configuration variables can be set by environment variables

data/README.rdoc

@@ -1,10 +1,42 @@
 = Taggable cache
 
-This gem simplifies cache expiration in rails.
+This gem simplifies cache expiration in rails by adding depends_on helper, which expires cache element when depending object is changed/deleted.
 
 = How to use
 
-See example in spec/internal.
+Controller(action caching):
+
+  caches_action :index
+
+  def index
+    Page.load_lot_of_data
+
+    #this depends on any Page object change - creation, deletion, change
+    depends_on Page
+  end
+
+View(fragment caching):
+
+  <%# Page.active can be AR scope, every Page object on change is checked if it is in this scope, and if is - expires cache element %>
+  <% cache 'cache_entry', :depends_on => [Page.active] do %>
+    <% Page.load_lot_of_data %>
+  <% end %>
+
+Usage with Rails.cache:
+
+  page = Page.first
+  #this cache key expires only if this Page object is changed/deleted
+  Rails.cache.write('key', 'value', :depends_on => [page])
+
+Usage with cells gem:
+
+  class TabsCell < Cell::Rails
+    cache :index, nil, :depends_on => [Category, Metacategory, Product]
+
+    def index
+      render
+    end
+  end
 
 == Build Status {<img src="https://secure.travis-ci.org/brain-geek/taggable-cache.png"/>}[http://travis-ci.org/brain-geek/taggable-cache]
 

data/lib/taggable_cache.rb

@@ -1,3 +1,5 @@
+require 'rails'
+
 module TaggableCache
 end
 

data/lib/taggable_cache/extensions.rb

@@ -0,0 +1,92 @@
+module TaggableCache
+  module CacheStoreExtension
+    extend ActiveSupport::Concern
+    def self.included(base)
+      base.class_eval do
+        def taggable
+          @taggable ||= ::TaggableCache::Store.new
+        end
+
+        alias_method :original_write, :write
+
+        def write(name, value, options = nil)
+          if !options.nil? && options.has_key?(:depends_on) 
+            add_tags(name, *options[:depends_on])
+          end
+
+          original_write(name, value, options)
+        end
+
+        def add_tags(key, *params)
+          taggable.add(key, *params)
+        end
+
+        def delete_by_tags(*params)
+          taggable.get(*params).each do |m|
+            self.delete(m)
+          end
+
+          taggable.get_scope(*(params.delete_if{|a| not a.is_a? ActiveRecord::Base})).each do |m|
+            self.delete(m)
+          end
+        end
+      end
+    end
+  end
+
+  module ActionControllerExtension
+    extend ActiveSupport::Concern
+    def self.included(base)
+      base.class_eval do
+        def depends_on(*keys)
+          _process_action_callbacks.find_all{|x| 
+              (x.kind == :around) && 
+              (x.raw_filter.is_a? ActionController::Caching::Actions::ActionCacheFilter) }.each do |callback|
+            cache_path = callback.raw_filter.instance_variable_get('@cache_path')
+
+            path_options = if cache_path.respond_to?(:call)
+              instance_exec(self, &cache_path)
+            else
+              cache_path
+            end
+
+            path_options = ::ActionController::Caching::Actions::ActionCachePath.new(self, path_options || {}).path
+
+            Rails.cache.add_tags(fragment_cache_key(path_options), *keys)
+          end
+        end        
+      end
+    end
+  end  
+
+  module ActiveRecordExtension
+    extend ActiveSupport::Concern
+    included do
+      # Future subclasses will pick up the model extension
+      class << self
+        def inherited_with_taggable(kls)
+          inherited_without_taggable kls
+          kls.send(:include, TaggableCache::ActiveRecordModelExtension) if kls.superclass == ActiveRecord::Base
+        end
+        alias_method_chain :inherited, :taggable
+      end
+
+      # Existing subclasses pick up the model extension as well
+      self.descendants.each do |kls|
+        kls.send(:include, TaggableCache::ActiveRecordModelExtension) if kls.superclass == ActiveRecord::Base
+      end
+    end
+  end
+
+
+  module ActiveRecordModelExtension
+    extend ActiveSupport::Concern
+    def self.included(base)
+        [:after_update, :before_update, :before_destroy, :after_create].each do |event|
+          base.send(event, Proc.new do |model|
+                  Rails.cache.delete_by_tags(model, model.class)
+                end)
+      end
+    end
+  end
+end

data/lib/taggable_cache/railtie.rb

@@ -1,51 +1,13 @@
-require 'active_record'
-require 'action_controller'
-require 'rails'
-
-require 'taggable_cache/spectator'
-
-ActiveSupport::Cache::Store.class_eval do
-  def taggable
-    @taggable ||= ::TaggableCache::Store.new
-  end
-
-  alias_method :original_write, :write
-
-  def write(name, value, options = nil)
-    if !options.nil? && options.has_key?(:depends_on) 
-      add_tags(name, *options[:depends_on])
-    end
-
-    original_write(name, value, options)
-  end
-
-  def add_tags(key, *params)
-    taggable.add(key, *params)
-  end
-
-  def delete_by_tags(*params)
-    taggable.get(*params).each do |m|
-      self.delete(m)
-    end
-
-    taggable.get_scope(*(params.delete_if{|a| not a.is_a? ActiveRecord::Base})).each do |m|
-      self.delete(m)
-    end
-  end
-end
-
-ActionController::Base.class_eval do
-  def depends_on(*params)
-    key_name = fragment_cache_key(::ActionController::Caching::Actions::ActionCachePath.new(self).path)
-    Rails.cache.add_tags(key_name, *params)
-  end
-end
+require 'taggable_cache/extensions'
 
 module TaggableCache
   class Railtie < ::Rails::Railtie
     initializer "taggable_cache" do |app|
-      ActiveRecord::Base.observers << TaggableCache::Spectator
-      ActiveRecord::Base.add_observer TaggableCache::Spectator.instance
-    end    
+      ActiveSupport.on_load(:active_record) do
+        ::ActiveRecord::Base.send :include, TaggableCache::ActiveRecordExtension
+        ::ActiveSupport::Cache::Store.send :include, TaggableCache::CacheStoreExtension
+        ::ActionController::Base.send :include, TaggableCache::ActionControllerExtension        
+      end
+    end
   end  
 end

data/lib/taggable_cache/store.rb

@@ -3,7 +3,8 @@ require "digest/md5"
 
 class TaggableCache::Store
   def initialize
-    @redis = Redis.new
+    @redis = Redis.new  :host => ENV['REDIS_HOST'] || '127.0.0.1',
+                        :port => ENV['REDIS_PORT'] ? ENV['REDIS_PORT'].to_i : 6379
   end
 
   def id_for(obj)

data/lib/taggable_cache/version.rb

@@ -1,3 +1,3 @@
 module TaggableCache
-  VERSION = "0.3.0" # This is for the gem and does not conflict with the rest of the functionality
+  VERSION = "0.4.0" # This is for the gem and does not conflict with the rest of the functionality
 end

data/spec/internal/app/controller/action_caching_controller.rb

@@ -1,15 +1,21 @@
 class ActionCachingController < ActionController::Base
   caches_action :index
 
+  caches_action :cp, :cache_path => Proc.new { {'key' => 'value', 2 => 56} }
+
   def index
     Page.load_lot_of_data
 
     depends_on Page
 
-    render :text => 'sdfsd'
+    render :text => 'none'
   end
 
-  def expire
-    expire_action :action => :index
+  def cp
+    Page.load_lot_of_data
+
+    depends_on Page
+
+    render :text => 'none'
   end
 end

data/spec/requests/action_caching_controller_spec.rb

@@ -1,28 +1,59 @@
 require 'spec_helper'
 
 describe ActionCachingController do
-  before :each do 
-    get 'action_caching/expire'
-    @url = 'action_caching/index'
-  end
+  describe "simple" do
+    before :each do 
+      Rails.cache.clear
+      Redis.new.flushall
+      @url = 'action_caching/index'
+    end
+
+    it "should be successful" do
+      Page.should_receive :load_lot_of_data
+      get @url
+      response.status.should be(200)      
+    end
+
+    it "should run second test with cache deletion" do
+      Page.should_receive(:load_lot_of_data).once
+      get @url
+      response.status.should be(200)
 
-  it "should be successful" do
-    Page.should_receive :load_lot_of_data
-    get @url
-    response.status.should be(200)      
+      get @url
+      response.status.should be(200)
+
+      Page.should_receive(:load_lot_of_data).once
+      Page.create
+      get @url
+      response.status.should be(200)
+    end
   end
 
-  it "should run second test without cache" do
-    Page.should_receive(:load_lot_of_data).once
-    get @url
-    response.status.should be(200)
+  describe "with cache_path" do
+    before :each do 
+      Rails.cache.clear
+      Redis.new.flushall
+      @url = 'action_caching/cp'
+    end
+
+    it "should be successful" do
+      Page.should_receive :load_lot_of_data
+      get @url
+      response.status.should be(200)
+    end
+
+    it "should run second test with cache deletion" do
+      Page.should_receive(:load_lot_of_data).once
+      get @url
+      response.status.should be(200)
 
-    get @url
-    response.status.should be(200)
+      get @url
+      response.status.should be(200)
 
-    Page.should_receive(:load_lot_of_data).once
-    Page.create
-    get @url
-    response.status.should be(200)
+      Page.should_receive(:load_lot_of_data).once
+      Page.create
+      get @url
+      response.status.should be(200)
+    end
   end
 end

data/spec/taggable-cache/settings_spec.rb

@@ -0,0 +1,23 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper.rb')
+
+describe TaggableCache::Store do
+  after :all do
+    ENV.delete("REDIS_HOST")
+    ENV.delete("REDIS_PORT")
+  end
+
+  it "should fall back to defaults if no settings given" do
+    Redis.should_receive(:new).with(:host => '127.0.0.1', :port => 6379)
+
+    TaggableCache::Store.new
+  end
+
+  it "should use ENV settings" do
+    ENV["REDIS_HOST"] =  'hostname.lvh.me';
+    ENV["REDIS_PORT"] =  '1234';
+
+    Redis.should_receive(:new).with(:host => 'hostname.lvh.me', :port => 1234)
+
+    TaggableCache::Store.new
+  end
+end

data/taggable-cache.gemspec

@@ -28,7 +28,10 @@ Gem::Specification.new do |s|
   s.rubygems_version = "1.8.15"
   s.summary = "This gem simplifies cache expiration in rails by providing depends_on option to rails cache."
 
-  s.add_dependency(%q<rails>, [">= 3.1.0"])
+  #s.add_dependency(%q<rails>, [">= 3.1.0"])
+  s.add_dependency(%q<railties>, [">= 3.1.0"])
+  s.add_dependency(%q<actionpack>, [">= 3.1.0"])
+  s.add_dependency(%q<activerecord>, [">= 3.1.0"])
   s.add_dependency(%q<redis>, [">= 2.2.2"])
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: taggable_cache
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -12,8 +12,8 @@ cert_chain: []
 date: 2012-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
-  requirement: &71322420 !ruby/object:Gem::Requirement
+  name: railties
+  requirement: &77251570 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,32 @@ dependencies:
         version: 3.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *71322420
+  version_requirements: *77251570
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: &77251040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *77251040
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &77250480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *77250480
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &71321470 !ruby/object:Gem::Requirement
+  requirement: &77249530 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +54,7 @@ dependencies:
         version: 2.2.2
   type: :runtime
   prerelease: false
-  version_requirements: *71321470
+  version_requirements: *77249530
 description: This gem simplifies cache expiration in rails
 email: brain-geek@yandex.ua
 executables: []
@@ -43,17 +65,16 @@ extra_rdoc_files:
 files:
 - .gitignore
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.rdoc
 - Rakefile
 - gemfiles/Gemfile-rails.3.1.x
 - gemfiles/Gemfile-rails.3.2.x
 - lib/taggable_cache.rb
-- lib/taggable_cache/dynamic_store.rb
+- lib/taggable_cache/extensions.rb
 - lib/taggable_cache/railtie.rb
-- lib/taggable_cache/spectator.rb
 - lib/taggable_cache/store.rb
 - lib/taggable_cache/version.rb
 - spec/integration/rails_cache_spec.rb
@@ -64,10 +85,10 @@ files:
 - spec/internal/config/database.yml
 - spec/internal/config/routes.rb
 - spec/internal/db/schema.rb
-- spec/internal/public/favicon.ico
 - spec/requests/action_caching_controller_spec.rb
 - spec/requests/fragment_caching_controller_spec.rb
 - spec/spec_helper.rb
+- spec/taggable-cache/settings_spec.rb
 - spec/taggable-cache/store_spec.rb
 - taggable-cache.gemspec
 homepage: http://github.com/brain-geek/taggable-cache
@@ -85,7 +106,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -516926623
+      hash: 1067828559
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -94,10 +115,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -516926623
+      hash: 1067828559
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: This gem simplifies cache expiration in rails by providing depends_on option

data/Gemfile.lock

@@ -1,148 +0,0 @@
-PATH
-  remote: .
-  specs:
-    taggable_cache (0.3.0)
-      rails (>= 3.1.0)
-      redis (>= 2.2.2)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    actionmailer (3.2.2)
-      actionpack (= 3.2.2)
-      mail (~> 2.4.0)
-    actionpack (3.2.2)
-      activemodel (= 3.2.2)
-      activesupport (= 3.2.2)
-      builder (~> 3.0.0)
-      erubis (~> 2.7.0)
-      journey (~> 1.0.1)
-      rack (~> 1.4.0)
-      rack-cache (~> 1.1)
-      rack-test (~> 0.6.1)
-      sprockets (~> 2.1.2)
-    activemodel (3.2.2)
-      activesupport (= 3.2.2)
-      builder (~> 3.0.0)
-    activerecord (3.2.2)
-      activemodel (= 3.2.2)
-      activesupport (= 3.2.2)
-      arel (~> 3.0.2)
-      tzinfo (~> 0.3.29)
-    activeresource (3.2.2)
-      activemodel (= 3.2.2)
-      activesupport (= 3.2.2)
-    activesupport (3.2.2)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
-    arel (3.0.2)
-    builder (3.0.0)
-    capybara (1.1.2)
-      mime-types (>= 1.16)
-      nokogiri (>= 1.3.3)
-      rack (>= 1.0.0)
-      rack-test (>= 0.5.4)
-      selenium-webdriver (~> 2.0)
-      xpath (~> 0.1.4)
-    childprocess (0.3.1)
-      ffi (~> 1.0.6)
-    coderay (1.0.5)
-    combustion (0.3.2)
-      rails (>= 3.0.0)
-      thor (>= 0.14.6)
-    diff-lcs (1.1.3)
-    erubis (2.7.0)
-    ffi (1.0.11)
-    hike (1.2.1)
-    i18n (0.6.0)
-    journey (1.0.3)
-    json (1.6.5)
-    mail (2.4.3)
-      i18n (>= 0.4.0)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    method_source (0.7.1)
-    mime-types (1.17.2)
-    multi_json (1.1.0)
-    nokogiri (1.5.0)
-    polyglot (0.3.3)
-    pry (0.9.8.4)
-      coderay (~> 1.0.5)
-      method_source (~> 0.7.1)
-      slop (>= 2.4.4, < 3)
-    pry-nav (0.1.0)
-      pry (~> 0.9.8.1)
-    rack (1.4.1)
-    rack-cache (1.2)
-      rack (>= 0.4)
-    rack-ssl (1.3.2)
-      rack
-    rack-test (0.6.1)
-      rack (>= 1.0)
-    rails (3.2.2)
-      actionmailer (= 3.2.2)
-      actionpack (= 3.2.2)
-      activerecord (= 3.2.2)
-      activeresource (= 3.2.2)
-      activesupport (= 3.2.2)
-      bundler (~> 1.0)
-      railties (= 3.2.2)
-    railties (3.2.2)
-      actionpack (= 3.2.2)
-      activesupport (= 3.2.2)
-      rack-ssl (~> 1.3.2)
-      rake (>= 0.8.7)
-      rdoc (~> 3.4)
-      thor (~> 0.14.6)
-    rake (0.9.2.2)
-    rdoc (3.12)
-      json (~> 1.4)
-    redis (2.2.2)
-    rspec (2.8.0)
-      rspec-core (~> 2.8.0)
-      rspec-expectations (~> 2.8.0)
-      rspec-mocks (~> 2.8.0)
-    rspec-core (2.8.0)
-    rspec-expectations (2.8.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.8.0)
-    rspec-rails (2.8.1)
-      actionpack (>= 3.0)
-      activesupport (>= 3.0)
-      railties (>= 3.0)
-      rspec (~> 2.8.0)
-    rubyzip (0.9.6.1)
-    selenium-webdriver (2.20.0)
-      childprocess (>= 0.2.5)
-      ffi (~> 1.0)
-      multi_json (~> 1.0)
-      rubyzip
-    slop (2.4.4)
-    sprockets (2.1.2)
-      hike (~> 1.2)
-      rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
-    sqlite3 (1.3.5)
-    thor (0.14.6)
-    tilt (1.3.3)
-    treetop (1.4.10)
-      polyglot
-      polyglot (>= 0.3.1)
-    tzinfo (0.3.32)
-    xpath (0.1.4)
-      nokogiri (~> 1.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  capybara
-  combustion
-  pry
-  pry-nav
-  rails (~> 3.2.0)
-  rake
-  rspec
-  rspec-rails
-  sqlite3
-  taggable_cache!

data/lib/taggable_cache/dynamic_store.rb

@@ -1,5 +0,0 @@
-require "redis"
-
-class TaggableCache::DynamicStore < TaggableCache::Store
-  
-end

data/lib/taggable_cache/spectator.rb

@@ -1,10 +0,0 @@
-class TaggableCache::Spectator < ActiveRecord::Observer
-  def event(model)
-    Rails.cache.delete_by_tags(model, model.class)
-  end
-
-  alias :after_update :event
-  alias :before_update :event
-  alias :before_destroy :event
-  alias :after_create :event
-end