Ruby on Rails
Go to file
Edouard CHIN 75aa3a07ec Fix TaggedLogging functionality when broadcasting:
- This PR fixes two issues with the Tagged Logging feature in
  conjunction with broadcasting logs.

  For the sake of clarity I'll define the "main logger" and
  the "broadcasted logger" in this snippet:

  ```ruby
    main_logger = ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new(io))
    broadcaster_logger = ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new(io))

    main_logger.extend(Activesupport::Logger.broadcast(broadcasted_logger))
  ```

  1) The first issue that this PR fixes, is that the tags on the "main logger"
     don't propagate to the "broadcasted logger" when you pass in a block.

     ```ruby
     main_logger.tagged("FOO") { |logger| logger.info("Hello") }

     # Outputs:
     # [Foo] Hello <- By the main logger
     # Hello       <- By the broadcasted logger
     ```

     A fix was made in 70af536b5d
     but that only works for the non block version

  2) It's quite common for the "broadcasted logger" to have a diffent
     log formatter that the "main logger". In example you'd want to
     output JSON logs in one and raw text in the other.

     That wasn't possible before. All loggers had to have the same
     instance of the formatter. The formatter was set on all loggers
     thanks to [this](3fc9d12875/activesupport/lib/active_support/logger.rb (L45-L48)) and it's [associated test](3fc9d12875/activesupport/test/broadcast_logger_test.rb (L58-L64))
     This requirement was needed to make the Tagged Logging feature
     work; the tags being set in a thread variable whose name
     uses the `object_id` 3fc9d12875/activesupport/lib/active_support/tagged_logging.rb (L59)
     (different formatter instance -> different object_id -> different variables)

     In this PR, I have removed the code that sets the same formatter
     instance on all logger. The "broadcaster logger" just need to
     have the `current_tags` point to the `current_tags` of the
     "main logger", I'm doing that by redefing the `current_tags`
     method each time the "main logger" uses a different formatter.

     The advantages by doing so is that custom made formatter
     can now call this `current_tags` method, which will return
     all the tags and process them the way they want.

     ```ruby
       class JSONLogFormatter
         def call(_, _, _, msg)
	   tags = current_tags # Can now retrieve the tags

	   { message: msg, tags: tags }.to_json
	 end
       end

       broadcasted_logger = Logger.new(io)
       broadcaster_logger.formatter = JSONLogFormatter.new
       main_logger = Logger.new(io)
       main_logger.extend(ActiveSupport::Logger.broadcast(broadcasted_logger))
     ```

     The behavior remains the same as before if a logger uses the
     Rails vanilla formatter or the Tagged Logging formatter.
2022-03-15 21:09:18 +01:00
.devcontainer Fix typos in the script 2021-11-15 22:18:36 +00:00
.github Update stale issue comment to mention 7-0-stable 2022-01-02 00:42:38 +00:00
actioncable Refactor Zeitwerk setup in Action Cable 2022-03-06 19:52:36 +01:00
actionmailbox Instrument Action Mailbox processing 2022-03-09 10:06:43 +00:00
actionmailer Eager load controllers `view_context_class` 2022-03-02 08:47:54 +01:00
actionpack Allow relative redirects when `raise_on_open_redirects` is enabled 2022-03-10 00:41:49 +00:00
actiontext Enable `Style/MapToHash` cop 2022-02-26 04:31:03 +09:00
actionview Extend audio_tag and video_tag to accept Active Storage attachments. 2022-03-14 02:05:37 -03:00
activejob Eager load ActiveJob::ConfiguredJob and Serializers 2022-03-01 12:16:52 +01:00
activemodel Merge pull request #44501 from ghousemohamed/fix-inconsistency-in-activemodel-testcases 2022-02-25 14:53:02 -05:00
activerecord Merge pull request #44654 from kaspernj/maria-db-default-function 2022-03-13 19:42:56 +01:00
activestorage Extend audio_tag and video_tag to accept Active Storage attachments. 2022-03-14 02:05:37 -03:00
activesupport Fix TaggedLogging functionality when broadcasting: 2022-03-15 21:09:18 +01:00
ci ✂️ 2021-10-14 16:36:56 +00:00
guides Merge pull request #44683 from ghousemohamed/fix-typo-github 2022-03-14 08:18:11 -04:00
railties Removed unwanted requires of and fixed rubocop errors 2022-03-10 01:19:55 +05:30
tasks Add support for YubiKey OTP codes during release 2021-12-14 12:48:01 -08:00
tools Replace webpack with importmapped Hotwire as default js (#42999) 2021-08-26 10:39:36 +02:00
.gitattributes
.gitignore Depend on ruby/debug, replacing Byebug 2021-09-08 17:35:41 +02:00
.rubocop.yml Enable `Style/MapToHash` cop 2022-02-26 04:31:03 +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 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 Switch from fork to queue_classic beta release 2022-02-27 22:55:41 +10:30
Gemfile.lock Load with Zeitwerk 2022-03-05 08:19:49 +01: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 Update URLs for the blog [ci-skip] 2021-12-17 11:02:05 +01: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 Start Rails 7.1 development 2021-12-07 15:52:30 +00:00
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.