cache_lookup 0.0.2

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.rvmrc
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+*~
+

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tom Fakes
+
+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,79 @@
+# CacheLookup
+
+Provide an alternative to **ActiveRecord#find** that uses the Rails cache to store retrieved items to reduce database load and increase
+performance for subsequent lookups for the same item.  **CacheLookup** also provides cache expiry for items when they are updated
+or deleted from teh database. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cache_lookup'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cache_lookup
+
+## Quick Start
+
+In your ActiveRecord model:
+
+```ruby
+class Article < ActiveRecord::Base
+
+  cache_lookup :id
+  cache_lookup :slug
+
+end
+```
+
+In your controller:
+
+```ruby
+class ArticleController < ApplicationController
+  
+  def show
+    @article = Article.lookup_by_id(params[:id])
+  end
+end
+```
+
+## Usage
+
+#### cache_lookup(attribute)
+
+Defines the attribute to use as the cache key, and for reading from the database.  The attribute must return a single item when queried, otherwise 
+cache expiry will be broken.
+
+Typically, the attribute will be 'id', but can be any attribute on the model.
+
+```ruby
+class Article < ActiveRecord::Base
+
+  cache_lookup :id
+
+end
+```
+
+#### Model#lookup_by_<attribute>
+
+The method **lookup_by_<attribute>** will be added to your model.  In the above example, this will be **lookup_by_id**.  When used with the 'id' attribute,
+this can be a direct replacement for Model.find(id).
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Credits
+
+[<img src="http://d1za39ny3bo0r4.cloudfront.net/assets/craz8-logo-8e807e1c44376d564da419a6d82ec5be.png">](http://craz8.com)
+
+CacheLookup is maintained by CRAZ8

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/cache_lookup.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/cache_lookup/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Tom Fakes"]
+  gem.email         = ["craz8@tomandlisa.us"]
+  gem.description   = "Provide a cache system for single ActiveRecord objects with expiry on update and delete"
+  gem.summary       = "Cached lookup of ActiveRecord objects with expiry on update"
+  gem.homepage      = ""
+
+  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.name          = "cache_lookup"
+  gem.require_paths = ["lib"]
+  gem.version       = CacheLookup::VERSION
+
+  gem.add_dependency "activesupport", ">= 3.0"
+  gem.add_dependency "rails", ">= 3.0"
+end

data/lib/cache_lookup.rb

@@ -0,0 +1,36 @@
+require "cache_lookup/version"
+require 'active_support/core_ext'
+require 'active_support/cache'
+
+require 'cache_lookup/railtie.rb' if defined?(Rails)
+
+module CacheLookup
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def cache_lookup(attribute)
+
+      # post.clear_id_cache
+      define_method("clear_#{attribute}_cache") do
+        Rails.cache.delete self.class.send("cache_key_for_#{attribute}", send("#{attribute}"))
+      end
+
+      # ActiveRecord callbacks on Save and Destroy to clear the cache
+      after_commit "clear_#{attribute}_cache".to_sym
+      after_destroy "clear_#{attribute}_cache".to_sym
+
+      # Post.lookup_by_id
+      define_singleton_method("lookup_by_#{attribute}") do |param|
+        Rails.cache.fetch(send("cache_key_for_#{attribute}", param)) do
+          where(attribute => param).first
+        end
+      end
+
+      # Post.cache_key_for_id
+      define_singleton_method("cache_key_for_#{attribute}") do |param|
+        "#{name}:#{attribute}:" + param.to_s
+      end
+    end
+  end
+
+end

data/lib/cache_lookup/railtie.rb

@@ -0,0 +1,11 @@
+module CacheLookup
+  class Railtie < ::Rails::Railtie
+
+    initializer 'cache_lookup.initialize' do
+      ActiveSupport.on_load(:active_record) do
+        ActiveRecord::Base.send :include, CacheLookup
+      end
+    end
+
+  end
+end

data/lib/cache_lookup/version.rb

@@ -0,0 +1,3 @@
+module CacheLookup
+  VERSION = "0.0.2"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: cache_lookup
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Tom Fakes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Provide a cache system for single ActiveRecord objects with expiry on
+  update and delete
+email:
+- craz8@tomandlisa.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- cache_lookup.gemspec
+- lib/cache_lookup.rb
+- lib/cache_lookup/railtie.rb
+- lib/cache_lookup/version.rb
+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.24
+signing_key: 
+specification_version: 3
+summary: Cached lookup of ActiveRecord objects with expiry on update
+test_files: []