scope_cache_key 0.0.1

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-19mode
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Carl Mercier
+
+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,40 @@
+# Scope Cache Key
+
+This gem adds the `cache_key` functionality to ActiveRecord scopes.
+
+This is useful when caching a page that contains multiple records. It is now
+possible to cache the entire page based on a scope. If any record in the scope
+changes, the entire cache will be busted.
+
+This should likely be used in a Russian Doll Caching scenario.
+
+NOTE: This currently only works with Postgresql. Adding support for MySQL should
+be trivial.
+
+[![Build Status](https://secure.travis-ci.org/cmer/scope_cache_key.png?branch=master)](http://travis-ci.org/cmer/scope_cache_key)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'scope_cache_key'
+
+## Usage
+
+Example:
+
+    <%
+    scope = Article.page(1) # This should probably be done in your controller!
+    cache scope do
+      # logic to render and cache each article here
+    end
+    %>
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/scope_cache_key.rb

@@ -0,0 +1,37 @@
+require "scope_cache_key/version"
+
+# Add support for passing models and scopes as cache keys.
+# The cache key will include the md5 digest of the ids and
+# timestamps. Any modification to the group of records will
+# generate a new key.
+#
+# Eg.:
+#
+#   cache [ Community.first, Category.active ] do ...
+#
+# Will use the key: communites/1/categories/0b27dac757428d88c0f3a0298eb0278f
+module ScopeCacheKey
+  # Compute the cache key of a group of records.
+  #
+  #   Item.cache_key # => "0b27dac757428d88c0f3a0298eb0278f"
+  #   Item.active.cache_key # => "0b27dac757428d88c0f3a0298eb0278e"
+  #
+  def cache_key
+    scope_sql = scoped.select("#{table_name}.id, #{table_name}.updated_at").to_sql
+
+    sql = "SELECT md5(array_agg(id || '-' || updated_at)::text) " +
+          "FROM (#{scope_sql}) as query"
+
+    md5 = connection.select_value(sql)
+
+    key = if md5.present?
+      md5
+    else
+      "empty"
+    end
+
+    "#{model_name.cache_key}/#{key}"
+  end
+end
+
+ActiveRecord::Base.extend ScopeCacheKey

data/lib/scope_cache_key/version.rb

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

data/scope_cache_key.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'scope_cache_key/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "scope_cache_key"
+  gem.version       = ScopeCacheKey::VERSION
+  gem.authors       = ["Carl Mercier"]
+  gem.email         = ["carl@carlmercier.com"]
+  gem.summary       = %q{Add cache_key functionality to scopes}
+  gem.homepage      = "http://github.com/cmer/scope_cache_key"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency('activerecord', '>= 3.2.9')
+
+  gem.add_development_dependency('rspec', '~> 2.13.0')
+  gem.add_development_dependency('activerecord', '~> 3.2.12')
+  gem.add_development_dependency('actionpack', '~> 3.2.12')
+  gem.add_development_dependency('pg')
+  gem.add_development_dependency('faker', '~> 1.1.2')
+  gem.add_development_dependency('pry')
+end

data/spec/scope_cache_key_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+describe ScopeCacheKey do
+  before(:all) do
+    @article = create_article
+    create_comment(Article.first, 100)
+  end
+
+  after(:all) do
+    Article.destroy_all
+    Comment.destroy_all
+  end
+
+  context "#cache_key" do
+    context "model" do
+      it "returns the correct value" do
+        scope = Comment
+        scope.cache_key.should == "comments/#{md5(scope)}"
+      end
+    end
+
+    context "after a record is updated" do
+      it "returns the correct value" do
+        old_key = Comment.cache_key
+        Comment.first.touch
+        Comment.cache_key.should_not == old_key
+      end
+    end
+
+    context "after a record is deleted" do
+      it "returns the correct value" do
+        old_key = Comment.cache_key
+        Comment.first.destroy
+        Comment.cache_key.should_not == old_key
+      end
+    end
+
+    context "scope returns an empty dataset" do
+      it "returns the correct value" do
+        Comment.where("1=2").cache_key.should == "comments/empty"
+      end
+    end
+
+    context "when order is specified" do
+      it "returns the correct value" do
+        scope = Comment.reorder(:id)
+        scope.cache_key.should == "comments/#{md5(scope)}"
+      end
+    end
+
+    context "when joined with another table" do
+      it "returns the correct value" do
+        Comment.joins(:article).cache_key.should_not == "comments/empty"
+      end
+    end
+
+    context "when included with another table" do
+      it "returns the correct value" do
+        Comment.includes(:article).cache_key.should_not == "comments/empty"
+      end
+    end
+
+    context "when offset is specified" do
+      it "returns the correct value" do
+        Comment.order(:id).offset(1).limit(1).cache_key.should_not == "comments/empty"
+      end
+    end
+  end
+
+
+  context "Fragment Cache Key" do
+    let(:controller) { ApplicationController.new }
+
+    it "returns the correct value when passed a simple model" do
+      controller.fragment_cache_key(Comment).should end_with(Comment.cache_key)
+    end
+
+    it "returns the correct value when passed a version and model" do
+      controller.fragment_cache_key(['v1', Comment]).should end_with("v1/#{Comment.cache_key}")
+    end
+
+    it "returns the correct value when passed complex arguments" do
+      objects = ['v1', Comment, Comment.where('1=2')]
+      controller.fragment_cache_key(objects).should end_with(
+        "v1/#{Comment.cache_key}/comments/empty")
+    end
+  end
+
+  context "performance" do
+    before :all do
+      @query_time     = Benchmark.realtime { Comment.all }
+      @cache_key_time = Benchmark.realtime { Comment.cache_key }
+      @ruby_time      = Benchmark.realtime { md5(Comment) }
+    end
+
+    it "is faster than running the query" do
+      @cache_key_time.should < @query_time
+    end
+
+    it "is faster than computing MD5 in Ruby" do
+      @cache_key_time.should < @ruby_time
+    end
+  end
+
+  def md5(scope)
+    string = scope.all.map { |i| "\"#{i.id}-#{i.updated_at_before_type_cast}\"" }.join(",")
+    Digest::MD5.hexdigest "{#{string}}"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,71 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'active_record'
+require 'action_controller'
+require 'faker'
+require 'rspec'
+require 'pry'
+require 'logger'
+
+require 'scope_cache_key'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+ActiveRecord::Base.configurations = {'postgresql' => {:adapter => 'postgresql', :database => 'scope_cache_key_test'}}
+ActiveRecord::Base.establish_connection('postgresql')
+
+ActiveRecord::Base.logger = Logger.new(STDERR)
+ActiveRecord::Base.logger.level = Logger::WARN
+
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Base.connection.execute("DROP TABLE articles;")
+ActiveRecord::Base.connection.execute("DROP TABLE comments;")
+
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :articles do |t|
+    t.string :title
+    t.text :body
+    t.timestamps
+  end
+
+  create_table :comments do |t|
+    t.references :article
+    t.text :body
+    t.string :user
+    t.timestamps
+  end
+end
+
+class Article < ActiveRecord::Base
+  has_many :comments
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :article
+end
+
+class ApplicationController < ActionController::Base
+end
+
+def create_article(count = 1)
+  count.times {
+    Article.create! title: Faker::Lorem.sentence, body: Faker::Lorem.paragraphs(10)
+  }
+end
+
+def create_comment(article, count = 1)
+  count.times {
+    Comment.create! user: Faker::Name.name, body: Faker::Lorem.paragraphs(10), article_id: article.id
+  }
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: scope_cache_key
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Carl Mercier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.9
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.12
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.12
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.12
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.12
+- !ruby/object:Gem::Dependency
+  name: pg
+  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: faker
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+description: 
+email:
+- carl@carlmercier.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/scope_cache_key.rb
+- lib/scope_cache_key/version.rb
+- scope_cache_key.gemspec
+- spec/scope_cache_key_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/cmer/scope_cache_key
+licenses: []
+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.23
+signing_key: 
+specification_version: 3
+summary: Add cache_key functionality to scopes
+test_files:
+- spec/scope_cache_key_spec.rb
+- spec/spec_helper.rb