1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
Ruby on Rails
Find a file
Genadi Samokovarov ca62dfeede Cleanup the whitelisting references after #33145
During the development of #33145, I have named a few concepts in the
code as `whitelisted`. We decided to stay away from the term and I
adjusted most of the code afterwards, but here are the cases I forgot to
change.

I also found a case in the API guide that we could have cleaned up as
well.

[ci skip]
2019-02-03 10:58:10 +02:00
.github Label Action Text PRs [ci skip] 2019-01-04 23:48:30 -05:00
actioncable Add CHANGELOG entries for npm package renames [ci skip] 2019-01-28 06:29:26 -05:00
actionmailbox Allow changing text and blob size without giving the limit option 2019-01-29 06:49:32 +09:00
actionmailer Preparing for 6.0.0.beta1 release 2019-01-18 15:42:12 -05:00
actionpack Cleanup the whitelisting references after #33145 2019-02-03 10:58:10 +02:00
actiontext Merge pull request #35071 from kamipo/text_without_limit 2019-01-29 17:02:04 +09:00
actionview Remove with_layout_format delegation 2019-01-28 15:09:13 -08:00
activejob Preparing for 6.0.0.beta1 release 2019-01-18 15:42:12 -05:00
activemodel Add missing require for Float#to_d 2019-01-26 12:38:34 +09:00
activerecord Merge pull request #35071 from kamipo/text_without_limit 2019-01-29 17:02:04 +09:00
activestorage Fix usage documentation in VideoAnalyzer 2019-01-28 21:13:11 -08:00
activesupport Preparing for 6.0.0.beta1 release 2019-01-18 15:42:12 -05:00
ci Import Action Text 2019-01-04 22:22:49 -05:00
guides Cleanup the whitelisting references after #33145 2019-02-03 10:58:10 +02:00
railties Cleanup the whitelisting references after #33145 2019-02-03 10:58:10 +02:00
tasks Prefer ImageProcessing's resize_to_limit macro over resize_to_fit 2019-01-24 11:46:42 -05:00
tools Use frozen string literal in tools/ 2017-08-13 22:04:59 +09:00
.codeclimate.yml Bump RuboCop to 0.63.0 2019-01-19 18:52:09 +09:00
.gitattributes
.gitignore Fix adding a rich_text_area to a form with no model 2018-12-31 12:16:21 -05:00
.rubocop.yml Add foreign key to active_storage_attachments for blob_id via new migration 2019-01-16 13:13:23 +00:00
.travis.yml Use Ubuntu Xenial (16.04) at Travis CI 2019-01-26 02:08:57 +00:00
.yardopts
.yarnrc Make Webpacker the default JavaScript compiler for Rails 6 (#33079) 2018-09-30 22:31:21 -07:00
Brewfile [ci skip] Add ImageMagick to Brewfile 2018-08-21 23:01:12 -05:00
CODE_OF_CONDUCT.md Update CoC to change a history of updates URL [ci skip] 2018-04-19 23:33:53 +09:00
CONTRIBUTING.md Remove html tag making markdown misrender [ci skip] 2017-06-05 22:11:57 -05:00
Gemfile Switch queue_classic back to origin repository 2019-01-25 20:01:47 +01:00
Gemfile.lock Switch queue_classic back to origin repository 2019-01-25 20:01:47 +01:00
MIT-LICENSE Bump license years for 2019 2018-12-31 10:24:38 +07:00
package.json Move all npm packages to @rails scope 2019-01-10 11:01:57 -05:00
rails.gemspec Import Action Text 2019-01-04 22:22:49 -05:00
RAILS_VERSION Preparing for 6.0.0.beta1 release 2019-01-18 15:42:12 -05:00
Rakefile Use frozen string literal in root files 2017-08-13 22:14:24 +09:00
README.md Add mention to the main README about new libraries [ci skip] 2019-01-13 20:22:14 +00:00
RELEASING_RAILS.md Move all npm packages to @rails scope 2019-01-10 11:01:57 -05:00
version.rb Preparing for 6.0.0.beta1 release 2019-01-18 15:42:12 -05:00
yarn.lock Move all npm packages to @rails scope 2019-01-10 11:01:57 -05: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.

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.

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.

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; and 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
     $ rails server
    

    Run with --help or -h for options.

  4. Go to http://localhost:3000 and you'll see: "Yay! Youre on Rails!"

  5. Follow the guidelines to start developing your application. You may find the following resources handy:

Contributing

Code Triage Badge

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.

Code Status

Build Status

License

Ruby on Rails is released under the MIT License.