Changeset 6277

Timestamp:

03/02/07 00:20:32 (1 year ago)

Author:

marcel

Message:

Split plugin location and loading out of the initializer and into a new Plugin namespace, which includes Plugin::Locater and Plugin::Loader. The loader class that is used can be customized using the config.plugin_loader option. Those monkey patching the plugin loading subsystem take note, the internals changing here will likely break your modifications. The good news is that it should be substantially easier to hook into the plugin locating and loading process now. [Marcel Molina Jr.]

Files:

• trunk/railties/CHANGELOG (modified) (1 diff)
• trunk/railties/lib/initializer.rb (modified) (6 diffs)
• trunk/railties/lib/plugin (added)
• trunk/railties/lib/plugin/loader.rb (added)
• trunk/railties/lib/plugin/locater.rb (added)
• trunk/railties/test/fixtures/plugins/default/plugin_with_no_lib_dir (added)
• trunk/railties/test/fixtures/plugins/default/plugin_with_no_lib_dir/init.rb (added)
• trunk/railties/test/plugin_loader_test.rb (added)
• trunk/railties/test/plugin_locater_test.rb (added)
• trunk/railties/test/plugin_test_helper.rb (added)
• trunk/railties/test/plugin_test.rb (deleted)

trunk/railties/CHANGELOG

@@ -1 +1 @@
-*SVN*
+
+* Split plugin location and loading out of the initializer and into a new Plugin namespace, which includes Plugin::Locater and Plugin::Loader. The loader class that is used can be customized using the config.plugin_loader option.  Those monkey patching the plugin loading subsystem take note, the internals changing here will likely break your modifications. The good news is that it should be substantially easier to hook into the plugin locating and loading process now.  [Marcel Molina Jr.]
-
-* Added assumption that all plugin creators desire to be sharing individuals and release their work under the MIT license [DHH]

trunk/railties/lib/initializer.rb

@@ -3 +3 @@
-require File.join(File.dirname(__FILE__), 'railties_path')
-require File.join(File.dirname(__FILE__), 'rails/version')
+require File.join(File.dirname(__FILE__), 'plugin/locater')
+require File.join(File.dirname(__FILE__), 'plugin/loader')
+
-
-RAILS_ENV = (ENV['RAILS_ENV'] || 'development').dup unless defined?(RAILS_ENV)
@@ -185 +188 @@
-    # order.
-    def load_plugins
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
-    end
-
@@ -344 +338 @@
-      end
-    end
-
-    protected
-      # Return a list of plugin paths within base_path.  A plugin path is
-      # a directory that contains either a lib directory or an init.rb file.
-      # This recurses into directories which are not plugin paths, so you
-      # may organize your plugins within the plugin path.
-      def find_plugins(*base_paths)
-        base_paths.flatten.inject([]) do |plugins, base_path|
-          Dir.glob(File.join(base_path, '*')).each do |path|
-            if plugin_path?(path)
-              plugins << path if plugin_enabled?(path)
-            elsif File.directory?(path)
-              plugins += find_plugins(path)
-            end
-          end
-          plugins
-        end
-      end
-
-      def plugin_path?(path)
-        File.directory?(path) and (File.directory?(File.join(path, 'lib')) or File.file?(File.join(path, 'init.rb')))
-      end
-
-      def plugin_enabled?(path)
-        configuration.plugins.nil? || configuration.plugins.include?(File.basename(path))
-      end
-
-      # Load the plugin at <tt>path</tt> unless already loaded.
-      #
-      # Each plugin is initialized:
-      # * add its +lib+ directory, if present, to the beginning of the load path
-      # * evaluate <tt>init.rb</tt> if present
-      #
-      # Returns <tt>true</tt> if the plugin is successfully loaded or
-      # <tt>false</tt> if it is already loaded (similar to Kernel#require).
-      # Raises <tt>LoadError</tt> if the plugin is not found.
-      def load_plugin(directory)
-        name = File.basename(directory)
-        return false if loaded_plugins.include?(name)
-
-        # Catch nonexistent and empty plugins.
-        raise LoadError, "No such plugin: #{directory}" unless plugin_path?(directory)
-
-        lib_path  = File.join(directory, 'lib')
-        init_path = File.join(directory, 'init.rb')
-        has_lib   = File.directory?(lib_path)
-        has_init  = File.file?(init_path)
-
-        # Add lib to load path *after* the application lib, to allow
-        # application libraries to override plugin libraries.
-        if has_lib
-          application_lib_index = $LOAD_PATH.index(File.join(RAILS_ROOT, "lib")) || 0
-          $LOAD_PATH.insert(application_lib_index + 1, lib_path)
-          Dependencies.load_paths << lib_path
-          Dependencies.load_once_paths << lib_path
-        end
-
-        # Allow plugins to reference the current configuration object
-        config = configuration
-        
-        # Add to set of loaded plugins before 'name' collapsed in eval.
-        loaded_plugins << name
-
-        # Evaluate init.rb.
-        silence_warnings { eval(IO.read(init_path), binding, init_path) } if has_init
-
-        true
-      end
-  end
-
@@ -503 +429 @@
-    # <tt>vendor/plugins</tt>.
-    attr_accessor :plugin_paths
+    
+    # The class that handles loading each plugin. Defaults to Rails::Plugin::Loader, but 
+    # a sub class would have access to fine grained modification of the loading behavior. See
+    # the implementation of Rails::Plugin::Loader for more details.
+    attr_accessor :plugin_loader
-
-    # Create a new Configuration instance, initialized with the default
@@ -519 +450 @@
-      self.plugins                      = default_plugins
-      self.plugin_paths                 = default_plugin_paths
+      self.plugin_loader                = default_plugin_loader
-      self.database_configuration_file  = default_database_configuration_file
-
@@ -673 +605 @@
-        ["#{root_path}/vendor/plugins"]
-      end
+      
+      def default_plugin_loader
+        Plugin::Loader
+      end
-  end
-end