mirror of
https://github.com/rails/rails.git
synced 2022-11-09 12:12:34 -05:00
Merge branch 'master' of git://github.com/lifo/docrails
This commit is contained in:
Xavier Noria
commit
4699c93301
10 changed files with 30 additions and 124 deletions
|
|
@ -1,7 +1,7 @@
|
|||
== Welcome to Rails
|
||||
|
||||
Rails is a web-application framework that includes everything needed to create
|
||||
database-backed web applications according to the Model-View-Controller pattern.
|
||||
database-backed web applications according to the {Model-View-Controller (MVC)}[http://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller] pattern.
|
||||
|
||||
Understanding the MVC pattern is key to understanding Rails. MVC divides your application
|
||||
into three layers, each with a specific responsibility.
|
||||
|
|
|
|||
|
|
@ -365,7 +365,7 @@ module ActionMailer #:nodoc:
|
|||
Mail.register_observer(delivery_observer)
|
||||
end
|
||||
|
||||
# Register an Inteceptor which will be called before mail is sent.
|
||||
# Register an Interceptor which will be called before mail is sent.
|
||||
# Either a class or a string can be passed in as the Interceptor. If a string is passed in
|
||||
# it will be <tt>constantize</tt>d.
|
||||
def register_interceptor(interceptor)
|
||||
|
|
|
|||
|
|
@ -1105,9 +1105,9 @@ module ActionDispatch
|
|||
#
|
||||
# The +comments+ resource here will have the following routes generated for it:
|
||||
#
|
||||
# post_comments GET /sekret/posts/:post_id/comments(.:format)
|
||||
# post_comments POST /sekret/posts/:post_id/comments(.:format)
|
||||
# new_post_comment GET /sekret/posts/:post_id/comments/new(.:format)
|
||||
# post_comments GET /posts/:post_id/comments(.:format)
|
||||
# post_comments POST /posts/:post_id/comments(.:format)
|
||||
# new_post_comment GET /posts/:post_id/comments/new(.:format)
|
||||
# edit_comment GET /sekret/comments/:id/edit(.:format)
|
||||
# comment GET /sekret/comments/:id(.:format)
|
||||
# comment PUT /sekret/comments/:id(.:format)
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ class Array
|
|||
# This method is similar in purpose to <tt>Kernel#Array</tt>, but there are some differences:
|
||||
#
|
||||
# * If the argument responds to +to_ary+ the method is invoked. <tt>Kernel#Array</tt>
|
||||
# moves on to try +to_a+ if the returned value is +nil+, but <tt>Arraw.wrap</tt> returns
|
||||
# moves on to try +to_a+ if the returned value is +nil+, but <tt>Array.wrap</tt> returns
|
||||
# such a +nil+ right away.
|
||||
# * If the returned value from +to_ary+ is neither +nil+ nor an +Array+ object, <tt>Kernel#Array</tt>
|
||||
# raises an exception, while <tt>Array.wrap</tt> does not, it just returns the value.
|
||||
|
|
|
|||
|
|
@ -182,7 +182,7 @@ It can receive an +:accept+ option, which determines the value that will be cons
|
|||
|
||||
<ruby>
|
||||
class Person < ActiveRecord::Base
|
||||
validates :terms_of_service, :acceptance => true, :accept => 'yes'
|
||||
validates :terms_of_service, :acceptance => { :accept => 'yes' }
|
||||
end
|
||||
</ruby>
|
||||
|
||||
|
|
@ -338,7 +338,7 @@ WARNING. Note that the regular expression above allows a trailing newline charac
|
|||
<ruby>
|
||||
class Player < ActiveRecord::Base
|
||||
validates :points, :numericality => true
|
||||
validates :games_played, :numericality => true, :only_integer => true
|
||||
validates :games_played, :numericality => { :only_integer => true }
|
||||
end
|
||||
</ruby>
|
||||
|
||||
|
|
@ -393,8 +393,8 @@ There is a +:scope+ option that you can use to specify other attributes that are
|
|||
|
||||
<ruby>
|
||||
class Holiday < ActiveRecord::Base
|
||||
validates :name, :uniqueness => true, :scope => :year,
|
||||
:message => "should happen once per year"
|
||||
validates :name, :uniqueness => { :scope => :year,
|
||||
:message => "should happen once per year" }
|
||||
end
|
||||
</ruby>
|
||||
|
||||
|
|
@ -402,7 +402,7 @@ There is also a +:case_sensitive+ option that you can use to define whether the
|
|||
|
||||
<ruby>
|
||||
class Person < ActiveRecord::Base
|
||||
validates :name, :uniqueness => true, :case_sensitive => false
|
||||
validates :name, :uniqueness => { :case_sensitive => false }
|
||||
end
|
||||
</ruby>
|
||||
|
||||
|
|
|
|||
|
|
@ -32,9 +32,9 @@ Sprockets, the rails tie that powers the asset pipeline, provides three directiv
|
|||
|
||||
The require directive loads a file with the supplied basename from the following paths: app/assets/*, lib/assets/*, vendor/assets/*, as well as any of your gem's asset files.
|
||||
|
||||
Require tree does...
|
||||
Using the +require_tree+ directive you can easily include an entire folder of assets. The paths must be relative, so begin them with either a forward slash or dots. For example to include a folder in the same directory you would do +require_tree ./folder_name+
|
||||
|
||||
Require self does...
|
||||
Require self does... something
|
||||
|
||||
h4. Stacking Preprocessors
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ Rails comes with every command line tool you'll need to
|
|||
* Create a Rails application
|
||||
* Generate models, controllers, database migrations, and unit tests
|
||||
* Start a development server
|
||||
* Mess with objects through an interactive shell
|
||||
* Experiment with objects through an interactive shell
|
||||
* Profile and benchmark your new creation
|
||||
|
||||
endprologue.
|
||||
|
|
@ -504,97 +504,3 @@ $ rails server mongrel
|
|||
=> Rails 3.1.0 application starting on http://0.0.0.0:3000
|
||||
...
|
||||
</shell>
|
||||
|
||||
h4. The Rails Generation: Generators
|
||||
|
||||
INFO: For a good rundown on generators, see "Understanding Generators":http://wiki.rubyonrails.org/rails/pages/UnderstandingGenerators. A lot of its material is presented here.
|
||||
|
||||
Generators are code that generates code. Let's experiment by building one. Our generator will generate a text file.
|
||||
|
||||
The Rails generator by default looks in these places for available generators, where Rails.root is the root of your Rails application, like /home/foobar/commandsapp:
|
||||
|
||||
* Rails.root/lib/generators
|
||||
* Rails.root/vendor/generators
|
||||
* Inside any plugin with a directory like "generators" or "rails_generators"
|
||||
* ~/.rails/generators
|
||||
* Inside any Gem you have installed with a name ending in "_generator"
|
||||
* Inside any Gem installed with a "rails_generators" path, and a file ending in "_generator.rb"
|
||||
* Finally, the builtin Rails generators (controller, model, mailer, etc.)
|
||||
|
||||
Let's try the fourth option (in our home directory), which will be easy to clean up later:
|
||||
|
||||
<shell>
|
||||
$ mkdir -p ~/.rails/generators/tutorial_test/templates
|
||||
$ touch ~/.rails/generators/tutorial_test/templates/tutorial.erb
|
||||
$ touch ~/.rails/generators/tutorial_test/tutorial_test_generator.rb
|
||||
</shell>
|
||||
|
||||
We'll fill +tutorial_test_generator.rb+ out with:
|
||||
|
||||
<ruby>
|
||||
class TutorialTestGenerator < Rails::Generator::Base
|
||||
def initialize(*runtime_args)
|
||||
super(*runtime_args)
|
||||
@tut_args = runtime_args
|
||||
end
|
||||
|
||||
def manifest
|
||||
record do |m|
|
||||
m.directory "public"
|
||||
m.template "tutorial.erb", File.join("public", "tutorial.txt"),
|
||||
:assigns => { :args => @tut_args }
|
||||
end
|
||||
end
|
||||
end
|
||||
</ruby>
|
||||
|
||||
We take whatever args are supplied, save them to an instance variable, and literally copying from the Rails source, implement a +manifest+ method, which calls +record+ with a block, and we:
|
||||
|
||||
* Check there's a *public* directory. You bet there is.
|
||||
* Run the ERB template called "tutorial.erb".
|
||||
* Save it into "Rails.root/public/tutorial.txt".
|
||||
* Pass in the arguments we saved through the +:assigns+ parameter.
|
||||
|
||||
Next we'll build the template:
|
||||
|
||||
<shell>
|
||||
$ cat ~/.rails/generators/tutorial_test/templates/tutorial.erb
|
||||
I'm a template!
|
||||
|
||||
I got assigned some args:
|
||||
<%= require 'pp'; PP.pp(args, "") %>
|
||||
</shell>
|
||||
|
||||
Then we'll make sure it got included in the list of available generators:
|
||||
|
||||
<shell>
|
||||
$ rails generate
|
||||
...
|
||||
...
|
||||
Installed Generators
|
||||
User: tutorial_test
|
||||
</shell>
|
||||
|
||||
SWEET! Now let's generate some text, yeah!
|
||||
|
||||
<shell>
|
||||
$ rails generate tutorial_test arg1 arg2 arg3
|
||||
exists public
|
||||
create public/tutorial.txt
|
||||
</shell>
|
||||
|
||||
And the result:
|
||||
|
||||
<shell>
|
||||
$ cat public/tutorial.txt
|
||||
I'm a template!
|
||||
|
||||
I got assigned some args:
|
||||
[["arg1", "arg2", "arg3"],
|
||||
{:collision=>:ask,
|
||||
:quiet=>false,
|
||||
:generator=>"tutorial_test",
|
||||
:command=>:create}]
|
||||
</shell>
|
||||
|
||||
Tada!
|
||||
|
|
|
|||
|
|
@ -220,21 +220,21 @@ h4. Configuring Active Record
|
|||
|
||||
* +config.active_record.table_name_suffix+ lets you set a global string to be appended to table names. If you set this to +_northwest+, then the Customer class will look for +customers_northwest+ as its table. The default is an empty string.
|
||||
|
||||
* +config.active_record.pluralize_table_names+ specifies whether Rails will look for singular or plural table names in the database. If set to +true+ (the default), then the Customer class will use the +customers+ table. If set to +false+, then the Customer class will use the +customer+ table.
|
||||
* +config.active_record.pluralize_table_names+ specifies whether Rails will look for singular or plural table names in the database. If set to true (the default), then the Customer class will use the +customers+ table. If set to false, then the Customer class will use the +customer+ table.
|
||||
|
||||
* +config.active_record.default_timezone+ determines whether to use +Time.local+ (if set to +:local+) or +Time.utc+ (if set to +:utc+) when pulling dates and times from the database. The default is +:utc+ for Rails, although Active Record defaults to +:local+ when used outside of Rails.
|
||||
|
||||
* +config.active_record.schema_format+ controls the format for dumping the database schema to a file. The options are +:ruby+ (the default) for a database-independent version that depends on migrations, or +:sql+ for a set of (potentially database-dependent) SQL statements.
|
||||
|
||||
* +config.active_record.timestamped_migrations+ controls whether migrations are numbered with serial integers or with timestamps. The default is +true+, to use timestamps, which are preferred if there are multiple developers working on the same application.
|
||||
* +config.active_record.timestamped_migrations+ controls whether migrations are numbered with serial integers or with timestamps. The default is true, to use timestamps, which are preferred if there are multiple developers working on the same application.
|
||||
|
||||
* +config.active_record.lock_optimistically+ controls whether Active Record will use optimistic locking. By default this is +true+.
|
||||
* +config.active_record.lock_optimistically+ controls whether Active Record will use optimistic locking and is true by default.
|
||||
|
||||
* +config.active_record.whitelist_attributes+ will create an empty whitelist of attributes available for mass-assignment security for all models in your app.
|
||||
|
||||
The MySQL adapter adds one additional configuration option:
|
||||
|
||||
* +ActiveRecord::ConnectionAdapters::MysqlAdapter.emulate_booleans+ controls whether Active Record will consider all +tinyint(1)+ columns in a MySQL database to be booleans. By default this is +true+.
|
||||
* +ActiveRecord::ConnectionAdapters::MysqlAdapter.emulate_booleans+ controls whether Active Record will consider all +tinyint(1)+ columns in a MySQL database to be booleans and is true by default.
|
||||
|
||||
The schema dumper adds one additional configuration option:
|
||||
|
||||
|
|
@ -260,7 +260,7 @@ h4. Configuring Action Controller
|
|||
|
||||
* +config.action_controller.request_forgery_protection_token+ sets the token parameter name for RequestForgery. Calling +protect_from_forgery+ sets it to +:authenticity_token+ by default.
|
||||
|
||||
* +config.action_controller.allow_forgery_protection+ enables or disables CSRF protection. By default this is +false+ in test mode and +true+ in all other modes.
|
||||
* +config.action_controller.allow_forgery_protection+ enables or disables CSRF protection. By default this is false in test mode and true in all other modes.
|
||||
|
||||
* +config.action_controller.relative_url_root+ can be used to tell Rails that you are deploying to a subdirectory. The default is +ENV['RAILS_RELATIVE_URL_ROOT']+.
|
||||
|
||||
|
|
@ -350,11 +350,11 @@ There are a number of settings available on +config.action_mailer+:
|
|||
** +:location+ - The location of the sendmail executable. Defaults to +/usr/sbin/sendmail+.
|
||||
** +:arguments+ - The command line arguments. Defaults to +-i -t+.
|
||||
|
||||
* +config.action_mailer.raise_delivery_errors+ specifies whether to raise an error if email delivery cannot be completed. It defaults to +true+.
|
||||
* +config.action_mailer.raise_delivery_errors+ specifies whether to raise an error if email delivery cannot be completed. It defaults to true.
|
||||
|
||||
* +config.action_mailer.delivery_method+ defines the delivery method. The allowed values are +:smtp+ (default), +:sendmail+, and +:test+.
|
||||
|
||||
* +config.action_mailer.perform_deliveries+ specifies whether mail will actually be delivered. By default this is +true+; it can be convenient to set it to +false+ for testing.
|
||||
* +config.action_mailer.perform_deliveries+ specifies whether mail will actually be delivered and is true by default. It can be convenient to set it to false for testing.
|
||||
|
||||
* +config.action_mailer.default+ configures Action Mailer defaults. These default to:
|
||||
<ruby>
|
||||
|
|
@ -366,12 +366,12 @@ There are a number of settings available on +config.action_mailer+:
|
|||
|
||||
* +config.action_mailer.observers+ registers observers which will be notified when mail is delivered.
|
||||
<ruby>
|
||||
config.active_record.observers = ["MailObserver"]
|
||||
config.action_mailer.observers = ["MailObserver"]
|
||||
</ruby>
|
||||
|
||||
* +config.action_mailer.interceptors+ registers interceptors which will be called before mail is sent.
|
||||
<ruby>
|
||||
config.active_record.interceptors = ["MailInterceptor"]
|
||||
config.action_mailer.interceptors = ["MailInterceptor"]
|
||||
</ruby>
|
||||
|
||||
h4. Configuring Active Resource
|
||||
|
|
@ -478,13 +478,13 @@ Serves as a placeholder so that +:load_environment_config+ can be defined to run
|
|||
|
||||
*+set_clear_dependencies_hook+* Provides a hook for +active_record.set_dispatch_hooks+ to use, which will run before this initializer. This initializer -- which runs only if +cache_classes+ is set to +false+ -- uses +ActionDispatch::Callbacks.after+ to remove the constants which have been referenced during the request from the object space so that they will be reloaded during the following request.
|
||||
|
||||
*+initialize_dependency_mechanism+* If +config.cache_classes+ is set to +true+, configures +ActiveSupport::Dependencies.mechanism+ to +require+ dependencies rather than +load+ them.
|
||||
*+initialize_dependency_mechanism+* If +config.cache_classes+ is true, configures +ActiveSupport::Dependencies.mechanism+ to +require+ dependencies rather than +load+ them.
|
||||
|
||||
*+bootstrap_hook+* Runs all configured +before_initialize+ blocks.
|
||||
|
||||
*+i18n.callbacks+* In the development environment, sets up a +to_prepare+ callback which will call +I18n.reload!+ if any of the locales have changed since the last request. In production mode this callback will only run on the first request.
|
||||
|
||||
*+active_support.initialize_whiny_nils+* Requires +active_support/whiny_nil+ if +config.whiny_nils+ is set to +true+. This file will output errors such as:
|
||||
*+active_support.initialize_whiny_nils+* Requires +active_support/whiny_nil+ if +config.whiny_nils+ is true. This file will output errors such as:
|
||||
|
||||
<plain>
|
||||
Called id for nil, which would mistakenly be 4 -- if you really wanted the id of nil, use object_id
|
||||
|
|
@ -568,13 +568,13 @@ The error occurred while evaluating nil.each
|
|||
|
||||
*+build_middleware_stack+* Builds the middleware stack for the application, returning an object which has a +call+ method which takes a Rack environment object for the request.
|
||||
|
||||
*+eager_load!+* If +config.cache_classes+ is +true+, runs the +config.before_eager_load+ hooks and then calls +eager_load!+ which will load all the Ruby files from +config.eager_load_paths+.
|
||||
*+eager_load!+* If +config.cache_classes+ is true, runs the +config.before_eager_load+ hooks and then calls +eager_load!+ which will load all the Ruby files from +config.eager_load_paths+.
|
||||
|
||||
*+finisher_hook+* Provides a hook for after the initialization of process of the application is complete, as well as running all the +config.after_initialize+ blocks for the application, railties and engines.
|
||||
|
||||
*+set_routes_reloader+* Configures Action Dispatch to reload the routes file using +ActionDispatch::Callbacks.to_prepare+.
|
||||
|
||||
*+disable_dependency_loading+* Disables the automatic dependency loading if the +config.cache_classes+ is set to +true+ and +config.dependency_loading+ is set to +false+.
|
||||
*+disable_dependency_loading+* Disables the automatic dependency loading if the +config.cache_classes+ is set to true and +config.dependency_loading+ is set to false.
|
||||
|
||||
h3. Changelog
|
||||
|
||||
|
|
|
|||
|
|
@ -350,7 +350,7 @@ Navigate to the Rails "GitHub repository":https://github.com/rails/rails and pre
|
|||
Add the new remote to your local repository on your local machine:
|
||||
|
||||
<shell>
|
||||
$ git remote add mine https://<your user name>@github.com/<your user name>/rails.git
|
||||
$ git remote add mine git@github.com:<your user name>/rails.git
|
||||
</shell>
|
||||
|
||||
Push to your remote:
|
||||
|
|
@ -361,7 +361,7 @@ $ git push mine my_new_branch
|
|||
|
||||
h4. Issue a Pull Request
|
||||
|
||||
Navigate to the Rails repository you just pushed to (e.g. https://github.com/<your user name>/rails) and press "Pull Request" in the upper right hand corner.
|
||||
Navigate to the Rails repository you just pushed to (e.g. https://github.com/your-user-name/rails) and press "Pull Request" in the upper right hand corner.
|
||||
|
||||
Write your branch name in branch field (is filled with master by default) and press "Update Commit Range"
|
||||
|
||||
|
|
|
|||
|
|
@ -573,7 +573,7 @@ h3. Useful Links
|
|||
h4. Rails Plugins and Gems
|
||||
|
||||
* "Rails Analyzer":http://rails-analyzer.rubyforge.org
|
||||
* "Palmist":http://www.flyingmachinestudios.com/projects/
|
||||
* "Palmist":http://www.flyingmachinestudios.com/programming/announcing-palmist
|
||||
* "Rails Footnotes":https://github.com/josevalim/rails-footnotes/tree/master
|
||||
* "Query Reviewer":https://github.com/dsboulder/query_reviewer/tree/master
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue