Changeset 2904

Timestamp:

11/07/05 08:09:38 (5 years ago)

Author:

bitsweat

Message:

New configuration option config.plugin_paths which may be a single path like the default 'vendor/plugins' or an array of paths: ['vendor/plugins', 'lib/plugins']. Plugins are discovered in nested paths, so you can organize your plugins directory as you like. Refactor load_plugin from load_plugins. Simplify initializer unit test. Closes #2757.

Files:

• trunk/railties/CHANGELOG (modified) (1 diff)
• trunk/railties/lib/initializer.rb (modified) (13 diffs)
• trunk/railties/test/fixtures/environment_with_constant.rb (modified) (1 diff)
• trunk/railties/test/fixtures/plugins (added)
• trunk/railties/test/fixtures/plugins/alternate (added)
• trunk/railties/test/fixtures/plugins/alternate/a (added)
• trunk/railties/test/fixtures/plugins/alternate/a/lib (added)
• trunk/railties/test/fixtures/plugins/default (added)
• trunk/railties/test/fixtures/plugins/default/acts (added)
• trunk/railties/test/fixtures/plugins/default/acts/acts_as_chunky_bacon (added)
• trunk/railties/test/fixtures/plugins/default/acts/acts_as_chunky_bacon/lib (added)
• trunk/railties/test/fixtures/plugins/default/empty (added)
• trunk/railties/test/fixtures/plugins/default/stubby (added)
• trunk/railties/test/fixtures/plugins/default/stubby/init.rb (added)
• trunk/railties/test/fixtures/plugins/default/stubby/lib (added)
• trunk/railties/test/fixtures/plugins/default/stubby/lib/stubby_mixin.rb (added)
• trunk/railties/test/initializer_test.rb (modified) (1 diff)
• trunk/railties/test/plugin_test.rb (added)

trunk/railties/CHANGELOG

@@ -1 +1 @@
-*SVN*
+
+* New configuration option config.plugin_paths which may be a single path like the default 'vendor/plugins' or an array of paths: ['vendor/plugins', 'lib/plugins'].  [Jeremy Kemper]
+
+* Plugins are discovered in nested paths, so you can organize your plugins directory as you like.  [Jeremy Kemper]
+
+* Refactor load_plugin from load_plugins.  #2757 [alex.r.moon@gmail.com]
-
-* Make use of silence_stderr in script/lighttpd, script/plugin, and Rails::Info [Sam Stephenson]

trunk/railties/lib/initializer.rb

@@ -1 +1 @@
-require 'logger'
+require 'set'
-
-RAILS_ENV = (ENV['RAILS_ENV'] || 'development').dup unless defined?(RAILS_ENV)
@@ -23 +24 @@
-    # The Configuration instance used by this Initializer instance.
-    attr_reader :configuration
-
+
+
+
+
-    # Runs the initializer. By default, this will invoke the #process method,
-    # which simply executes all of the initialization routines. Alternately,
@@ -41 +45 @@
-    def initialize(configuration)
-      @configuration = configuration
-
-
+
+
+
-    # Sequentially step through all of the available initialization routines,
-    # in order:
@@ -121 +126 @@
-      require 'rails_info'
-    end
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
-    #
-    # After all plugins are loaded, duplicates are removed from the load path.
-    def load_plugins
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-      $LOAD_PATH.uniq!
-    end
@@ -261 +253 @@
-      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 which 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
+            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
+
+      # 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(path)
+        name = File.basename(path)
+        return false if loaded_plugins.include?(name)
+
+        # Catch nonexistent and empty plugins.
+        raise LoadError, "No such plugin: #{path}" unless plugin_path?(path)
+
+        lib_path  = File.join(path, 'lib')
+        init_path = File.join(path, 'init.rb')
+        has_lib   = File.directory?(lib_path)
+        has_init  = File.file?(init_path)
+
+        # Add lib to load path.
+        $LOAD_PATH.unshift(lib_path) if has_lib
+
+        # Evaluate init.rb.
+        silence_warnings { eval(IO.read(init_path), binding) } if has_init
+
+        # Add to set of loaded plugins.
+        loaded_plugins << name
+        true
+      end
-  end
-
+
-  # The Configuration class holds all the parameters for the Initializer and
-  # ships with defaults that suites most Rails applications. But it's possible
@@ -340 +386 @@
-    attr_accessor :whiny_nils
-    
+    # The path to the root of the plugins directory. By default, it is in
+    # <tt>vendor/plugins</tt>.
+    attr_accessor :plugin_paths
+
-    # Create a new Configuration instance, initialized with the default
-    # values.
@@ -352 +402 @@
-      self.breakpoint_server            = default_breakpoint_server
-      self.whiny_nils                   = default_whiny_nils
+      self.plugin_paths                 = default_plugin_paths
-      self.database_configuration_file  = default_database_configuration_file
-
+
-      for framework in default_frameworks
-        self.send("#{framework}=", OrderedOptions.new)
@@ -369 +420 @@
-    # default the file is at <tt>config/environments/#{environment}.rb</tt>.
-    def environment_path
-
-
-
-
-
-
-
-
-
+
+
+
-    # Return the currently selected environment. By default, it returns the
-    # value of the +RAILS_ENV+ constant.
@@ -385 +430 @@
-
-    private
+      def root_path
+        ::RAILS_ROOT
+      end
+
-      def default_frameworks
-        [ :active_record, :action_controller, :action_view, :action_mailer, :action_web_service ]
@@ -390 +439 @@
-    
-      def default_load_paths
-RAILS_ROOT
+root_path
-
-        # Then model subdirectories.
-        # TODO: Don't include .rb models as load paths
-RAILS_ROOT
-RAILS_ROOT
+root_path
+root_path
-
-        # Followed by the standard includes.
@@ -417 +466 @@
-          vendor/rails/actionmailer/lib
-          vendor/rails/actionwebservice/lib
-RAILS_ROOT
+root_path
-      end
-
-      def default_log_path
-RAILS_ROOT
+root_path
-      end
-      
@@ -429 +478 @@
-      
-      def default_database_configuration_file
-RAILS_ROOT
+root_path
-      end
-      
-      def default_view_path
-RAILS_ROOT
+root_path
-      end
-      
-      def default_controller_paths
-RAILS_ROOT, 'app', 'controllers'), File.join(RAILS_ROOT
+root_path, 'app', 'controllers'), File.join(root_path
-      end
-      
@@ -454 +503 @@
-      def default_whiny_nils
-        false
+      end
+
+      def default_plugin_paths
+        ["#{root_path}/vendor/plugins"]
-      end
-  end

trunk/railties/test/fixtures/environment_with_constant.rb

@@ -1 @@
-SET_FROM_ENV
+$initialize_test_set_from_env

trunk/railties/test/initializer_test.rb

@@ -16 +16 @@
-      @envpath
-    end
+
+    protected
+      def root_path
+        File.dirname(__FILE__)
+      end
-  end
-
-  def setup
-    Object.const_set(:RAILS_ROOT, "") rescue nil
-  end
-  
-  def teardown
-    Object.remove_const(:RAILS_ROOT) rescue nil
-  end
-  
-  def test_load_environment_with_constant
-    config = ConfigurationMock.new("#{File.dirname(__FILE__)}/fixtures/environment_with_constant.rb")
+    assert_nil $initialize_test_set_from_env
-    Rails::Initializer.run(:load_environment, config)
-
-
+
-  ensure
-Object.remove_const(:SET_FROM_ENV) rescue
+$initialize_test_set_from_env =
-  end
-end