ryanb-render-caching 0.1.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Ryan Bates
+
+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/Manifest

@@ -0,0 +1,12 @@
+CHANGELOG
+lib/render_caching/controller_additions.rb
+lib/render_caching.rb
+LICENSE
+Manifest
+README
+render-caching.gemspec
+spec/render_caching/controller_additions_spec.rb
+spec/spec_helper.rb
+tasks/deployment.rake
+tasks/spec.rake
+TODO

data/README

@@ -0,0 +1,61 @@
+= Render Caching
+
+Cache render calls in Rails controllers.
+
+
+== Install
+
+First install the gem.
+
+  gem install ryanb-render-caching --source=http://gems.github.com
+
+Then specify it in your Rails config.
+
+	gem.config 'ryanb-render-caching', :lib => 'render_caching', :source => 'http://gems.github.com'
+
+Rails 2.1 or later required.
+
+
+== Usage
+
+This gem adds the render_with_cache method to all controllers. Call 
+this inside of an action to cache the view.
+
+	def show
+	  @user = User.find(params[:id])
+	  render_with_cache
+	end
+
+This will cache the full rendered contents into a key matching the URL 
+path (similar to action caching). You can change this key by simply 
+passing any parameter.
+
+	def show
+	  @user = User.find(params[:id])
+	  render_with_cache @user.cache_key
+	end
+
+Cache key is a method supplied by Rails. This includes the updated_at 
+time which will give you an auto-expiring cache when the user record is 
+updated.
+
+You can also supply a block to the render call which will only get 
+executed if there is no cache. Here is a good place to do any custom 
+render calls.
+
+	def show
+	  @user = User.find(params[:id])
+	  render_with_cache @user.cache_key do
+	    render :layout => false
+	  end
+	end
+
+
+== Development
+
+This project can be found on github at the following URL.
+
+http://github.com/ryanb/render-caching/
+
+If you would like to contribute to this project, please fork the 
+repository and send me a pull request.

data/lib/render_caching.rb

@@ -0,0 +1,2 @@
+$:.unshift(File.dirname(__FILE__))
+require 'render_caching/controller_additions'

data/lib/render_caching/controller_additions.rb

@@ -0,0 +1,21 @@
+module RenderCaching
+  module ControllerAdditions
+    private
+    
+    def render_with_cache(key = nil, options = nil)
+      key ||= request.request_uri
+      body = Rails.cache.read(key)
+      if body
+        render :text => body
+      else
+        yield if block_given?
+        render unless performed?
+        Rails.cache.write(key, response.body, options)
+      end
+    end
+  end
+end
+
+class ActionController::Base
+  include RenderCaching::ControllerAdditions
+end

data/render-caching.gemspec

@@ -0,0 +1,50 @@
+
+# Gem::Specification for Render-caching-0.1.1
+# Originally generated by Echoe
+
+Gem::Specification.new do |s|
+  s.name = %q{render-caching}
+  s.version = "0.1.1"
+
+  s.specification_version = 2 if s.respond_to? :specification_version=
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ryan Bates"]
+  s.date = %q{2008-06-19}
+  s.description = %q{Cache render calls in Rails controllers.}
+  s.email = %q{ryan (at) railscasts (dot) com}
+  s.extra_rdoc_files = ["CHANGELOG", "lib/render_caching/controller_additions.rb", "lib/render_caching.rb", "LICENSE", "README", "tasks/deployment.rake", "tasks/spec.rake", "TODO"]
+  s.files = ["CHANGELOG", "lib/render_caching/controller_additions.rb", "lib/render_caching.rb", "LICENSE", "Manifest", "README", "render-caching.gemspec", "spec/render_caching/controller_additions_spec.rb", "spec/spec_helper.rb", "tasks/deployment.rake", "tasks/spec.rake", "TODO"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/ryanb/render-caching}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Render-caching", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{render-caching}
+  s.rubygems_version = %q{1.0.0}
+  s.summary = %q{Cache render calls in Rails controllers.}
+end
+
+
+# # Original Rakefile source (requires the Echoe gem):
+# 
+# require 'rubygems'
+# require 'rake'
+#  
+# begin
+#   require 'echoe'
+# 
+#   Echoe.new('render-caching', '0.1.1') do |p|
+#     p.summary        = "Cache render calls in Rails controllers."
+#     p.description    = "Cache render calls in Rails controllers."
+#     p.url            = "http://github.com/ryanb/render-caching"
+#     p.author         = 'Ryan Bates'
+#     p.email          = "ryan (at) railscasts (dot) com"
+#     p.ignore_pattern = ["script/*"]
+#   end
+# 
+# rescue LoadError => boom
+#   puts "You are missing a dependency required for meta-operations on this gem."
+#   puts "#{boom.to_s.capitalize}."
+# end
+# 
+# Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/spec/render_caching/controller_additions_spec.rb

@@ -0,0 +1,82 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+# stub the Rails module functionality
+RAILS_CACHE = ActiveSupport::Cache.lookup_store(:memory_store)
+module Rails
+  def self.cache
+    RAILS_CACHE
+  end
+end
+
+describe ActionController::Base do
+  it "should have render_with_cache private method" do
+    ActionController::Base.new.private_methods.should include('render_with_cache')
+  end
+end
+
+
+describe RenderCaching::ControllerAdditions do
+  include RenderCaching::ControllerAdditions
+  
+  before(:each) do
+    Rails.cache.clear
+    @request = stub
+    @response = stub(:body => '')
+    stubs(:request).returns(@request)
+    stubs(:response).returns(@response)
+    stubs(:performed?)
+    stubs(:render)
+  end
+  
+  it "should read from the cache with request uri as key and render that text" do
+    @request.stubs(:request_uri).returns('/foo/bar')
+    Rails.cache.write('/foo/bar', 'page content')
+    expects(:render).with(:text => 'page content')
+    render_with_cache
+  end
+  
+  it "should read from the cache with custom passed key and render that text" do
+    Rails.cache.write('my_key', 'page content')
+    expects(:render).with(:text => 'page content')
+    render_with_cache 'my_key'
+  end
+  
+  it "should save response.body to cache as key when not specified" do
+    @response.stubs(:body).returns('content')
+    render_with_cache 'some_key'
+    Rails.cache.read('some_key').should == 'content'
+  end
+  
+  it "should call render when not cached or rendered yet" do
+    stubs(:performed?).returns(false)
+    expects(:render).with()
+    render_with_cache 'some_key'
+  end
+  
+  it "should not call render if already rendered" do
+    stubs(:performed?).returns(true)
+    stubs(:render).raises('should not be called')
+    lambda { render_with_cache 'some_key' }.should_not raise_error
+  end
+  
+  it "should not call render :text if cache doesn't exist" do
+    stubs(:render).with(:text => @response.body).raises('should not be called')
+    lambda { render_with_cache 'some_key' }.should_not raise_error
+  end
+  
+  it "should yield to block when not cached" do
+    pass = false
+    render_with_cache('some_key') { pass = true }
+    pass.should be_true
+  end
+  
+  it "should not yield to block when cached" do
+    Rails.cache.write('some_key', 'page content')
+    render_with_cache('some_key') { violated('block was executed') }
+  end
+  
+  it "should pass options to cache write call" do
+    Rails.cache.expects(:write).with('some_key', @response.body, :expires_in => 5)
+    render_with_cache('some_key', :expires_in => 5)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'spec'
+require 'active_support'
+require 'active_record'
+require 'action_controller'
+require 'action_view'
+require File.dirname(__FILE__) + '/../lib/render_caching.rb'
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end

data/tasks/deployment.rake

@@ -0,0 +1,2 @@
+desc "Build the manifest and gemspec files."
+task :build => [:build_manifest, :build_gemspec]

data/tasks/spec.rake

@@ -0,0 +1,9 @@
+require 'spec/rake/spectask'
+
+spec_files = Rake::FileList["spec/**/*_spec.rb"]
+
+desc "Run specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = spec_files
+  t.spec_opts = ["-c"]
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: ryanb-render-caching
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Ryan Bates
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-19 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Cache render calls in Rails controllers.
+email: ryan (at) railscasts (dot) com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- lib/render_caching/controller_additions.rb
+- lib/render_caching.rb
+- LICENSE
+- README
+- tasks/deployment.rake
+- tasks/spec.rake
+- TODO
+files: 
+- CHANGELOG
+- lib/render_caching/controller_additions.rb
+- lib/render_caching.rb
+- LICENSE
+- Manifest
+- README
+- render-caching.gemspec
+- spec/render_caching/controller_additions_spec.rb
+- spec/spec_helper.rb
+- tasks/deployment.rake
+- tasks/spec.rake
+- TODO
+has_rdoc: true
+homepage: http://github.com/ryanb/render-caching
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Render-caching
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: render-caching
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Cache render calls in Rails controllers.
+test_files: []
+