From a2f3684cecb361db2bf5f7ec0b6de0603868ffd5 Mon Sep 17 00:00:00 2001
From: Yehuda Katz + Carl Lerche <ykatz+clerche@engineyard.com>
Date: Mon, 11 May 2009 10:57:59 -0700
Subject: Ported fresh_when into a ConditionalGet module

---
 actionpack/lib/action_controller/new_base.rb       |  1 +
 actionpack/lib/action_controller/new_base/base.rb  |  1 +
 .../action_controller/new_base/conditional_get.rb  | 42 ++++++++++++++++++++++
 .../lib/action_controller/new_base/testing.rb      |  1 +
 4 files changed, 45 insertions(+)
 create mode 100644 actionpack/lib/action_controller/new_base/conditional_get.rb

(limited to 'actionpack/lib')

diff --git a/actionpack/lib/action_controller/new_base.rb b/actionpack/lib/action_controller/new_base.rb
index 7098b812f6..8a7de1476c 100644
--- a/actionpack/lib/action_controller/new_base.rb
+++ b/actionpack/lib/action_controller/new_base.rb
@@ -1,5 +1,6 @@
 module ActionController
   autoload :Base,                 "action_controller/new_base/base"
+  autoload :ConditionalGet,       "action_controller/new_base/conditional_get"
   autoload :HideActions,          "action_controller/new_base/hide_actions"
   autoload :Http,                 "action_controller/new_base/http"
   autoload :Layouts,              "action_controller/new_base/layouts"
diff --git a/actionpack/lib/action_controller/new_base/base.rb b/actionpack/lib/action_controller/new_base/base.rb
index 8af6ffbc92..40f507b6e7 100644
--- a/actionpack/lib/action_controller/new_base/base.rb
+++ b/actionpack/lib/action_controller/new_base/base.rb
@@ -10,6 +10,7 @@ module ActionController
     use ActionController::UrlFor
     use ActionController::Renderer
     use ActionController::Layouts
+    use ActionController::ConditionalGet
     
     # Legacy modules
     include SessionManagement
diff --git a/actionpack/lib/action_controller/new_base/conditional_get.rb b/actionpack/lib/action_controller/new_base/conditional_get.rb
new file mode 100644
index 0000000000..16104c51fc
--- /dev/null
+++ b/actionpack/lib/action_controller/new_base/conditional_get.rb
@@ -0,0 +1,42 @@
+module ActionController
+  module ConditionalGet
+    
+    # Sets the etag, last_modified, or both on the response and renders a
+    # "304 Not Modified" response if the request is already fresh.
+    #
+    # Parameters:
+    # * <tt>:etag</tt>
+    # * <tt>:last_modified</tt> 
+    # * <tt>:public</tt> By default the Cache-Control header is private, set this to true if you want your application to be cachable by other devices (proxy caches).
+    #
+    # Example:
+    #
+    #   def show
+    #     @article = Article.find(params[:id])
+    #     fresh_when(:etag => @article, :last_modified => @article.created_at.utc, :public => true)
+    #   end
+    #
+    # This will render the show template if the request isn't sending a matching etag or
+    # If-Modified-Since header and just a "304 Not Modified" response if there's a match.
+    #    
+    def fresh_when(options)
+      options.assert_valid_keys(:etag, :last_modified, :public)
+
+      response.etag          = options[:etag]          if options[:etag]
+      response.last_modified = options[:last_modified] if options[:last_modified]
+      
+      if options[:public] 
+        cache_control = response.headers["Cache-Control"].split(",").map {|k| k.strip }
+        cache_control.delete("private")
+        cache_control.delete("no-cache")
+        cache_control << "public"
+        response.headers["Cache-Control"] = cache_control.join(', ')
+      end
+
+      if request.fresh?(response)
+        head :not_modified
+      end
+    end    
+    
+  end
+end
\ No newline at end of file
diff --git a/actionpack/lib/action_controller/new_base/testing.rb b/actionpack/lib/action_controller/new_base/testing.rb
index 428f339b3d..181c5c0ecd 100644
--- a/actionpack/lib/action_controller/new_base/testing.rb
+++ b/actionpack/lib/action_controller/new_base/testing.rb
@@ -7,6 +7,7 @@ module ActionController
       @_response = response
       ret = process(request.parameters[:action])
       @_response.body = self.response_body
+      @_response.prepare!
       set_test_assigns
       ret
     end
-- 
cgit v1.2.3