Go to file
Hartley McGuire c2901eb084
Restore some config.secret_key_base functionality
The [deprecated secrets removal][1] ended up removing a bit of
non-deprecated functionality related to config.secret_key_base:

- the original implementation prioritized the value of
  config.secret_key_base over other sources in all environments
- if unset, the value of config.secret_key_base would be updated to
  whichever fallback value was found

The new implementation only sets config.secret_key_base to a fallback
value when Rails.env.local?, and never considers it at all in
production.

This commit aims to restore this missing functionality as well as
simplify the implementation:

- Rails.application.secret_key_base now always delegates to
  config.secret_key_base (like the pre-secret-removal implementation)
- secret_key_base validation was moved from the reader to the writer
- config.secret_key_base now handles setting itself to a fallback value
  when unset
- In addition, generate_local_secret was simplified because it
  previously did 3 things: file manipulation, setting
  config.secret_key_base, and returning a value. Now it only creates the
  file if necessary and returns the value stored in it

The new implementation has an additional benefit, which is that manually
set config.secret_key_base values are now validated, whereas previously
only fallback values were validated.

[1]: 0c76f17f2dbf0d7ad90c890e6f334743cacce41f

Co-authored-by: Petrik <petrik@deheus.net>
2024-06-10 23:04:23 -04: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 Merge pull request #52012 from Shopify/defer_route_drawing 2024-06-06 11:23:47 -05:00
actiontext Sanitize ActionText HTML ContentAttachment in Trix edit view 2024-06-04 10:08:12 -07: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 Improve documentation of RecordNotSaved and RecordNotDestroyed [ci-skip] 2024-06-08 10:11:32 +02:00
activestorage Add test 2024-05-28 21:13:20 -06:00
activesupport Remove changelog, change backported to 7-2-stable 2024-06-05 11:03:18 -03:00
guides Improve RTL Rendering for Guides (#51613) 2024-06-07 14:00:52 -03:00
railties Restore some config.secret_key_base functionality 2024-06-10 23:04:23 -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 Fix Rake :preview_docs tarball 2024-04-26 16:13:01 +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.