Ruby on Rails
Go to file
Daniel Morton 94ccd5410d
`retry_on` parameter `attempts` now accepts `:unlimited` (#41761)
In some applications, some classes of errors may be raised during the
execution of a job which the developer would want to retry forever.

These classes of errors would most likely be infrastructure problems that
the developer knows will be resolved eventually but may take a variable
amount of time or errors where due to application business logic, there
could be something temporarily blocking the job from executing, like a
resource that is needed for the job being locked for a lengthy amount of
time.

While an arbitrarily large number of attempts could previously be passed,
this is inexpressive as sometimes the developer may just need the job to
continue to be retried until it eventually succeeds. Without this,
developers would need to include additional code to handle the situation
where the job eventually fails its attempts limit and has to be re-enqueued
manually.

As with many things this should be used with caution and only for errors
that the developer knows will definitely eventually be resolved, allowing
the job to continue.

[Daniel Morton + Rafael Mendonça França]
2021-07-28 18:32:19 -04:00
.github [ci skip] Mention executable test cases in issue template 2021-06-01 11:51:31 -07:00
actioncable Fixup CHANGELOGs [ci skip] 2021-07-21 10:08:08 +09:00
actionmailbox Fixup CHANGELOGs [ci skip] 2021-07-21 10:08:08 +09:00
actionmailer Default values are not evaluated when overridden 2021-06-08 10:06:14 +02:00
actionpack Merge pull request #42896 from ghiculescu/patch-2 2021-07-28 15:21:47 -04:00
actiontext No underscore style (#42898) 2021-07-28 15:34:59 -04:00
actionview Update resolve_link_as to include SVG (#42892) 2021-07-28 16:26:55 -04:00
activejob `retry_on` parameter `attempts` now accepts `:unlimited` (#41761) 2021-07-28 18:32:19 -04:00
activemodel Fix `to_json` after `changes_applied` for `ActiveModel::Dirty` object 2021-07-24 08:22:18 +09:00
activerecord Remove offensive wording from active record 2021-07-28 21:25:50 +02:00
activestorage Move Active Storage JS to ESM and drop Babel transpiling (#42895) 2021-07-28 15:17:13 -04:00
activesupport Merge pull request #42626 from Shopify/as-file-store-remove-local-cache 2021-07-28 17:06:56 +02:00
ci chore: Use `e.g.` which is the more used spelling 2021-07-21 09:17:54 +09:00
guides Merge pull request #42867 from sato11/rename-middleware-remove 2021-07-28 14:45:23 -04:00
railties Add plugin to common command USAGE (#41457) 2021-07-28 17:59:22 -04:00
tasks Fix a rubocop offence for `Lint/ErbNewArguments` 2021-02-05 12:39:58 +09:00
tools Fix bin/test 2020-10-30 21:33:19 +00:00
.gitattributes
.gitignore Remove non-project specific entry from gitignore 2021-03-22 22:02:00 +00:00
.rubocop.yml Fix odd closing parenthesis by enabling the `Layout/ClosingParenthesisIndentation` cop 2021-07-02 18:01:50 +09:00
.yardopts Updating .yardopts to document .rb files in [GEM]/app 2019-08-20 13:25:36 -04:00
.yarnrc Make Webpacker the default JavaScript compiler for Rails 6 (#33079) 2018-09-30 22:31:21 -07:00
Brewfile Address `Error: caskroom/cask was moved. Tap homebrew/cask-cask instead. ` 2019-12-18 18:50:57 +09:00
CODE_OF_CONDUCT.md Updated links from http to https in guides, docs, etc 2019-03-09 16:43:47 +05:30
CONTRIBUTING.md Adding badges and logo to README and CONTRIBUTING page 2021-01-20 10:53:47 +01:00
Gemfile Replace uglifier with terser in dummy applications 2021-06-28 00:48:56 -04:00
Gemfile.lock Update globalid to 0.5.1 for ruby-head compatibility 2021-07-27 23:23:13 +02:00
MIT-LICENSE Bump license years to 2021 [ci skip] 2021-01-01 12:21:20 +09:00
RAILS_VERSION Rails 6.2 is now Rails 7.0 2021-02-04 16:47:16 +00:00
README.md Adding badges and logo to README and CONTRIBUTING page 2021-01-20 10:53:47 +01:00
RELEASING_RAILS.md Rename master to main in all code references 2021-01-19 20:46:33 +00:00
Rakefile Use frozen string literal in root files 2017-08-13 22:14:24 +09:00
codespell.txt Add spell checking with codespell as a GitHub Action 2021-05-04 14:46:21 +10:00
package.json Install JavaScript packages before run test 2019-02-11 09:58:08 +09:00
rails.gemspec Rails 7 requires Ruby 2.7 and prefer Ruby 3+ 2021-02-04 16:34:53 +00:00
version.rb Rails 6.2 is now Rails 7.0 2021-02-04 16:47:16 +00:00
yarn.lock Upgrade kind-of 2020-04-19 23:59:27 -03: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; 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

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.