rails-cache-tags 1.1.1 → 1.2.0

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 amikhailov
+Copyright (c) 2012 Alexei Mikhailov
 
 MIT License
 

data/README.md

@@ -1,6 +1,7 @@
 # Synopsys
 
 Tagged caching support within your Rails application. Tested against Rails 3.0, Rails 3.1 and Rails 3.2
+[Dalli](https://github.com/mperham/dalli) store is also supported!
 
 # Installation
 
@@ -30,6 +31,39 @@ cache.delete_tag "baz"
 cache.read "foo" => nil
 ```
 
+More realistic example:
+```ruby
+class PostsController < ApplicationController
+  def index
+    @posts = cache.fetch("index", :tags =>
+
+    @posts = cache.read("posts") || begin
+      posts_from_db = Post.all
+
+      cache.write "posts", :tags => {:post => posts_from_db.map(&:id)}
+
+      posts_from_db
+    end
+  end
+
+  def show
+    id = params[:id]
+
+    @post = cache.fetch(["post", id], :tags => {:post => id}) do
+      Post.find(id)
+    end
+  end
+
+  def update
+    @post = Post.find(params[:id])
+
+    if @post.update_attributes
+      cache.delete_tag :post => @post.id
+    end
+  end
+end
+```
+
 In your controller:
 ```ruby
 class PostController < ActionController::Base
@@ -51,6 +85,6 @@ end
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Write tests!
-5. Run tests against all appraisals
+5. Run tests against all major version of Rails starting from 3.0
 6. Push to the branch (`git push origin my-new-feature`)
-7. Create new Pull Request
+7. Create new Pull Request

data/lib/rails-cache-tags.rb

@@ -5,6 +5,7 @@ require "action_controller"
 require "rails/cache/tag"
 require "rails/cache/tags/store"
 
+# Patch ActiveSupport common store
 module ActiveSupport
   module Cache
     class Store
@@ -17,6 +18,7 @@ module ActiveSupport
   end
 end
 
+# Patch ActionDispatch
 class ActionController::Base < ActionController::Metal
   def expire_fragments_by_tags *args
     return unless cache_configured?
@@ -24,4 +26,18 @@ class ActionController::Base < ActionController::Metal
     cache_store.delete_tag *args
   end
   alias expire_fragments_by_tag expire_fragments_by_tags
+end
+
+# Patch Dalli store
+begin
+  require "dalli"
+  require "dalli/version"
+
+  if Dalli::VERSION.to_f > 2
+    require "active_support/cache/dalli_store"
+
+    ActiveSupport::Cache::DalliStore.extend(Rails::Cache::Tags::Store)
+  end
+rescue LoadError, NameError
+  # ignore
 end

data/lib/rails/cache/tags/store.rb

@@ -4,6 +4,9 @@ module Rails
   module Cache
     module Tags
       module Store
+        # cache entry (for Dalli mainly)
+        Entry = Struct.new(:value, :tags)
+
         # patched +new+ method
         def new(*args, &block) #:nodoc:
           unless acts_like?(:cached_tags)
@@ -37,8 +40,13 @@ module Rails
           def read_entry_with_tags(key, options) #:nodoc
             entry = read_entry_without_tags(key, options)
 
-            if entry && entry.tags.present?
-              current_versions = fetch_tags(entry.tags.keys)
+            # tags are supported only for ActiveSupport::Cache::Entry or Rails::Cache::Tags::Entry
+            tags = if entry.is_a?(ActiveSupport::Cache::Entry) || entry.is_a?(Entry)
+              entry.tags
+            end
+
+            if tags.is_a?(Hash) && tags.present?
+              current_versions = fetch_tags(entry.tags.keys).values
               saved_versions   = entry.tags.values
 
               if current_versions != saved_versions
@@ -48,15 +56,27 @@ module Rails
               end
             end
 
-            entry
+            entry.is_a?(Entry) ?
+                entry.value :
+                entry
           end # def read_entry_with_tags
 
           def write_entry_with_tags(key, entry, options) #:nodoc:
             tags = Rails::Cache::Tag.build_tags Array.wrap(options[:tags]).flatten.compact
 
             if entry && tags.present?
-              current_versions = fetch_tags(tags) # => [1, 2, 3]
-              entry.tags = Hash[tags.zip(current_versions).map { |tag, v| [tag.name, v || tag.increment(self)] }]
+              options[:raw] = false # force :raw => false
+
+              # Dalli treats ActiveSupport::Cache::Entry as deprecated behavior, so we use our own Entry class
+              entry = Entry.new(entry, nil) unless entry.is_a?(ActiveSupport::Cache::Entry)
+
+              entry.tags = fetch_tags(tags).reduce(HashWithIndifferentAccess.new) do |hash, v|
+                tag, value = v
+
+                hash[tag.name] = value || tag.increment(self)
+
+                hash
+              end
             end
 
             write_entry_without_tags(key, entry, options)
@@ -64,16 +84,19 @@ module Rails
 
           private
           # fetch tags versions from store
-          # fetch ['user:1', 'post:2', 'country:2'] => [3, 4, nil]
+          # fetch ['user/1', 'post/2', 'country/2'] => [Tag('user/1') => 3, Tag('post/2') => 4, Tag('country/2') => nil]
           def fetch_tags(names) #:nodoc:
             tags = Rails::Cache::Tag.build_tags names
-            keys = tags.map(&:to_key)
-            stored = read_multi(*keys)
+            stored = read_multi(*tags.map(&:to_key))
 
-            # we should save order
-            keys.collect { |k| stored[k] }
-          end
-        end
+            # build hash
+            tags.reduce(Hash.new) do |hash, t|
+              hash[t] = stored[t.to_key]
+
+              hash
+            end
+          end # def fetch_tags
+        end # module InstanceMethods
       end # module Store
     end # module Tags
   end # module Cache

data/lib/rails/cache/tags/version.rb

@@ -1,7 +1,7 @@
 module Rails
   module Cache
     module Tags
-      VERSION = "1.1.1"
+      VERSION = "1.2.0"
     end
   end
 end

data/rails-cache-tags.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |gem|
   gem.summary       = %q{Tagged caching support for Rails}
   gem.homepage      = "https://github.com/take-five/rails-cache-tags"
 
-  gem.files         = `git ls-files`.split($\)
+  gem.files         = %W(LICENSE README.md lib/rails-cache-tags.rb lib/rails/cache/tag.rb rails-cache-tags.gemspec lib/rails/cache/tags/store.rb lib/rails/cache/tags/version.rb test/cache_tags_test.rb test/caching_test.rb test/test_helper.rb)
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "rails-cache-tags"
   gem.require_paths = %W(lib)
@@ -22,4 +22,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rack'
   gem.add_development_dependency 'mocha'
   gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'dalli', '>= 2.0'
 end

data/test/cache_tags_test.rb

@@ -73,6 +73,9 @@ module CacheTagsBehavior
     @cache.write("foo", "bar", :tags => {:baz => 1})
     assert_equal 'bar', @cache.read('foo')
 
+    @cache.delete_tag :baz => 2
+    assert_equal 'bar', @cache.read('foo')
+
     @cache.delete_tag :baz => 1
 
     assert_nil @cache.read('foo')
@@ -91,6 +94,6 @@ module CacheTagsBehavior
   end
 end
 
-[FileStoreTest, MemoryStoreTest, MemCacheStoreTest].each do |klass|
+[FileStoreTest, MemoryStoreTest, MemCacheStoreTest, DalliStoreTest].each do |klass|
   klass.send :include, CacheTagsBehavior
 end

data/test/caching_test.rb

@@ -3,138 +3,6 @@ $:.unshift(File.dirname(__FILE__))
 require 'test_helper'
 require 'logger'
 
-class CacheKeyTest < ActiveSupport::TestCase
-  def test_expand_cache_key
-    assert_equal '1/2/true', ActiveSupport::Cache.expand_cache_key([1, '2', true])
-    assert_equal 'name/1/2/true', ActiveSupport::Cache.expand_cache_key([1, '2', true], :name)
-  end
-
-  def test_expand_cache_key_with_rails_cache_id
-    begin
-      ENV['RAILS_CACHE_ID'] = 'c99'
-      assert_equal 'c99/foo', ActiveSupport::Cache.expand_cache_key(:foo)
-      assert_equal 'c99/foo', ActiveSupport::Cache.expand_cache_key([:foo])
-      assert_equal 'nm/c99/foo', ActiveSupport::Cache.expand_cache_key(:foo, :nm)
-      assert_equal 'nm/c99/foo', ActiveSupport::Cache.expand_cache_key([:foo], :nm)
-    ensure
-      ENV['RAILS_CACHE_ID'] = nil
-    end
-  end
-
-  def test_expand_cache_key_with_rails_app_version
-    begin
-      ENV['RAILS_APP_VERSION'] = 'rails3'
-      assert_equal 'rails3/foo', ActiveSupport::Cache.expand_cache_key(:foo)
-    ensure
-      ENV['RAILS_APP_VERSION'] = nil
-    end
-  end
-
-  def test_expand_cache_key_rails_cache_id_should_win_over_rails_app_version
-    begin
-      ENV['RAILS_CACHE_ID'] = 'c99'
-      ENV['RAILS_APP_VERSION'] = 'rails3'
-      assert_equal 'c99/foo', ActiveSupport::Cache.expand_cache_key(:foo)
-    ensure
-      ENV['RAILS_CACHE_ID'] = nil
-      ENV['RAILS_APP_VERSION'] = nil
-    end
-  end
-
-  def test_respond_to_cache_key
-    key = 'foo'
-    def key.cache_key
-      :foo_key
-    end
-    assert_equal 'foo_key', ActiveSupport::Cache.expand_cache_key(key)
-  end
-
-end
-
-class CacheStoreSettingTest < ActiveSupport::TestCase
-  def test_file_fragment_cache_store
-    store = ActiveSupport::Cache.lookup_store :file_store, "/path/to/cache/directory"
-    assert_kind_of(ActiveSupport::Cache::FileStore, store)
-    assert_equal "/path/to/cache/directory", store.cache_path
-  end
-
-  def test_mem_cache_fragment_cache_store
-    MemCache.expects(:new).with(%w[localhost], {})
-    store = ActiveSupport::Cache.lookup_store :mem_cache_store, "localhost"
-    assert_kind_of(ActiveSupport::Cache::MemCacheStore, store)
-  end
-
-  def test_mem_cache_fragment_cache_store_with_given_mem_cache
-    mem_cache = MemCache.new
-    MemCache.expects(:new).never
-    store = ActiveSupport::Cache.lookup_store :mem_cache_store, mem_cache
-    assert_kind_of(ActiveSupport::Cache::MemCacheStore, store)
-  end
-
-  def test_mem_cache_fragment_cache_store_with_given_mem_cache_like_object
-    MemCache.expects(:new).never
-    memcache = Object.new
-    def memcache.get() true end
-    store = ActiveSupport::Cache.lookup_store :mem_cache_store, memcache
-    assert_kind_of(ActiveSupport::Cache::MemCacheStore, store)
-  end
-
-  def test_mem_cache_fragment_cache_store_with_multiple_servers
-    MemCache.expects(:new).with(%w[localhost 192.168.1.1], {})
-    store = ActiveSupport::Cache.lookup_store :mem_cache_store, "localhost", '192.168.1.1'
-    assert_kind_of(ActiveSupport::Cache::MemCacheStore, store)
-  end
-
-  def test_mem_cache_fragment_cache_store_with_options
-    MemCache.expects(:new).with(%w[localhost 192.168.1.1], { :timeout => 10 })
-    store = ActiveSupport::Cache.lookup_store :mem_cache_store, "localhost", '192.168.1.1', :namespace => 'foo', :timeout => 10
-    assert_kind_of(ActiveSupport::Cache::MemCacheStore, store)
-    assert_equal 'foo', store.options[:namespace]
-  end
-
-  def test_object_assigned_fragment_cache_store
-    store = ActiveSupport::Cache.lookup_store ActiveSupport::Cache::FileStore.new("/path/to/cache/directory")
-    assert_kind_of(ActiveSupport::Cache::FileStore, store)
-    assert_equal "/path/to/cache/directory", store.cache_path
-  end
-end
-
-class CacheStoreNamespaceTest < ActiveSupport::TestCase
-  def test_static_namespace
-    cache = ActiveSupport::Cache.lookup_store(:memory_store, :namespace => "tester")
-    cache.write("foo", "bar")
-    assert_equal "bar", cache.read("foo")
-    assert_equal "bar", cache.instance_variable_get(:@data)["tester:foo"].value
-  end
-
-  def test_proc_namespace
-    test_val = "tester"
-    proc = lambda{test_val}
-    cache = ActiveSupport::Cache.lookup_store(:memory_store, :namespace => proc)
-    cache.write("foo", "bar")
-    assert_equal "bar", cache.read("foo")
-    assert_equal "bar", cache.instance_variable_get(:@data)["tester:foo"].value
-  end
-
-  def test_delete_matched_key_start
-    cache = ActiveSupport::Cache.lookup_store(:memory_store, :namespace => "tester")
-    cache.write("foo", "bar")
-    cache.write("fu", "baz")
-    cache.delete_matched(/^fo/)
-    assert_equal false, cache.exist?("foo")
-    assert_equal true, cache.exist?("fu")
-  end
-
-  def test_delete_matched_key
-    cache = ActiveSupport::Cache.lookup_store(:memory_store, :namespace => "foo")
-    cache.write("foo", "bar")
-    cache.write("fu", "baz")
-    cache.delete_matched(/OO/i)
-    assert_equal false, cache.exist?("foo")
-    assert_equal true, cache.exist?("fu")
-  end
-end
-
 # Tests the base functionality that should be identical across all cache stores.
 module CacheStoreBehavior
   def test_should_read_and_write_strings
@@ -566,24 +434,37 @@ uses_memcached 'memcached backed store' do
       end
     end
   end
-end
 
-class CacheStoreLoggerTest < ActiveSupport::TestCase
-  def setup
-    @cache = ActiveSupport::Cache.lookup_store(:memory_store)
+  class DalliStoreTest < ActiveSupport::TestCase
+    def setup
+      @cache = ActiveSupport::Cache.lookup_store(:dalli_store, :expires_in => 60)
+      @peek = ActiveSupport::Cache.lookup_store(:dalli_store)
+      @data = @cache.instance_variable_get(:@data)
+      @cache.clear
+      @cache.silence!
+    end
 
-    @buffer = StringIO.new
-    @cache.logger = Logger.new(@buffer)
-  end
+    def test_should_read_and_write_strings
+      assert_equal true, @cache.write('foo', 'bar')
+      assert_equal 'bar', @cache.read('foo')
+    end
 
-  def test_logging
-    @cache.fetch('foo') { 'bar' }
-    assert_present @buffer.string
-  end
+    def test_should_read_and_write_hash
+      assert_equal true, @cache.write('foo', {:a => "b"})
+      assert_equal({:a => "b"}, @cache.read('foo'))
+    end
 
-  def test_mute_logging
-    @cache.mute { @cache.fetch('foo') { 'bar' } }
-    assert_blank @buffer.string
+    def test_should_read_and_write_integer
+      assert_equal true, @cache.write('foo', 1)
+      assert_equal 1, @cache.read('foo')
+    end
+
+    def test_read_multi
+      @cache.write('foo', 'bar')
+      @cache.write('fu', 'baz')
+      @cache.write('fud', 'biz')
+      assert_equal({"foo" => "bar", "fu" => "baz"}, @cache.read_multi('foo', 'fu'))
+    end
   end
 end
 

data/test/test_helper.rb

@@ -1,5 +1,7 @@
 require "bundler/setup"
 
+require 'rails'
+
 require 'active_support/all'
 require 'active_support/test_case'
 require "active_support/core_ext"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-cache-tags
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-09 00:00:00.000000000Z
+date: 2012-07-16 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &18370040 !ruby/object:Gem::Requirement
+  requirement: &20459380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *18370040
+  version_requirements: *20459380
 - !ruby/object:Gem::Dependency
   name: appraisal
-  requirement: &18369620 !ruby/object:Gem::Requirement
+  requirement: &20458680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18369620
+  version_requirements: *20458680
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &18369080 !ruby/object:Gem::Requirement
+  requirement: &20457820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '3.2'
   type: :development
   prerelease: false
-  version_requirements: *18369080
+  version_requirements: *20457820
 - !ruby/object:Gem::Dependency
   name: memcache-client
-  requirement: &18368620 !ruby/object:Gem::Requirement
+  requirement: &20457360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18368620
+  version_requirements: *20457360
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &18368160 !ruby/object:Gem::Requirement
+  requirement: &20456820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18368160
+  version_requirements: *20456820
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &18367680 !ruby/object:Gem::Requirement
+  requirement: &20455780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18367680
+  version_requirements: *20455780
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &18367220 !ruby/object:Gem::Requirement
+  requirement: &20454640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18367220
+  version_requirements: *20454640
+- !ruby/object:Gem::Dependency
+  name: dalli
+  requirement: &20440600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: *20440600
 description: Tagged caching support for Rails
 email:
 - amikhailov83@gmail.com
@@ -95,17 +106,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- Appraisals
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
 - lib/rails-cache-tags.rb
 - lib/rails/cache/tag.rb
+- rails-cache-tags.gemspec
 - lib/rails/cache/tags/store.rb
 - lib/rails/cache/tags/version.rb
-- rails-cache-tags.gemspec
 - test/cache_tags_test.rb
 - test/caching_test.rb
 - test/test_helper.rb
@@ -121,18 +128,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1966449301647994117
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1966449301647994117
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.17
@@ -143,3 +144,4 @@ test_files:
 - test/cache_tags_test.rb
 - test/caching_test.rb
 - test/test_helper.rb
+has_rdoc: 

data/.gitignore

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

data/Appraisals

@@ -1,11 +0,0 @@
-appraise "rails3.0" do
-  gem "rails", "~> 3.0.0"
-end
-
-appraise "rails3.1" do
-  gem "rails", "~> 3.1.0"
-end
-
-appraise "rails3.2" do
-  gem "rails", "~> 3.2.0"
-end

data/Gemfile

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

data/Rakefile

@@ -1,11 +0,0 @@
-#!/usr/bin/env rake
-require "bundler/gem_tasks"
-require 'appraisal'
-
-desc 'Run tests'
-task :test do
-  test_dir = File.expand_path(File.join("..", "test"), __FILE__)
-
-  Dir[File.join(test_dir, '**', '*_test.rb')].each { |f| require f }
-  require 'minitest/autorun'
-end