rails 4.1.4 → 5.0.0

data/guides/source/development_dependencies_install.md

@@ -1,278 +0,0 @@
-Development Dependencies Install
-================================
-
-This guide covers how to setup an environment for Ruby on Rails core development.
-
-After reading this guide, you will know:
-
-* How to set up your machine for Rails development
-* How to run specific groups of unit tests from the Rails test suite
-* How the ActiveRecord portion of the Rails test suite operates
-
---------------------------------------------------------------------------------
-
-The Easy Way
-------------
-
-The easiest and recommended way to get a development environment ready to hack is to use the [Rails development box](https://github.com/rails/rails-dev-box).
-
-The Hard Way
-------------
-
-In case you can't use the Rails development box, see section above, these are the steps to manually build a development box for Ruby on Rails core development.
-
-### Install Git
-
-Ruby on Rails uses Git for source code control. The [Git homepage](http://git-scm.com/) has installation instructions. There are a variety of resources on the net that will help you get familiar with Git:
-
-* [Try Git course](http://try.github.io/) is an interactive course that will teach you the basics.
-* The [official Documentation](http://git-scm.com/documentation) is pretty comprehensive and also contains some videos with the basics of Git
-* [Everyday Git](http://schacon.github.io/git/everyday.html) will teach you just enough about Git to get by.
-* The [PeepCode screencast](https://peepcode.com/products/git) on Git is easier to follow.
-* [GitHub](http://help.github.com) offers links to a variety of Git resources.
-* [Pro Git](http://git-scm.com/book) is an entire book about Git with a Creative Commons license.
-
-### Clone the Ruby on Rails Repository
-
-Navigate to the folder where you want the Ruby on Rails source code (it will create its own `rails` subdirectory) and run:
-
-```bash
-$ git clone git://github.com/rails/rails.git
-$ cd rails
-```
-
-### Set up and Run the Tests
-
-The test suite must pass with any submitted code. No matter whether you are writing a new patch, or evaluating someone else's, you need to be able to run the tests.
-
-Install first libxml2 and libxslt together with their development files for Nokogiri. In Ubuntu that's
-
-```bash
-$ sudo apt-get install libxml2 libxml2-dev libxslt1-dev
-```
-
-If you are on Fedora or CentOS, you can run
-
-```bash
-$ sudo yum install libxml2 libxml2-devel libxslt libxslt-devel
-```
-
-If you are running Arch Linux, you're done with:
-
-```bash
-$ sudo pacman -S libxml2 libxslt
-```
-
-On FreeBSD, you just have to run:
-
-```bash
-# pkg_add -r libxml2 libxslt
-```
-
-Alternatively, you can install the `textproc/libxml2` and `textproc/libxslt`
-ports.
-
-If you have any problems with these libraries, you can install them manually by compiling the source code. Just follow the instructions at the [Red Hat/CentOS section of the Nokogiri tutorials](http://nokogiri.org/tutorials/installing_nokogiri.html#red_hat__centos) .
-
-Also, SQLite3 and its development files for the `sqlite3-ruby` gem - in Ubuntu you're done with just
-
-```bash
-$ sudo apt-get install sqlite3 libsqlite3-dev
-```
-
-And if you are on Fedora or CentOS, you're done with
-
-```bash
-$ sudo yum install sqlite3 sqlite3-devel
-```
-
-If you are on Arch Linux, you will need to run:
-
-```bash
-$ sudo pacman -S sqlite
-```
-
-For FreeBSD users, you're done with:
-
-```bash
-# pkg_add -r sqlite3
-```
-
-Or compile the `databases/sqlite3` port.
-
-Get a recent version of [Bundler](http://gembundler.com/)
-
-```bash
-$ gem install bundler
-$ gem update bundler
-```
-
-and run:
-
-```bash
-$ bundle install --without db
-```
-
-This command will install all dependencies except the MySQL and PostgreSQL Ruby drivers. We will come back to these soon.
-
-NOTE: If you would like to run the tests that use memcached, you need to ensure that you have it installed and running.
-
-You can use homebrew to install memcached on OSX:
-
-```bash
-$ brew install memcached
-```
-
-On Ubuntu you can install it with apt-get:
-
-```bash
-$ sudo apt-get install memcached
-```
-
-Or use yum on Fedora or CentOS:
-
-```bash
-$ sudo yum install memcached
-```
-
-With the dependencies now installed, you can run the test suite with:
-
-```bash
-$ bundle exec rake test
-```
-
-You can also run tests for a specific component, like Action Pack, by going into its directory and executing the same command:
-
-```bash
-$ cd actionpack
-$ bundle exec rake test
-```
-
-If you want to run the tests located in a specific directory use the `TEST_DIR` environment variable. For example, this will run the tests in the `railties/test/generators` directory only:
-
-```bash
-$ cd railties
-$ TEST_DIR=generators bundle exec rake test
-```
-
-You can run the tests for a particular file by using:
-
-```bash
-$ cd actionpack
-$ bundle exec ruby -Itest test/template/form_helper_test.rb
-```
-
-Or, you can run a single test in a particular file:
-
-```bash
-$ cd actionpack
-$ bundle exec ruby -Itest path/to/test.rb -n test_name
-```
-
-### Active Record Setup
-
-The test suite of Active Record attempts to run four times: once for SQLite3, once for each of the two MySQL gems (`mysql` and `mysql2`), and once for PostgreSQL. We are going to see now how to set up the environment for them.
-
-WARNING: If you're working with Active Record code, you _must_ ensure that the tests pass for at least MySQL, PostgreSQL, and SQLite3. Subtle differences between the various adapters have been behind the rejection of many patches that looked OK when tested only against MySQL.
-
-#### Database Configuration
-
-The Active Record test suite requires a custom config file: `activerecord/test/config.yml`. An example is provided in `activerecord/test/config.example.yml` which can be copied and used as needed for your environment.
-
-#### MySQL and PostgreSQL
-
-To be able to run the suite for MySQL and PostgreSQL we need their gems. Install first the servers, their client libraries, and their development files. In Ubuntu just run
-
-```bash
-$ sudo apt-get install mysql-server libmysqlclient15-dev
-$ sudo apt-get install postgresql postgresql-client postgresql-contrib libpq-dev
-```
-
-On Fedora or CentOS, just run:
-
-```bash
-$ sudo yum install mysql-server mysql-devel
-$ sudo yum install postgresql-server postgresql-devel
-```
-
-If you are running Arch Linux, MySQL isn't supported anymore so you will need to
-use MariaDB instead (see [this announcement](https://www.archlinux.org/news/mariadb-replaces-mysql-in-repositories/)):
-
-```bash
-$ sudo pacman -S mariadb libmariadbclient mariadb-clients
-$ sudo pacman -S postgresql postgresql-libs
-```
-
-FreeBSD users will have to run the following:
-
-```bash
-# pkg_add -r mysql56-client mysql56-server
-# pkg_add -r postgresql92-client postgresql92-server
-```
-
-Or install them through ports (they are located under the `databases` folder).
-If you run into troubles during the installation of MySQL, please see
-[the MySQL documentation](http://dev.mysql.com/doc/refman/5.1/en/freebsd-installation.html).
-
-After that, run:
-
-```bash
-$ rm .bundle/config
-$ bundle install
-```
-
-First, we need to delete `.bundle/config` because Bundler remembers in that file that we didn't want to install the "db" group (alternatively you can edit the file).
-
-In order to be able to run the test suite against MySQL you need to create a user named `rails` with privileges on the test databases:
-
-```bash
-$ mysql -uroot -p
-
-mysql> CREATE USER 'rails'@'localhost';
-mysql> GRANT ALL PRIVILEGES ON activerecord_unittest.*
-       to 'rails'@'localhost';
-mysql> GRANT ALL PRIVILEGES ON activerecord_unittest2.*
-       to 'rails'@'localhost';
-mysql> GRANT ALL PRIVILEGES ON inexistent_activerecord_unittest.*
-       to 'rails'@'localhost';
-```
-
-and create the test databases:
-
-```bash
-$ cd activerecord
-$ bundle exec rake mysql:build_databases
-```
-
-PostgreSQL's authentication works differently. A simple way to set up the development environment for example is to run with your development account
-
-```bash
-$ sudo -u postgres createuser --superuser $USER
-```
-
-and then create the test databases with
-
-```bash
-$ cd activerecord
-$ bundle exec rake postgresql:build_databases
-```
-
-It is possible to build databases for both PostgreSQL and MySQL with
-
-```bash
-$ cd activerecord
-$ bundle exec rake db:create
-```
-
-You can cleanup the databases using
-
-```bash
-$ cd activerecord
-$ bundle exec rake db:drop
-```
-
-NOTE: Using the rake task to create the test databases ensures they have the correct character set and collation.
-
-NOTE: You'll see the following warning (or localized warning) during activating HStore extension in PostgreSQL 9.1.x or earlier: "WARNING: => is deprecated as an operator".
-
-If you're using another database, check the file `activerecord/test/config.yml` or `activerecord/test/config.example.yml` for default connection information. You can edit `activerecord/test/config.yml` to provide different credentials on your machine if you must, but obviously you should not push any such changes back to Rails.

data/guides/source/documents.yaml

@@ -1,193 +0,0 @@
--
-  name: Start Here
-  documents:
-    -
-      name: Getting Started with Rails
-      url: getting_started.html
-      description: Everything you need to know to install Rails and create your first application.
--
-  name: Models
-  documents:
-    -
-      name: Active Record Basics
-      url: active_record_basics.html
-      description: This guide will get you started with models, persistence to database and the Active Record pattern and library.
-    -
-      name: Rails Database Migrations
-      url: migrations.html
-      description: This guide covers how you can use Active Record migrations to alter your database in a structured and organized manner.
-    -
-      name: Active Record Validations
-      url: active_record_validations.html
-      description: This guide covers how you can use Active Record validations
-    -
-      name: Active Record Callbacks
-      url: active_record_callbacks.html
-      description: This guide covers how you can use Active Record callbacks.
-    -
-      name: Active Record Associations
-      url: association_basics.html
-      description: This guide covers all the associations provided by Active Record.
-    -
-      name: Active Record Query Interface
-      url: active_record_querying.html
-      description: This guide covers the database query interface provided by Active Record.
--
-  name: Views
-  documents:
-    -
-      name: Action View Overview
-      url: action_view_overview.html
-      description: This guide provides an introduction to Action View and introduces a few of the more common view helpers.
-      work_in_progress: true
-    -
-      name: Layouts and Rendering in Rails
-      url: layouts_and_rendering.html
-      description: This guide covers the basic layout features of Action Controller and Action View, including rendering and redirecting, using content_for blocks, and working with partials.
-    -
-      name: Action View Form Helpers
-      url: form_helpers.html
-      description: Guide to using built-in Form helpers.
--
-  name: Controllers
-  documents:
-    -
-      name: Action Controller Overview
-      url: action_controller_overview.html
-      description: This guide covers how controllers work and how they fit into the request cycle in your application. It includes sessions, filters, and cookies, data streaming, and dealing with exceptions raised by a request, among other topics.
-    -
-      name: Rails Routing from the Outside In
-      url: routing.html
-      description: This guide covers the user-facing features of Rails routing. If you want to understand how to use routing in your own Rails applications, start here.
--
-  name: Digging Deeper
-  documents:
-    -
-      name: Active Support Core Extensions
-      url: active_support_core_extensions.html
-      description: This guide documents the Ruby core extensions defined in Active Support.
-    -
-      name: Rails Internationalization API
-      url: i18n.html
-      description: This guide covers how to add internationalization to your applications. Your application will be able to translate content to different languages, change pluralization rules, use correct date formats for each country and so on.
-    -
-      name: Action Mailer Basics
-      url: action_mailer_basics.html
-      description: This guide describes how to use Action Mailer to send and receive emails.
-    -
-      name: Testing Rails Applications
-      url: testing.html
-      work_in_progress: true
-      description: This is a rather comprehensive guide to doing both unit and functional tests in Rails. It covers everything from 'What is a test?' to the testing APIs. Enjoy.
-    -
-      name: Securing Rails Applications
-      url: security.html
-      description: This guide describes common security problems in web applications and how to avoid them with Rails.
-    -
-      name: Debugging Rails Applications
-      url: debugging_rails_applications.html
-      description: This guide describes how to debug Rails applications. It covers the different ways of achieving this and how to understand what is happening "behind the scenes" of your code.
-    -
-      name: Configuring Rails Applications
-      url: configuring.html
-      description: This guide covers the basic configuration settings for a Rails application.
-    -
-      name: Rails Command Line Tools and Rake Tasks
-      url: command_line.html
-      description: This guide covers the command line tools and rake tasks provided by Rails.
-    -
-      name: Caching with Rails
-      work_in_progress: true
-      url: caching_with_rails.html
-      description: Various caching techniques provided by Rails.
-    -
-      name: Asset Pipeline
-      url: asset_pipeline.html
-      description: This guide documents the asset pipeline.
-    -
-      name: Working with JavaScript in Rails
-      url: working_with_javascript_in_rails.html
-      description: This guide covers the built-in Ajax/JavaScript functionality of Rails.
-    -
-      name: Getting Started with Engines
-      url: engines.html
-      description: This guide explains how to write a mountable engine.
-      work_in_progress: true
-    -
-      name: The Rails Initialization Process
-      work_in_progress: true
-      url: initialization.html
-      description: This guide explains the internals of the Rails initialization process as of Rails 4
--
-  name: Extending Rails
-  documents:
-    -
-      name: The Basics of Creating Rails Plugins
-      work_in_progress: true
-      url: plugins.html
-      description: This guide covers how to build a plugin to extend the functionality of Rails.
-    -
-      name: Rails on Rack
-      url: rails_on_rack.html
-      description: This guide covers Rails integration with Rack and interfacing with other Rack components.
-    -
-      name: Creating and Customizing Rails Generators
-      url: generators.html
-      description: This guide covers the process of adding a brand new generator to your extension or providing an alternative to an element of a built-in Rails generator (such as providing alternative test stubs for the scaffold generator).
--
-  name: Contributing to Ruby on Rails
-  documents:
-    -
-      name: Contributing to Ruby on Rails
-      url: contributing_to_ruby_on_rails.html
-      description: Rails is not 'somebody else's framework.' This guide covers a variety of ways that you can get involved in the ongoing development of Rails.
-    -
-      name: API Documentation Guidelines
-      url: api_documentation_guidelines.html
-      description: This guide documents the Ruby on Rails API documentation guidelines.
-    -
-      name: Ruby on Rails Guides Guidelines
-      url: ruby_on_rails_guides_guidelines.html
-      description: This guide documents the Ruby on Rails guides guidelines.
--
-  name: Maintenance Policy
-  documents:
-    -
-      name: Maintenance Policy
-      url: maintenance_policy.html
-      description: What versions of Ruby on Rails are currently supported, and when to expect new versions.
--
-  name: Release Notes
-  documents:
-    -
-      name: Upgrading Ruby on Rails
-      url: upgrading_ruby_on_rails.html
-      description: This guide helps in upgrading applications to latest Ruby on Rails versions.
-    -
-      name: Ruby on Rails 4.1 Release Notes
-      url: 4_1_release_notes.html
-      description: Release notes for Rails 4.1.
-    -
-      name: Ruby on Rails 4.0 Release Notes
-      url: 4_0_release_notes.html
-      description: Release notes for Rails 4.0.
-    -
-      name: Ruby on Rails 3.2 Release Notes
-      url: 3_2_release_notes.html
-      description: Release notes for Rails 3.2.
-    -
-      name: Ruby on Rails 3.1 Release Notes
-      url: 3_1_release_notes.html
-      description: Release notes for Rails 3.1.
-    -
-      name: Ruby on Rails 3.0 Release Notes
-      url: 3_0_release_notes.html
-      description: Release notes for Rails 3.0.
-    -
-      name: Ruby on Rails 2.3 Release Notes
-      url: 2_3_release_notes.html
-      description: Release notes for Rails 2.3.
-    -
-      name: Ruby on Rails 2.2 Release Notes
-      url: 2_2_release_notes.html
-      description: Release notes for Rails 2.2.