rails 4.2.1 → 5.1.7

data/guides/source/plugins.md

@@ -1,444 +0,0 @@
-The Basics of Creating Rails Plugins
-====================================
-
-A Rails plugin is either an extension or a modification of the core framework. Plugins provide:
-
-* A way for developers to share bleeding-edge ideas without hurting the stable code base.
-* A segmented architecture so that units of code can be fixed or updated on their own release schedule.
-* An outlet for the core developers so that they don't have to include every cool new feature under the sun.
-
-After reading this guide, you will know:
-
-* How to create a plugin from scratch.
-* How to write and run tests for the plugin.
-
-This guide describes how to build a test-driven plugin that will:
-
-* Extend core Ruby classes like Hash and String.
-* Add methods to `ActiveRecord::Base` in the tradition of the `acts_as` plugins.
-* Give you information about where to put generators in your plugin.
-
-For the purpose of this guide pretend for a moment that you are an avid bird watcher.
-Your favorite bird is the Yaffle, and you want to create a plugin that allows other developers to share in the Yaffle
-goodness.
-
---------------------------------------------------------------------------------
-
-Setup
------
-
-Currently, Rails plugins are built as gems, _gemified plugins_. They can be shared across
-different rails applications using RubyGems and Bundler if desired.
-
-### Generate a gemified plugin.
-
-
-Rails ships with a `rails plugin new` command which creates a
-skeleton for developing any kind of Rails extension with the ability
-to run integration tests using a dummy Rails application. Create your 
-plugin with the command:
-
-```bash
-$ rails plugin new yaffle
-```
-
-See usage and options by asking for help:
-
-```bash
-$ rails plugin new --help
-```
-
-Testing Your Newly Generated Plugin
------------------------------------
-
-You can navigate to the directory that contains the plugin, run the `bundle install` command
- and run the one generated test using the `rake` command.
-
-You should see:
-
-```bash
-  1 runs, 1 assertions, 0 failures, 0 errors, 0 skips
-```
-
-This will tell you that everything got generated properly and you are ready to start adding functionality.
-
-Extending Core Classes
-----------------------
-
-This section will explain how to add a method to String that will be available anywhere in your rails application.
-
-In this example you will add a method to String named `to_squawk`. To begin, create a new test file with a few assertions:
-
-```ruby
-# yaffle/test/core_ext_test.rb
-
-require 'test_helper'
-
-class CoreExtTest < ActiveSupport::TestCase
-  def test_to_squawk_prepends_the_word_squawk
-    assert_equal "squawk! Hello World", "Hello World".to_squawk
-  end
-end
-```
-
-Run `rake` to run the test. This test should fail because we haven't implemented the `to_squawk` method:
-
-```bash
-    1) Error:
-  CoreExtTest#test_to_squawk_prepends_the_word_squawk:
-  NoMethodError: undefined method `to_squawk' for "Hello World":String
-    /path/to/yaffle/test/core_ext_test.rb:5:in `test_to_squawk_prepends_the_word_squawk'
-```
-
-Great - now you are ready to start development.
-
-In `lib/yaffle.rb`, add `require 'yaffle/core_ext'`:
-
-```ruby
-# yaffle/lib/yaffle.rb
-
-require 'yaffle/core_ext'
-
-module Yaffle
-end
-```
-
-Finally, create the `core_ext.rb` file and add the `to_squawk` method:
-
-```ruby
-# yaffle/lib/yaffle/core_ext.rb
-
-String.class_eval do
-  def to_squawk
-    "squawk! #{self}".strip
-  end
-end
-```
-
-To test that your method does what it says it does, run the unit tests with `rake` from your plugin directory.
-
-```bash
-  2 runs, 2 assertions, 0 failures, 0 errors, 0 skips
-```
-
-To see this in action, change to the test/dummy directory, fire up a console and start squawking:
-
-```bash
-$ bin/rails console
->> "Hello World".to_squawk
-=> "squawk! Hello World"
-```
-
-Add an "acts_as" Method to Active Record
-----------------------------------------
-
-A common pattern in plugins is to add a method called `acts_as_something` to models. In this case, you
-want to write a method called `acts_as_yaffle` that adds a `squawk` method to your Active Record models.
-
-To begin, set up your files so that you have:
-
-```ruby
-# yaffle/test/acts_as_yaffle_test.rb
-
-require 'test_helper'
-
-class ActsAsYaffleTest < ActiveSupport::TestCase
-end
-```
-
-```ruby
-# yaffle/lib/yaffle.rb
-
-require 'yaffle/core_ext'
-require 'yaffle/acts_as_yaffle'
-
-module Yaffle
-end
-```
-
-```ruby
-# yaffle/lib/yaffle/acts_as_yaffle.rb
-
-module Yaffle
-  module ActsAsYaffle
-    # your code will go here
-  end
-end
-```
-
-### Add a Class Method
-
-This plugin will expect that you've added a method to your model named `last_squawk`. However, the
-plugin users might have already defined a method on their model named `last_squawk` that they use
-for something else. This plugin will allow the name to be changed by adding a class method called `yaffle_text_field`.
-
-To start out, write a failing test that shows the behavior you'd like:
-
-```ruby
-# yaffle/test/acts_as_yaffle_test.rb
-
-require 'test_helper'
-
-class ActsAsYaffleTest < ActiveSupport::TestCase
-
-  def test_a_hickwalls_yaffle_text_field_should_be_last_squawk
-    assert_equal "last_squawk", Hickwall.yaffle_text_field
-  end
-
-  def test_a_wickwalls_yaffle_text_field_should_be_last_tweet
-    assert_equal "last_tweet", Wickwall.yaffle_text_field
-  end
-
-end
-```
-
-When you run `rake`, you should see the following:
-
-```
-    1) Error:
-  ActsAsYaffleTest#test_a_hickwalls_yaffle_text_field_should_be_last_squawk:
-  NameError: uninitialized constant ActsAsYaffleTest::Hickwall
-    /path/to/yaffle/test/acts_as_yaffle_test.rb:6:in `test_a_hickwalls_yaffle_text_field_should_be_last_squawk'
-
-    2) Error:
-  ActsAsYaffleTest#test_a_wickwalls_yaffle_text_field_should_be_last_tweet:
-  NameError: uninitialized constant ActsAsYaffleTest::Wickwall
-    /path/to/yaffle/test/acts_as_yaffle_test.rb:10:in `test_a_wickwalls_yaffle_text_field_should_be_last_tweet'
-
-  4 runs, 2 assertions, 0 failures, 2 errors, 0 skips
-```
-
-This tells us that we don't have the necessary models (Hickwall and Wickwall) that we are trying to test.
-We can easily generate these models in our "dummy" Rails application by running the following commands from the
-test/dummy directory:
-
-```bash
-$ cd test/dummy
-$ bin/rails generate model Hickwall last_squawk:string
-$ bin/rails generate model Wickwall last_squawk:string last_tweet:string
-```
-
-Now you can create the necessary database tables in your testing database by navigating to your dummy app
-and migrating the database. First, run:
-
-```bash
-$ cd test/dummy
-$ bin/rake db:migrate
-```
-
-While you are here, change the Hickwall and Wickwall models so that they know that they are supposed to act
-like yaffles.
-
-```ruby
-# test/dummy/app/models/hickwall.rb
-
-class Hickwall < ActiveRecord::Base
-  acts_as_yaffle
-end
-
-# test/dummy/app/models/wickwall.rb
-
-class Wickwall < ActiveRecord::Base
-  acts_as_yaffle yaffle_text_field: :last_tweet
-end
-
-```
-
-We will also add code to define the `acts_as_yaffle` method.
-
-```ruby
-# yaffle/lib/yaffle/acts_as_yaffle.rb
-module Yaffle
-  module ActsAsYaffle
-    extend ActiveSupport::Concern
-
-    included do
-    end
-
-    module ClassMethods
-      def acts_as_yaffle(options = {})
-        # your code will go here
-      end
-    end
-  end
-end
-
-ActiveRecord::Base.send :include, Yaffle::ActsAsYaffle
-```
-
-You can then return to the root directory (`cd ../..`) of your plugin and rerun the tests using `rake`.
-
-```
-    1) Error:
-  ActsAsYaffleTest#test_a_hickwalls_yaffle_text_field_should_be_last_squawk:
-  NoMethodError: undefined method `yaffle_text_field' for #<Class:0x007fd105e3b218>
-    activerecord (4.1.5) lib/active_record/dynamic_matchers.rb:26:in `method_missing'
-    /path/to/yaffle/test/acts_as_yaffle_test.rb:6:in `test_a_hickwalls_yaffle_text_field_should_be_last_squawk'
-
-    2) Error:
-  ActsAsYaffleTest#test_a_wickwalls_yaffle_text_field_should_be_last_tweet:
-  NoMethodError: undefined method `yaffle_text_field' for #<Class:0x007fd105e409c0>
-    activerecord (4.1.5) lib/active_record/dynamic_matchers.rb:26:in `method_missing'
-    /path/to/yaffle/test/acts_as_yaffle_test.rb:10:in `test_a_wickwalls_yaffle_text_field_should_be_last_tweet'  
-
-  4 runs, 2 assertions, 0 failures, 2 errors, 0 skips
-
-```
-
-Getting closer... Now we will implement the code of the `acts_as_yaffle` method to make the tests pass.
-
-```ruby
-# yaffle/lib/yaffle/acts_as_yaffle.rb
-
-module Yaffle
-  module ActsAsYaffle
-   extend ActiveSupport::Concern
-
-    included do
-    end
-
-    module ClassMethods
-      def acts_as_yaffle(options = {})
-        cattr_accessor :yaffle_text_field
-        self.yaffle_text_field = (options[:yaffle_text_field] || :last_squawk).to_s
-      end
-    end
-  end
-end
-
-ActiveRecord::Base.send :include, Yaffle::ActsAsYaffle
-```
-
-When you run `rake`, you should see the tests all pass:
-
-```bash
-  4 runs, 4 assertions, 0 failures, 0 errors, 0 skips
-```
-
-### Add an Instance Method
-
-This plugin will add a method named 'squawk' to any Active Record object that calls 'acts_as_yaffle'. The 'squawk'
-method will simply set the value of one of the fields in the database.
-
-To start out, write a failing test that shows the behavior you'd like:
-
-```ruby
-# yaffle/test/acts_as_yaffle_test.rb
-require 'test_helper'
-
-class ActsAsYaffleTest < ActiveSupport::TestCase
-
-  def test_a_hickwalls_yaffle_text_field_should_be_last_squawk
-    assert_equal "last_squawk", Hickwall.yaffle_text_field
-  end
-
-  def test_a_wickwalls_yaffle_text_field_should_be_last_tweet
-    assert_equal "last_tweet", Wickwall.yaffle_text_field
-  end
-
-  def test_hickwalls_squawk_should_populate_last_squawk
-    hickwall = Hickwall.new
-    hickwall.squawk("Hello World")
-    assert_equal "squawk! Hello World", hickwall.last_squawk
-  end
-
-  def test_wickwalls_squawk_should_populate_last_tweet
-    wickwall = Wickwall.new
-    wickwall.squawk("Hello World")
-    assert_equal "squawk! Hello World", wickwall.last_tweet
-  end
-end
-```
-
-Run the test to make sure the last two tests fail with an error that contains "NoMethodError: undefined method `squawk'",
-then update 'acts_as_yaffle.rb' to look like this:
-
-```ruby
-# yaffle/lib/yaffle/acts_as_yaffle.rb
-
-module Yaffle
-  module ActsAsYaffle
-    extend ActiveSupport::Concern
-
-    included do
-    end
-
-    module ClassMethods
-      def acts_as_yaffle(options = {})
-        cattr_accessor :yaffle_text_field
-        self.yaffle_text_field = (options[:yaffle_text_field] || :last_squawk).to_s
-
-        include Yaffle::ActsAsYaffle::LocalInstanceMethods
-      end
-    end
-
-    module LocalInstanceMethods
-      def squawk(string)
-        write_attribute(self.class.yaffle_text_field, string.to_squawk)
-      end
-    end
-  end
-end
-
-ActiveRecord::Base.send :include, Yaffle::ActsAsYaffle
-```
-
-Run `rake` one final time and you should see:
-
-```
-  6 runs, 6 assertions, 0 failures, 0 errors, 0 skips
-```
-
-NOTE: The use of `write_attribute` to write to the field in model is just one example of how a plugin can interact with the model, and will not always be the right method to use. For example, you could also use:
-
-```ruby
-send("#{self.class.yaffle_text_field}=", string.to_squawk)
-```
-
-Generators
-----------
-
-Generators can be included in your gem simply by creating them in a lib/generators directory of your plugin. More information about
-the creation of generators can be found in the [Generators Guide](generators.html)
-
-Publishing Your Gem
--------------------
-
-Gem plugins currently in development can easily be shared from any Git repository. To share the Yaffle gem with others, simply
-commit the code to a Git repository (like GitHub) and add a line to the Gemfile of the application in question:
-
-```ruby
-gem 'yaffle', git: 'git://github.com/yaffle_watcher/yaffle.git'
-```
-
-After running `bundle install`, your gem functionality will be available to the application.
-
-When the gem is ready to be shared as a formal release, it can be published to [RubyGems](http://www.rubygems.org).
-For more information about publishing gems to RubyGems, see: [Creating and Publishing Your First Ruby Gem](http://blog.thepete.net/2010/11/creating-and-publishing-your-first-ruby.html).
-
-RDoc Documentation
-------------------
-
-Once your plugin is stable and you are ready to deploy, do everyone else a favor and document it! Luckily, writing documentation for your plugin is easy.
-
-The first step is to update the README file with detailed information about how to use your plugin. A few key things to include are:
-
-* Your name
-* How to install
-* How to add the functionality to the app (several examples of common use cases)
-* Warnings, gotchas or tips that might help users and save them time
-
-Once your README is solid, go through and add rdoc comments to all of the methods that developers will use. It's also customary to add '#:nodoc:' comments to those parts of the code that are not included in the public API.
-
-Once your comments are good to go, navigate to your plugin directory and run:
-
-```bash
-$ bin/rake rdoc
-```
-
-### References
-
-* [Developing a RubyGem using Bundler](https://github.com/radar/guides/blob/master/gem-development.md)
-* [Using .gemspecs as Intended](http://yehudakatz.com/2010/04/02/using-gemspecs-as-intended/)
-* [Gemspec Reference](http://guides.rubygems.org/specification-reference/)
-* [GemPlugins: A Brief Introduction to the Future of Rails Plugins](http://www.intridea.com/blog/2008/6/11/gemplugins-a-brief-introduction-to-the-future-of-rails-plugins)

data/guides/source/rails_application_templates.md

@@ -1,266 +0,0 @@
-Rails Application Templates
-===========================
-
-Application templates are simple Ruby files containing DSL for adding gems/initializers etc. to your freshly created Rails project or an existing Rails project.
-
-After reading this guide, you will know:
-
-* How to use templates to generate/customize Rails applications.
-* How to write your own reusable application templates using the Rails template API.
-
---------------------------------------------------------------------------------
-
-Usage
------
-
-To apply a template, you need to provide the Rails generator with the location of the template you wish to apply using the -m option. This can either be a path to a file or a URL.
-
-```bash
-$ rails new blog -m ~/template.rb
-$ rails new blog -m http://example.com/template.rb
-```
-
-You can use the rake task `rails:template` to apply templates to an existing Rails application. The location of the template needs to be passed in to an environment variable named LOCATION. Again, this can either be path to a file or a URL.
-
-```bash
-$ bin/rake rails:template LOCATION=~/template.rb
-$ bin/rake rails:template LOCATION=http://example.com/template.rb
-```
-
-Template API
-------------
-
-The Rails templates API is easy to understand. Here's an example of a typical Rails template:
-
-```ruby
-# template.rb
-generate(:scaffold, "person name:string")
-route "root to: 'people#index'"
-rake("db:migrate")
-
-after_bundle do
-  git :init
-  git add: "."
-  git commit: %Q{ -m 'Initial commit' }
-end
-```
-
-The following sections outline the primary methods provided by the API:
-
-### gem(*args)
-
-Adds a `gem` entry for the supplied gem to the generated application's `Gemfile`.
-
-For example, if your application depends on the gems `bj` and `nokogiri`:
-
-```ruby
-gem "bj"
-gem "nokogiri"
-```
-
-Please note that this will NOT install the gems for you and you will have to run `bundle install` to do that.
-
-```bash
-bundle install
-```
-
-### gem_group(*names, &block)
-
-Wraps gem entries inside a group.
-
-For example, if you want to load `rspec-rails` only in the `development` and `test` groups:
-
-```ruby
-gem_group :development, :test do
-  gem "rspec-rails"
-end
-```
-
-### add_source(source, options = {})
-
-Adds the given source to the generated application's `Gemfile`.
-
-For example, if you need to source a gem from `"http://code.whytheluckystiff.net"`:
-
-```ruby
-add_source "http://code.whytheluckystiff.net"
-```
-
-### environment/application(data=nil, options={}, &block)
-
-Adds a line inside the `Application` class for `config/application.rb`.
-
-If `options[:env]` is specified, the line is appended to the corresponding file in `config/environments`.
-
-```ruby
-environment 'config.action_mailer.default_url_options = {host: "http://yourwebsite.example.com"}', env: 'production'
-```
-
-A block can be used in place of the `data` argument.
-
-### vendor/lib/file/initializer(filename, data = nil, &block)
-
-Adds an initializer to the generated application's `config/initializers` directory.
-
-Let's say you like using `Object#not_nil?` and `Object#not_blank?`:
-
-```ruby
-initializer 'bloatlol.rb', <<-CODE
-  class Object
-    def not_nil?
-      !nil?
-    end
-
-    def not_blank?
-      !blank?
-    end
-  end
-CODE
-```
-
-Similarly, `lib()` creates a file in the `lib/` directory and `vendor()` creates a file in the `vendor/` directory.
-
-There is even `file()`, which accepts a relative path from `Rails.root` and creates all the directories/files needed:
-
-```ruby
-file 'app/components/foo.rb', <<-CODE
-  class Foo
-  end
-CODE
-```
-
-That'll create the `app/components` directory and put `foo.rb` in there.
-
-### rakefile(filename, data = nil, &block)
-
-Creates a new rake file under `lib/tasks` with the supplied tasks:
-
-```ruby
-rakefile("bootstrap.rake") do
-  <<-TASK
-    namespace :boot do
-      task :strap do
-        puts "i like boots!"
-      end
-    end
-  TASK
-end
-```
-
-The above creates `lib/tasks/bootstrap.rake` with a `boot:strap` rake task.
-
-### generate(what, *args)
-
-Runs the supplied rails generator with given arguments.
-
-```ruby
-generate(:scaffold, "person", "name:string", "address:text", "age:number")
-```
-
-### run(command)
-
-Executes an arbitrary command. Just like the backticks. Let's say you want to remove the `README.rdoc` file:
-
-```ruby
-run "rm README.rdoc"
-```
-
-### rake(command, options = {})
-
-Runs the supplied rake tasks in the Rails application. Let's say you want to migrate the database:
-
-```ruby
-rake "db:migrate"
-```
-
-You can also run rake tasks with a different Rails environment:
-
-```ruby
-rake "db:migrate", env: 'production'
-```
-
-### route(routing_code)
-
-Adds a routing entry to the `config/routes.rb` file. In the steps above, we generated a person scaffold and also removed `README.rdoc`. Now, to make `PeopleController#index` the default page for the application:
-
-```ruby
-route "root to: 'person#index'"
-```
-
-### inside(dir)
-
-Enables you to run a command from the given directory. For example, if you have a copy of edge rails that you wish to symlink from your new apps, you can do this:
-
-```ruby
-inside('vendor') do
-  run "ln -s ~/commit-rails/rails rails"
-end
-```
-
-### ask(question)
-
-`ask()` gives you a chance to get some feedback from the user and use it in your templates. Let's say you want your user to name the new shiny library you're adding:
-
-```ruby
-lib_name = ask("What do you want to call the shiny library ?")
-lib_name << ".rb" unless lib_name.index(".rb")
-
-lib lib_name, <<-CODE
-  class Shiny
-  end
-CODE
-```
-
-### yes?(question) or no?(question)
-
-These methods let you ask questions from templates and decide the flow based on the user's answer. Let's say you want to freeze rails only if the user wants to:
-
-```ruby
-rake("rails:freeze:gems") if yes?("Freeze rails gems?")
-# no?(question) acts just the opposite.
-```
-
-### git(:command)
-
-Rails templates let you run any git command:
-
-```ruby
-git :init
-git add: "."
-git commit: "-a -m 'Initial commit'"
-```
-
-### after_bundle(&block)
-
-Registers a callback to be executed after the gems are bundled and binstubs
-are generated. Useful for all generated files to version control:
-
-```ruby
-after_bundle do
-  git :init
-  git add: '.'
-  git commit: "-a -m 'Initial commit'"
-end
-```
-
-The callbacks gets executed even if `--skip-bundle` and/or `--skip-spring` has
-been passed.
-
-Advanced Usage
---------------
-
-The application template is evaluated in the context of a
-`Rails::Generators::AppGenerator` instance. It uses the `apply` action
-provided by
-[Thor](https://github.com/erikhuda/thor/blob/master/lib/thor/actions.rb#L207).
-This means you can extend and change the instance to match your needs.
-
-For example by overwriting the `source_paths` method to contain the
-location of your template. Now methods like `copy_file` will accept
-relative paths to your template's location.
-
-```ruby
-def source_paths
-  [File.expand_path(File.dirname(__FILE__))]
-end
-```