Go to file
Oliver Günther 4692ed7e12
Document `deep_interpolation` parameter for bulk lookups
Bulk lookups are sort of an edge case, I have not heard of them until a colleague of mine decided to dynamically iterate over a growing set of translations and receiving them in bulk as a hash with `I18n.t 'welcome'` as in the example above.

When passing an interpolation to these bulk lookups, they will only be performed when also passing `deep_interpolation: true`.

**Without passing `deep_interpolation` flag:**
```ruby
I18n.t 'welcome', app_name: 'book store'
# => {:title=>"Welcome!", :content=>"Welcome to the %{app_name}"}

**With passing `deep_interpolation`:**
I18n.t 'welcome', deep_interpolation: true, app_name: 'book store'
# => {:title=>"Welcome!", :content=>"Welcome to the book store"}
```

I found this digging in the I18n lookup backend, the flag is listed on [I18n's Rubydoc](https://www.rubydoc.info/github/svenfuchs/i18n/master/I18n) but not otherwise listed. Since bulk lookups are mentioned here, I suggest to add a note with this flag along with it.
2018-10-25 07:46:58 +02:00
.github Remove some autolabeling globs 2018-10-05 14:44:05 -04:00
actioncable Remove unnecessary escape character 2018-10-19 15:59:20 +02:00
actionmailer Fix tests on Mail 2.7.1 2018-10-14 14:44:47 +09:00
actionpack Use request object for context if there's no controller 2018-10-22 17:16:52 +01:00
actionview Add allocations to template renderer subscription 2018-10-10 08:07:12 -04:00
activejob Merge pull request #34204 from XrXr/aj-test-helper-args 2018-10-24 15:49:10 -04:00
activemodel Add new exception message to datetime from hash cast 2018-10-21 10:05:48 +02:00
activerecord Deterministic connection collation in tests 2018-10-25 10:50:27 +09:00
activestorage update activestorage attachment model documentation reflect recent behavior changes 2018-10-24 09:08:45 -04:00
activesupport Merge pull request #34034 from runephilosof/patch-2 2018-10-24 11:48:35 -04:00
ci Use the same option for create database statements between Raketask and travis.rb 2018-09-26 03:18:56 +00:00
guides Document `deep_interpolation` parameter for bulk lookups 2018-10-25 07:46:58 +02:00
railties Do not need to mention the method that is being called in the exception 2018-10-23 18:00:28 -04:00
tasks Fix rubocop offenses 2018-08-15 08:34:31 +03:00
tools Use frozen string literal in tools/ 2017-08-13 22:04:59 +09:00
.codeclimate.yml Bump RuboCop to 0.58.2 2018-07-26 17:48:07 +09:00
.gitattributes adds .gitattributes to enable Ruby-awareness 2016-03-16 11:15:22 +01:00
.gitignore Add `/yarn-error.log` to `.gitignore` 2018-10-21 22:44:11 +03:00
.rubocop.yml Skip node_modules dir in the rubocop check 2018-10-05 21:14:15 +05:30
.travis.yml Replace port number 5433 to 5432 which tests expect 2018-10-19 12:38:15 +09:00
.yardopts Let YARD document the railties gem 2010-09-09 18:24:34 -07:00
.yarnrc Make Webpacker the default JavaScript compiler for Rails 6 (#33079) 2018-09-30 22:31:21 -07:00
Brewfile [ci skip] Add ImageMagick to Brewfile 2018-08-21 23:01:12 -05:00
CODE_OF_CONDUCT.md Update CoC to change a history of updates URL [ci skip] 2018-04-19 23:33:53 +09:00
CONTRIBUTING.md Remove html tag making markdown misrender [ci skip] 2017-06-05 22:11:57 -05:00
Gemfile Add test retries for railties 2018-10-11 10:43:29 -04:00
Gemfile.lock Bump mail to `2.7.1` 2018-10-14 08:33:40 +09:00
MIT-LICENSE Bump license years for 2018 2017-12-31 22:36:55 +09:00
RAILS_VERSION Start Rails 6.0 development!!! 2018-01-30 18:51:17 -05:00
README.md All links from README.md now served over https 2018-07-31 00:31:43 -05:00
RELEASING_RAILS.md Use https with weblog URI 2018-05-02 21:06:03 +09:00
Rakefile Use frozen string literal in root files 2017-08-13 22:14:24 +09:00
package.json Make Webpacker the default JavaScript compiler for Rails 6 (#33079) 2018-09-30 22:31:21 -07:00
rails.gemspec Rails 6 requires Ruby 2.4.1+ 2018-02-17 15:34:57 -08:00
version.rb Start Rails 6.0 development!!! 2018-01-30 18:51:17 -05:00

README.md

Welcome to Rails

What's 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: Model, View, and Controller, each with a specific responsibility.

Model layer

The Model layer represents the domain model (such as Account, Product, Person, Post, etc.) and encapsulates the business logic 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. 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.

Controller layer

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.

View layer

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.

Frameworks and libraries

Active Record, Active Model, Action Pack, and Action View can each be used independently outside Rails. In addition to that, Rails also comes with Action Mailer, a library to generate and send emails; Active Job, a framework for declaring jobs and making them run on a variety of queueing backends; Action Cable, a framework to integrate WebSockets with a Rails application; Active Storage, a library to attach cloud and local files to Rails applications; and Active Support, 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. Go to http://localhost:3000 and you'll see: "Yay! Youre on Rails!"

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

Contributing

Code Triage Badge

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!

Trying to report a possible security vulnerability in Rails? Please check out our security policy for guidelines about how to proceed.

Everyone interacting in Rails and its sub-projects' codebases, issue trackers, chat rooms, and mailing lists is expected to follow the Rails code of conduct.

Code Status

Build Status

License

Ruby on Rails is released under the MIT License.