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
Olivier Lacan 4a2d5efa94 Document best practices with old migrations
The copy here is of course up for discussion but it feels like we need
to address the issue of old migrations in the Migration guide because
other than mentioning the canonical nature of schema.rb/structure.sql
or the actual database compared to migration files, it seems like more
guidance would help.

Here's a sample of the kinds of question people seem to often ask about
old Rails migrations:

- https://stackoverflow.com/questions/20119391/delete-old-migrations-files-in-a-rails-app
- https://www.reddit.com/r/rails/comments/4ayosd/compacting_migrations_files_or_delete_them/
- https://stackoverflow.com/questions/4248682/is-it-a-good-idea-to-purge-old-rails-migration-files
- https://stackoverflow.com/questions/707013/is-it-a-good-idea-to-collapse-old-rails-migrations
- https://stackoverflow.com/questions/1981777/rails-remove-old-models-with-migrations
- https://stackoverflow.com/questions/3343534/rebase-rails-migrations-in-a-long-running-project

The common theme seems to be: "I've got old migrations, should I keep
them around on an old project?".

My personal stance is that as long as migrations run and don't take too long do
so, you should keep them around since it allows people working on the Rails
project with you to seamlessly upgrade their local development database
without having to do a `db:drop db:schema:load` and lose all their seed data.

While writing down this suggested new section it felt like I was describing a
very cumbersome process that could be address with a rake task like:

```bash
rails db:migrate:remove VERSION=20121201123456
```

It rollback to the version just before `20121201123456`, delete the migration
file, and run `db:migrate` to get back to the latest migration.

This of course doesn't address a situation when someone would want to delete or
merge all migrations prior to a certain date, which is addressed by
[squasher](https://github.com/jalkoby/squasher).

I'm not sure this is something we want to encourage people to do. Although I
feel like with more and more production Rails apps over 5-years old, it's
definitely a concern we should address.
2018-08-03 12:59:04 +02:00
.github Update stale issue comment to mention 5-2-stable 2018-05-24 23:23:30 +01:00
actioncable Enable Start/EndWith and RegexpMatch cops 2018-07-28 17:37:17 -04:00
actionmailer Turn on performance based cops 2018-07-23 15:37:06 -07:00
actionpack Enable Start/EndWith and RegexpMatch cops 2018-07-28 17:37:17 -04:00
actionview Enable Start/EndWith and RegexpMatch cops 2018-07-28 17:37:17 -04:00
activejob Rails guides are now served over https 2018-07-24 11:29:31 +09:00
activemodel ActiveModel::Naming delegate match? in the same manner as =~ and != (#33466) 2018-07-29 19:58:35 +02:00
activerecord MySQL: Raise ActiveRecord::InvalidForeignKey for foreign-key constraint violations on delete 2018-07-30 09:12:55 -04:00
activestorage Update ActiveStorage::Previewer docs 2018-07-29 11:48:11 -04:00
activesupport Only use CLOCK_PROCESS_CPUTIME_ID if it's defined 2018-07-29 14:58:03 -04:00
ci Bump RuboCop to 0.58.2 2018-07-26 17:48:07 +09:00
guides Document best practices with old migrations 2018-08-03 12:59:04 +02:00
railties Enable Start/EndWith and RegexpMatch cops 2018-07-28 17:37:17 -04:00
tasks Enable Start/EndWith and RegexpMatch cops 2018-07-28 17:37:17 -04:00
tools Use frozen string literal in tools/ 2017-08-13 22:04:59 +09:00
.codeclimate.yml Bump RuboCop to 0.58.2 2018-07-26 17:48:07 +09:00
.gitattributes adds .gitattributes to enable Ruby-awareness 2016-03-16 11:15:22 +01:00
.gitignore Clean up and consolidate .gitignores 2018-02-17 14:26:19 -08:00
.rubocop.yml Enable Start/EndWith and RegexpMatch cops 2018-07-28 17:37:17 -04:00
.travis.yml Revert "Avoid Node.js v10.4.0 for now" 2018-06-25 10:18:52 +09:00
.yardopts
Brewfile Use frozen string literal 2018-04-11 17:10:15 +09: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 Support streaming downloads from Google Cloud Storage 2018-05-01 23:20:56 -04:00
Gemfile.lock Bump RuboCop to 0.58.2 2018-07-26 17:48:07 +09:00
MIT-LICENSE Bump license years for 2018 2017-12-31 22:36:55 +09:00
rails.gemspec Rails 6 requires Ruby 2.4.1+ 2018-02-17 15:34:57 -08:00
RAILS_VERSION Start Rails 6.0 development!!! 2018-01-30 18:51:17 -05:00
Rakefile Use frozen string literal in root files 2017-08-13 22:14:24 +09:00
README.md Rails guides are now served over https 2018-07-24 11:29:31 +09:00
RELEASING_RAILS.md Use https with weblog URI 2018-05-02 21:06:03 +09:00
version.rb Start Rails 6.0 development!!! 2018-01-30 18:51:17 -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; Active Job, a framework for declaring jobs and making them run on a variety of queueing 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; 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.