has_cache_key 0.0.1

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+gemspec
+
+group :test, :development do
+  gem 'rspec'
+  gem 'sqlite3'
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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,41 @@
+HasCacheKey -- automatic cache key management For Rails
+================================
+
+Allows you describe cache keys in the models, and provides automatic expiration
+
+Installation
+------------
+
+Add this line to your Gemfile:
+
+    gem 'has_cache_key'
+
+Usage
+-----
+
+Define cache_keys in your model
+
+    class Listing < ActiveRecord::Base
+      # Default cache key for the listing view
+      has_cache_key :id
+      # A cache key for the home page of category in location
+      has_cache_key [:location_id, :category_id], name: :category_in_location_home_page
+    end
+
+To get a cache key in you can use one of the following:
+
+
+   # Default cache key
+   @listing.cache_key
+
+   # A cache key
+   @listing.cache_key(:category_in_location_home_page)
+
+   # A cache key without a listing instance:
+   Listing.cache_key(:category_in_location_home_page, category_id: 10, location_id: 10)
+
+
+Your cache keys will be automatically updates after_save and after_destroy according to the attribute changes.
+
+
+This project uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,22 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rdoc/task'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Has Cache Key'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/has_cache_key/cache_key.rb

@@ -0,0 +1,24 @@
+module HasCacheKey
+  class CacheKey
+    attr_reader :name, :keys
+
+    # *keys, options
+    def initialize(*args)
+      options = args.extract_options!
+      keys = args
+      @keys = args.map { |k| k.is_a?(Symbol) ? k : k.to_sym }.freeze
+      @format = options[:format]
+      if options[:name]
+        @name = options[:name]
+        @name = @name.to_sym unless @name.is_a?(Symbol)
+      end
+    end
+
+    def format(values = nil)
+      return @format if !values
+      values = values.symbolize_keys
+      fmt = @format
+      fmt.is_a?(Proc) ? fmt.call(values) : (fmt % values)
+    end
+  end
+end

data/lib/has_cache_key/model_ext.rb

@@ -0,0 +1,87 @@
+require 'has_cache_key/possible_values'
+require 'has_cache_key/cache_key'
+
+module HasCacheKey
+  module ModelExt
+    def self.included(base)
+      base.extend ClassMethods
+      base.after_save :expire_cache_keys
+      base.after_destroy :expire_cache_keys
+    end
+
+    def expire_cache_keys
+      # First, assemble all keys the listing is involved in, and the values that were affected
+      affected_values_by_key = {}
+      attr_changes = self.changes
+      keys = self.class.cache_keys.map(&:keys)
+      keys.flatten!
+      keys.uniq!
+
+      keys.each do |key|
+        affected_values_by_key[key] = if attr_changes.has_key?(key)
+                                        # For :updated_at only expire the first value , because the second one never exists
+                                        if key == :updated_at
+                                          [attr_changes[key][0]]
+                                        else
+                                          attr_changes[key]
+                                        end
+                                      else
+                                        [send(key)]
+                                      end
+      end
+
+      self.class.cache_keys.each do |cache_key|
+        PossibleValues.new(affected_values_by_key.slice(*cache_key.keys)).each do |interpolations|
+          expire_fragment_key(cache_key.format(interpolations))
+        end
+      end
+    end
+
+    # @returns cache key string for the cache key with the given name
+    def cache_key(name = self.class.name.to_s.demodulize.underscore)
+      self.class.cache_key(name, attributes)
+    end
+
+    protected
+    def expire_fragment_key(key)
+      (@controller ||= ActionController::Base.new).expire_fragment(key)
+    end
+
+    module ClassMethods
+      def cache_keys
+        @cache_keys ||= []
+      end
+
+      def cache_key(name, format_values = nil)
+        (@cache_key_by_name ||= {}.with_indifferent_access)[name].format(format_values)
+      end
+
+
+      # Adds a cache key association to your model
+      # @param [Array|Symbol] composed_of keys that make up the cache key,
+      #   can be also passed as @option composed_of
+      #
+      # @option [Symbol] name unique name which is used to refer to the cache key from your application
+      #   defaults to: name.to_s.demodulize.underscore
+      #
+      # @example Expire on any update:
+      #   has_cache_key :product_snippet, composed_of: [:updated_at]
+      def has_cache_key(*args)
+        if (options = args.extract_options!)
+          options[:composed_of] ||= args.flatten
+        else
+          options = {}
+        end
+        options[:composed_of] = Array(options[:composed_of])
+        options[:name] ||= name.to_s.demodulize.underscore
+        options[:format] ||= "#{options[:name]}-#{options[:composed_of].map { |k| "%{#{k}}" }.join('-')}"
+        cache_key = HasCacheKey::CacheKey.new(*options[:composed_of], options)
+        (@cache_keys ||= []) << cache_key
+        (@cache_key_by_name ||= {}.with_indifferent_access)[cache_key.name] = cache_key
+      end
+    end
+  end
+end
+
+require 'active_record'
+ActiveRecord::Base.class_eval { include HasCacheKey::ModelExt }

data/lib/has_cache_key/possible_values.rb

@@ -0,0 +1,45 @@
+module HasCacheKey
+  class PossibleValues
+    attr_reader :data
+    include Enumerable
+
+    # Yields with {slot_name => possible value} for all possible values
+    # It yields exactly this many times:
+    #  PRODUCT{i in 0..COUNT(slot))}
+    #             COUNT(VALUES(slot)))
+    def each(&block)
+      if @results
+        @results.each &block
+        return self
+      end
+      @results = []
+      cur_v_i = Array.new(@data.keys.length, 0)
+      keys = @data.keys.sort_by(&:to_s)
+      result = {}
+      keys.each do |key|
+        result[key] = @data[key][0]
+      end
+      while true
+        r = result.dup
+        @results << r
+        block.call(r) if block
+        keys.each_with_index do |k, k_i|
+          v_i = ((cur_v_i[k_i] = (1 + cur_v_i[k_i]) % @data[k].length))
+          result[k] = @data[k][v_i]
+          if v_i > 0 # Found next ?
+            break
+          elsif k_i == keys.length - 1 # Last?
+            return
+          end
+        end
+      end
+      @results
+    end
+
+    # Iterates over possible all possible values of keys
+    # data hash of {slot_name => [possible values...]}
+    def initialize(data)
+      @data = data
+    end
+  end
+end

data/lib/has_cache_key/version.rb

@@ -0,0 +1,3 @@
+module HasCacheKey
+  VERSION = '0.0.1'
+end

data/lib/has_cache_key.rb

@@ -0,0 +1,2 @@
+require 'has_cache_key/version'
+require 'has_cache_key/model_ext'

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: has_cache_key
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Gleb Mazovetskiy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-18 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &15820680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: *15820680
+description: Allows you to define multiple cache keys on the module, and automatically
+  expires them.
+email: glex.spb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/has_cache_key/possible_values.rb
+- lib/has_cache_key/model_ext.rb
+- lib/has_cache_key/cache_key.rb
+- lib/has_cache_key/version.rb
+- lib/has_cache_key.rb
+- MIT-LICENSE
+- Rakefile
+- Gemfile
+- README.md
+homepage: 
+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.11
+signing_key: 
+specification_version: 3
+summary: Automatic Cache Key Management for Rails Models. v0.0.1
+test_files: []