actionpack 3.2.22.5 → 5.2.4

data/lib/action_controller/caching/fragments.rb

@@ -1,127 +0,0 @@
-module ActionController #:nodoc:
-  module Caching
-    # Fragment caching is used for caching various blocks within 
-    # views without caching the entire action as a whole. This is
-    # useful when certain elements of an action change frequently or 
-    # depend on complicated state while other parts rarely change or 
-    # can be shared amongst multiple parties. The caching is done using
-    # the <tt>cache</tt> helper available in the Action View. A 
-    # template with fragment caching might look like:
-    #
-    #   <b>Hello <%= @name %></b>
-    #
-    #   <% cache do %>
-    #     All the topics in the system:
-    #     <%= render :partial => "topic", :collection => Topic.all %>
-    #   <% end %>
-    #
-    # This cache will bind the name of the action that called it, so if
-    # this code was part of the view for the topics/list action, you 
-    # would be able to invalidate it using:
-    #
-    #   expire_fragment(:controller => "topics", :action => "list")
-    #
-    # This default behavior is limited if you need to cache multiple 
-    # fragments per action or if the action itself is cached using 
-    # <tt>caches_action</tt>. To remedy this, there is an option to 
-    # qualify the name of the cached fragment by using the 
-    # <tt>:action_suffix</tt> option:
-    #
-    #   <% cache(:action => "list", :action_suffix => "all_topics") do %>
-    #
-    # That would result in a name such as 
-    # <tt>/topics/list/all_topics</tt>, avoiding conflicts with the 
-    # action cache and with any fragments that use a different suffix.
-    # Note that the URL doesn't have to really exist or be callable
-    # - the url_for system is just used to generate unique cache names
-    # that we can refer to when we need to expire the cache.
-    #
-    # The expiration call for this example is:
-    #
-    #   expire_fragment(:controller => "topics", 
-    #                   :action => "list", 
-    #                   :action_suffix => "all_topics")
-    module Fragments
-      # Given a key (as described in <tt>expire_fragment</tt>), returns
-      # a key suitable for use in reading, writing, or expiring a 
-      # cached fragment. If the key is a hash, the generated key is the
-      # return value of url_for on that hash (without the protocol). 
-      # All keys are prefixed with <tt>views/</tt> and uses
-      # ActiveSupport::Cache.expand_cache_key for the expansion.
-      def fragment_cache_key(key)
-        ActiveSupport::Cache.expand_cache_key(key.is_a?(Hash) ? url_for(key).split("://").last : key, :views)
-      end
-
-      # Writes <tt>content</tt> to the location signified by 
-      # <tt>key</tt> (see <tt>expire_fragment</tt> for acceptable formats).
-      def write_fragment(key, content, options = nil)
-        return content unless cache_configured?
-
-        key = fragment_cache_key(key)
-        instrument_fragment_cache :write_fragment, key do
-          content = content.to_str
-          cache_store.write(key, content, options)
-        end
-        content
-      end
-
-      # Reads a cached fragment from the location signified by <tt>key</tt>
-      # (see <tt>expire_fragment</tt> for acceptable formats).
-      def read_fragment(key, options = nil)
-        return unless cache_configured?
-
-        key = fragment_cache_key(key)
-        instrument_fragment_cache :read_fragment, key do
-          result = cache_store.read(key, options)
-          result.respond_to?(:html_safe) ? result.html_safe : result
-        end
-      end
-
-      # Check if a cached fragment from the location signified by 
-      # <tt>key</tt> exists (see <tt>expire_fragment</tt> for acceptable formats)
-      def fragment_exist?(key, options = nil)
-        return unless cache_configured?
-        key = fragment_cache_key(key)
-
-        instrument_fragment_cache :exist_fragment?, key do
-          cache_store.exist?(key, options)
-        end
-      end
-
-      # Removes fragments from the cache.
-      #
-      # +key+ can take one of three forms:
-      #
-      # * String - This would normally take the form of a path, like
-      #   <tt>pages/45/notes</tt>.
-      # * Hash - Treated as an implicit call to +url_for+, like
-      #   <tt>{:controller => "pages", :action => "notes", :id => 45}</tt>
-      # * Regexp - Will remove any fragment that matches, so
-      #   <tt>%r{pages/\d*/notes}</tt> might remove all notes. Make sure you
-      #   don't use anchors in the regex (<tt>^</tt> or <tt>$</tt>) because
-      #   the actual filename matched looks like
-      #   <tt>./cache/filename/path.cache</tt>. Note: Regexp expiration is
-      #   only supported on caches that can iterate over all keys (unlike
-      #   memcached).
-      #
-      # +options+ is passed through to the cache store's <tt>delete</tt>
-      # method (or <tt>delete_matched</tt>, for Regexp keys.)
-      def expire_fragment(key, options = nil)
-        return unless cache_configured?
-        key = fragment_cache_key(key) unless key.is_a?(Regexp)
-
-        instrument_fragment_cache :expire_fragment, key do
-          if key.is_a?(Regexp)
-            cache_store.delete_matched(key, options)
-          else
-            cache_store.delete(key, options)
-          end
-        end
-      end
-
-      def instrument_fragment_cache(name, key)
-        ActiveSupport::Notifications.instrument("#{name}.action_controller", :key => key){ yield }
-      end
-    end
-  end
-end

data/lib/action_controller/caching/pages.rb

@@ -1,187 +0,0 @@
-require 'fileutils'
-require 'active_support/core_ext/class/attribute_accessors'
-
-module ActionController #:nodoc:
-  module Caching
-    # Page caching is an approach to caching where the entire action output of is stored as a HTML file that the web server
-    # can serve without going through Action Pack. This is the fastest way to cache your content as opposed to going dynamically
-    # through the process of generating the content. Unfortunately, this incredible speed-up is only available to stateless pages
-    # where all visitors are treated the same. Content management systems -- including weblogs and wikis -- have many pages that are
-    # a great fit for this approach, but account-based systems where people log in and manipulate their own data are often less
-    # likely candidates.
-    #
-    # Specifying which actions to cache is done through the <tt>caches_page</tt> class method:
-    #
-    #   class WeblogController < ActionController::Base
-    #     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
-    # 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.
-    #
-    # Expiration of the cache is handled by deleting the cached file, which results in a lazy regeneration approach where the cache
-    # is not restored before another hit is made against it. The API for doing so mimics the options from +url_for+ and friends:
-    #
-    #   class WeblogController < ActionController::Base
-    #     def update
-    #       List.update(params[:list][:id], params[:list])
-    #       expire_page :action => "show", :id => params[:list][:id]
-    #       redirect_to :action => "show", :id => params[:list][:id]
-    #     end
-    #   end
-    #
-    # Additionally, you can expire caches using Sweepers that act on changes in the model to determine when a cache is supposed to be
-    # expired.
-    module Pages
-      extend ActiveSupport::Concern
-
-      included do
-        # 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.
-        class_attribute :page_cache_directory
-        self.page_cache_directory ||= ''
-
-        # 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.
-        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
-        # Expires the page that was cached with the +path+ as a key. Example:
-        #   expire_page "/lists/show"
-        def expire_page(path)
-          return unless perform_caching
-          path = page_cache_path(path)
-
-          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, 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
-        # matches the triggering url.
-        #
-        # You can also pass a :gzip option to override the class configuration one.
-        #
-        # Usage:
-        #
-        #   # cache the index action
-        #   caches_page :index
-        #
-        #   # 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!
-
-          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
-          def page_cache_file(path, extension)
-            name = (path.empty? || path == "/") ? "/index" : URI.parser.unescape(path.chomp('/'))
-            unless (name.split('/').last || name).include? '.'
-              name << (extension || self.page_cache_extension)
-            end
-            return name
-          end
-
-          def page_cache_path(path, extension = nil)
-            page_cache_directory.to_s + page_cache_file(path, extension)
-          end
-
-          def instrument_page_cache(name, path)
-            ActiveSupport::Notifications.instrument("#{name}.action_controller", :path => path){ yield }
-          end
-      end
-
-      # Expires the page that was cached with the +options+ as a key. Example:
-      #   expire_page :controller => "lists", :action => "show"
-      def expire_page(options = {})
-        return unless self.class.perform_caching
-
-        if options.is_a?(Hash)
-          if options[:action].is_a?(Array)
-            options[:action].each do |action|
-              self.class.expire_page(url_for(options.merge(:only_path => true, :action => action)))
-            end
-          else
-            self.class.expire_page(url_for(options.merge(:only_path => true)))
-          end
-        else
-          self.class.expire_page(options)
-        end
-      end
-
-      # 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, gzip = Zlib::BEST_COMPRESSION)
-        return unless self.class.perform_caching && caching_allowed?
-
-        path = case options
-          when Hash
-            url_for(options.merge(:only_path => true, :format => params[:format]))
-          when String
-            options
-          else
-            request.path
-        end
-
-        if (type = Mime::LOOKUP[self.content_type]) && (type_symbol = type.symbol).present?
-          extension = ".#{type_symbol}"
-        end
-
-        self.class.cache_page(content || response.body, path, extension, gzip)
-      end
-
-    end
-  end
-end

data/lib/action_controller/caching/sweeping.rb

@@ -1,97 +0,0 @@
-module ActionController #:nodoc:
-  module Caching
-    # Sweepers are the terminators of the caching world and responsible for expiring caches when model objects change.
-    # They do this by being half-observers, half-filters and implementing callbacks for both roles. A Sweeper example:
-    #
-    #   class ListSweeper < ActionController::Caching::Sweeper
-    #     observe List, Item
-    #
-    #     def after_save(record)
-    #       list = record.is_a?(List) ? record : record.list
-    #       expire_page(:controller => "lists", :action => %w( show public feed ), :id => list.id)
-    #       expire_action(:controller => "lists", :action => "all")
-    #       list.shares.each { |share| expire_page(:controller => "lists", :action => "show", :id => share.url_key) }
-    #     end
-    #   end
-    #
-    # The sweeper is assigned in the controllers that wish to have its job performed using the <tt>cache_sweeper</tt> class method:
-    #
-    #   class ListsController < ApplicationController
-    #     caches_action :index, :show, :public, :feed
-    #     cache_sweeper :list_sweeper, :only => [ :edit, :destroy, :share ]
-    #   end
-    #
-    # In the example above, four actions are cached and three actions are responsible for expiring those caches.
-    #
-    # You can also name an explicit class in the declaration of a sweeper, which is needed if the sweeper is in a module:
-    #
-    #   class ListsController < ApplicationController
-    #     caches_action :index, :show, :public, :feed
-    #     cache_sweeper OpenBar::Sweeper, :only => [ :edit, :destroy, :share ]
-    #   end
-    module Sweeping
-      extend ActiveSupport::Concern
-
-      module ClassMethods #:nodoc:
-        def cache_sweeper(*sweepers)
-          configuration = sweepers.extract_options!
-
-          sweepers.each do |sweeper|
-            ActiveRecord::Base.observers << sweeper if defined?(ActiveRecord) and defined?(ActiveRecord::Base)
-            sweeper_instance = (sweeper.is_a?(Symbol) ? Object.const_get(sweeper.to_s.classify) : sweeper).instance
-
-            if sweeper_instance.is_a?(Sweeper)
-              around_filter(sweeper_instance, :only => configuration[:only])
-            else
-              after_filter(sweeper_instance, :only => configuration[:only])
-            end
-          end
-        end
-      end
-    end
-
-    if defined?(ActiveRecord) and defined?(ActiveRecord::Observer)
-      class Sweeper < ActiveRecord::Observer #:nodoc:
-        attr_accessor :controller
-
-        def before(controller)
-          self.controller = controller
-          callback(:before) if controller.perform_caching
-          true # before method from sweeper should always return true
-        end
-
-        def after(controller)
-          self.controller = controller
-          callback(:after) if controller.perform_caching
-          # Clean up, so that the controller can be collected after this request
-          self.controller = nil
-        end
-
-        protected
-          # gets the action cache path for the given options.
-          def action_path_for(options)
-            Actions::ActionCachePath.new(controller, options).path
-          end
-
-          # Retrieve instance variables set in the controller.
-          def assigns(key)
-            controller.instance_variable_get("@#{key}")
-          end
-
-        private
-          def callback(timing)
-            controller_callback_method_name = "#{timing}_#{controller.controller_name.underscore}"
-            action_callback_method_name     = "#{controller_callback_method_name}_#{controller.action_name}"
-
-            __send__(controller_callback_method_name) if respond_to?(controller_callback_method_name, true)
-            __send__(action_callback_method_name)     if respond_to?(action_callback_method_name, true)
-          end
-
-          def method_missing(method, *arguments, &block)
-            return unless @controller
-            @controller.__send__(method, *arguments, &block)
-          end
-      end
-    end
-  end
-end

data/lib/action_controller/deprecated/integration_test.rb

@@ -1,2 +0,0 @@
-ActionController::Integration = ActionDispatch::Integration
-ActionController::IntegrationTest = ActionDispatch::IntegrationTest

data/lib/action_controller/deprecated/performance_test.rb

@@ -1 +0,0 @@
-ActionController::PerformanceTest = ActionDispatch::PerformanceTest

data/lib/action_controller/deprecated.rb

@@ -1,3 +0,0 @@
-ActionController::AbstractRequest = ActionController::Request = ActionDispatch::Request
-ActionController::AbstractResponse = ActionController::Response = ActionDispatch::Response
-ActionController::Routing = ActionDispatch::Routing

data/lib/action_controller/metal/compatibility.rb

@@ -1,65 +0,0 @@
-require 'active_support/deprecation'
-
-module ActionController
-  module Compatibility
-    extend ActiveSupport::Concern
-
-    # Temporary hax
-    included do
-      ::ActionController::UnknownAction = ActiveSupport::Deprecation::DeprecatedConstantProxy.new('ActionController::UnknownAction', '::AbstractController::ActionNotFound')
-      ::ActionController::DoubleRenderError = ActiveSupport::Deprecation::DeprecatedConstantProxy.new('ActionController::DoubleRenderError', '::AbstractController::DoubleRenderError')
-
-      # ROUTES TODO: This should be handled by a middleware and route generation
-      # should be able to handle SCRIPT_NAME
-      self.config.relative_url_root = ENV['RAILS_RELATIVE_URL_ROOT']
-
-      def self.default_charset=(new_charset)
-        ActiveSupport::Deprecation.warn "Setting default charset at controller level" \
-          " is deprecated, please use `config.action_dispatch.default_charset` instead", caller
-        ActionDispatch::Response.default_charset = new_charset
-      end
-
-      self.protected_instance_variables = %w(
-        @_status @_headers @_params @_env @_response @_request
-        @_view_runtime @_stream @_url_options @_action_has_layout
-      )
-
-      def rescue_action(env)
-        ActiveSupport::Deprecation.warn "Calling `rescue_action` is deprecated and will be removed in Rails 4.0.", caller
-        raise env["action_dispatch.rescue.exception"]
-      end
-    end
-
-    # For old tests
-    def initialize_template_class(*)
-      ActiveSupport::Deprecation.warn "Calling `initialize_template_class` is deprecated and has no effect anymore.", caller
-    end
-
-    def assign_shortcuts(*)
-      ActiveSupport::Deprecation.warn "Calling `assign_shortcuts` is deprecated and has no effect anymore.", caller
-    end
-
-    def _normalize_options(options)
-      options[:text] = nil if options.delete(:nothing) == true
-      options[:text] = " " if options.key?(:text) && options[:text].nil?
-      super
-    end
-
-    def render_to_body(options)
-      options[:template].sub!(/^\//, '') if options.key?(:template)
-      super || " "
-    end
-
-    def _handle_method_missing
-      ActiveSupport::Deprecation.warn "Using `method_missing` to handle non" \
-        " existing actions is deprecated and will be removed in Rails 4.0, " \
-        " please use `action_missing` instead.", caller
-      method_missing(@_action_name.to_sym)
-    end
-
-    def method_for_action(action_name)
-      super || ((self.class.public_method_defined?(:method_missing) ||
-        self.class.protected_method_defined?(:method_missing)) && "_handle_method_missing")
-    end
-  end
-end

data/lib/action_controller/metal/hide_actions.rb

@@ -1,41 +0,0 @@
-require 'active_support/core_ext/class/attribute'
-
-module ActionController
-  # Adds the ability to prevent public methods on a controller to be called as actions.
-  module HideActions
-    extend ActiveSupport::Concern
-
-    included do
-      class_attribute :hidden_actions
-      self.hidden_actions = Set.new.freeze
-    end
-
-  private
-
-    # Overrides AbstractController::Base#action_method? to return false if the
-    # action name is in the list of hidden actions.
-    def method_for_action(action_name)
-      self.class.visible_action?(action_name) && super
-    end
-
-    module ClassMethods
-      # Sets all of the actions passed in as hidden actions.
-      #
-      # ==== Parameters
-      # * <tt>args</tt> - A list of actions
-      def hide_action(*args)
-        self.hidden_actions = hidden_actions.dup.merge(args.map(&:to_s)).freeze
-      end
-
-      def visible_action?(action_name)
-        not hidden_actions.include?(action_name)
-      end
-
-      # Overrides AbstractController::Base#action_methods to remove any methods
-      # that are listed as hidden methods.
-      def action_methods
-        @action_methods ||= Set.new(super.reject { |name| hidden_actions.include?(name) }).freeze
-      end
-    end
-  end
-end

data/lib/action_controller/metal/rack_delegation.rb

@@ -1,26 +0,0 @@
-require 'action_dispatch/http/request'
-require 'action_dispatch/http/response'
-
-module ActionController
-  module RackDelegation
-    extend ActiveSupport::Concern
-
-    delegate :headers, :status=, :location=, :content_type=,
-             :status, :location, :content_type, :to => "@_response"
-
-    def dispatch(action, request, response = ActionDispatch::Response.new)
-      @_response ||= response
-      @_response.request ||= request
-      super(action, request)
-    end
-
-    def response_body=(body)
-      response.body = body if response
-      super
-    end
-
-    def reset_session
-      @_request.reset_session
-    end
-  end
-end