Ticket #6726: add_elective_gem_plugin_support.diff

railties/test/plugin_test.rb

@@ -31 +31 @@
-    assert !@init.send(:plugin_path?, "#{File.dirname(__FILE__)}/fixtures/plugins/default/jalskdjflkas")
-  end
-
-
+_path
-    base    = "#{File.dirname(__FILE__)}/fixtures/plugins"
-    default = "#{base}/default"
-    alt     = "#{base}/alternate"
-    acts    = "#{default}/acts"
-
-
-
+_path
+_path
+_path
-  end
-
-
+_path
-    stubby = "#{File.dirname(__FILE__)}/fixtures/plugins/default/stubby"
-    expected = Set.new(['stubby'])
-
-
+_path
-    assert_equal expected, @init.loaded_plugins
-
-
+_path
-    assert_equal expected, @init.loaded_plugins
-
-
+_path
-    assert_equal expected, @init.loaded_plugins
-  end
-

railties/lib/initializer.rb

@@ -99 +99 @@
-      # could overwrite anything set from the defaults/global through
-      # the individual base class configurations.
-      load_environment
+      
+      load_plugins
-
-      add_support_load_paths
-
-      load_plugins
-
-      # Observers are loaded after plugins in case Observers or observed models are modified by plugins.
-      load_observers
-
@@ -166 +166 @@
-    def add_support_load_paths
-    end
-
-
+
+
+
+
-    # defaults to <tt>vendor/plugins</tt> but may also be set to a list of
-    # paths, such as
-    #   config.plugin_paths = ['lib/plugins', 'vendor/plugins']
-    #
-
-
-
+
+
+
+
-    #
+    #  To include version requirements for a gem plugin, use an array (like the arguments you'd pass
+    #  to <tt>require_gem</tt>), such as
+    #    config.plugins = ['foo', ['bar', '>1.0.7', '<=1.0.9'], 'baz']
+    #
-    # After all plugins are loaded, duplicates are removed from the load path.
-
+
+
-    def load_plugins
-
+
+
+
+
+
+
+
+
+
+
-      $LOAD_PATH.uniq!
-    end
-
@@ -323 +341 @@
-    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.
-
+_path
-        base_paths.flatten.inject([]) do |plugins, base_path|
-          Dir.glob(File.join(base_path, '*')).each do |path|
-            if plugin_path?(path)
-
+path_
-            elsif File.directory?(path)
-
+_path
-            end
-          end
-          plugins
-        end
-      end
+      
+      # Return a list of plugins and related gemspecs for plugins set in <tt>configuration.plugins</tt>
+      # and available as RubyGems (when not already loaded from <tt>find_plugins_paths</tt>).
+      def find_gem_plugins
+        configuration.plugins.inject([]) do |plugins,plugin|
+          next plugins if loaded_plugins.include?(plugin)
+          name, version_requirements = plugin.to_a
+          gem = Gem::Dependency.new(name, version_requirements || [])
+          if gemspec = Gem.source_index.find_name(gem.name, gem.version_requirements).last
+            plugins.push([plugin, gemspec])
+          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
-
-
+path_
-        configuration.plugins.empty? || configuration.plugins.include?(File.basename(path))
-      end
-
@@ -357 +390 @@
-      # 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.
-
+_path
-        name = File.basename(directory)
+        # Check this just in case, even though <tt>find_gem_plugins</tt> does when used normally
-        return false if loaded_plugins.include?(name)
-
-        # Catch nonexistent and empty plugins.
@@ -366 +400 @@
-
-        lib_path  = File.join(directory, 'lib')
-        init_path = File.join(directory, 'init.rb')
-
-
-
-
-
-
+
+
-          application_lib_index = $LOAD_PATH.index(File.join(RAILS_ROOT, "lib")) || 0
-          $LOAD_PATH.insert(application_lib_index + 1, lib_path)
-        end
-
-
-
-
+
-        # Add to set of loaded plugins before 'name' collapsed in eval.
-        loaded_plugins << name
-
-
-
-
+
+
+
+
+
+
+
-        true
-      end
+      
+      # Load plugin from RubyGem unless already loaded.
+      #
+      # Each plugin is initialized:
+      # * the gem is required (and its <tt>autorequire</tt>s automatically, too)
+      # * 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_gem_plugin(plugin, gemspec)
+        return false if loaded_plugins.include?(plugin)
+        require_gem gemspec.name, gemspec.version.version
+        directory = gemspec.full_gem_path
+        lib_path  = File.join(directory, 'lib')
+        init_path = File.join(directory, 'init.rb')
+        
+        if File.directory?(lib_path)
+          configuration.load_paths << lib_path
+          # Circumvent freeze
+          configuration.load_once_paths = configuration.load_once_paths.dup + [lib_path]
+        end
+        
+        if File.file?(init_path)
+          # Allow plugins to reference the current configuration object
+          config = configuration
+          # Evaluate init.rb.
+          silence_warnings { eval(IO.read(init_path), binding, init_path) }
+        end
+        
+      rescue LoadError => e
+        raise LoadError, "No such gem plugin: #{plugin.inspect} (#{e.message})"
+      end
+                  
-  end
-
-  # The Configuration class holds all the parameters for the Initializer and