Ticket #7869: improved_actionpack_readme.diff

actionpack/README

@@ -1 @@
-r
+R
-
-
-
-
-
-
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
+
-
-
-
-
-
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
+
-
-
+
+
+
+
-
-
-and can therefore share helper methods.
+
+map.connect '', :controller => "main", :action => "introduction"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-
-
+
-
+=== Controllers
-
-
+
+
+
+
+
+
-
-
-
-
+
-
-
+
+
+
+
-
-
-
-
-
-
+
+
-
+Other times, rather than render, you may want to redirect to another action.  Rails handles this for you (using HTTP headers)
+so you don't have to worry about sending the headers yourself or whether or not your users have JavaScript enabled.  Simply
+put something like the following in your controller...
-
-
+
-
-
-
-
-
-
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
+
+
+
-
+See the ActionController::Base or ActionController::Filters::ClassMethods documentation for more information and examples.
-
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
-
-
+
+
-
-
-
-
-
-
-
+
-
+Another feature of Action Controller is scaffolding, a simple CRUD interface to your ActiveRecord
+models.  Simply drop one line of code into your controller...
-
-
-
+
-
-
-
-
-
-
-
+
+
+
+
-
-
-
-
-
-
-
-
-
+
-
-
+
+
+
+
+
+
+
-
+By default, these Action View templates are written using Ruby embedded in tags that are 
+mingled in with the HTML called Embedded Ruby(hence, the file extension erb).  You can also
+use Builder (.builder view files) to construct XML views, along with a number of other
+alternative view template handlers.  For more information on implementing these alternative
+handlers, see the ActionView::Base documentation.
-
-
+
-
-
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
+
+
+
+
+
+
-
-
-
+
-
-
+
+
+
+
-
+  <%= form "post" %>
-
-
+
+
+
-
-
-
-
-
-
+
-
+Some of the features of ActionPack, such as scaffolding and form building, are tied to
+ActiveRecord[http://ar.rubyonrails.org] (an object-relational
+mapping package), but that doesn't mean that Action Pack depends on Active
+Record. Action Pack is an independent package that can be used with any sort
+of backend (Instiki[http://www.instiki.org], which is based on an older version
+of Action Pack, used Madeleine for example). Read more about the role Action
+Pack can play when used together with Active Record on
+http://www.rubyonrails.org.
-
-* Pagination for navigating lists of results.
-
-    # controller
-    def list
-      @pages, @people =
-        paginate :people, :order => 'last_name, first_name'
-    end
-
-    # view
-    <%= link_to "Previous page", { :page => @pages.current.previous } if @pages.current.previous %>
-    <%= link_to "Next page", { :page => @pages.current.next } if @pages.current.next %>
-
-  {Learn more}[link:classes/ActionController/Pagination.html]
-
-
-* Easy testing of both controller and template result through TestRequest/Response
-
-    class LoginControllerTest < Test::Unit::TestCase
-      def setup
-        @controller = LoginController.new
-        @request    = ActionController::TestRequest.new
-        @response   = ActionController::TestResponse.new
-      end
-
-      def test_failing_authenticate
-        process :authenticate, :user_name => "nop", :password => ""
-        assert flash.has_key?(:alert)
-        assert_redirected_to :action => "index"
-      end
-    end
-
-  {Learn more}[link:classes/ActionController/TestRequest.html]
-
-
-* Automated benchmarking and integrated logging
-
-    Processing WeblogController#index (for 127.0.0.1 at Fri May 28 00:41:55)
-    Parameters: {"action"=>"index", "controller"=>"weblog"}
-    Rendering weblog/index (200 OK)
-    Completed in 0.029281 (34 reqs/sec)
-
-    If Active Record is used as the model, you'll have the database debugging
-    as well:
-
-    Processing WeblogController#create (for 127.0.0.1 at Sat Jun 19 14:04:23)
-    Params: {"controller"=>"weblog", "action"=>"create",  
-             "post"=>{"title"=>"this is good"} }
-    SQL (0.000627) INSERT INTO posts (title) VALUES('this is good')
-    Redirected to http://test/weblog/display/5
-    Completed in 0.221764 (4 reqs/sec) | DB: 0.059920 (27%)
-
-    You specify a logger through a class method, such as:
-
-    ActionController::Base.logger = Logger.new("Application Log")
-    ActionController::Base.logger = Log4r::Logger.new("Application Log")
-
-
-* Caching at three levels of granularity (page, action, fragment)
-
-    class WeblogController < ActionController::Base
-      caches_page :show
-      caches_action :account
-      
-      def show
-        # the output of the method will be cached as 
-        # ActionController::Base.page_cache_directory + "/weblog/show/n.html"
-        # and the web server will pick it up without even hitting Rails
-      end
-      
-      def account
-        # the output of the method will be cached in the fragment store
-        # but Rails is hit to retrieve it, so filters are run
-      end
-      
-      def update
-        List.update(params[:list][:id], params[:list])
-        expire_page   :action => "show", :id => params[:list][:id]
-        expire_action :action => "account"
-        redirect_to   :action => "show", :id => params[:list][:id]
-      end
-    end
-
-  {Learn more}[link:classes/ActionController/Caching.html]
-
-
-* Component requests from one controller to another
-
-    class WeblogController < ActionController::Base
-      # Performs a method and then lets hello_world output its render
-      def delegate_action
-        do_other_stuff_before_hello_world
-        render_component :controller => "greeter",  :action => "hello_world"
-      end
-    end
-  
-    class GreeterController < ActionController::Base
-      def hello_world
-        render_text "Hello World!"
-      end
-    end
-  
-    The same can be done in a view to do a partial rendering:
-  
-      Let's see a greeting:
-      <%= render_component :controller => "greeter", :action => "hello_world" %>
-
-  {Learn more}[link:classes/ActionController/Components.html]
-  
-
-* Powerful debugging mechanism for local requests
-
-    All exceptions raised on actions performed on the request of a local user
-    will be presented with a tailored debugging screen that includes exception
-    message, stack trace, request parameters, session contents, and the
-    half-finished response.
-
-  {Learn more}[link:classes/ActionController/Rescue.html]
-
-
-* Scaffolding for Active Record model objects
-
-    class AccountController < ActionController::Base
-      scaffold :account
-    end
-    
-    The AccountController now has the full CRUD range of actions and default
-    templates: list, show, destroy, new, create, edit, update
-    
-  {Learn more}[link:classes/ActionController/Scaffolding/ClassMethods.html]
-
-
-* Form building for Active Record model objects
-
-    The post object has a title (varchar), content (text), and 
-    written_on (date)
-
-    <%= form "post" %>
-    
-    ...will generate something like (the selects will have more options, of
-    course):
-    
-    <form action="create" method="POST">
-      <p>
-        <b>Title:</b><br/> 
-        <input type="text" name="post[title]" value="<%= @post.title %>" />
-      </p>
-      <p>
-        <b>Content:</b><br/>
-        <textarea name="post[content]"><%= @post.title %></textarea>
-      </p>
-      <p>
-        <b>Written on:</b><br/>
-        <select name='post[written_on(3i)]'><option>18</option></select>
-        <select name='post[written_on(2i)]'><option value='7'>July</option></select>
-        <select name='post[written_on(1i)]'><option>2004</option></select>
-      </p>
-
-      <input type="submit" value="Create">
-    </form>
-
-    This form generates a params[:post] array that can be used directly in a save action:
-    
-    class WeblogController < ActionController::Base
-      def create
-        post = Post.create(params[:post])
-        redirect_to :action => "display", :id => post.id
-      end
-    end
-
-  {Learn more}[link:classes/ActionView/Helpers/ActiveRecordHelper.html]
-
-
-* Runs on top of WEBrick, Mongrel, CGI, FCGI, and mod_ruby
-
-
-== Simple example (from outside of Rails)
-
-This example will implement a simple weblog system using inline templates and
-an Active Record model. So let's build that WeblogController with just a few
-methods:
-
-  require 'action_controller'
-  require 'post'
-
-  class WeblogController < ActionController::Base
-    layout "weblog/layout"
-  
-    def index
-      @posts = Post.find(:all)
-    end
-    
-    def display
-      @post = Post.find(params[:id])
-    end
-    
-    def new
-      @post = Post.new
-    end
-    
-    def create
-      @post = Post.create(params[:post])
-      redirect_to :action => "display", :id => @post.id
-    end
-  end
-
-  WeblogController::Base.view_paths = [ File.dirname(__FILE__) ]
-  WeblogController.process_cgi if $0 == __FILE__
-
-The last two lines are responsible for telling ActionController where the
-template files are located and actually running the controller on a new
-request from the web-server (like to be Apache).
-
-And the templates look like this:
-
-  weblog/layout.erb:
-    <html><body>
-    <%= yield %>
-    </body></html>
-
-  weblog/index.erb:
-    <% for post in @posts %>
-      <p><%= link_to(post.title, :action => "display", :id => post.id %></p>
-    <% end %>
-
-  weblog/display.erb:
-    <p>
-      <b><%= post.title %></b><br/>
-      <b><%= post.content %></b>
-    </p>
-
-  weblog/new.erb:
-    <%= form "post" %>
-  
-This simple setup will list all the posts in the system on the index page,
-which is called by accessing /weblog/. It uses the form builder for the Active
-Record model to make the new screen, which in turn hands everything over to
-the create action (that's the default target for the form builder when given a
-new model). After creating the post, it'll redirect to the display page using
-an URL such as /weblog/display/5 (where 5 is the id of the post).
-
-
-== Examples
-
-Action Pack ships with three examples that all demonstrate an increasingly