railties 3.2.22.5 → 4.0.0.beta1

data/guides/source/rails_application_templates.textile

@@ -1,240 +0,0 @@
-h2. Rails Application Templates
-
-Application templates are simple Ruby files containing DSL for adding plugins/gems/initializers etc. to your freshly created Rails project or an existing Rails project.
-
-By referring to this guide, you will be able to:
-
-* Use templates to generate/customize Rails applications
-* Write your own reusable application templates using the Rails template API
-
-endprologue.
-
-h3. Usage
-
-To apply a template, you need to provide the Rails generator with the location of the template you wish to apply, using -m option. This can either be path to a file or a URL.
-
-<shell>
-$ rails new blog -m ~/template.rb
-$ rails new blog -m http://example.com/template.rb
-</shell>
-
-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.
-
-<shell>
-$ rake rails:template LOCATION=~/template.rb
-$ rake rails:template LOCATION=http://example.com/template.rb
-</shell>
-
-h3. Template API
-
-Rails templates API is very self explanatory and easy to understand. Here's an example of a typical Rails template:
-
-<ruby>
-# template.rb
-run "rm public/index.html"
-generate(:scaffold, "person name:string")
-route "root :to => 'people#index'"
-rake("db:migrate")
-
-git :init
-git :add => "."
-git :commit => "-a -m 'Initial commit'"
-</ruby>
-
-The following sections outlines the primary methods provided by the API:
-
-h4. gem(name, options = {})
-
-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"
-</ruby>
-
-Please note that this will NOT install the gems for you and you will have to run +bundle install+ to do that.
-
-<ruby>
-bundle install
-</ruby>
-
-h4. gem_group(*names, &block)
-
-Wraps gem entries inside a group.
-
-For example, if you want to load +rspec-rails+ only in +development+ and +test+ group:
-
-<ruby>
-gem_group :development, :test do
-  gem "rspec-rails"
-end
-</ruby>
-
-h4. 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"
-</ruby>
-
-h4. plugin(name, options = {})
-
-Installs a plugin to the generated application.
-
-Plugin can be installed from Git:
-
-<ruby>
-plugin 'authentication', :git => 'git://github.com/foor/bar.git'
-</ruby>
-
-You can even install plugins as git submodules:
-
-<ruby>
-plugin 'authentication', :git => 'git://github.com/foor/bar.git',
-                         :submodule => true
-</ruby>
-
-Please note that you need to +git :init+ before you can install a plugin as a submodule.
-
-Or use plain old SVN:
-
-<ruby>
-plugin 'usingsvn', :svn => 'svn://example.com/usingsvn/trunk'
-</ruby>
-
-h4. vendor/lib/file/initializer(filename, data = nil, &block)
-
-Adds an initializer to the generated application’s +config/initializers+ directory.
-
-Lets 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
-</ruby>
-
-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/file needed:
-
-<ruby>
-file 'app/components/foo.rb', <<-CODE
-class Foo
-end
-CODE
-</ruby>
-
-That’ll create +app/components+ directory and put +foo.rb+ in there.
-
-h4. 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
-</ruby>
-
-The above creates +lib/tasks/bootstrap.rake+ with a +boot:strap+ rake task.
-
-h4. generate(what, args)
-
-Runs the supplied rails generator with given arguments.
-
-<ruby>
-generate(:scaffold, "person", "name:string", "address:text", "age:number")
-</ruby>
-
-h4. run(command)
-
-Executes an arbitrary command. Just like the backticks. Let's say you want to remove the +public/index.html+ file:
-
-<ruby>
-run "rm public/index.html"
-</ruby>
-
-h4. 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"
-</ruby>
-
-You can also run rake tasks with a different Rails environment:
-
-<ruby>
-rake "db:migrate", :env => 'production'
-</ruby>
-
-h4. route(routing_code)
-
-This adds a routing entry to the +config/routes.rb+ file. In above steps, we generated a person scaffold and also removed +public/index.html+. Now to make +PeopleController#index+ as the default page for the application:
-
-<ruby>
-route "root :to => 'person#index'"
-</ruby>
-
-h4. 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
-</ruby>
-
-h4. ask(question)
-
-+ask()+ gives you a chance to get some feedback from the user and use it in your templates. Lets 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
-</ruby>
-
-h4. yes?(question) or no?(question)
-
-These methods let you ask questions from templates and decide the flow based on the user’s answer. Lets say you want to freeze rails only if the user want to:
-
-<ruby>
-rake("rails:freeze:gems") if yes?("Freeze rails gems ?")
-no?(question) acts just the opposite.
-</ruby>
-
-h4. git(:command)
-
-Rails templates let you run any git command:
-
-<ruby>
-git :init
-git :add => "."
-git :commit => "-a -m 'Initial commit'"
-</ruby>

data/guides/source/rails_on_rack.textile

@@ -1,236 +0,0 @@
-h2. Rails on Rack
-
-This guide covers Rails integration with Rack and interfacing with other Rack components. By referring to this guide, you will be able to:
-
-* Create Rails Metal applications
-* Use Rack Middlewares in your Rails applications
-* Understand Action Pack's internal Middleware stack
-* Define a custom Middleware stack
-
-endprologue.
-
-WARNING: This guide assumes a working knowledge of Rack protocol and Rack concepts such as middlewares, url maps and +Rack::Builder+.
-
-h3. Introduction to Rack
-
-bq. Rack provides a minimal, modular and adaptable interface for developing web applications in Ruby. By wrapping HTTP requests and responses in the simplest way possible, it unifies and distills the API for web servers, web frameworks, and software in between (the so-called middleware) into a single method call.
-
-- "Rack API Documentation":http://rack.rubyforge.org/doc/
-
-Explaining Rack is not really in the scope of this guide. In case you are not familiar with Rack's basics, you should check out the "Resources":#resources section below.
-
-h3. Rails on Rack
-
-h4. Rails Application's Rack Object
-
-<tt>ActionController::Dispatcher.new</tt> is the primary Rack application object of a Rails application. Any Rack compliant web server should be using +ActionController::Dispatcher.new+ object to serve a Rails application.
-
-h4. +rails server+
-
-<tt>rails server</tt> does the basic job of creating a +Rack::Builder+ object and starting the webserver. This is Rails' equivalent of Rack's +rackup+ script.
-
-Here's how +rails server+ creates an instance of +Rack::Builder+
-
-<ruby>
-app = Rack::Builder.new {
-  use Rails::Rack::LogTailer unless options[:detach]
-  use Rails::Rack::Debugger if options[:debugger]
-  use ActionDispatch::Static
-  run ActionController::Dispatcher.new
-}.to_app
-</ruby>
-
-Middlewares used in the code above are primarily useful only in the development environment. The following table explains their usage:
-
-|_.Middleware|_.Purpose|
-|+Rails::Rack::LogTailer+|Appends log file output to console|
-|+ActionDispatch::Static+|Serves static files inside +Rails.root/public+ directory|
-|+Rails::Rack::Debugger+|Starts Debugger|
-
-h4. +rackup+
-
-To use +rackup+ instead of Rails' +rails server+, you can put the following inside +config.ru+ of your Rails application's root directory:
-
-<ruby>
-# Rails.root/config.ru
-require "config/environment"
-
-use Rails::Rack::LogTailer
-use ActionDispatch::Static
-run ActionController::Dispatcher.new
-</ruby>
-
-And start the server:
-
-<shell>
-$ rackup config.ru
-</shell>
-
-To find out more about different +rackup+ options:
-
-<shell>
-$ rackup --help
-</shell>
-
-h3. Action Controller Middleware Stack
-
-Many of Action Controller's internal components are implemented as Rack middlewares. +ActionController::Dispatcher+ uses +ActionController::MiddlewareStack+ to combine various internal and external middlewares to form a complete Rails Rack application.
-
-NOTE: +ActionController::MiddlewareStack+ is Rails' equivalent of +Rack::Builder+, but built for better flexibility and more features to meet Rails' requirements.
-
-h4. Inspecting Middleware Stack
-
-Rails has a handy rake task for inspecting the middleware stack in use:
-
-<shell>
-$ rake middleware
-</shell>
-
-For a freshly generated Rails application, this might produce something like:
-
-<ruby>
-use ActionDispatch::Static
-use Rack::Lock
-use ActiveSupport::Cache::Strategy::LocalCache
-use Rack::Runtime
-use Rails::Rack::Logger
-use ActionDispatch::ShowExceptions
-use ActionDispatch::DebugExceptions
-use ActionDispatch::RemoteIp
-use Rack::Sendfile
-use ActionDispatch::Callbacks
-use ActiveRecord::ConnectionAdapters::ConnectionManagement
-use ActiveRecord::QueryCache
-use ActionDispatch::Cookies
-use ActionDispatch::Session::CookieStore
-use ActionDispatch::Flash
-use ActionDispatch::ParamsParser
-use Rack::MethodOverride
-use ActionDispatch::Head
-use ActionDispatch::BestStandardsSupport
-run Blog::Application.routes
-</ruby>
-
-Purpose of each of this middlewares is explained in the "Internal Middlewares":#internal-middleware-stack section.
-
-h4. Configuring Middleware Stack
-
-Rails provides a simple configuration interface +config.middleware+ for adding, removing and modifying the middlewares in the middleware stack via +application.rb+ or the environment specific configuration file <tt>environments/&lt;environment&gt;.rb</tt>.
-
-h5. Adding a Middleware
-
-You can add a new middleware to the middleware stack using any of the following methods:
-
-* <tt>config.middleware.use(new_middleware, args)</tt> - Adds the new middleware at the bottom of the middleware stack.
-
-* <tt>config.middleware.insert_before(existing_middleware, new_middleware, args)</tt> - Adds the new middleware before the specified existing middleware in the middleware stack.
-
-* <tt>config.middleware.insert_after(existing_middleware, new_middleware, args)</tt> - Adds the new middleware after the specified existing middleware in the middleware stack.
-
-<ruby>
-# config/application.rb
-
-# Push Rack::BounceFavicon at the bottom
-config.middleware.use Rack::BounceFavicon
-
-# Add Lifo::Cache after ActiveRecord::QueryCache.
-# Pass { :page_cache => false } argument to Lifo::Cache.
-config.middleware.insert_after ActiveRecord::QueryCache, Lifo::Cache, :page_cache => false
-</ruby>
-
-h5. Swapping a Middleware
-
-You can swap an existing middleware in the middleware stack using +config.middleware.swap+.
-
-<ruby>
-# config/application.rb
-
-# Replace ActionController::Failsafe with Lifo::Failsafe
-config.middleware.swap ActionController::Failsafe, Lifo::Failsafe
-</ruby>
-
-h5. Middleware Stack is an Array
-
-The middleware stack behaves just like a normal +Array+. You can use any +Array+ methods to insert, reorder, or remove items from the stack. Methods described in the section above are just convenience methods.
-
-For example, the following removes the middleware matching the supplied class name:
-
-<ruby>
-config.middleware.delete(middleware)
-</ruby>
-
-h4. Internal Middleware Stack
-
-Much of Action Controller's functionality is implemented as Middlewares. The following table explains the purpose of each of them:
-
-|_.Middleware|_.Purpose|
-|+Rack::Lock+|Sets <tt>env["rack.multithread"]</tt> flag to +true+ and wraps the application within a Mutex.|
-|+ActionController::Failsafe+|Returns HTTP Status +500+ to the client if an exception gets raised while dispatching.|
-|+ActiveRecord::QueryCache+|Enables the Active Record query cache.|
-|+ActionDispatch::Session::CookieStore+|Uses the cookie based session store.|
-|+ActionDispatch::Session::CacheStore+|Uses the Rails cache based session store.|
-|+ActionDispatch::Session::MemCacheStore+|Uses the memcached based session store.|
-|+ActiveRecord::SessionStore+|Uses the database based session store.|
-|+Rack::MethodOverride+|Sets HTTP method based on +_method+ parameter or <tt>env["HTTP_X_HTTP_METHOD_OVERRIDE"]</tt>.|
-|+Rack::Head+|Discards the response body if the client sends a +HEAD+ request.|
-
-TIP: It's possible to use any of the above middlewares in your custom Rack stack.
-
-h4. Customizing Internal Middleware Stack
-
-It's possible to replace the entire middleware stack with a custom stack using <tt>ActionController::Dispatcher.middleware=</tt>.
-
-Put the following in an initializer:
-
-<ruby>
-# config/initializers/stack.rb
-ActionController::Dispatcher.middleware = ActionController::MiddlewareStack.new do |m|
-  m.use ActionController::Failsafe
-  m.use ActiveRecord::QueryCache
-  m.use Rack::Head
-end
-</ruby>
-
-And now inspecting the middleware stack:
-
-<shell>
-$ rake middleware
-(in /Users/lifo/Rails/blog)
-use ActionController::Failsafe
-use ActiveRecord::QueryCache
-use Rack::Head
-run ActionController::Dispatcher.new
-</shell>
-
-h4. Using Rack Builder
-
-The following shows how to replace use +Rack::Builder+ instead of the Rails supplied +MiddlewareStack+.
-
-<strong>Clear the existing Rails middleware stack</strong>
-
-<ruby>
-# config/application.rb
-config.middleware.clear
-</ruby>
-
-<br />
-<strong>Add a +config.ru+ file to +Rails.root+</strong>
-
-<ruby>
-# config.ru
-use MyOwnStackFromScratch
-run ActionController::Dispatcher.new
-</ruby>
-
-h3. Resources
-
-h4. Learning Rack
-
-* "Official Rack Website":http://rack.github.com
-* "Introducing Rack":http://chneukirchen.org/blog/archive/2007/02/introducing-rack.html
-* "Ruby on Rack #1 - Hello Rack!":http://m.onkey.org/ruby-on-rack-1-hello-rack
-* "Ruby on Rack #2 - The Builder":http://m.onkey.org/ruby-on-rack-2-the-builder
-
-h4. Understanding Middlewares
-
-* "Railscast on Rack Middlewares":http://railscasts.com/episodes/151-rack-middleware