cache_proxy 0.1.1

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Lucas Húngaro
+
+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.textile

@@ -0,0 +1,69 @@
+h1. cache_proxy
+
+A mixin that provides better encapsulation and control when using cache in Rails
+
+Does cache-proxy helps your daily work with Rails? So, "please recommend me in Work With Rails":http://workingwithrails.com/recommendation/new/person/9370-lucas-h-ngaro and thanks for your kindness! :)
+
+h2. Why?
+
+Using the default Rails abstration for caching will scatter calls to Rails.cache all over your code. Also, it isn't trivial to bypass the cache when you need to - most of the time you end up creating two versions of the "same" method: one cached and one uncached. Using cache-proxy you will encapsulate the access to the cache and will be able to bypass the cached result using a hash option.
+
+h2. How?
+
+First, install the gem:
+
+<pre>
+$ [sudo] gem install cache_proxy
+</pre>
+
+Then, add it as a dependency in your code using your favorite way (a simple require or mechanisms like the Bundler gem).
+
+The gem will provide you a module to mixin into the classes the access the cache. For example:
+
+<pre>
+class User < ActiveRecord::Base
+  include CacheProxy
+
+  has_many :search_terms, :dependent => :destroy, :order => "term ASC"
+
+  def saved_search_terms
+    cache_proxy("my_cache_key") do
+      self.search_terms
+    end
+  end
+end
+</pre>
+
+The cache_proxy method gives you the possibility of passing in two options:
+
+<pre>
+	# this will bypass the cache and hit the storage, default is true
+    cache_proxy("my_cache_key", :cached => false) do
+      self.search_terms
+    end
+
+	# time to live, default is 30.days
+    cache_proxy("my_other_cache_key", :cache_expires_in => 2.hours) do
+      self.expensive_canculations
+    end
+</pre>
+
+And... that's it! You can use it both in class and instance methods.
+
+h2. Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+h2. Contributors
+
+This library was implemented in conjuction with "Nando Vieira":http://simplesideias.com.br/, a really great programmer and friend.
+
+h3. Copyright
+
+Copyright (c) 2010 Lucas Húngaro. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,47 @@
+# encoding: utf-8
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "cache_proxy"
+    gem.summary = %Q{A mixin that provides better encapsulation and control when using cache in Rails}
+    gem.description = %Q{A mixin that provides better encapsulation and control when using cache in Rails}
+    gem.email = "lucashungaro@gmail.com"
+    gem.homepage = "http://github.com/lucashungaro/cache_proxy"
+    gem.authors = ["Lucas Húngaro"]
+    gem.add_development_dependency "rspec", ">= 1.3.0"
+    gem.add_development_dependency "mocha", ">= 0.9.8"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cache_proxy #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/cache_proxy.rb

@@ -0,0 +1,33 @@
+require "active_support"
+
+module CacheProxy
+  def self.included(receiver)
+    receiver.extend         ClassMethods
+    receiver.send :include, InstanceMethods
+  end
+
+  module Common
+    def cache_proxy(key, options = {}, &block)
+      options.reverse_merge!({
+        :cached => true,
+        :cache_expires_in => 30.days
+      })
+
+      repository = options[:repository] || Rails.cache
+
+      if options[:cached]
+        repository.fetch(key, :expires_in => options[:cache_expires_in], &block)
+      else
+        yield
+      end
+    end
+  end
+
+  module ClassMethods
+    include Common
+  end
+
+  module InstanceMethods
+    include Common
+  end
+end

data/spec/cache_proxy_spec.rb

@@ -0,0 +1,41 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/fixtures/my_model')
+
+describe CacheProxy do
+  before(:each) do
+    MyModel.send(:include, CacheProxy)
+    @model = MyModel.new
+  end
+
+  context "with the default options" do
+    it "should cache the result" do
+      repository = mock("repository")
+      repository.expects(:fetch)
+
+      @model.my_method({:repository => repository})
+    end
+
+    it "should expire the cache in 30 days" do
+      repository = mock("repository")
+      repository.expects(:fetch).with("my_key", :expires_in => 30.days)
+
+      @model.my_method({:repository => repository})
+    end
+  end
+  
+  context "with user-specified options" do
+    it "should bypass the cache storage if desired by the user" do
+      repository = mock("repository")
+      repository.expects(:fetch).never
+
+      @model.my_method({:repository => repository, :cached => false})
+    end
+
+    it "should expire the cache using the range set by the user" do
+      repository = mock("repository")
+      repository.expects(:fetch).with("my_key", :expires_in => 3.days)
+
+      @model.my_method({:repository => repository, :cache_expires_in => 3.days})
+    end
+  end
+end

data/spec/fixtures/my_model.rb

@@ -0,0 +1,7 @@
+class MyModel
+  def my_method(options = {})
+    cache_proxy("my_key", options) do
+      "Expensive call"
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'cache_proxy'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: cache_proxy
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- "Lucas H\xC3\xBAngaro"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-25 00:00:00 -02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 0
+        - 9
+        - 8
+        version: 0.9.8
+  type: :development
+  version_requirements: *id002
+description: A mixin that provides better encapsulation and control when using cache in Rails
+email: lucashungaro@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- .gitignore
+- LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- lib/cache_proxy.rb
+- spec/cache_proxy_spec.rb
+- spec/fixtures/my_model.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/lucashungaro/cache_proxy
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A mixin that provides better encapsulation and control when using cache in Rails
+test_files: 
+- spec/cache_proxy_spec.rb
+- spec/fixtures/my_model.rb
+- spec/spec_helper.rb