Go to file
Damir Zekić 6c93373842 Update ActiveJob que adapter for compatibility
que 1.2 introduced a deprecation warning when specifying job options
directly within the `#enqueue` method. From 1.2 job options need to be
provided as a hash in `job_options` keyword argument.

que 1.x is not compatible with Ruby 3 yet. que 2 will be.

This commit resolves the deprecation warning and ensures future
compatibility with que 2, allowing path to Ruby 3 upgrade preserving
compatibility with que 1.0.

Co-authored-by: Adis Hasović <adis@80pct.com>
2022-03-21 13:27:59 +01:00
.devcontainer Auto-create user and grant privs when creating dbs 2022-03-17 08:43:35 -04:00
.github Update stale issue comment to mention 7-0-stable 2022-01-02 00:42:38 +00:00
actioncable Fix #version docs and some typos 2022-03-16 01:48:37 +05:30
actionmailbox Merge pull request #44693 from ghousemohamed/fix-docs-related-gem-versions 2022-03-15 16:28:07 -04:00
actionmailer Only configure smtp_settings if provided on configuration 2022-03-15 22:31:04 -03:00
actionpack Restore application/problem+json after tests 2022-03-20 11:58:29 +00:00
actiontext Fix deprecation warnings in Action Text tests 2022-03-19 07:20:31 +00:00
actionview Merge pull request #44693 from ghousemohamed/fix-docs-related-gem-versions 2022-03-15 16:28:07 -04:00
activejob Update ActiveJob que adapter for compatibility 2022-03-21 13:27:59 +01:00
activemodel Merge pull request #44664 from jonathanhefner/active_model-attribute_registration 2022-03-17 10:24:11 -07:00
activerecord Assume less in the on_unload callback for AR scopes 2022-03-21 12:04:45 +01:00
activestorage Merge pull request #44693 from ghousemohamed/fix-docs-related-gem-versions 2022-03-15 16:28:07 -04:00
activesupport Deprecate preserving the pre-Ruby 2.4 behavior of `to_time` 2022-03-20 10:07:59 +00:00
ci ✂️ 2021-10-14 16:36:56 +00:00
guides Adds a section about the undocumented before_remove_const in the Classic to Zeitwerk HOWTO 2022-03-20 23:05:19 +01:00
railties Assume less in the on_unload callback for AR scopes 2022-03-21 12:04:45 +01:00
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 adds .gitattributes to enable Ruby-awareness 2016-03-16 11:15:22 +01:00
.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 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.