Go to file
Sean Griffin 34321e4a43 Add an immutable string type to opt out of string duping
This type adds an escape hatch to apps for which string duping causes
unacceptable memory growth. The reason we are duping them is in order to
detect mutation, which was a feature added to 4.2 in #15674. The string
type was modified to support this behavior in #15788.

Memory growth is really only a concern for string types, as it's the
only mutable type where the act of coersion does not create a new object
regardless (as we're usually returning an object of a different class).

I do feel strongly that if we are going to support detecting mutation,
we should do it universally for any type which is mutable. While it is
less common and ideomatic to mutate strings than arrays or hashes, there
shouldn't be rules or gotchas to understanding our behavior.

However, I also appreciate that for apps which are using a lot of string
columns, this would increase the number of allocations by a large
factor. To ensure that we keep our contract, if you'd like to opt out of
mutation detection on strings, you'll also be option out of mutation of
those strings.

I'm not completely married to the thought that strings coming out of
this actually need to be frozen -- and I think the name is correct
either way, as the purpose of this is to provide a string type which
does not detect mutation.

In the new implementation, I'm only overriding `cast_value`. I did not
port over the duping in `serialize`. I cannot think of a reason we'd
need to dup the string there, and the tests pass without it.
Unfortunately that line was introduced at a time where I was not nearly
as good about writing my commit messages, so I have no context as to
why I added it. Thanks past Sean. You are a jerk.
2015-10-15 09:50:37 -07:00
actionmailer Merge pull request #17388 from akampjes/master 2015-10-12 14:26:11 -04:00
actionpack Merge pull request #19135 from yuki24/access-control-support 2015-10-13 11:16:50 -07:00
actionview Merge pull request #21894 from abhishekjain16/refactor_with_dry 2015-10-08 14:16:46 -03:00
activejob Merge pull request #21878 from Gaurav2728/require_monitor 2015-10-10 02:42:11 +10:30
activemodel Add an immutable string type to opt out of string duping 2015-10-15 09:50:37 -07:00
activerecord Add an immutable string type to opt out of string duping 2015-10-15 09:50:37 -07:00
activesupport Only prepend a single module when defining deprecation wrappers. 2015-10-13 11:16:49 -05:00
ci Add the bug report templates to the Travis CI build 2015-06-05 15:29:48 -05:00
guides Fix formatting of ActiveRecord PostgreSQL guide. 2015-10-13 14:50:19 -06:00
railties Merge pull request #21961 from Gaurav2728/migration_class_methods_nodoc 2015-10-14 14:18:23 -04:00
tasks Allow release when CHANGELOG is changed 2015-08-24 15:07:27 -03:00
tools make it possible to customize the executable inside rereun snippets. 2015-06-13 11:58:43 +02:00
.gitignore .gitignore: Ignore .ruby-version in any subdir 2015-09-07 16:37:14 -07:00
.travis.yml Added beanstalkd to Travis so ActiveJob integration tests for beanstalkd can run 2015-09-19 15:10:14 -07:00
.yardopts Let YARD document the railties gem 2010-09-09 18:24:34 -07:00
CODE_OF_CONDUCT.md Move the CoC text to the Rails website 2015-08-21 12:32:59 -07:00
CONTRIBUTING.md Changed 'ask the rubyonrails-talk mailing list.' to 'ask it on the rubyonrails-talk mailing list.' 2015-05-03 16:16:03 +05:30
Gemfile edit pass over the project Gemfile [ci skip] 2015-10-12 13:50:24 +02:00
Gemfile.lock use methods for accessing the cache control headers 2015-10-06 13:39:03 -07:00
load_paths.rb require "rubygems" is obsolete in Ruby 1.9.3 2012-05-13 14:47:25 +02:00
RAILS_VERSION Start Rails 5 development 🎉 2014-11-28 15:00:06 -02:00
rails.gemspec Require sprockets-rails >= 2 2015-09-01 09:30:38 -07:00
Rakefile Remove activejob integration tests 2014-08-12 10:07:21 +00:00
README.md [ci skip] Add Active Model to a list of independently used modules. 2015-09-27 10:54:25 +09:00
RELEASING_RAILS.md Convert Releasing Rails guide to Markdown 2015-08-15 09:21:46 -04:00
version.rb Start Rails 5 development 🎉 2014-11-28 15:00:06 -02:00

Welcome to 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, each with a specific responsibility.

The Model layer represents your domain model (such as Account, Product, Person, Post, etc.) and encapsulates the business logic that is 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. You can read more about Active Record in its README. 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. You can read more about Active Model in its README.

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. You can read more about Action Pack in its README.

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. You can read more about Action View in its README.

Active Record, Active Model, Action Pack, and Action View can each be used independently outside Rails. In addition to them, Rails also comes with Action Mailer (README), a library to generate and send emails; Active Job (README), a framework for declaring jobs and making them run on a variety of queueing backends; and Active Support (README), 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. Using a browser, go to http://localhost:3000 and you'll see: "Welcome aboard: You're riding Ruby on Rails!"

  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!

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.