redcar 0.3.1dev → 0.3.2dev

data/lib/plugin_manager/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/lib/plugin_manager/plugin_definition.rb

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

data/lib/plugin_manager/plugin_manager.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{plugin_manager}
+  s.version = "1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Daniel Lucraft"]
+  s.date = %q{2010-01-17}
+  s.default_executable = %q{plugin_manager}
+  s.email = %q{dan@fluentradical.com}
+  s.executables = ["plugin_manager"]
+  s.extra_rdoc_files = ["README.md"]
+  s.files = ["README.md", "bin", "spec", "lib/plugin_manager", "lib/plugin_manager/definition_builder.rb", "lib/plugin_manager/plugin.rb", "lib/plugin_manager/plugin_definition.rb", "lib/plugin_manager.rb", "bin/plugin_manager"]
+  s.homepage = %q{http://github.com/danlucraft/plugin_manager}
+  s.rdoc_options = ["--main", "README.md"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A Ruby plugin loader}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end

data/lib/plugin_manager/spec/fixtures/error_in_definition/core/plugin.rb

@@ -0,0 +1,2 @@
+
+foo[

data/lib/plugin_manager/spec/fixtures/error_in_plugin/core/core.rb

@@ -0,0 +1,4 @@
+
+
+[
+

data/lib/plugin_manager/spec/fixtures/error_in_plugin/core/plugin.rb

@@ -0,0 +1,7 @@
+
+Plugin.define do
+  name         "Core"
+  version      "1.0"
+  object       "App::Core"
+  file         "core"
+end

data/lib/plugin_manager/spec/fixtures/example/core/core.rb

@@ -0,0 +1,20 @@
+
+module App
+  def self.plugins
+    @plugins ||= []
+  end
+  
+  class << self
+    attr_accessor :times_loaded
+  end
+  
+  if self.times_loaded 
+    self.times_loaded += 1
+  else
+    self.times_loaded = 1
+  end
+  
+  class Core
+    App.plugins << :core
+  end
+end

data/lib/plugin_manager/spec/fixtures/example/core/plugin.rb

@@ -0,0 +1,7 @@
+
+Plugin.define do
+  name         "Core"
+  version      "1.0"
+  object       "App::Core"
+  file         "core"
+end

data/lib/plugin_manager/spec/fixtures/example/debug/debug.rb

@@ -0,0 +1,6 @@
+
+module App
+  class Debug
+    App.plugins << :debug
+  end
+end

data/lib/plugin_manager/spec/fixtures/example/debug/plugin.rb

@@ -0,0 +1,8 @@
+
+Plugin.define do
+  name         "Debug"
+  version      "1.0"
+  object       "App::Debug"
+  file          File.join(File.dirname(__FILE__), %w(debug))
+  dependencies "Extras", ">=1.0"
+end

data/lib/plugin_manager/spec/fixtures/example/extras/extras.rb

@@ -0,0 +1,6 @@
+
+module App
+  class Extras
+    App.plugins << :extras
+  end
+end

data/lib/plugin_manager/spec/fixtures/example/extras/plugin.rb

@@ -0,0 +1,8 @@
+
+Plugin.define do
+  name         "Extras"
+  version      "1.0"
+  object       "App::Extras"
+  file          File.join(File.dirname(__FILE__), %w(extras))
+  dependencies "Core", ">=1.0"
+end

data/lib/plugin_manager/spec/fixtures/two_versions1/core/core.rb

@@ -0,0 +1,20 @@
+
+module App
+  def self.plugins
+    @plugins ||= []
+  end
+  
+  class << self
+    attr_accessor :times_loaded
+  end
+  
+  if self.times_loaded 
+    self.times_loaded += 1
+  else
+    self.times_loaded = 1
+  end
+  
+  class Core
+    App.plugins << :core
+  end
+end

data/lib/plugin_manager/spec/fixtures/two_versions1/core/plugin.rb

@@ -0,0 +1,7 @@
+
+Plugin.define do
+  name         "Core"
+  version      "1.0"
+  object       "App::Core"
+  file         "core"
+end

data/lib/plugin_manager/spec/fixtures/two_versions1/core2/core.rb

@@ -0,0 +1,20 @@
+
+module App
+  def self.plugins
+    @plugins ||= []
+  end
+  
+  class << self
+    attr_accessor :times_loaded
+  end
+  
+  if self.times_loaded 
+    self.times_loaded += 1
+  else
+    self.times_loaded = 1
+  end
+  
+  class Core
+    App.plugins << :core
+  end
+end

data/lib/plugin_manager/spec/fixtures/two_versions1/core2/plugin.rb

@@ -0,0 +1,7 @@
+
+Plugin.define do
+  name         "Core"
+  version      "2.0"
+  object       "App::Core"
+  file         "core"
+end

data/lib/plugin_manager/spec/fixtures/two_versions2/core/core.rb

@@ -0,0 +1,20 @@
+
+module App
+  def self.plugins
+    @plugins ||= []
+  end
+  
+  class << self
+    attr_accessor :times_loaded
+  end
+  
+  if self.times_loaded 
+    self.times_loaded += 1
+  else
+    self.times_loaded = 1
+  end
+  
+  class Core
+    App.plugins << :core
+  end
+end

data/lib/plugin_manager/spec/fixtures/two_versions2/core/plugin.rb

@@ -0,0 +1,7 @@
+
+Plugin.define do
+  name         "Core"
+  version      "1.0"
+  object       "App::Core"
+  file         "core"
+end

data/lib/plugin_manager/spec/fixtures/two_versions2/core2/core.rb

@@ -0,0 +1,20 @@
+
+module App
+  def self.plugins
+    @plugins ||= []
+  end
+  
+  class << self
+    attr_accessor :times_loaded
+  end
+  
+  if self.times_loaded 
+    self.times_loaded += 1
+  else
+    self.times_loaded = 1
+  end
+  
+  class Core
+    App.plugins << :core
+  end
+end

data/lib/plugin_manager/spec/fixtures/two_versions2/core2/plugin.rb

@@ -0,0 +1,8 @@
+
+Plugin.define do
+  name         "Core"
+  version      "2.0"
+  object       "App::Core"
+  file         "core"
+  dependencies "foo", "1.111"
+end

data/lib/plugin_manager/spec/fixtures/unmet_dependencies1/core/core.rb

@@ -0,0 +1,10 @@
+
+module App
+  def self.plugins
+    @plugins ||= []
+  end
+  
+  class Core
+    App.plugins << :core
+  end
+end

data/lib/plugin_manager/spec/fixtures/unmet_dependencies1/core/plugin.rb

@@ -0,0 +1,7 @@
+
+Plugin.define do
+  name         "Core"
+  version      "1.0"
+  object       "App::Core"
+  file         "core"
+end

data/lib/plugin_manager/spec/fixtures/unmet_dependencies1/debug/debug.rb

@@ -0,0 +1,6 @@
+
+module App
+  class Debug
+    App.plugins << :debug
+  end
+end

data/lib/plugin_manager/spec/fixtures/unmet_dependencies1/debug/plugin.rb

@@ -0,0 +1,8 @@
+
+Plugin.define do
+  name         "Debug"
+  version      "1.0"
+  object       "App::Debug"
+  file          File.join(File.dirname(__FILE__), %w(debug))
+  dependencies "Extras", ">=1.0"
+end

data/lib/plugin_manager/spec/fixtures/unmet_dependencies2/core/core.rb

@@ -0,0 +1,10 @@
+
+module App
+  def self.plugins
+    @plugins ||= []
+  end
+  
+  class Core
+    App.plugins << :core
+  end
+end

data/lib/plugin_manager/spec/fixtures/unmet_dependencies2/core/plugin.rb

@@ -0,0 +1,7 @@
+
+Plugin.define do
+  name         "Core"
+  version      "1.0"
+  object       "App::Core"
+  file         "core"
+end

data/lib/plugin_manager/spec/fixtures/unmet_dependencies2/debug/debug.rb

@@ -0,0 +1,6 @@
+
+module App
+  class Debug
+    App.plugins << :debug
+  end
+end

data/lib/plugin_manager/spec/fixtures/unmet_dependencies2/debug/plugin.rb

@@ -0,0 +1,8 @@
+
+Plugin.define do
+  name         "Debug"
+  version      "1.0"
+  object       "App::Debug"
+  file          File.join(File.dirname(__FILE__), %w(debug))
+  dependencies "Core", ">=1.1"
+end

data/lib/plugin_manager/spec/plugin_manager_spec.rb

@@ -0,0 +1,208 @@
+
+require File.join(File.dirname(__FILE__), "spec_helper")
+
+describe PluginManager do
+  before do
+    @before_files = $".clone
+    if defined?(App)
+      App.times_loaded = 0
+    end
+  end
+  
+  after do
+    added_files = $".clone - @before_files
+    added_files.each do |file|
+      $".delete(file)
+    end
+  end
+  
+  describe "loading plugin definitions" do
+    before do
+      @manager = PluginManager.new
+      @manager.add_plugin_source(File.join(File.dirname(__FILE__), %w(fixtures example)))
+    end
+    
+    it "should find plugin files inside the source" do
+      @manager.plugins.map do |f| 
+        f.definition_file[/example\/(.*)\/plugin.rb/, 1]
+      end.sort.should == %w(core debug extras)
+    end
+    
+    it "should load the plugin definitions" do
+      @manager.plugins.length.should == 3
+      @manager.plugins.map {|d| d.name }.should == %w(Core Debug Extras)
+    end
+  end
+  
+  describe "loading plugin definitions with syntax errors in them" do
+    before do
+      @manager = PluginManager.new
+      @manager.add_plugin_source(File.join(File.dirname(__FILE__), %w(fixtures error_in_definition)))
+    end
+    
+    it "should not die when loading the definition" do
+      @manager.plugins.length.should == 0
+    end
+    
+    it "should report it as an error" do
+      @manager.unreadable_definitions.length.should == 1
+      @manager.unreadable_definitions.first.should == 
+        File.expand_path(File.join(File.dirname(__FILE__), %w(fixtures error_in_definition core plugin.rb)))
+    end
+  end
+  
+  describe "loading plugins" do
+    before do
+      @manager = PluginManager.new
+      @manager.add_plugin_source(File.join(File.dirname(__FILE__), %w(fixtures example)))
+      @manager.load
+    end
+    
+    it "should load the plugins in dependency order" do
+      App.plugins.should == [:core, :extras, :debug]
+    end
+    
+    it "should record the files that were loaded" do
+      @manager.plugins.find {|pl| pl.name == "Core"}.required_files.length.should == 1
+    end
+  end
+  
+  describe "loading plugins with errors in them" do
+    before do
+      @manager = PluginManager.new
+      @manager.add_plugin_source(File.join(File.dirname(__FILE__), %w(fixtures error_in_plugin)))
+    end
+    
+    it "should not die when loading plugins" do
+      @manager.load
+    end
+    
+    it "should report them as having errors" do
+      @manager.load
+      @manager.plugins_with_errors.length.should == 1
+      @manager.plugins_with_errors.first.name.should == "Core"
+    end
+  end
+  
+  describe "loading plugins with unmet dependencies because the plugin is missing" do
+    before do
+      @manager = PluginManager.new
+      @manager.add_plugin_source(File.join(File.dirname(__FILE__), %w(fixtures unmet_dependencies1)))
+    end
+    
+    it "should load the rest of the plugins ok" do
+      @manager.load
+      @manager.loaded_plugins.map {|pl| pl.name }.should == ["Core"]
+    end
+  end
+
+  describe "loading plugins with unmet dependencies because the plugin is not recent enough" do
+    before do
+      @manager = PluginManager.new
+      @manager.add_plugin_source(File.join(File.dirname(__FILE__), %w(fixtures unmet_dependencies2)))
+    end
+    
+    it "should load the rest of the plugins ok" do
+      @manager.load
+      @manager.loaded_plugins.map {|pl| pl.name }.should == ["Core"]
+    end
+  end
+  
+  describe "reloading plugins" do
+    before do
+      @manager = PluginManager.new
+      @manager.add_plugin_source(File.join(File.dirname(__FILE__), %w(fixtures example)))
+      @manager.load
+    end
+    
+    it "should actually reload the code" do
+      @manager.loaded_plugins.find {|pl| pl.name == "Core"}.load
+      App.times_loaded.should == 2
+    end
+  end
+  
+  describe "loading when there are multiple versions" do
+    before do
+      @manager = PluginManager.new
+      @manager.add_plugin_source(File.join(File.dirname(__FILE__), %w(fixtures two_versions1)))
+      @manager.load
+    end
+    
+    it "should only load one version" do
+      @manager.loaded_plugins.length.should == 1
+    end
+    
+    it "should load the most recent version" do
+      @manager.loaded_plugins.first.version.should == "2.0"
+    end
+  end
+  
+  describe "loading when there are multiple versions and the most recent has unmet deps" do
+    before do
+      @manager = PluginManager.new
+      @manager.add_plugin_source(File.join(File.dirname(__FILE__), %w(fixtures two_versions2)))
+      @manager.load
+    end
+     
+    it "should only load one version" do
+      @manager.loaded_plugins.length.should == 1
+    end
+    
+    it "should load the most recent version with met dependencies" do
+      @manager.loaded_plugins.first.version.should == "1.0"
+    end
+  end
+    
+  describe "version comparison" do
+    it "should return true if it is equal" do
+      PluginManager.compare_version("=1.0", "1.0").should be_true
+    end
+    
+    it "should return false if it is not equal" do
+      PluginManager.compare_version("=2.0", "1.0").should be_false
+    end
+    
+    it "should return true if it is bigger than" do
+      PluginManager.compare_version(">1.0", "2.0").should be_true
+    end
+    
+    it "should return false if it is bigger than and not valid" do
+      PluginManager.compare_version(">1.0", "0.5").should be_false
+    end
+    
+    it "should return true if it is bigger than or equal to" do
+      PluginManager.compare_version(">=1.0", "2.0").should be_true
+      PluginManager.compare_version(">=1.0", "1.0").should be_true
+      PluginManager.compare_version(">=1.0", "0.5").should be_false
+    end
+    
+    it "should match against multiple requirements" do
+      PluginManager.compare_version(">=1.0, <3.0", "2.0").should be_true
+      PluginManager.compare_version(">1.0, <=3.0", "5.0").should be_false
+      PluginManager.compare_version(">1.0, <3.0", "0.5").should be_false
+    end
+    
+    it "should match not equal requirements" do
+      PluginManager.compare_version("!=1.0", "2.0").should be_true
+      PluginManager.compare_version("!=1.0", "0.999").should be_true
+      PluginManager.compare_version("!=1.0", "1.0").should be_false
+    end
+    
+    it "should not care about trailing 0s" do
+      PluginManager.compare_version("=1.0", "1.0.0").should be_true
+      PluginManager.compare_version("!=1.0", "1.0.0").should be_false
+      PluginManager.compare_version("=1.0.0", "1.0").should be_true
+      PluginManager.compare_version("!=1.0.0", "1.0").should be_false
+      PluginManager.compare_version("=2.0.1.0", "2.0.1.0.0.0").should be_true
+    end
+  end
+end
+
+
+
+
+
+
+
+
+