1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
Ruby on Rails
Find a file
Kasper Timm Hansen 11644fd0ce Collections automatically cache and fetch partials.
Collections can take advantage of `multi_read` if they render one template
and their partials begin with a cache call.

The cache call must correspond to either what the collections elements are
rendered as, or match the inferred name of the partial.

So with a notifications/_notification.html.erb template like:

```ruby
<% cache notification %>
  <%# ... %>
<% end %>
```

A collection would be able to use `multi_read` if rendered like:

```ruby
<%= render @notifications %>
<%= render partial: 'notifications/notification', collection: @notifications, as: :notification %>
```
2015-02-21 16:06:57 +01:00
actionmailer remove noise from AM tests 2015-02-07 13:38:18 +05:30
actionpack Collections automatically cache and fetch partials. 2015-02-21 16:06:57 +01:00
actionview Collections automatically cache and fetch partials. 2015-02-21 16:06:57 +01:00
activejob Move #18833 changelog to the top [ci skip] 2015-02-08 11:52:47 -02:00
activemodel Merge branch 'master' of github.com:rails/docrails 2015-02-14 15:35:47 +00:00
activerecord Merge branch 'master' of github.com:rails/docrails 2015-02-14 15:35:47 +00:00
activesupport Merge branch 'master' of github.com:rails/docrails 2015-02-14 15:35:47 +00:00
ci Pass symbol as an argument instead of a block 2014-11-29 11:53:24 +01:00
guides fix syntax error in render partial example [ci skip] 2015-02-15 19:55:24 +09:00
railties Fix some typos in railties/lib/rails/engine.rb [ci-skip] 2015-02-10 22:29:28 -06:00
tasks activejob needs to be built before actionmailer 2014-12-19 16:12:32 -08:00
tools minor docs change [ci skip] 2014-11-03 12:37:39 +05:30
.gitignore Updated link to to GitHub article about ignoring files [ci skip] 2013-05-05 20:33:24 +05:30
.travis.yml Move ruby-head to allowed failures [ci skip] 2015-02-05 07:39:32 -07:00
.yardopts Let YARD document the railties gem 2010-09-09 18:24:34 -07:00
CONTRIBUTING.md Changed "in GitHub" to "on GitHub" [ci skip] 2015-01-14 16:37:36 +05:30
Gemfile Remove most PG specific type subclasses 2015-02-11 08:49:31 -07:00
install.rb Added activejob to install.rb 2014-08-12 15:37:18 +03:00
load_paths.rb require "rubygems" is obsolete in Ruby 1.9.3 2012-05-13 14:47:25 +02:00
rails.gemspec Remove documentation tasks 2015-02-06 21:04:54 +01:00
RAILS_VERSION Start Rails 5 development 🎉 2014-11-28 15:00:06 -02:00
Rakefile Remove activejob integration tests 2014-08-12 10:07:21 +00:00
README.md Remove bullet 2014-12-21 16:28:25 -04:00
RELEASING_RAILS.rdoc Remove note about supported plugins from the releasing docs 2015-01-09 22:42:29 -02:00
version.rb Start Rails 5 development 🎉 2014-11-28 15:00:06 -02:00

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 (MVC) pattern.

Understanding the MVC pattern is key to understanding Rails. MVC divides your application into three layers, each with a specific responsibility.

The Model layer represents your domain model (such as Account, Product, Person, Post, etc.) and encapsulates the business logic that is specific to your application. In Rails, database-backed model classes are derived from ActiveRecord::Base. Active Record allows you to present the data from database rows as objects and embellish these data objects with business logic methods. You can read more about Active Record in its README. Although most Rails models are backed by a database, models can also be ordinary Ruby classes, or Ruby classes that implement a set of interfaces as provided by the Active Model module. You can read more about Active Model in its README.

The Controller layer is responsible for handling incoming HTTP requests and providing a suitable response. Usually this means returning HTML, but Rails controllers can also generate XML, JSON, PDFs, mobile-specific views, and more. Controllers load and manipulate models, and render view templates in order to generate the appropriate HTTP response. In Rails, incoming requests are routed by Action Dispatch to an appropriate controller, and controller classes are derived from ActionController::Base. Action Dispatch and Action Controller are bundled together in Action Pack. You can read more about Action Pack in its README.

The View layer is composed of "templates" that are responsible for providing appropriate representations of your application's resources. Templates can come in a variety of formats, but most view templates are HTML with embedded Ruby code (ERB files). Views are typically rendered to generate a controller response, or to generate the body of an email. In Rails, View generation is handled by Action View. You can read more about Action View in its README.

Active Record, Action Pack, and Action View can each be used independently outside Rails. In addition to them, Rails also comes with Action Mailer (README), a library to generate and send emails; Active Job (README), a framework for declaring jobs and making them run on a variety of queueing backends; and Active Support (README), a collection of utility classes and standard library extensions that are useful for Rails, and may also be used independently outside Rails.

Getting Started

  1. Install Rails at the command prompt if you haven't yet:

     gem install rails
    
  2. At the command prompt, create a new Rails application:

     rails new myapp
    

    where "myapp" is the application name.

  3. Change directory to myapp and start the web server:

     cd myapp
     rails server
    

    Run with --help or -h for options.

  4. Using a browser, go to http://localhost:3000 and you'll see: "Welcome aboard: You're riding Ruby on Rails!"

  5. Follow the guidelines to start developing your application. You may find the following resources handy:

Contributing

We encourage you to contribute to Ruby on Rails! Please check out the Contributing to Ruby on Rails guide for guidelines about how to proceed. Join us!

Code Status

Build Status

License

Ruby on Rails is released under the MIT License.