Go to file
Jonathan Hefner 21f1199448 Always run `rails app:update` in app update tests
Prior to this commit, several tests in `AppGeneratorTest` were testing
app update behavior without actually running `rails app:update`.  This
meant the logic in `Rails::AppUpdater#generator_options` that detects
which frameworks and components are installed was not being tested.

Additionally, because `ENV["BUNDLE_GEMFILE"]` is set when tests are run
(by `require "bundler/setup"` in `tools/test.rb`), any tests which did
run `rails app:update` used the Rails repo Gemfile, instead of the
generated app Gemfile.  The difference becomes obvious when running
`rails app:update` after generating an app without Sprockets (as in
`test_app_update_does_not_generate_manifest_config_when_propshaft_is_used`),
because `rails app:update` will load the Sprockets railtie (due to
`Bundler.require` using the Rails repo Gemfile), and then exit with a
`Sprockets::Railtie::ManifestNeededError`.  However, if
`rails app:update` is run within a `quietly` block, such an error will
be swallowed.

This commit changes all such tests to run `rails app:update` via a
`run_app_update` helper that: (1) overrides the `BUNDLE_GEMFILE`
environment variable to point to the generated app Gemfile, (2) points
the `rails` gem in the generated app Gemfile to the Rails repo
(otherwise the `rails` gem version cannot be resolved), and (3) sets
`exception: true` so that the `system` call will raise an error if
`rails app:update` exits with an error code.

This commit also adds `jbuilder` and `web-console` to the Rails repo
Gemfile to ensure they are already installed when evaluating the
generated app Gemfile.

These changes do add a couple dozen seconds to the test suite run time,
but the thorough test coverage seems worth it.
2022-10-04 12:33:26 -05:00
.devcontainer Use devcontainer features to install github CLI (#45990) 2022-09-09 18:52:20 -04:00
.github Ignore qunit for spelling check 2022-09-20 21:13:39 +00:00
actioncable Fix #45738 2022-09-25 14:57:32 +02:00
actionmailbox Facilitate use of any regular ERB in database.yml 2022-09-27 17:07:40 +02:00
actionmailer Fix word case. `html` -> `HTML` 2022-09-18 04:21:22 +10:00
actionpack Fix tests for selenium-webdriver v4.5.0 2022-09-29 11:13:06 -05:00
actiontext Facilitate use of any regular ERB in database.yml 2022-09-27 17:07:40 +02:00
actionview Merge pull request #46068 from goulvench/allow-passing-classes-to-dom_id 2022-09-20 15:05:36 -04:00
activejob Communicate minimum Sidekiq version in its adapter 2022-09-20 21:07:17 +00:00
activemodel Avoid double type cast when serializing attributes 2022-09-29 11:34:29 -05:00
activerecord Fix sqlite -> SQLite 2022-10-02 09:17:18 +05:30
activestorage Merge pull request #45837 from hahmed/ha/active-storage-fix-rotation-test-failing 2022-09-27 15:17:00 -04:00
activesupport Remove duplicate frozen_string_literal comment 2022-10-04 00:16:25 +09:00
ci upgrade to QUnit 2 for ujs tests 2022-09-20 18:03:55 +10:00
guides Merge pull request #46175 from datt/fix-rdoc-typo 2022-10-02 10:55:47 +02:00
railties Always run `rails app:update` in app update tests 2022-10-04 12:33:26 -05:00
tasks Update `rubocop-performance` and enable more performance-related cops 2022-08-26 15:07:11 +03: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 Remove unnecessary gitignore entry 2022-09-09 22:15:29 +00:00
.rubocop.yml Enable Minitest/SkipEnsure 2022-09-20 21:20:17 -04: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 Always run `rails app:update` in app update tests 2022-10-04 12:33:26 -05:00
Gemfile.lock Always run `rails app:update` in app update tests 2022-10-04 12:33:26 -05: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 Add more instructions to RELEASING_RAILS 2022-09-09 13:37:14 -07: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 Add MIT-LICENSE file to Rails gem 2022-06-30 21:45:33 -04:00
version.rb Fix #version docs and some typos 2022-03-16 01:48:37 +05:30
yarn.lock Convert rails-ujs to ES2015 modules 2022-07-07 21:52:08 -04: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.