plugin_manager 1

data/README.md

@@ -0,0 +1,61 @@
+
+Plugin Manager
+==============
+
+This is a plugin loader for Ruby. Features:
+
+  * dependencies
+  * versioning
+  * multiple plugin sources
+  * safe against plugins with broken code
+  * plugin code reloading
+  
+It is not tied to Rubygems or Rails. A plugin is any directory with a plugin.rb file
+inside that looks like this:
+    
+    Plugin.define do
+      name         "Extras"
+      version      "1.0"
+      
+      # the file to load to load the plugin. It is expected to be an .rb
+      # file relative to this definition
+      file         "extras"
+      
+      # this is an object that is defined by the plugin code
+      object       "App::Extras"
+      
+      # Dependencies of the plugin
+      dependencies "core", ">=1.0",
+                   "fonts", ">=0.5, <1.9",
+                   "debug", ">0, !=0.95, < 2"
+    end
+
+See the spec/fixtures/example/ directory for an example of a set of plugins.
+
+This
+directory of plugins can be loaded with:
+
+    manager = PluginManager.new
+    manager.add_plugin_source("spec/fixtures/example")
+    manager.load
+
+The code in the appropriate plugins will be loaded and you will then have available:
+    
+    # plugins that were loaded successfully
+    manager.loaded_plugins
+    
+    # plugins that could not be loaded because of unmet dependencies, 
+    # or because a more recent version was available.
+    manager.unloaded_plugins
+    
+    # plugin.rb files that could not be read
+    manager.unreadable_definitions
+    
+    # plugins that raised exceptions while being loaded
+    manager.plugins_with_errors
+
+
+License
+=======
+
+MIT

data/bin/plugin_manager

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require File.join(File.dirname(__FILE__), "..", "lib", "plugin_manager")
+

data/lib/plugin_manager/definition_builder.rb

@@ -0,0 +1,37 @@
+
+class PluginManager
+  class DefinitionBuilder
+    def initialize(&block)
+      @block = block
+      @definition = PluginDefinition.new
+    end
+    
+    def build
+      instance_eval(&@block)
+      @definition
+    end
+    
+    def name(value)
+      @definition.name = value
+    end
+    
+    def version(value)
+      @definition.version = value
+    end
+    
+    def object(value)
+      @definition.object = value
+    end
+    
+    def file(value)
+      @definition.file = value
+    end
+    
+    def dependencies(*deps)
+      @definition.dependencies ||= []
+      deps.each_slice(2) do |name, ver|
+        @definition.dependencies << [name, ver]
+      end
+    end
+  end
+end

data/lib/plugin_manager/plugin.rb

@@ -0,0 +1,9 @@
+
+class PluginManager
+  class Plugin
+    def self.define(&block)
+      builder = DefinitionBuilder.new(&block)
+      builder.build
+    end
+  end
+end

data/lib/plugin_manager/plugin_definition.rb

@@ -0,0 +1,37 @@
+
+class PluginManager
+  class PluginDefinition
+    attr_accessor :name,
+                  :version,
+                  :object,
+                  :file,
+                  :dependencies,
+                  :definition_file
+                  
+    def inspect
+      "<Plugin #{name} #{version} depends:[#{(dependencies||[]).map{|dep| dep.join("")}.join(", ")}] #{required_files.length} files>"
+    end
+    
+    def required_files
+      @required_files ||= []
+    end
+    
+    def load
+      required_files.each {|file| $".delete(file) }
+      new_files = log_requires do
+        require File.expand_path(File.join(File.dirname(definition_file), file))
+      end
+      required_files.unshift(*new_files)
+    end
+    
+    private
+    
+    def log_requires
+      before = $".dup 
+      yield
+      after = $".dup
+      result = after - before
+      result
+    end
+  end
+end

data/lib/plugin_manager.rb

@@ -0,0 +1,104 @@
+
+$:.unshift(File.dirname(__FILE__))
+
+require 'plugin_manager/plugin'
+require 'plugin_manager/plugin_definition'
+require 'plugin_manager/definition_builder'
+
+class PluginManager
+  attr_reader :unreadable_definitions, :plugins_with_errors, :loaded_plugins
+
+  def initialize
+    @unloaded_plugins = []
+    @loaded_plugins = []
+    @unreadable_definitions = []
+    @plugins_with_errors = []
+  end
+
+  def plugins
+    @unloaded_plugins + @loaded_plugins
+  end
+
+  def add_plugin_source(directory)
+    definition_files = Dir[File.join(File.expand_path(directory), "*", "plugin.rb")]
+    definition_files.reject! {|f| plugins.any? {|pl| pl.definition_file == File.expand_path(f) } }
+    new_definitions = 
+      definition_files.map do |file|
+        begin
+          definition = instance_eval(File.read(file))
+          definition.definition_file = File.expand_path(file)
+          definition
+        rescue Object
+          puts "Unreadable plugin definition: #{file}"
+          @unreadable_definitions << file
+          nil
+        end
+      end.compact.sort_by {|p| p.name.downcase }
+    @unloaded_plugins += new_definitions
+  end
+  
+  def load
+    previous_length = @unloaded_plugins.length + 1
+    while previous_length > @unloaded_plugins.length
+      previous_length = @unloaded_plugins.length
+      if plugin = next_to_load
+        begin
+          plugin.load
+        rescue Object => e
+          puts "Error loading plugin: #{plugin}"
+          puts "  " + e.message
+          puts e.backtrace.map {|l| "  " + l }
+          @plugins_with_errors << plugin
+        end
+        @loaded_plugins << plugin
+        @unloaded_plugins.delete(plugin)
+      end
+    end
+  end
+  
+  private
+  
+  def next_to_load
+    # this ordering ensures we try the most recent version of a plugin first
+    remaining_plugins = @unloaded_plugins.sort_by {|pl| pl.version }.reverse
+    
+    remaining_plugins.detect do |d|
+      next if @loaded_plugins.map {|pl| pl.name }.include?(d.name)
+      (d.dependencies||[]).all? do |dep|
+        req_name, req_ver = *dep
+        @loaded_plugins.detect do |d1| 
+          d1.name == req_name and 
+            PluginManager.compare_version(req_ver, d1.version)
+        end
+      end
+    end
+  end
+  
+  def self.compare_version(required, got)
+    got = got.gsub(/(\.0)+$/, "")
+    required.split(",").all? do |req|
+      req = req.strip
+      req = req.gsub(/(\.0)+$/, "")
+      if md = req.match(/^(=|>|>=|<|<=|!=)?([\d\.]*)$/)
+        case md[1]
+        when ">"
+          got > md[2]
+        when ">="
+          got >= md[2]
+        when "<"
+          got < md[2]
+        when "<="
+          got <= md[2]
+        when "="
+          md[2] == got
+        when "!="
+          md[2] != got
+        end
+      else
+        puts "don't recognize version string: #{required.inspect}"
+      end
+    end
+  end
+end
+
+

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: plugin_manager
+version: !ruby/object:Gem::Version 
+  version: "1"
+platform: ruby
+authors: 
+- Daniel Lucraft
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-16 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: dan@fluentradical.com
+executables: 
+- plugin_manager
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- README.md
+- lib/plugin_manager/definition_builder.rb
+- lib/plugin_manager/plugin.rb
+- lib/plugin_manager/plugin_definition.rb
+- lib/plugin_manager.rb
+has_rdoc: true
+homepage: http://github.com/danlucraft/plugin_manager
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.md
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A Ruby plugin loader
+test_files: []
+