Go to file
Hartley McGuire 96a86cb630
Revert "Merge pull request #48527 from ghiculescu/active-record-enum-id"
This reverts commit 8b36095881435e996db16604c52737e144b6bff3, reversing
changes made to e05245db878077097d666f7667c0f9057f767583.

Railties tests have been failing since this change. The issue is that
calling `primary_key` as the model is loaded requires either a
connection to the database or a populated schema cache. This becomes an
issue when an app loads models that do not have underlying tables, as
shown in the failing Railties tests.

When eager loading an app using `rails/all`,
`ActionMailbox::InboundEmail` will be loaded whether or not `rails g
action_mailbox:install` has been run. This means the `primary_key` for
`InboundEmail` will not be in the schema cache and a database connection
will be required to boot the app.
2023-06-20 17:44:36 -04:00
.devcontainer Fix devcontainer trilogy connection for tests 2023-06-20 12:07:01 -04:00
.github Fix duplicate Gemfile entry warning 2023-04-05 11:15:55 +09:00
actioncable Merge pull request #48222 from JoeDupuis/health-check-standalone-cable 2023-05-30 16:35:12 -04:00
actionmailbox Merge pull request #48288 from zzak/rdoc-fixed-width-namespaces 2023-05-25 07:14:47 +09:00
actionmailer Make ActionMailer::TestCase#read_fixture public 2023-06-20 15:44:52 +09:00
actionpack Update Action View and Action Dispatch to use HTML5 when available 2023-06-19 16:34:33 -04:00
actiontext Update Action Text to use HTML5 when available 2023-06-19 15:59:59 -04:00
actionview Update Action View and Action Dispatch to use HTML5 when available 2023-06-19 16:34:33 -04:00
activejob Unlink Rails constant from READMEs 2023-05-29 15:14:44 +09:00
activemodel Merge pull request #48065 from nvasilevski/disallow-assertionless-tests-in-active-model 2023-06-09 17:59:56 -04:00
activerecord Revert "Merge pull request #48527 from ghiculescu/active-record-enum-id" 2023-06-20 17:44:36 -04:00
activestorage Allow an ActiveStorage attachment to be removed via a form post 2023-05-29 22:58:25 -05:00
activesupport Document ActiveSupport::TestCase.fixture_paths= and getter 2023-06-20 15:47:12 +09:00
guides Update guides generation to use Nokogiri's HTML5 parser 2023-06-19 15:38:13 -04:00
railties 💅 Move `:enddoc: to the top of the file 2023-06-19 09:38:31 +09:00
tasks Support VISUAL env var, and prefer it over EDITOR 2023-06-01 20:55:27 -06: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
.mdlrc Introduce markdownlint for guides 2023-03-27 12:14:18 +09:00
.mdlrc.rb Introduce markdownlint for guides 2023-03-27 12:14:18 +09:00
.rubocop.yml Add rubocop-md for linting guides snippets 2023-03-15 10:48:19 +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 Add libvips to Development Dependency guide 2022-05-01 03:07:21 -04:00
CODE_OF_CONDUCT.md Trim trailing whitespace from *.md files 2022-12-17 15:27:51 -08:00
codespell.txt Expand rails route search to all table content 2023-03-03 17:14:33 +11:00
CONTRIBUTING.md Add note about ActiveSupport to CONTRIBUTING.md 2022-11-09 10:26:41 +09:00
Gemfile Upgrade rack and related dependencies in Gemfile and lockfile 2023-06-12 21:45:58 -07:00
Gemfile.lock Upgrade rack to fix "assigned but unused variable" 2023-06-13 23:28:08 -04:00
MIT-LICENSE Remove Copyright years (#47467) 2023-02-23 11:38:16 +01:00
package.json Install JavaScript packages before run test 2019-02-11 09:58:08 +09:00
RAILS_VERSION Start Rails 7.1 development 2021-12-07 15:52:30 +00:00
rails.gemspec Revert "Merge pull request #46817 from yahonda/bump_required_rubygems_version_to_3313" 2023-02-28 08:42:28 +09:00
Rakefile Use frozen string literal in root files 2017-08-13 22:14:24 +09: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
version.rb Replace all occurrences of '<tt>(\w+::\w+)</tt>' with '+$1+' 2023-05-25 06:52:32 +09:00
yarn.lock Update Action Text's Trix dependency (2.0.4) 2023-03-28 12:23:01 -04: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.

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.