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
Sean Doyle 7cf52ae981
Extend ActionView::Helpers#translate to yield
This commit extends the `ActionView::Helpers#translate` (and by way of
alias, `#t`) helper methods to accept blocks.

When invoked with a block, the `translate` call will yield the
translated text as its first block argument, along with the resolved
translation key as its second:

```erb
<%= translate(".key") do |translation, resolved_key| %>
  <span data-i18n-key="<%= resolved_key %>"><%= translation %></span>
<% end %>
```

In cases where relative translation keys are foregone in lieu of fully
qualified keys, or if the caller is not interested in the resolved key,
the second block argument can be omitted:

```erb
<%= translate("action.template.key") do |translation| %>
  <p><%= translation %></p>
  <p><%= translation %>, but a second time</p>
<% end %>
```

A benefit of yielding the translation is that it enabled template-local
variable re-use. Alternatively, [`Object#tap`][tap] could be used.

Prior to this commit, however, the resolution of the translation key was
internal to `ActionView`, and unavailable to the caller (unless they
were willing to explicitly determine the resolved key themselves). By
making it available as a block parameter, it could be used to annotate
the translated value in the resulting elements.

[tap]: https://ruby-doc.org/core-2.7.0/Object.html#method-i-tap
2020-08-26 20:46:33 +00:00
.github Merge pull request #39420 from jonathanhefner/verba-sequentur-config 2020-08-26 13:47:22 -04:00
actioncable Merge pull request #39123 from tannakartikey/actioncable_logger_docs 2020-07-06 14:28:43 -04:00
actionmailbox Sendgrid: prepend X-Original-To header with envelope recipients 2020-07-21 19:38:38 -04:00
actionmailer Deprecate custom Action Mailer delivery job: 2020-08-26 17:48:47 +02:00
actionpack Merge pull request #39363 from p8/format-did-you-mean-suggestions-on-error-pages 2020-08-26 16:15:36 -04:00
actiontext Remove white list word 2020-06-09 13:41:51 -04:00
actionview Extend ActionView::Helpers#translate to yield 2020-08-26 20:46:33 +00:00
activejob fix typo in Active Job exceptions docs 2020-07-18 11:05:35 +01:00
activemodel Documents other_than option also accepts the proc or a symbol for numericality validation [skip ci] 2020-08-24 21:27:45 +05:30
activerecord Merge pull request #40001 from tgxworld/actionable_migration_not_dumping_schema 2020-08-26 14:00:41 -04:00
activestorage Update service metadata for updated Blobs only 2020-08-13 10:45:46 -04:00
activesupport Merge pull request #39350 from jaynetics/fix_rounding_of_custom_formatted_negative_amounts 2020-08-26 16:08:55 -04:00
ci Remove .travis.yml and ci/travis.rb 2020-01-02 09:27:53 +09:00
guides Add note to avoid requiring config/initializers 2020-08-25 20:25:46 -04:00
railties Merge pull request #40114 from adrianna-chang-shopify/soft-deprecate-application-secrets 2020-08-26 15:22:33 -04:00
tasks Fix release task 2019-11-27 12:24:31 -03:00
tools Introduce Rails::TestUnitReporter.app_root to inject app_root when needed. 2020-06-14 00:02:49 +02:00
.gitattributes
.gitignore
.rubocop.yml Remove redundant Exclude in .rubocop.yml 2020-06-29 16:06:48 -07:00
.yardopts
.yarnrc
Brewfile Address Error: caskroom/cask was moved. Tap homebrew/cask-cask instead. 2019-12-18 18:50:57 +09:00
CODE_OF_CONDUCT.md
CONTRIBUTING.md Update the Rails mailing list URLs to new discuss discourse URL [ci skip] 2020-04-02 22:00:28 +05:30
Gemfile Use Rouge for guides code highlighting [ci skip] 2020-07-08 09:05:08 +02:00
Gemfile.lock Update Gemfile.lock 2020-08-18 18:14:00 +09:00
MIT-LICENSE Bump license years from 2019 to 2020 [ci skip] 2020-01-01 15:10:31 +05:30
package.json
rails.gemspec Update outdated bundler in gemspec 2020-08-18 00:39:54 +08:00
RAILS_VERSION
Rakefile
README.md remove reference to global rails command and replace with bin/rails 2019-12-27 19:32:37 +00:00
RELEASING_RAILS.md fix: Update Agile Web Development with Rails book link [ci skip] 2020-08-13 10:36:46 +05:30
version.rb
yarn.lock Upgrade kind-of 2020-04-19 23:59:27 -03:00

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; Action Mailbox, a library to receive emails within a Rails application; Active Job, a framework for declaring jobs and making them run on a variety of queuing 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; Action Text, a library to handle rich text content; 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
     $ bin/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.