diff options
author | Marcel Molina <marcel@vernix.org> | 2007-03-02 23:39:29 +0000 |
---|---|---|
committer | Marcel Molina <marcel@vernix.org> | 2007-03-02 23:39:29 +0000 |
commit | 15c466dd729e744379380d08b8c25b9860fd836d (patch) | |
tree | 1adf48f88b4cb7d7d98e939584f6c3c7a304bba5 /railties/lib/plugin/locator.rb | |
parent | b0e1430c523cf09155f72d5996be2cc2bf8e2eb7 (diff) | |
download | rails-15c466dd729e744379380d08b8c25b9860fd836d.tar.gz rails-15c466dd729e744379380d08b8c25b9860fd836d.tar.bz2 rails-15c466dd729e744379380d08b8c25b9860fd836d.zip |
Split out the basic plugin locator functionality into an abstract super class. Add a FileSystemLocator to do the job of checking the plugin_paths for plugins. Add plugin_locators configuration option which will iterate over the set of plugin locators and load each of the plugin loaders they return. Rename locater everywhere to locator. [Marcel Molina Jr.]
git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@6290 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
Diffstat (limited to 'railties/lib/plugin/locator.rb')
-rw-r--r-- | railties/lib/plugin/locator.rb | 75 |
1 files changed, 75 insertions, 0 deletions
diff --git a/railties/lib/plugin/locator.rb b/railties/lib/plugin/locator.rb new file mode 100644 index 0000000000..326a2a74f5 --- /dev/null +++ b/railties/lib/plugin/locator.rb @@ -0,0 +1,75 @@ +module Rails + module Plugin + class Locator + include Enumerable + attr_reader :initializer + + def initialize(initializer) + @initializer = initializer + end + + def plugins + located_plugins.select(&:enabled?).sort + end + + def each(&block) + plugins.each(&block) + end + + def plugin_names + plugins.map(&:name) + end + + private + def located_plugins + raise "The `located_plugins' method must be defined by concrete subclasses of #{self.class}" + end + end + + class FileSystemLocator < Locator + private + def located_plugins + returning locate_plugins do |loaders| + ensure_all_registered_plugins_are_loaded!(loaders) + end + end + + def locate_plugins + initializer.configuration.plugin_paths.flatten.inject([]) do |plugins, path| + plugins.concat locate_plugins_under(path) + plugins + end.flatten + end + + def ensure_all_registered_plugins_are_loaded!(loaders) + registered_plugins = initializer.configuration.plugins + unless registered_plugins.nil? || registered_plugins.empty? + missing_plugins = registered_plugins - loaders.map(&:name) + unless missing_plugins.empty? + raise LoadError, "Could not locate the following plugins: #{missing_plugins.inspect}" + end + end + end + + # This starts at the base path looking for directories that pass the plugin_path? test of the Plugin::Loader. + # 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') + # => 'acts_as_chunky_bacon' + def locate_plugins_under(base_path) + Dir.glob(File.join(base_path, '*')).inject([]) do |plugins, path| + plugin_loader = initializer.configuration.plugin_loader.new(initializer, path) + if plugin_loader.plugin_path? && plugin_loader.enabled? + plugins << plugin_loader + elsif File.directory?(path) + plugins.concat locate_plugins_under(path) + end + plugins + end + end + end + end +end
\ No newline at end of file |