cache_money_millionaire 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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 John Koht
+
+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,65 @@
+# CacheMoneyMillionaire
+
+Rails ActiveRecord Query Caching like a Millionaire
+
+CacheMoneyMillionaire is a simple Ruby gem that extends Rail's basic find, save and touch methods to create, set and update cache keys for ActiveRecord models. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cache_money_millionaire'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cache_money_millionaire
+
+## Usage
+
+In order to get started, make sure you add the initializer:
+  
+    # config/initializers/cache_money_millionaire.rb
+    CacheMoneyMillionaire.configure do |config|
+      config.cacheable = true
+      config.expires_in = 30.days
+    end
+    
+Caching will only occur if the config.cacheable AND your Rails application is set to perform_caching. Please note that development environments have caching turned off, so if you want to test locally, make sure you update your development.rb.
+
+That's it! Everything else is automatic!
+
+### Skip Caching
+
+If you want, you can ignore the cached version when fetching a model, to do so, simple do:
+  
+    # Get a fresh copy of the record by bypassing the cached version
+    Post.find(3, cache: false)
+
+### ActiveRecord Collection and Array Helper
+
+There are two active record patches for the ActiveRecord Collections and Array. These allow you to call .cache_key on a collection or an array and receive an MD5 hash for caching:
+
+    # Cache key for all posts
+    Post.published.all.cache_key
+    # => "ba6a3c1d35e7c7d1b4acdcd5330f8891"
+    
+    # Cache key for paginated post collection
+    Post.published.page(params[:page]).per(20)
+    # => "b7ff80c902b673c03b5f195dcf3e492e"
+    
+    # Cache key for Arrays
+    tags = Post.find(3).tags
+    tags.cache_key
+    # => "9d72ecf5ab79e30cfe67fe5ee0b03aa9"
+
+## 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 @@
+require "bundler/gem_tasks"

data/cache_money_millionaire.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cache_money_millionaire/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cache_money_millionaire"
+  spec.version       = CacheMoneyMillionaire::VERSION
+  spec.authors       = ["John Koht"]
+  spec.email         = ["john@kohactive.com"]
+  spec.description   = "Rails ActiveRecord Query Caching like a Millionaire"
+  spec.summary       = "Rails ActiveRecord Query Caching like a Millionaire"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/cache_money_millionaire/config.rb

@@ -0,0 +1,30 @@
+module CacheMoneyMillionaire
+  module Config
+        
+    VALID_OPTION_KEYS = [
+      :cacheable,
+      :expires_in
+    ]
+    
+    attr_accessor *VALID_OPTION_KEYS
+    
+    def configure
+      yield self
+      self
+    end
+    
+    def options
+      options = {}
+      VALID_OPTION_KEYS.each{ |pname| options[pname] = send(pname) }
+      options
+    end
+    
+    # Is the application cacheable? We'll only perform caching if the perform_caching
+    # setting is true
+    def cacheable?
+      Rails.application.config.action_controller.perform_caching and options[:cacheable]
+      #true
+    end
+        
+  end
+end

data/lib/cache_money_millionaire/rails/active_record_patch.rb

@@ -0,0 +1,62 @@
+module ActiveRecord
+  class Base
+    
+    # Include the CacheMoneyMillionaire module
+    extend CacheMoneyMillionaire
+    
+    
+    # Extend the find method for ActiveRecord
+    # This method will create or fetch a record by a cache key. If the record exists in cache
+    # then we fetch it, otherwise, we'll create a cache key for it and store it in memory
+    # To ignore cache, pass cache: false as a parameter
+    
+    def self.find *args
+      # extract the options and see if the :cache: option was passed, and set the skip_cache
+      # variable based on it's validity. Then we'll remove from the arguments and pass
+      # the original arguments back into our hash
+      options = args.extract_options!
+      cache = options.delete(:cache) || true
+      args.push(options)
+      
+      # If it's cacheable and cache isn't set to false, then let's CacheMoneyMillionaire this bitch!
+      # We set the cache key to the object class name and id, i.e. Post 3, User 109, etc.
+      if CacheMoneyMillionaire.cacheable? and cache
+        model = Rails.cache.fetch (Digest::MD5.hexdigest "#{self} #{args[0]}"), expires_in: CacheMoneyMillionaire.options[:expires_in] do
+          super *args
+        end
+      else
+        # if no caching, then let's just ignore and call typical .find method
+        super *args
+      end
+    end
+    
+    
+    # Extend the save method for ActiveRecord
+    # When an object is saved, let's update the cache key (the one we created above) so we can
+    # invalidate our stale cache
+    def save *args
+      self.rewrite_cache
+      super
+    end
+    
+    
+    # Extend the touch method for ActiveRecord
+    # Similar to the save method extention, we'll just hijack the touch method and update the
+    # cache key value with our updated data
+    def touch
+      super
+      self.rewrite_cache
+    end
+    
+    # rewrite the cache for this model
+    def rewrite_cache
+      if CacheMoneyMillionaire.cacheable?
+        cache_key = Digest::MD5.hexdigest "#{self.class.name} #{self.id}"
+        Rails.cache.write cache_key, self
+      else
+        false
+      end
+    end
+         
+  end
+end

data/lib/cache_money_millionaire/rails/cache_key_patch.rb

@@ -0,0 +1,30 @@
+# CacheKey Patch
+# Add cache_key methods to Arrays and ActiveRecord collections which allows us to
+# easily cache sets of data without any problems.
+
+# example: Posts.all.cache_key
+# example: Posts.published.page(params[:page]).per(20).cache_key
+
+# This is great for HTTP caching in the controller, here's a quick example:
+# @posts = Post.scoped.published.page(params[:page]).per(10)	  
+# if stale?(etag: @posts.cache_key, last_modified: @posts.maximum(:updated_at), public: true)
+#   ...
+# end
+
+
+# Extend Array to include a cache_key method
+class Array
+  def cache_key
+    Digest::MD5.hexdigest "#{self.count}-#{self.inspect}"
+  end
+end
+
+
+# Extend ActiveRecord::Base Collections to include a cache_key method
+module ActiveRecord
+  class Base
+    def self.cache_key
+      Digest::MD5.hexdigest "#{scoped.maximum(:updated_at).try(:to_i)}-#{scoped.count}"
+    end
+  end
+end

data/lib/cache_money_millionaire/rails/engine.rb

@@ -0,0 +1,6 @@
+module CacheMoneyMillionaire
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/cache_money_millionaire/version.rb

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

data/lib/cache_money_millionaire.rb

@@ -0,0 +1,20 @@
+require "cache_money_millionaire/version"
+require "cache_money_millionaire/config"
+require "cache_money_millionaire/rails/active_record_patch"
+require "cache_money_millionaire/rails/cache_key_patch"
+
+module CacheMoneyMillionaire
+      
+  extend Config
+  
+  class << self  
+    def initialize attrs={}
+      puts "initialize..."
+      attrs = CacheMoneyMillionaire.options.merge(attrs)
+      Config::VALID_OPTION_KEYS.each do |key|
+        instance_variable_set("@#{key}".to_sym, attrs[key])
+      end
+    end
+  end
+    
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: cache_money_millionaire
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- John Koht
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Rails ActiveRecord Query Caching like a Millionaire
+email:
+- john@kohactive.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cache_money_millionaire.gemspec
+- lib/cache_money_millionaire.rb
+- lib/cache_money_millionaire/config.rb
+- lib/cache_money_millionaire/rails/active_record_patch.rb
+- lib/cache_money_millionaire/rails/cache_key_patch.rb
+- lib/cache_money_millionaire/rails/engine.rb
+- lib/cache_money_millionaire/version.rb
+homepage: ''
+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: Rails ActiveRecord Query Caching like a Millionaire
+test_files: []