Go to file
@schneems and @sgrif 2bbcca004c Deprecate *_path methods in mailers
Email does not support relative links since there is no implicit host. Therefore all links inside of emails must be fully qualified URLs. All path helpers are now deprecated. When removed, the error will give early indication to developers to use `*_url` methods instead.

Currently if a developer uses a `*_path` helper, their tests and `mail_view` will not catch the mistake. The only way to see the error is by sending emails in production. Preventing sending out emails with non-working path's is the desired end goal of this PR.

Currently path helpers are mixed-in to controllers (the ActionMailer::Base acts as a controller). All `*_url` and `*_path` helpers are made available through the same module. This PR separates this behavior into two modules so we can extend the `*_path` methods to add a Deprecation to them. Once deprecated we can use this same area to raise a NoMethodError and add an informative message directing the developer to use `*_url` instead.

The module with warnings is only mixed in when a controller returns false from the newly added `supports_relative_path?`.

Paired @sgrif & @schneems
2014-07-30 12:01:45 -05:00
actionmailer Deprecate *_path methods in mailers 2014-07-30 12:01:45 -05:00
actionpack Deprecate *_path methods in mailers 2014-07-30 12:01:45 -05:00
actionview Deprecate *_path methods in mailers 2014-07-30 12:01:45 -05:00
activemodel Merge pull request #15959 from aditya-kapoor/remove-unneeded-cases 2014-07-29 18:08:07 -03:00
activerecord Remove @state.parent assignment on commit 2014-07-29 10:38:11 -04:00
activesupport Revert "Merge pull request #15305 from tgxworld/remove_unnecessary_require" 2014-07-30 09:46:33 -03:00
ci Reorganize ActiveRecord tasks [Arun Agrawal & Abd ar-Rahman Hamidi] 2014-05-16 23:09:05 +02:00
guides Deprecate *_path methods in mailers 2014-07-30 12:01:45 -05:00
railties Deprecate *_path methods in mailers 2014-07-30 12:01:45 -05:00
tasks Fix release task 2014-03-31 14:45:34 -04:00
tools Removing Gem.source_index [ci skip] 2013-07-13 12:05:52 +02:00
.gitignore Updated link to to GitHub article about ignoring files [ci skip] 2013-05-05 20:33:24 +05:30
.travis.yml Split Action Pack tests in a new job on travis 2014-07-23 14:58:59 -03:00
.yardopts Let YARD document the railties gem 2010-09-09 18:24:34 -07:00
CONTRIBUTING.md Follow-up to #16097 [ci skip] 2014-07-18 12:29:54 +02:00
Gemfile Set Psych as the YAML engine for Rubinius 2014-07-23 20:05:14 +02:00
install.rb actionview should be able to install using install.rb [ci skip] 2013-07-09 00:10:07 +02:00
load_paths.rb require "rubygems" is obsolete in Ruby 1.9.3 2012-05-13 14:47:25 +02:00
RAILS_VERSION update version to 4.2.0.alpha 2014-02-23 13:14:43 +01:00
rails.gemspec Make possible to use sprockets-rails 2.1 2014-04-04 16:25:46 -03:00
Rakefile Fix task comment to match which file should be changed 2014-03-25 15:37:18 -03:00
README.md [ci skip] update wiki link for MVC 2014-06-15 00:03:01 +05:30
RELEASING_RAILS.rdoc Add important plugins as one of the tasks of the release 2014-06-16 14:26:23 -03:00
version.rb Introduce Rails.gem_version 2014-03-05 12:37:38 -05: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. 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 Record 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, 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; 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!

Code Status

  • Build Status

License

Ruby on Rails is released under the MIT License.