rails 1.0.0 → 2.0.0

data/lib/rails/plugin/loader.rb

@@ -0,0 +1,150 @@
+require "rails/plugin"
+
+module Rails
+  class Plugin
+    class Loader
+      attr_reader :initializer
+
+      # Creates a new Plugin::Loader instance, associated with the given
+      # Rails::Initializer. This default implementation automatically locates
+      # all plugins, and adds all plugin load paths, when it is created. The plugins
+      # are then fully loaded (init.rb is evaluated) when load_plugins is called.
+      #
+      # It is the loader's responsibility to ensure that only the plugins specified
+      # in the configuration are actually loaded, and that the order defined
+      # is respected.
+      def initialize(initializer)
+        @initializer = initializer
+      end
+      
+      # Returns the plugins to be loaded, in the order they should be loaded.
+      def plugins
+        @plugins ||= all_plugins.select { |plugin| should_load?(plugin) }.sort { |p1, p2| order_plugins(p1, p2) }
+      end
+
+      # Returns all the plugins that could be found by the current locators.
+      def all_plugins
+        @all_plugins ||= locate_plugins
+        @all_plugins
+      end
+    
+      def load_plugins
+        plugins.each do |plugin| 
+          plugin.load(initializer)
+          register_plugin_as_loaded(plugin)
+        end
+        ensure_all_registered_plugins_are_loaded!
+      end
+      
+      # Adds the load paths for every plugin into the $LOAD_PATH. Plugin load paths are
+      # added *after* the application's <tt>lib</tt> directory, to ensure that an application
+      # can always override code within a plugin.
+      #
+      # Plugin load paths are also added to Dependencies.load_paths, and Dependencies.load_once_paths.  
+      def add_plugin_load_paths
+        plugins.each do |plugin|
+          plugin.load_paths.each do |path|
+            $LOAD_PATH.insert(application_lib_index + 1, path)
+            Dependencies.load_paths      << path
+            Dependencies.load_once_paths << path
+          end
+        end
+        $LOAD_PATH.uniq!
+      end      
+      
+      protected
+      
+        # The locate_plugins method uses each class in config.plugin_locators to
+        # find the set of all plugins available to this Rails application.
+        def locate_plugins
+          configuration.plugin_locators.map { |locator|
+            locator.new(initializer).plugins
+          }.flatten
+          # TODO: sorting based on config.plugins
+        end
+
+        def register_plugin_as_loaded(plugin)
+          initializer.loaded_plugins << plugin
+        end
+
+        def configuration
+          initializer.configuration
+        end
+        
+        def should_load?(plugin)
+          # uses Plugin#name and Plugin#valid?
+          enabled?(plugin) && plugin.valid?
+        end
+
+        def order_plugins(plugin_a, plugin_b)
+          if !explicit_plugin_loading_order?
+            plugin_a <=> plugin_b
+          else
+            if !explicitly_enabled?(plugin_a) && !explicitly_enabled?(plugin_b)
+              plugin_a <=> plugin_b
+            else
+              effective_order_of(plugin_a) <=> effective_order_of(plugin_b)
+            end            
+          end
+        end
+        
+        def effective_order_of(plugin)
+          if explicitly_enabled?(plugin)
+            registered_plugin_names.index(plugin.name) 
+          else
+            registered_plugin_names.index('all')
+          end        
+        end
+
+        def application_lib_index
+          $LOAD_PATH.index(File.join(RAILS_ROOT, 'lib')) || 0
+        end      
+
+        def enabled?(plugin)
+          !explicit_plugin_loading_order? || registered?(plugin)
+        end
+
+        def explicit_plugin_loading_order?
+          !registered_plugin_names.nil?
+        end
+
+        def registered?(plugin)
+          explicit_plugin_loading_order? && registered_plugins_names_plugin?(plugin)
+        end
+
+        def explicitly_enabled?(plugin)
+          !explicit_plugin_loading_order? || explicitly_registered?(plugin)
+        end
+
+        def explicitly_registered?(plugin)
+          explicit_plugin_loading_order? && registered_plugin_names.include?(plugin.name)
+        end
+      
+        def registered_plugins_names_plugin?(plugin)
+          registered_plugin_names.include?(plugin.name) || registered_plugin_names.include?('all')
+        end
+        
+        # The plugins that have been explicitly listed with config.plugins. If this list is nil
+        # then it means the client does not care which plugins or in what order they are loaded, 
+        # so we load all in alphabetical order. If it is an empty array, we load no plugins, if it is
+        # non empty, we load the named plugins in the order specified.
+        def registered_plugin_names
+          configuration.plugins ? configuration.plugins.map(&:to_s) : nil
+        end
+        
+        def loaded?(plugin_name)
+          initializer.loaded_plugins.detect { |plugin| plugin.name == plugin_name.to_s }
+        end
+        
+        def ensure_all_registered_plugins_are_loaded!
+          if explicit_plugin_loading_order?
+            if configuration.plugins.detect {|plugin| plugin != :all && !loaded?(plugin) }
+              missing_plugins = configuration.plugins - (plugins + [:all])
+              raise LoadError, "Could not locate the following plugins: #{missing_plugins.to_sentence}"
+            end
+          end
+        end
+  
+    end
+  end
+end

data/lib/rails/plugin/locator.rb

@@ -0,0 +1,78 @@
+module Rails
+  class Plugin
+    
+    # The Plugin::Locator class should be subclasses to provide custom plugin-finding
+    # abilities to Rails (i.e. loading plugins from Gems, etc). Each subclass should implement
+    # the <tt>located_plugins</tt> method, which return an array of Plugin objects that have been found.
+    class Locator
+      include Enumerable
+      
+      attr_reader :initializer
+      
+      def initialize(initializer)
+        @initializer = initializer
+      end
+      
+      # This method should return all the plugins which this Plugin::Locator can find
+      # These will then be used by the current Plugin::Loader, which is responsible for actually
+      # loading the plugins themselves
+      def plugins
+        raise "The `plugins' method must be defined by concrete subclasses of #{self.class}"
+      end
+      
+      def each(&block)
+        plugins.each(&block)
+      end
+      
+      def plugin_names
+        plugins.map(&:name)
+      end
+    end
+    
+    # The Rails::Plugin::FileSystemLocator will try to locate plugins by examining the directories
+    # the the paths given in configuration.plugin_paths. Any plugins that can be found are returned
+    # in a list. 
+    #
+    # The criteria for a valid plugin in this case is found in Rails::Plugin#valid?, although
+    # other subclasses of Rails::Plugin::Locator can of course use different conditions.
+    class FileSystemLocator < Locator
+      
+      # Returns all the plugins which can be loaded in the filesystem, under the paths given
+      # by configuration.plugin_paths.
+      def plugins
+        initializer.configuration.plugin_paths.flatten.inject([]) do |plugins, path|
+          plugins.concat locate_plugins_under(path)
+          plugins
+        end.flatten
+      end
+          
+      private
+      
+        # Attempts to create a plugin from the given path. If the created plugin is valid?
+        # (see Rails::Plugin#valid?) then the plugin instance is returned; otherwise nil.
+        def create_plugin(path)
+          plugin = Rails::Plugin.new(path)
+          plugin.valid? ? plugin : nil
+        end
+
+        # This starts at the base path looking for valid plugins (see Rails::Plugin#valid?).
+        # Since plugins can be nested arbitrarily deep within an unspecified number of intermediary 
+        # directories, this method runs recursively until it finds a plugin directory, e.g.
+        #
+        #     locate_plugins_under('vendor/plugins/acts/acts_as_chunky_bacon')
+        #     => <Rails::Plugin name: 'acts_as_chunky_bacon' ... >
+        #
+        def locate_plugins_under(base_path)
+           Dir.glob(File.join(base_path, '*')).inject([]) do |plugins, path|
+            if plugin = create_plugin(path)
+              plugins << plugin
+            elsif File.directory?(path)
+              plugins.concat locate_plugins_under(path)
+            end
+            plugins
+          end
+        end
+        
+    end
+  end
+end

data/lib/rails/plugin.rb

@@ -0,0 +1,84 @@
+module Rails
+
+  # The Plugin class should be an object which provides the following methods:
+  #
+  # * +name+       - used during initialisation to order the plugin (based on name and
+  #                  the contents of <tt>config.plugins</tt>)
+  # * +valid?+     - returns true if this plugin can be loaded
+  # * +load_paths+ - each path within the returned array will be added to the $LOAD_PATH
+  # * +load+       - finally 'load' the plugin.
+  #
+  # These methods are expected by the Rails::Plugin::Locator and Rails::Plugin::Loader classes.
+  # The default implementation returns the <tt>lib</tt> directory as its </tt>load_paths</tt>, 
+  # and evaluates <tt>init.rb</tt> when <tt>load</tt> is called.
+  class Plugin
+    include Comparable
+    
+    attr_reader :directory, :name
+    
+    def initialize(directory)
+      @directory = directory
+      @name = File.basename(@directory) rescue nil
+      @loaded = false
+    end
+    
+    def valid?
+      File.directory?(directory) && (has_lib_directory? || has_init_file?)
+    end
+  
+    # Returns a list of paths this plugin wishes to make available in $LOAD_PATH
+    def load_paths
+      report_nonexistant_or_empty_plugin! unless valid?
+      has_lib_directory? ? [lib_path] : []
+    end
+
+    # Evaluates a plugin's init.rb file
+    def load(initializer)
+      return if loaded?
+      report_nonexistant_or_empty_plugin! unless valid?
+      evaluate_init_rb(initializer)
+      @loaded = true
+    end
+    
+    def loaded?
+      @loaded
+    end
+    
+    def <=>(other_plugin)
+      name <=> other_plugin.name
+    end
+    
+    private
+
+      def report_nonexistant_or_empty_plugin!
+        raise LoadError, "Can not find the plugin named: #{name}"
+      end      
+    
+      def lib_path
+        File.join(directory, 'lib')
+      end
+
+      def init_path
+        File.join(directory, 'init.rb')
+      end
+
+      def has_lib_directory?
+        File.directory?(lib_path)
+      end
+
+      def has_init_file?
+        File.file?(init_path)
+      end
+
+      def evaluate_init_rb(initializer)
+         if has_init_file?
+           silence_warnings do
+             # Allow plugins to reference the current configuration object
+             config = initializer.configuration
+             
+             eval(IO.read(init_path), binding, init_path)
+           end
+         end
+      end               
+  end
+end

data/lib/{rails_version.rb → rails/version.rb}

@@ -1,6 +1,6 @@
 module Rails
   module VERSION #:nodoc:
-    MAJOR = 1
+    MAJOR = 2
     MINOR = 0
     TINY  = 0
 

data/lib/rails_generator/base.rb

@@ -1,20 +1,50 @@
 require File.dirname(__FILE__) + '/options'
 require File.dirname(__FILE__) + '/manifest'
 require File.dirname(__FILE__) + '/spec'
+require File.dirname(__FILE__) + '/generated_attribute'
 
-# Rails::Generator is a code generation platform tailored for the Rails
-# web application framework.  Generators are easily invoked within Rails
-# applications to add and remove components such as models and controllers.
-# New generators are easy to create and may be distributed as RubyGems or
-# tarballs for inclusion system-wide, per-user, or per-application.
-#
-# Generators may subclass other generators to provide variations that
-# require little or no new logic but replace the template files.
-# The postback generator is an example:  it subclasses the scaffold
-# generator and just replaces the code templates with its own.
-#
-# Now go forth and multiply^Wgenerate.
 module Rails
+  # Rails::Generator is a code generation platform tailored for the Rails
+  # web application framework.  Generators are easily invoked within Rails
+  # applications to add and remove components such as models and controllers.
+  # New generators are easy to create and may be distributed as RubyGems,
+  # tarballs, or Rails plugins for inclusion system-wide, per-user, 
+  # or per-application.
+  #
+  # For actual examples see the rails_generator/generators directory in the
+  # Rails source (or the +railties+ directory if you have frozen the Rails
+  # source in your application).
+  #
+  # Generators may subclass other generators to provide variations that
+  # require little or no new logic but replace the template files.
+  #
+  # For a RubyGem, put your generator class and templates in the +lib+
+  # directory. For a Rails plugin, make a +generators+ directory at the 
+  # root of your plugin.
+  #
+  # The layout of generator files can be seen in the built-in 
+  # +controller+ generator:
+  #   
+  #   generators/
+  #     components/
+  #       controller/
+  #         controller_generator.rb
+  #         templates/
+  #           controller.rb
+  #           functional_test.rb
+  #           helper.rb
+  #           view.html.erb
+  #
+  # The directory name (+controller+) matches the name of the generator file
+  # (controller_generator.rb) and class (+ControllerGenerator+). The files
+  # that will be copied or used as templates are stored in the +templates+
+  # directory.
+  #
+  # The filenames of the templates don't matter, but choose something that
+  # will be self-explanatory since you will be referencing these in the 
+  # +manifest+ method inside your generator subclass.
+  #
+  # 
   module Generator
     class GeneratorError < StandardError; end
     class UsageError < GeneratorError; end
@@ -22,27 +52,36 @@ module Rails
 
     # The base code generator is bare-bones.  It sets up the source and
     # destination paths and tells the logger whether to keep its trap shut.
-    # You're probably looking for NamedBase, a subclass meant for generating
-    # "named" components such as models, controllers, and mailers.
+    #
+    # It's useful for copying files such as stylesheets, images, or 
+    # javascripts.
+    #
+    # For more comprehensive template-based passive code generation with
+    # arguments, you'll want Rails::Generator::NamedBase. 
     #
     # Generators create a manifest of the actions they perform then hand
-    # the manifest to a command which replay the actions to do the heavy
-    # lifting.  Create, destroy, and list commands are included.  Since a
+    # the manifest to a command which replays the actions to do the heavy
+    # lifting (such as checking for existing files or creating directories
+    # if needed). Create, destroy, and list commands are included.  Since a
     # single manifest may be used by any command, creating new generators is
     # as simple as writing some code templates and declaring what you'd like
     # to do with them.
     #
     # The manifest method must be implemented by subclasses, returning a
-    # Rails::Generator::Manifest.  The record method is provided as a
+    # Rails::Generator::Manifest.  The +record+ method is provided as a
     # convenience for manifest creation.  Example:
-    #   class EliteGenerator < Rails::Generator::Base
+    #
+    #   class StylesheetGenerator < Rails::Generator::Base
     #     def manifest
     #       record do |m|
-    #         m.do(some)
-    #         m.things(in) { here }
+    #         m.directory('public/stylesheets')
+    #         m.file('application.css', 'public/stylesheets/application.css')
     #       end
     #     end
     #   end
+    #
+    # See Rails::Generator::Commands::Create for a list of methods available
+    # to the manifest.
     class Base
       include Options
 
@@ -78,7 +117,7 @@ module Rails
         usage if options[:help]
       end
 
-      # Generators must provide a manifest.  Use the record method to create
+      # Generators must provide a manifest.  Use the +record+ method to create
       # a new manifest and record your generator's actions.
       def manifest
         raise NotImplementedError, "No manifest for '#{spec.name}' generator."
@@ -136,13 +175,25 @@ module Rails
     # The base generator for named components: models, controllers, mailers,
     # etc.  The target name is taken as the first argument and inflected to
     # singular, plural, class, file, and table forms for your convenience.
-    # The remaining arguments are aliased to actions for controller and
-    # mailer convenience.
+    # The remaining arguments are aliased to +actions+ as an array for 
+    # controller and mailer convenience.
+    #
+    # Several useful local variables and methods are populated in the 
+    # +initialize+ method. See below for a list of Attributes and
+    # External Aliases available to both the manifest and to all templates.    
     #
     # If no name is provided, the generator raises a usage error with content
     # optionally read from the USAGE file in the generator's base path.
     #
-    # See Rails::Generator::Base for a discussion of Manifests and Commands.
+    # For example, the +controller+ generator takes the first argument as 
+    # the name of the class and subsequent arguments as the names of
+    # actions to be generated:
+    #
+    #   ./script/generate controller Article index new create
+    #
+    # See Rails::Generator::Base for a discussion of manifests, 
+    # Rails::Generator::Commands::Create for methods available to the manifest,
+    # and Rails::Generator for a general discussion of generators.
     class NamedBase < Base
       attr_reader   :name, :class_name, :singular_name, :plural_name, :table_name
       attr_reader   :class_path, :file_path, :class_nesting, :class_nesting_depth
@@ -165,16 +216,25 @@ module Rails
         def banner
           "Usage: #{$0} #{spec.name} #{spec.name.camelize}Name [options]"
         end
+    
+        def attributes
+          @attributes ||= @args.collect do |attribute|
+            Rails::Generator::GeneratedAttribute.new(*attribute.split(":"))
+          end
+        end
+
 
       private
         def assign_names!(name)
           @name = name
           base_name, @class_path, @file_path, @class_nesting, @class_nesting_depth = extract_modules(@name)
           @class_name_without_nesting, @singular_name, @plural_name = inflect_names(base_name)
-          @table_name = ActiveRecord::Base.pluralize_table_names ? plural_name : singular_name
+          @table_name = (!defined?(ActiveRecord::Base) || ActiveRecord::Base.pluralize_table_names) ? plural_name : singular_name
+          @table_name.gsub! '/', '_'
           if @class_nesting.empty?
             @class_name = @class_name_without_nesting
           else
+            @table_name = @class_nesting.underscore << "_" << @table_name
             @class_name = "#{@class_nesting}::#{@class_name_without_nesting}"
           end
         end