From 4443f4173ba3bda535a49f3507375848c253da22 Mon Sep 17 00:00:00 2001
From: Mikel Lindsaar <raasdnil@gmail.com>
Date: Fri, 22 Jan 2010 14:54:32 +1100
Subject: Added more documentation on railtie.rb

---
 railties/lib/rails/railtie.rb | 67 ++++++++++++++++++++++++++++++++++---------
 1 file changed, 53 insertions(+), 14 deletions(-)

(limited to 'railties/lib/rails/railtie.rb')

diff --git a/railties/lib/rails/railtie.rb b/railties/lib/rails/railtie.rb
index cba18a5196..49a4d22319 100644
--- a/railties/lib/rails/railtie.rb
+++ b/railties/lib/rails/railtie.rb
@@ -8,7 +8,7 @@ module Rails
   # 
   # In fact, every major component of Rails (Action Mailer, Action Controller,
   # Action View, Active Record and Active Resource) are all now just plain
-  # old plugins.
+  # old plugins, so anything they can do, your plugin can do.
   # 
   # Developing a plugin for Rails does not _require_ any implementation of
   # Railtie, there is no fixed rule, but as a guideline, if your plugin works
@@ -33,41 +33,80 @@ module Rails
   # way to do it through Railtie, if there isn't, then you have found a lacking
   # feature of Railtie, please lodge a ticket.
   # 
-  # Implementing Railtie in your plugin is done with the following:
+  # Implementing Railtie in your plugin is by creating a class Railtie in your
+  # application that has your plugin name and making sure that this gets loaded
+  # durng boot time of the Rails stack.
   # 
-  # * Create a class Railtie which inherits from Rails::Railtie and is namespaced
-  #   to your plugin
-  #
+  # You can do this however you wish, but three straight forward ways are:
+  # 
+  # == For gems or plugins that are not used outside of Rails
+  # 
+  # * Create a Railtie subclass within your lib/my_plugin.rb file:
+  #   
+  #   # lib/my_plugin.rb
   #   module MyPlugin
   #     class Railtie < Rails::Railtie
   #     end
   #   end
   # 
-  # * Require your own plugin as well as rails in this file.
+  # * Pass in your plugin name
+  # 
+  #   # lib/my_plugin.rb
+  #   module MyPlugin
+  #     class Railtie < Rails::Railtie
+  #       plugin_name :my_plugin
+  #     end
+  #   end
+  #   
+  # == For gems that could be used without Rails
   # 
-  #   require 'my_plugin'
+  # * Create a file (say, lib/my_gem/railtie.rb) which contains class Railtie inheriting from
+  #   Rails::Railtie and is namespaced to your gem:
+  #
+  #   # lib/my_gem/railtie.rb
+  #   module MyGem
+  #     class Railtie < Rails::Railtie
+  #     end
+  #   end
+  # 
+  # * Require your own gem as well as rails in this file:
+  # 
+  #   # lib/my_gem/railtie.rb
+  #   require 'my_gem'
   #   require 'rails'
   # 
-  #   module MyPlugin
+  #   module MyGem
   #     class Railtie < Rails::Railtie
   #     end
   #   end
   #   
-  # * Give your plugin a unique name
+  # * Give your gem a unique name:
   # 
-  #   require 'my_plugin'
+  #   # lib/my_gem/railtie.rb
+  #   require 'my_gem'
   #   require 'rails'
   # 
-  #   module MyPlugin
+  #   module MyGem
   #     class Railtie < Rails::Railtie
-  #       plugin_name :my_plugin
+  #       plugin_name :my_gem
   #     end
   #   end
   # 
-  # * Then start implementing the components of Railtie you need to
-  #   get your plugin working!
+  # * Make sure your Gem loads the railtie.rb file if Rails is loaded first, an easy
+  #   way to check is by checking for the Rails constant which will exist if Rails
+  #   has started:
   # 
+  #   # lib/my_gem.rb
+  #   module MyGem
+  #     require 'lib/railtie' if defined?(Rails)
+  #   end
   # 
+  # * Or instead of doing the require automatically, you can ask your users to require
+  #   it for you in their Gemfile:
+  # 
+  #   # #{USER_RAILS_ROOT}/Gemfile
+  #   gem "my_gem", :require_as => ["my_gem", "my_gem/railtie"]
+  #
   class Railtie
     include Initializable
 
-- 
cgit v1.2.3