Merge branch 'gzip-index' which contains two features:

1) Adding gzip to pages cache, closes #4124

2) Allow scaffold/model/migration generators to accept a "index" and "uniq"
modifiers, as in: "tracking_id:integer:uniq" in order to generate (unique)
indexes. Some types also accept custom options, for instance, you can
specify the precision and scale for decimals as "price:decimal{7,2}".
This feature closes #2555.

4 files changed, 84 insertions, 23 deletions

diff --git a/actionpack/lib/abstract_controller/rendering.rb b/actionpack/lib/abstract_controller/rendering.rb
index d95770c049..9019c07bca 100644
--- a/actionpack/lib/abstract_controller/rendering.rb
+++ b/actionpack/lib/abstract_controller/rendering.rb
@@ -35,7 +35,7 @@ module AbstractController
     include AbstractController::ViewPaths
 
     included do
-      config_accessor :protected_instance_variables, :instance_reader => false
+      class_attribute :protected_instance_variables
       self.protected_instance_variables = []
     end
 
@@ -59,12 +59,6 @@ module AbstractController
 
     attr_internal_writer :view_context_class
 
-    # Explicitly define protected_instance_variables so it can be
-    # inherited and overwritten by other modules if needed.
-    def protected_instance_variables
-      config.protected_instance_variables
-    end
-
     def view_context_class
       @_view_context_class ||= self.class.view_context_class
     end
diff --git a/actionpack/lib/action_controller/caching/pages.rb b/actionpack/lib/action_controller/caching/pages.rb
index 957bb7de6b..159f718029 100644
--- a/actionpack/lib/action_controller/caching/pages.rb
+++ b/actionpack/lib/action_controller/caching/pages.rb
@@ -16,7 +16,7 @@ module ActionController #:nodoc:
     #     caches_page :show, :new
     #   end
     #
-    # This will generate cache files such as <tt>weblog/show/5.html</tt> and <tt>weblog/new.html</tt>, which match the URLs used 
+    # This will generate cache files such as <tt>weblog/show/5.html</tt> and <tt>weblog/new.html</tt>, which match the URLs used
     # that would normally trigger dynamic page generation. Page caching works by configuring a web server to first check for the
     # existence of files on disk, and to serve them directly when found, without passing the request through to Action Pack.
     # This is much faster than handling the full dynamic request in the usual way.
@@ -38,23 +38,25 @@ module ActionController #:nodoc:
       extend ActiveSupport::Concern
 
       included do
-        ##
-        # :singleton-method:
         # The cache directory should be the document root for the web server and is set using <tt>Base.page_cache_directory = "/document/root"</tt>.
         # For Rails, this directory has already been set to Rails.public_path (which is usually set to <tt>Rails.root + "/public"</tt>). Changing
         # this setting can be useful to avoid naming conflicts with files in <tt>public/</tt>, but doing so will likely require configuring your
         # web server to look in the new location for cached files.
-        config_accessor :page_cache_directory
+        class_attribute :page_cache_directory
         self.page_cache_directory ||= ''
 
-        ##
-        # :singleton-method:
         # Most Rails requests do not have an extension, such as <tt>/weblog/new</tt>. In these cases, the page caching mechanism will add one in
         # order to make it easy for the cached files to be picked up properly by the web server. By default, this cache extension is <tt>.html</tt>.
         # If you want something else, like <tt>.php</tt> or <tt>.shtml</tt>, just set Base.page_cache_extension. In cases where a request already has an
         # extension, such as <tt>.xml</tt> or <tt>.rss</tt>, page caching will not add an extension. This allows it to work well with RESTful apps.
-        config_accessor :page_cache_extension
+        class_attribute :page_cache_extension
         self.page_cache_extension ||= '.html'
+
+        # The compression used for gzip. If false (default), the page is not compressed.
+        # If can be a symbol showing the ZLib compression method, for example, :best_compression
+        # or :best_speed or an integer configuring the compression level.
+        class_attribute :page_cache_compression
+        self.page_cache_compression ||= false
       end
 
       module ClassMethods
@@ -66,24 +68,31 @@ module ActionController #:nodoc:
 
           instrument_page_cache :expire_page, path do
             File.delete(path) if File.exist?(path)
+            File.delete(path + '.gz') if File.exist?(path + '.gz')
           end
         end
 
         # Manually cache the +content+ in the key determined by +path+. Example:
         #   cache_page "I'm the cached content", "/lists/show"
-        def cache_page(content, path, extension = nil)
+        def cache_page(content, path, extension = nil, gzip = Zlib::BEST_COMPRESSION)
           return unless perform_caching
           path = page_cache_path(path, extension)
 
           instrument_page_cache :write_page, path do
             FileUtils.makedirs(File.dirname(path))
             File.open(path, "wb+") { |f| f.write(content) }
+            if gzip
+              Zlib::GzipWriter.open(path + '.gz', gzip) { |f| f.write(content) }
+            end
           end
         end
 
-        # Caches the +actions+ using the page-caching approach that'll store the cache in a path within the page_cache_directory that
+        # Caches the +actions+ using the page-caching approach that'll store
+        # the cache in a path within the page_cache_directory that
         # matches the triggering url.
         #
+        # You can also pass a :gzip option to override the class configuration one.
+        #
         # Usage:
         #
         #   # cache the index action
@@ -91,10 +100,28 @@ module ActionController #:nodoc:
         #
         #   # cache the index action except for JSON requests
         #   caches_page :index, :if => Proc.new { |c| !c.request.format.json? }
+        #
+        #   # don't gzip images
+        #   caches_page :image, :gzip => false
         def caches_page(*actions)
           return unless perform_caching
           options = actions.extract_options!
-          after_filter({:only => actions}.merge(options)) { |c| c.cache_page }
+
+          gzip_level = options.fetch(:gzip, page_cache_compression)
+          gzip_level = case gzip_level
+          when Symbol
+            Zlib.const_get(gzip_level.to_s.upcase)
+          when Fixnum
+            gzip_level
+          when false
+            nil
+          else
+            Zlib::BEST_COMPRESSION
+          end
+
+          after_filter({:only => actions}.merge(options)) do |c|
+            c.cache_page(nil, nil, gzip_level)
+          end
         end
 
         private
@@ -136,7 +163,7 @@ module ActionController #:nodoc:
       # Manually cache the +content+ in the key determined by +options+. If no content is provided, the contents of response.body is used.
       # If no options are provided, the url of the current request being handled is used. Example:
       #   cache_page "I'm the cached content", :controller => "lists", :action => "show"
-      def cache_page(content = nil, options = nil)
+      def cache_page(content = nil, options = nil, gzip = Zlib::BEST_COMPRESSION)
         return unless self.class.perform_caching && caching_allowed?
 
         path = case options
@@ -152,7 +179,7 @@ module ActionController #:nodoc:
           extension = ".#{type_symbol}"
         end
 
-        self.class.cache_page(content || response.body, path, extension)
+        self.class.cache_page(content || response.body, path, extension, gzip)
       end
 
     end
diff --git a/actionpack/lib/action_controller/metal/helpers.rb b/actionpack/lib/action_controller/metal/helpers.rb
index bd515bba82..50d7aac300 100644
--- a/actionpack/lib/action_controller/metal/helpers.rb
+++ b/actionpack/lib/action_controller/metal/helpers.rb
@@ -56,7 +56,7 @@ module ActionController
     include AbstractController::Helpers
 
     included do
-      config_accessor :helpers_path, :include_all_helpers
+      class_attribute :helpers_path, :include_all_helpers
       self.helpers_path ||= []
       self.include_all_helpers = true
     end
diff --git a/actionpack/test/controller/caching_test.rb b/actionpack/test/controller/caching_test.rb
index 015e6b9955..34a38a5567 100644
--- a/actionpack/test/controller/caching_test.rb
+++ b/actionpack/test/controller/caching_test.rb
@@ -14,10 +14,14 @@ class CachingController < ActionController::Base
 end
 
 class PageCachingTestController < CachingController
+  self.page_cache_compression = :best_compression
+
   caches_page :ok, :no_content, :if => Proc.new { |c| !c.request.format.json? }
   caches_page :found, :not_found
   caches_page :about_me
-
+  caches_page :default_gzip
+  caches_page :no_gzip, :gzip => false
+  caches_page :gzip_level, :gzip => :best_speed
 
   def ok
     head :ok
@@ -40,6 +44,18 @@ class PageCachingTestController < CachingController
     cache_page("Super soaker", "/index.html")
   end
 
+  def default_gzip
+    render :text => "Text"
+  end
+
+  def no_gzip
+    render :text => "PNG"
+  end
+
+  def gzip_level
+    render :text => "Big text"
+  end
+
   def expire_custom_path
     expire_page("/index.html")
     head :ok
@@ -115,6 +131,30 @@ class PageCachingTest < ActionController::TestCase
     assert !File.exist?("#{FILE_STORE_PATH}/index.html")
   end
 
+  def test_should_gzip_cache
+    get :custom_path
+    assert File.exist?("#{FILE_STORE_PATH}/index.html.gz")
+
+    get :expire_custom_path
+    assert !File.exist?("#{FILE_STORE_PATH}/index.html.gz")
+  end
+
+  def test_should_allow_to_disable_gzip
+    get :no_gzip
+    assert File.exist?("#{FILE_STORE_PATH}/page_caching_test/no_gzip.html")
+    assert !File.exist?("#{FILE_STORE_PATH}/page_caching_test/no_gzip.html.gz")
+  end
+
+  def test_should_use_config_gzip_by_default
+    @controller.expects(:cache_page).with(nil, nil, Zlib::BEST_COMPRESSION)
+    get :default_gzip
+  end
+
+  def test_should_set_gzip_level
+    @controller.expects(:cache_page).with(nil, nil, Zlib::BEST_SPEED)
+    get :gzip_level
+  end
+
   def test_should_cache_without_trailing_slash_on_url
     @controller.class.cache_page 'cached content', '/page_caching_test/trailing_slash'
     assert File.exist?("#{FILE_STORE_PATH}/page_caching_test/trailing_slash.html")
@@ -194,7 +234,7 @@ class ActionCachingTestController < CachingController
   caches_action :show, :cache_path => 'http://test.host/custom/show'
   caches_action :edit, :cache_path => Proc.new { |c| c.params[:id] ? "http://test.host/#{c.params[:id]};edit" : "http://test.host/edit" }
   caches_action :with_layout
-  caches_action :with_format_and_http_param, :cache_path => Proc.new { |c| { :key => 'value' } } 
+  caches_action :with_format_and_http_param, :cache_path => Proc.new { |c| { :key => 'value' } }
   caches_action :layout_false, :layout => false
   caches_action :record_not_found, :four_oh_four, :simple_runtime_error
 
@@ -224,7 +264,7 @@ class ActionCachingTestController < CachingController
     @cache_this = MockTime.now.to_f.to_s
     render :text => @cache_this
   end
-  
+
   def record_not_found
     raise ActiveRecord::RecordNotFound, "oops!"
   end