Ruby on Rails
Go to file
Eike Send 5ba8aa5854
Facilitate use of any regular ERB in database.yml
Commit 37d1429ab1 introduced the DummyERB to avoid loading the environment when
running `rake -T`.

The DummyCompiler simply replaced all output from `<%=` with a fixed string and
removed everything else. This worked okay when it was used for YAML values.
When using `<%=` within a YAML key, it caused an error in the YAML parser,
making it impossible to use ERB as you would expect. For example a
`database.yml` file containing the following should be possible:

  development:
    <% 5.times do |i| %>
    shard_<%= i %>:
      database: db/development_shard_<%= i %>.sqlite3
      adapter: sqlite3
    <% end %>

Instead of using a broken ERB compiler we can temporarily use a
`Rails.application.config` that does not raise an error when configurations are
accessed which have not been set as described in #35468.

This change removes the `DummyCompiler` and uses the standard `ERB::Compiler`.
It introduces the `DummyConfig` which delegates all known configurations to the
real `Rails::Application::Configuration` instance and returns a dummy string for
everything else. This restores the full ERB capabilities without compromising on
speed when generating the rake tasks for multiple databases.

Deprecates `config.active_record.suppress_multiple_database_warning`.
2022-09-27 17:07:40 +02:00
.devcontainer Use devcontainer features to install github CLI (#45990) 2022-09-09 18:52:20 -04:00
.github Ignore qunit for spelling check 2022-09-20 21:13:39 +00:00
actioncable Updates for Puma 6 2022-09-22 12:40:54 -05:00
actionmailbox Facilitate use of any regular ERB in database.yml 2022-09-27 17:07:40 +02:00
actionmailer Fix word case. `html` -> `HTML` 2022-09-18 04:21:22 +10:00
actionpack Allow specifying the HTTP status code in assert_redirected_to 2022-09-19 13:51:14 -04:00
actiontext Facilitate use of any regular ERB in database.yml 2022-09-27 17:07:40 +02:00
actionview Merge pull request #46068 from goulvench/allow-passing-classes-to-dom_id 2022-09-20 15:05:36 -04:00
activejob Communicate minimum Sidekiq version in its adapter 2022-09-20 21:07:17 +00:00
activemodel Dup and freeze complex types when making query attributes 2022-09-19 09:41:39 +02:00
activerecord Facilitate use of any regular ERB in database.yml 2022-09-27 17:07:40 +02:00
activestorage Fix word case. `html` -> `HTML` 2022-09-18 04:21:22 +10:00
activesupport Merge pull request #46107 from jonathanhefner/deprecation-tests-use-explicit-deprecator-pt4 2022-09-22 13:08:25 -05:00
ci upgrade to QUnit 2 for ujs tests 2022-09-20 18:03:55 +10:00
guides Take into account timeout limit when retrying queries 2022-09-22 14:29:33 -04:00
railties Facilitate use of any regular ERB in database.yml 2022-09-27 17:07:40 +02:00
tasks Update `rubocop-performance` and enable more performance-related cops 2022-08-26 15:07:11 +03:00
tools Replace webpack with importmapped Hotwire as default js (#42999) 2021-08-26 10:39:36 +02:00
.gitattributes
.gitignore Remove unnecessary gitignore entry 2022-09-09 22:15:29 +00:00
.rubocop.yml Enable Minitest/SkipEnsure 2022-09-20 21:20:17 -04:00
.yardopts Updating .yardopts to document .rb files in [GEM]/app 2019-08-20 13:25:36 -04:00
.yarnrc
Brewfile Add libvips to Development Dependency guide 2022-05-01 03:07:21 -04:00
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md 2022-01-18 11:22:46 -05:00
CONTRIBUTING.md Fix 404 links on https://rubyonrails.org/ [ci-skip] 2021-12-17 02:26:34 +09:00
Gemfile Updates for Puma 6 2022-09-22 12:40:54 -05:00
Gemfile.lock Updates for Puma 6 2022-09-22 12:40:54 -05:00
MIT-LICENSE Bump license years to 2022 [ci-skip] 2022-01-01 15:22:15 +09:00
RAILS_VERSION Start Rails 7.1 development 2021-12-07 15:52:30 +00:00
README.md Convert lib and frameworks to bulleted list-README 2022-02-14 23:15:16 +05:30
RELEASING_RAILS.md Add more instructions to RELEASING_RAILS 2022-09-09 13:37:14 -07:00
Rakefile
codespell.txt Fix misspelling of value is tests 2022-02-15 14:50:33 +01:00
package.json
rails.gemspec Add MIT-LICENSE file to Rails gem 2022-06-30 21:45:33 -04:00
version.rb Fix #version docs and some typos 2022-03-16 01:48:37 +05:30
yarn.lock Convert rails-ujs to ES2015 modules 2022-07-07 21:52:08 -04: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.

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

  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 the Rails bootscreen with your Rails and Ruby versions.

  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.