Ruby on Rails | Screencasts | Download | Documentation | Weblog | Community | Source

Changeset 1731

Show
Ignore:
Timestamp:
07/06/05 09:32:00 (3 years ago)
Author:
david
Message:

Made documentation ready for release (AP)

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/actionpack/CHANGELOG

    r1728 r1731  
    11*1.9.0* (6 July, 2005) 
    2  
    3 * Fixed that a SessionRestoreError was thrown if a model object was placed in the session that wasn't available to all controllers 
    42 
    53* Added logging of the request URI in the benchmark statement (makes it easy to grep for slow actions) 

  • trunk/actionpack/lib/action_controller/caching.rb

    r1423 r1731  
    459459     
    460460    if defined?(ActiveRecord::Observer) 
    461       class Sweeper < ActiveRecord::Observer 
     461      class Sweeper < ActiveRecord::Observer #:nodoc: 
    462462        attr_accessor :controller 
    463463         

  • trunk/actionpack/lib/action_controller/code_generation.rb

    r1557 r1731  
    11module ActionController 
    2   module CodeGeneration #:nodoc 
    3     class GenerationError < StandardError 
     2  module CodeGeneration #:nodoc: 
     3    class GenerationError < StandardError #:nodoc: 
    44    end 
    55   
    6     class Source 
     6    class Source #:nodoc: 
    77      attr_reader :lines, :indentation_level 
    88      IndentationString = '  ' 
    …… 
    2525    end 
    2626 
    27     class CodeGenerator 
     27    class CodeGenerator #:nodoc: 
    2828      attr_accessor :source, :locals 
    2929      def initialize(source = nil) 
    …… 
    7373    end 
    7474 
    75     class RecognitionGenerator < CodeGenerator 
     75    class RecognitionGenerator < CodeGenerator #:nodoc: 
    7676      Attributes = [:after, :before, :current, :results, :constants, :depth, :move_ahead, :finish_statement] 
    7777      attr_accessor(*Attributes) 
    …… 
    164164    end 
    165165   
    166     class GenerationGenerator < CodeGenerator 
     166    class GenerationGenerator < CodeGenerator #:nodoc: 
    167167      Attributes = [:after, :before, :current, :segments] 
    168168      attr_accessor(*Attributes) 

  • trunk/actionpack/lib/action_controller/layout.rb

    r1728 r1731  
    126126    # If you have a layout that by default is applied to all the actions of a controller, you still have the option of rendering 
    127127    # a given action or set of actions without a layout, or restricting a layout to only a single action or a set of actions. The  
    128     # +:only+ and +:except+ options can be passed to the layout call. For example: 
     128    # <tt>:only</tt> and <tt>:except</tt> options can be passed to the layout call. For example: 
    129129    # 
    130130    #   class WeblogController < ActionController::Base 
    …… 
    138138    # around the rendered view. 
    139139    # 
    140     # Both the +:only+ and +:except+ condition can accept an arbitrary number of method references, so +:except => [ :rss, :text_only ]+  
    141     # is valid, as is # +:except => :rss+. 
     140    # Both the <tt>:only</tt> and <tt>:except</tt> condition can accept an arbitrary number of method references, so  
     141    # #<tt>:except => [ :rss, :text_only ]</tt> is valid, as is <tt>:except => :rss</tt>. 
    142142    # 
    143143    # == Using a different layout in the action render call 

  • trunk/actionpack/lib/action_controller/routing.rb

    r1713 r1731  
    11module ActionController 
    2   module Routing 
     2  module Routing #:nodoc: 
    33    class << self 
    4  
    54      def expiry_hash(options, recall) 
    65        k = v = nil 
    …… 
    4544    end 
    4645 
    47     class Component #:nodoc 
     46    class Component #:nodoc: 
    4847      def dynamic?()  false end 
    4948      def optional?() false end 
    …… 
    6261    end 
    6362 
    64     class StaticComponent < Component #:nodoc 
     63    class StaticComponent < Component #:nodoc: 
    6564      attr_reader :value 
    6665   
    …… 
    8079    end 
    8180 
    82     class DynamicComponent < Component #:nodoc 
     81    class DynamicComponent < Component #:nodoc: 
    8382      attr_reader :key, :default 
    8483      attr_accessor :condition 
    …… 
    175174    end 
    176175 
    177     class ControllerComponent < DynamicComponent #:nodoc 
     176    class ControllerComponent < DynamicComponent #:nodoc: 
    178177      def key() :controller end 
    179178 
    …… 
    226225    end 
    227226 
    228     class PathComponent < DynamicComponent #:nodoc  
     227    class PathComponent < DynamicComponent #:nodoc: 
    229228      def optional?() true end 
    230229      def default()   ''   end 
    …… 
    256255    end 
    257256 
    258     class Route 
     257    class Route #:nodoc: 
    259258      attr_accessor :components, :known 
    260259      attr_reader :path, :options, :keys 
    …… 
    352351    end 
    353352 
    354     class RouteSet 
     353    class RouteSet #:nodoc: 
    355354      attr_reader :routes, :categories, :controller_to_selector 
    356355      def initialize 
    …… 
    564563    end 
    565564 
    566     module NamedRoutes 
     565    module NamedRoutes #:nodoc: 
    567566      Helpers = [] 
    568567      class << self 

  • trunk/actionpack/lib/action_controller/upload_progress.rb

    r1570 r1731  
    77 
    88module ActionController #:nodoc: 
     9  # == THIS IS AN EXPERIMENTAL FEATURE 
     10  # 
     11  # Which means that it doesn't yet work on all systems. We're still working on full 
     12  # compatibility. It's thus not advised to use this unless you've verified it to work 
     13  # fully on all the systems that is a part of your environment. Consider this an extended 
     14  # preview. 
     15  # 
    916  # == Action Pack Upload Progress for multipart uploads 
    1017  # 
    …… 
    125132  #     render :inline => '<%= upload_progress_status %> <div>Updated at <%= Time.now %></div>', :layout => false 
    126133  #   end 
    127   # 
    128   # 
    129   module UploadProgress #:nodoc: 
     134  module UploadProgress 
    130135    def self.append_features(base) #:nodoc: 
    131136      super 
    …… 
    263268    end 
    264269 
     270    # == THIS IS AN EXPERIMENTAL FEATURE 
     271    # 
     272    # Which means that it doesn't yet work on all systems. We're still working on full 
     273    # compatibility. It's thus not advised to use this unless you've verified it to work 
     274    # fully on all the systems that is a part of your environment. Consider this an extended 
     275    # preview. 
     276    # 
    265277    # Upload Progress abstracts the progress of an upload.  It's used by the 
    266278    # multipart progress IO that keeps track of the upload progress and creating 

  • trunk/actionpack/lib/action_controller/vendor/xml_simple.rb

    r1303 r1731  
    88 
    99# Easy API to maintain XML (especially configuration files). 
    10 class XmlSimple 
     10class XmlSimple #:nodoc: 
    1111  include REXML 
    1212 
    …… 
    1515  # A simple cache for XML documents that were already transformed 
    1616  # by xml_in. 
    17   class Cache 
     17  class Cache #:nodoc: 
    1818    # Creates and initializes a new Cache object. 
    1919    def initialize 

  • trunk/actionpack/lib/action_controller/verification.rb

    r1463 r1731  
    11module ActionController #:nodoc: 
    2  
    3   # This module provides a class-level method for specifying that certain 
    4   # actions are guarded against being called without certain prerequisites 
    5   # being met. This is essentially a special kind of before_filter. 
    6   # 
    7   # An action may be guarded against being invoked without certain request 
    8   # parameters being set, or without certain session values existing. 
    9   # 
    10   # When a verification is violated, values may be inserted into the flash, and 
    11   # a specified redirection is triggered. 
    12   # 
    13   # Usage: 
    14   # 
    15   #   class GlobalController < ActionController::Base 
    16   #     # prevent the #update_settings action from being invoked unless 
    17   #     # the 'admin_privileges' request parameter exists. 
    18   #     verify :params => "admin_privileges", :only => :update_post, 
    19   #            :redirect_to => { :action => "settings" } 
    20   # 
    21   #     # disallow a post from being updated if there was no information 
    22   #     # submitted with the post, and if there is no active post in the 
    23   #     # session, and if there is no "note" key in the flash. 
    24   #     verify :params => "post", :session => "post", "flash" => "note", 
    25   #            :only => :update_post, 
    26   #            :add_flash => { "alert" => "Failed to create your message" }, 
    27   #            :redirect_to => :category_url 
    28   # 
    29   module Verification 
     2  module Verification #:nodoc: 
    303    def self.append_features(base) #:nodoc: 
    314      super 
    …… 
    336    end 
    347 
     8    # This module provides a class-level method for specifying that certain 
     9    # actions are guarded against being called without certain prerequisites 
     10    # being met. This is essentially a special kind of before_filter. 
     11    # 
     12    # An action may be guarded against being invoked without certain request 
     13    # parameters being set, or without certain session values existing. 
     14    # 
     15    # When a verification is violated, values may be inserted into the flash, and 
     16    # a specified redirection is triggered. 
     17    # 
     18    # Usage: 
     19    # 
     20    #   class GlobalController < ActionController::Base 
     21    #     # prevent the #update_settings action from being invoked unless 
     22    #     # the 'admin_privileges' request parameter exists. 
     23    #     verify :params => "admin_privileges", :only => :update_post, 
     24    #            :redirect_to => { :action => "settings" } 
     25    # 
     26    #     # disallow a post from being updated if there was no information 
     27    #     # submitted with the post, and if there is no active post in the 
     28    #     # session, and if there is no "note" key in the flash. 
     29    #     verify :params => "post", :session => "post", "flash" => "note", 
     30    #            :only => :update_post, 
     31    #            :add_flash => { "alert" => "Failed to create your message" }, 
     32    #            :redirect_to => :category_url 
     33    # 
    3534    module ClassMethods 
    3635      # Verify the given actions so that if certain prerequisites are not met, 

  • trunk/actionpack/lib/action_view/helpers/upload_progress_helper.rb

    r1580 r1731  
    11module ActionView  
    22  module Helpers 
     3    # == THIS IS AN EXPERIMENTAL FEATURE 
     4    # 
     5    # Which means that it doesn't yet work on all systems. We're still working on full 
     6    # compatibility. It's thus not advised to use this unless you've verified it to work 
     7    # fully on all the systems that is a part of your environment. Consider this an extended 
     8    # preview. 
     9    # 
    310    # Provides a set of methods to be used in your views to help with the 
    411    # rendering of Ajax enabled status updating during a multipart upload. 
    …… 
    5158    # 
    5259    # Default styling is included with the scaffolding CSS. 
    53     # 
    54     module UploadProgressHelper #:nodoc: 
     60    module UploadProgressHelper 
    5561      unless const_defined? :FREQUENCY 
    5662        # Default number of seconds between client updates