977bc53932
Thor, the generator USAGE files and some command USAGE files use
identation to divide the USAGE files into separate sections.
Indentation is also used to describe the options that can be passed
to the commands.
For consistency we should use the same formatting for all commands.
As Thor and most USAGE files already use identation it's a smaller
change to use identation for all commands.
For the examples extra identation is used. This makes them stand out
more allows removing the backticks which make it easier to copy the code
examples.
__Before (example for runner)__
```console
bin/rails runner --help
Commands:
bin/rails runner [<'Some.ruby(code)'> | <filename.rb> | -] # Run Ruby code in the context of your application
bin/rails runner:help [COMMAND] # Describe available commands or one specific command
Options:
-e, [--environment=ENVIRONMENT] # The environment to run `runner` in (e.g. test / development / production).
Examples:
Run `puts Rails.env` after loading the app:
bin/rails runner 'puts Rails.env'
Run the Ruby file located at `path/to/filename.rb` after loading the app:
bin/rails runner path/to/filename.rb
Run the Ruby script read from stdin after loading the app:
bin/rails runner -
You can also use the runner command as a shebang line for your executables:
#!/usr/bin/env /path/to/weblog/bin/rails runner
Product.all.each { |p| p.price *= 2 ; p.save! }
```
__After__
```console
bin/rails runner --help
Usage:
bin/rails runner [<'Some.ruby(code)'> | <filename.rb> | -]
Options:
-e, [--environment=ENVIRONMENT] # The environment to run `runner` in (e.g. test / development / production).
Run Ruby code in the context of your application
Description:
The Rails `runner` allows running Ruby code in the context of your application.
Examples:
Run `puts Rails.env` after loading the app:
bin/rails runner 'puts Rails.env'
Run the Ruby file located at `path/to/filename.rb` after loading the app:
bin/rails runner path/to/filename.rb
Run the Ruby script read from stdin after loading the app:
bin/rails runner -
You can also use the runner command as a shebang line for your executables:
#!/usr/bin/env /path/to/weblog/bin/rails runner
Product.all.each { |p| p.price *= 2 ; p.save! }
```
|
||
|---|---|---|
| .devcontainer | ||
| .github | ||
| actioncable | ||
| actionmailbox | ||
| actionmailer | ||
| actionpack | ||
| actiontext | ||
| actionview | ||
| activejob | ||
| activemodel | ||
| activerecord | ||
| activestorage | ||
| activesupport | ||
| guides | ||
| railties | ||
| tasks | ||
| tools | ||
| .gitattributes | ||
| .gitignore | ||
| .rubocop.yml | ||
| .yardopts | ||
| .yarnrc | ||
| Brewfile | ||
| CODE_OF_CONDUCT.md | ||
| codespell.txt | ||
| CONTRIBUTING.md | ||
| Gemfile | ||
| Gemfile.lock | ||
| MIT-LICENSE | ||
| package.json | ||
| RAILS_VERSION | ||
| rails.gemspec | ||
| Rakefile | ||
| README.md | ||
| RELEASING_RAILS.md | ||
| version.rb | ||
| yarn.lock | ||
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.
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.
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.
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
- 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
-
Install Rails at the command prompt if you haven't yet:
$ gem install rails -
At the command prompt, create a new Rails application:
$ rails new myappwhere "myapp" is the application name.
-
Change directory to
myappand start the web server:$ cd myapp $ bin/rails serverRun with
--helpor-hfor options. -
Go to
http://localhost:3000and you'll see the Rails bootscreen with your Rails and Ruby versions. -
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!
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.
License
Ruby on Rails is released under the MIT License.