Go to file
Matthew Draper fadb6830f8 Harden the .current_transaction API
Based on https://github.com/rails/rails/pull/52017

One concern raised by Xavier is users holding on the return value
of `.current_transaction` beyond the point where it is committed /
rolled back / invalidated.

I believe this is an invalid use of the API, just like holding
`ActiveRecord::Base.connection` beyond the scope of a request is.

However we can be more explicit about it, so I changed the callback
registration methods to raise an error when called on a finalized
transaction.

Another concern was the usability of the null-object in the Active
Record notification payloads, and I agree that while the null-object
make sense when calling `Model.current_transaction`, it doesn't make
sense to include it in the payload of events. The goal of the
`.current_transaction` API is to allow implementing transaction aware
code in a streamlined way. The goal of the `:transaction` in events
however it to allow logging whether a query was inside a transaction
or not, so it's much more ergonomic for it to be nilable.
So I kept Matthew's change that passes `transaction: nil` in `sql.active_record` events
when not inside a transaction. I also added test coverage to make
sure it behaves consistently whether we're inside a transactional
test or not.

I also kept the separation between internal and "user" transaction
objects, as I think it's a nice way to limit the effectively exposed
API, and prevent users from abusing that API too much.

Co-Authored-By: Jean Boussier <jean.boussier@gmail.com>
2024-06-13 09:34:58 +02:00
.devcontainer Remove the default network from the devcontainer compose 2024-06-04 19:18:07 +00:00
.github Lock rails-new-docker action to Ruby 3.3.1 2024-05-30 23:39:21 +02:00
actioncable :nodoc: for ActionCable::Connection::TestCookies 2024-05-31 17:30:03 -06:00
actionmailbox Enable Rails minitest plugin in our rake tasks 2024-05-23 16:16:37 +00:00
actionmailer Enable Rails minitest plugin in our rake tasks 2024-05-23 16:16:37 +00:00
actionpack Don't try to set invalid cookies. 2024-06-12 18:28:41 +00:00
actiontext Merge pull request #52093 from p8/actiontext/fix-remote-image-preview 2024-06-12 14:21:38 -04:00
actionview Add an explicit dependency on the logger gem 2024-06-05 13:53:33 +02:00
activejob Enable Rails minitest plugin in our rake tasks 2024-05-23 16:16:37 +00:00
activemodel Enable Rails minitest plugin in our rake tasks 2024-05-23 16:16:37 +00:00
activerecord Harden the .current_transaction API 2024-06-13 09:34:58 +02:00
activestorage Add test 2024-05-28 21:13:20 -06:00
activesupport [ActiveSupport] Add option filter on in_order_of (#52072) 2024-06-12 15:13:50 -07:00
guides Update the upgrade guides for Rails 7.1 regarding the breaking change (in development/test environments) of the location of secret_key_base (#52083) 2024-06-12 13:15:02 -07:00
railties Merge pull request #52064 from feliperaul/improve_message_verifier_and_signed_id_docs 2024-06-12 18:00:28 -04:00
tasks Remove rollup and test machinery for rails-ujs (#50535) 2024-01-02 16:49:36 +01:00
tools Revert "Remove deprecated support for the pre-Ruby 2.4 behavior of to_time" 2024-06-02 23:52:59 +09:30
.gitattributes adds .gitattributes to enable Ruby-awareness 2016-03-16 11:15:22 +01:00
.gitignore Ignore tarball from rake preview_docs 2024-05-01 08:05:42 +09: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 Revert RuboCop workaround 2024-05-23 14:56:53 +02: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 chore: update Brewfile per renaming postgresql Formula 2024-05-23 13:47:57 +00:00
CODE_OF_CONDUCT.md Trim trailing whitespace from *.md files 2022-12-17 15:27:51 -08:00
CONTRIBUTING.md Replace outdated links with correct links 2023-12-17 13:39:05 +09:00
Gemfile Update sprockets-rails to 3.5.1 2024-06-07 11:29:32 +02:00
Gemfile.lock Update sprockets-rails to 3.5.1 2024-06-07 11:29:32 +02:00
MIT-LICENSE Remove Copyright years (#47467) 2023-02-23 11:38:16 +01:00
package.json chore: remove webpack from yarn dependencies in Rails dev 2024-05-23 16:25:00 +00:00
RAILS_VERSION Development of Rails 8.0 starts now 2024-05-13 16:45:20 +00:00
rails.gemspec Bump the required Ruby version to 3.1.0 2023-12-31 08:54:03 +01:00
Rakefile Add support for fast smoke tests. 2024-06-12 16:51:26 +09:00
README.md Add markdown codehighlight for bash script 2024-01-04 00:30:50 +05:30
RELEASING_RAILS.md Remove rollup and test machinery for rails-ujs (#50535) 2024-01-02 16:49:36 +01:00
version.rb Development of Rails 8.0 starts now 2024-05-13 16:45:20 +00:00
yarn.lock Depend on activestorage 8.0.0-alpha 2024-05-31 23:04:54 +00: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.