From e460e7cac076664999a1642cb86a179bdb8e83e0 Mon Sep 17 00:00:00 2001 From: schneems Date: Tue, 5 Aug 2014 11:45:44 -0500 Subject: [ci skip] Document PublicExceptions middleware --- actionpack/lib/action_dispatch/middleware/public_exceptions.rb | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'actionpack/lib') diff --git a/actionpack/lib/action_dispatch/middleware/public_exceptions.rb b/actionpack/lib/action_dispatch/middleware/public_exceptions.rb index 6c8944e067..3664e38af9 100644 --- a/actionpack/lib/action_dispatch/middleware/public_exceptions.rb +++ b/actionpack/lib/action_dispatch/middleware/public_exceptions.rb @@ -1,4 +1,14 @@ module ActionDispatch + # When called, this middleware renders an error page. By default if an html + # response is expected it will render static error pages from the `/public` + # directory. For example when this middleware receives a 500 response it will + # render the template found in `/public/500.html`. + # If an internationalized locale is set, this middleware will attempt to render + # the template in `/public/500..html`. If an internationalized template + # is not found it will fall back on `/public/500.html`. + # + # When a request with a content type other than HTML is made, this middleware + # will attempt to convert error information into the appropriate response type. class PublicExceptions attr_accessor :public_path -- cgit v1.2.3 From 658b40e20713d76699e676a4a5afc818ff26b595 Mon Sep 17 00:00:00 2001 From: schneems Date: Tue, 5 Aug 2014 12:16:46 -0500 Subject: [ci skip] document ActionDispatch::FileHandler --- actionpack/lib/action_dispatch/middleware/static.rb | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'actionpack/lib') diff --git a/actionpack/lib/action_dispatch/middleware/static.rb b/actionpack/lib/action_dispatch/middleware/static.rb index 2764584fe9..7d75cf96f1 100644 --- a/actionpack/lib/action_dispatch/middleware/static.rb +++ b/actionpack/lib/action_dispatch/middleware/static.rb @@ -2,6 +2,16 @@ require 'rack/utils' require 'active_support/core_ext/uri' module ActionDispatch + # This middleware returns a file's contents from disk in the body response. + # When initialized it can accept an optional 'Cache-Control' header which + # will be set when a response containing a file's contents is delivered. + # + # This middleware will render the file specified in `env["PATH_INFO"]` + # where the base path is in the +root+ directory. For example if the +root+ + # is set to `public/` then a request with `env["PATH_INFO"]` of + # `assets/application.js` will return a response with contents of a file + # located at `public/assets/application.js` if the file exists. If the file + # does not exist a 404 "File not Found" response will be returned. class FileHandler def initialize(root, cache_control) @root = root.chomp('/') -- cgit v1.2.3 From a9a6423fd654ee2ad8f1c6bfb63bd169880c9a0c Mon Sep 17 00:00:00 2001 From: schneems Date: Tue, 5 Aug 2014 12:17:03 -0500 Subject: [ci skip] Document ActionDispatch::Static --- actionpack/lib/action_dispatch/middleware/static.rb | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'actionpack/lib') diff --git a/actionpack/lib/action_dispatch/middleware/static.rb b/actionpack/lib/action_dispatch/middleware/static.rb index 7d75cf96f1..25e32cdef8 100644 --- a/actionpack/lib/action_dispatch/middleware/static.rb +++ b/actionpack/lib/action_dispatch/middleware/static.rb @@ -55,6 +55,15 @@ module ActionDispatch end end + # This middleware will attempt to return the contents of a file's body from + # disk in the response. If a file is not found on disk, the request will be + # delegated to the application stack. This middleware is commonly initialized + # to serve assets from a server's `public/` directory. + # + # This middleware verifies the path to ensure that only files + # living in the root directory can be rendered. A request cannot + # produce a directory traversal using this middleware. Only 'GET' and 'HEAD' + # requests will result in a file being returned. class Static def initialize(app, path, cache_control=nil) @app = app -- cgit v1.2.3 From 71c7fd101324046995d8f7e51e78475c0e37ec1a Mon Sep 17 00:00:00 2001 From: Hendy Tanata Date: Fri, 8 Aug 2014 14:25:18 -0700 Subject: Uppercase HTML in docs. [skip ci] --- actionpack/lib/action_controller/metal/mime_responds.rb | 14 +++++++------- .../action_controller/metal/request_forgery_protection.rb | 4 ++-- .../lib/action_dispatch/middleware/public_exceptions.rb | 2 +- 3 files changed, 10 insertions(+), 10 deletions(-) (limited to 'actionpack/lib') diff --git a/actionpack/lib/action_controller/metal/mime_responds.rb b/actionpack/lib/action_controller/metal/mime_responds.rb index 00e7e980f8..e323f19ca0 100644 --- a/actionpack/lib/action_controller/metal/mime_responds.rb +++ b/actionpack/lib/action_controller/metal/mime_responds.rb @@ -285,7 +285,7 @@ module ActionController #:nodoc: # e.g. index.html.erb. If no template is available, the behavior # depends on the selected format: # - # * for an html response - if the request method is +get+, an exception + # * for an HTML response - if the request method is +get+, an exception # is raised but for other requests such as +post+ the response # depends on whether the resource has any validation errors (i.e. # assuming that an attempt has been made to save the resource, @@ -334,12 +334,12 @@ module ActionController #:nodoc: # # As outlined above, the +resources+ argument passed to +respond_with+ # can play two roles. It can be used to generate the redirect url - # for successful html requests (e.g. for +create+ actions when - # no template exists), while for formats other than html and JavaScript + # for successful HTML requests (e.g. for +create+ actions when + # no template exists), while for formats other than HTML and JavaScript # it is the object that gets rendered, by being converted directly to the # required format (again assuming no template exists). # - # For redirecting successful html requests, +respond_with+ also supports + # For redirecting successful HTML requests, +respond_with+ also supports # the use of nested resources, which are supplied in the same way as # in form_for and polymorphic_url. For example - # @@ -351,7 +351,7 @@ module ActionController #:nodoc: # end # # This would cause +respond_with+ to redirect to project_task_url - # instead of task_url. For request formats other than html or + # instead of task_url. For request formats other than HTML or # JavaScript, if multiple resources are passed in this way, it is the last # one specified that is rendered. # @@ -384,9 +384,9 @@ module ActionController #:nodoc: # # Two additional options are relevant specifically to +respond_with+ - # 1. :location - overwrites the default redirect location used after - # a successful html +post+ request. + # a successful HTML +post+ request. # 2. :action - overwrites the default render action used after an - # unsuccessful html +post+ request. + # unsuccessful HTML +post+ request. def respond_with(*resources, &block) if self.class.mimes_for_respond_to.empty? raise "In order to use respond_with, first you need to declare the " \ diff --git a/actionpack/lib/action_controller/metal/request_forgery_protection.rb b/actionpack/lib/action_controller/metal/request_forgery_protection.rb index 0efa0fb259..7afbd767ce 100644 --- a/actionpack/lib/action_controller/metal/request_forgery_protection.rb +++ b/actionpack/lib/action_controller/metal/request_forgery_protection.rb @@ -9,7 +9,7 @@ module ActionController #:nodoc: end # Controller actions are protected from Cross-Site Request Forgery (CSRF) attacks - # by including a token in the rendered html for your application. This token is + # by including a token in the rendered HTML for your application. This token is # stored as a random string in the session, to which an attacker does not have # access. When a request reaches your application, \Rails verifies the received # token with the token in the session. Only HTML and JavaScript requests are checked, @@ -44,7 +44,7 @@ module ActionController #:nodoc: # # The token parameter is named authenticity_token by default. The name and # value of this token must be added to every layout that renders forms by including - # csrf_meta_tags in the html +head+. + # csrf_meta_tags in the HTML +head+. # # Learn more about CSRF attacks and securing your application in the # {Ruby on Rails Security Guide}[http://guides.rubyonrails.org/security.html]. diff --git a/actionpack/lib/action_dispatch/middleware/public_exceptions.rb b/actionpack/lib/action_dispatch/middleware/public_exceptions.rb index 3664e38af9..040cb215b7 100644 --- a/actionpack/lib/action_dispatch/middleware/public_exceptions.rb +++ b/actionpack/lib/action_dispatch/middleware/public_exceptions.rb @@ -1,5 +1,5 @@ module ActionDispatch - # When called, this middleware renders an error page. By default if an html + # When called, this middleware renders an error page. By default if an HTML # response is expected it will render static error pages from the `/public` # directory. For example when this middleware receives a 500 response it will # render the template found in `/public/500.html`. -- cgit v1.2.3