Go to file
Yusuke Endoh 3beb2aff3b Use error_highlight gem to locate the columns where an error was raised
This change incorporates to Rails a feature called error_highlight that
has been available since Ruby 3.1. This allow Rails' error report screen
to display the fine-grained location where an error occurred (not only a
line number but also beginning and end column numbers of the code
fragment).

For ErrorHighlight, see https://bugs.ruby-lang.org/issues/17930 in
detail.

To use error_highlight, ExceptionWrapper now prefers
`Exception#backtrace_locations` (since Ruby 2.1), which returns an array
of `Thread::Backtrace::Location`s, instead of `Exception#backtrace`.
This is because error_highlight requires `Thread::Backtrace::Location`
to locate the column where an error was raised.

Co-Authored-By: John Hawthorn <john@hawthorn.email>
Co-Authored-By: Jean Boussier <jean.boussier@gmail.com>
2022-08-24 00:28:50 +09:00
.devcontainer Fix building docker container 2022-06-22 18:46:29 +09:00
.github Install specific version of codespell 2022-08-18 12:58:50 -07:00
actioncable Action Cable redis-rb 5+ compatibility 2022-08-22 09:01:27 +02:00
actionmailbox Improve mailbox generator usage docs 2022-06-21 00:30:49 -05:00
actionmailer Optimize AS::LogSubscriber 2022-08-12 09:58:17 +02:00
actionpack Use error_highlight gem to locate the columns where an error was raised 2022-08-24 00:28:50 +09:00
actiontext Merge pull request #45412 from skipkayhil/fix-actiontext-js-main 2022-08-10 19:11:48 -03:00
actionview Merge pull request #45796 from Shopify/log-subscriber-silenced 2022-08-22 10:43:49 +02:00
activejob Optimize AS::LogSubscriber 2022-08-12 09:58:17 +02:00
activemodel Use tap in conditionally-required password example [ci-skip] 2022-08-04 11:39:29 -05:00
activerecord Clean up schema load tasks 2022-08-22 14:35:33 -04:00
activestorage Optimize AS::LogSubscriber 2022-08-12 09:58:17 +02:00
activesupport Use error_highlight gem to locate the columns where an error was raised 2022-08-24 00:28:50 +09:00
ci ✂️ 2021-10-14 16:36:56 +00:00
guides Stop testing hiredis 2022-08-22 09:01:27 +02:00
railties Use error_highlight gem to locate the columns where an error was raised 2022-08-24 00:28:50 +09:00
tasks Update the npm package release task to not add the latest package for every version. 2022-06-28 23:16:09 +02:00
tools Replace webpack with importmapped Hotwire as default js (#42999) 2021-08-26 10:39:36 +02:00
.gitattributes adds .gitattributes to enable Ruby-awareness 2016-03-16 11:15:22 +01:00
.gitignore Rotate the debug.log on each 100MB 2022-04-13 15:38:19 +03:00
.rubocop.yml Enable `Style/RedundantCondition` cop 2022-08-11 11:38:14 +03: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 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 Use error_highlight gem to locate the columns where an error was raised 2022-08-24 00:28:50 +09:00
Gemfile.lock Use error_highlight gem to locate the columns where an error was raised 2022-08-24 00:28:50 +09: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 Upgrade Release guide to match current practices 2022-05-18 23:04:29 +00:00
Rakefile Use frozen string literal in root files 2017-08-13 22:14:24 +09:00
codespell.txt Fix misspelling of value is tests 2022-02-15 14:50:33 +01:00
package.json Install JavaScript packages before run test 2019-02-11 09:58:08 +09:00
rails.gemspec Fix gemspec 2021-11-15 21:06:21 +00:00
version.rb Fix #version docs and some typos 2022-03-16 01:48:37 +05:30
yarn.lock [ci skip] Added a note about Github Codespaces' warning (#44148) 2022-01-21 09:08:50 -05: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.