pluginator 0.9.0

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+#ruby=1.9.3
+
+gemspec

data/README.md

@@ -0,0 +1,86 @@
+# Pluginator
+
+Gem plugin system management, detects plugins using `Gem.find_file`.
+Is only supposed with ruby 1.9.2+
+
+Pluginator tries to stay out of your way, you do not have to include or inherit anything.
+Pluginator only finds and groups plugins, rest is up to you,
+you decide what methods to define and how to find them.
+
+## Defining plugins
+
+crate a gem with a path:
+
+```ruby
+plugins/<prefix>/<type>/<name>.rb
+```
+
+with a class inside:
+
+```ruby
+<prefix>::<type>::<name>
+```
+
+where `<type>` can be nested
+
+## Loading plugins
+
+```ruby
+rvm2plugins = Pluginator.new("<prefix>")
+type_plugins = rvm2plugins["<type>"]
+types = rvm2plugins.types
+```
+
+## Examples
+
+### Example 1 - task plugins
+
+`plugins/rvm2/cli/echo.rb`:
+
+```ruby
+class Rvm2::Cli::Echo
+  def self.question? command
+    command == "echo"
+  end
+  def answer param
+    puts param
+  end
+end
+```
+
+where `question?` and `answer` are user defined methods
+
+Now the plugin can be used:
+
+```ruby
+require 'pluginator'
+
+rvm2plugins = Pluginator.new("rvm2")
+plugin = rvm2plugins["cli"].first{ |plugin|
+  plugin.question?('echo')
+}
+plugin.new.answer("Hello world")
+```
+
+### Example 2 - hook plugins
+
+`plugins/rvm2/hooks/after_install/show.rb`:
+
+```ruby
+class Rvm2::Hooks::AfterInstall::Show
+  def self.execute name, path
+    puts "Ruby '#{name}' was installed in '#{path}'."
+  end
+end
+```
+
+and using hooks:
+
+```ruby
+require 'pluginator'
+
+rvm2plugins = Pluginator.new("rvm2")
+plugin = rvm2plugins["hooks/after_install"].each{ |plugin|
+  plugin.execute(name, path)
+}
+```

data/lib/pluginator.rb

@@ -0,0 +1,84 @@
+class Pluginator
+  attr_reader :plugins_name
+
+  def initialize(plugins_name)
+    @plugins = {}
+    @plugins_name = plugins_name
+    detect
+  end
+
+  def first_plugin type, method, *args
+    result = nil
+    name, plugin = all_by_type(type).detect do |name, plugin|
+      result = plugin.send(method.to_sym, *args)
+    end
+    [ name, plugin, result ]
+  end
+
+  def all_by_type type
+    @plugins[type.to_s]
+  end
+  alias :[] :all_by_type
+
+  def types
+    @plugins.keys
+  end
+
+# TODO do we need those???
+  def all_plugins type, method, *args
+    @plugins[type.to_s].select do |name,plugin|
+      plugin.send(method.to_sym, *args)
+    end
+  end
+  def first_plugin_by_parent parent_class
+    @plugins.detect do |type, plugins|
+      plugins.detect do |name, plugin|
+        plugin < parent_class
+      end
+    end
+  end
+  def find_class_by_parent parent_class
+    classes = []
+    ObjectSpace.each_object(Class) do |klass|
+      classes << klass if klass < parent_class
+    end
+    classes
+  end
+
+private
+
+  def detect
+    Gem.find_files("plugins/#{@plugins_name}/*/*.rb").each do |file_name|
+# $stderr.puts "parsing #{file_name}"
+      path, name, type = file_name.match(/.*\/(plugins\/(#{@plugins_name}\/(.*)\/[^\/]*)\.rb)$/)[1..3]
+      load_plugin path, file_name
+      register_plugin type, name
+    end
+  end
+
+  def load_plugin path, file_name
+    gemspec = Gem::Specification.find_by_path(path)
+    gemspec.activate if gemspec && !gemspec.activated?
+    require path
+  end
+
+  def register_plugin type, name
+    type = type.to_s
+    @plugins[type] ||= {}
+    if @plugins[type][name].nil?
+# $stderr.puts "loading #{name}"
+      @plugins[type][name] = name2class(name)
+    end
+  end
+
+  def name2class name
+    klass = Kernel
+    name.split(/\//).map{ |part|
+      part.capitalize.gsub(/_(.)/){ $1.upcase }
+    }.each{|part|
+      klass = klass.const_get( part )
+    }
+    klass
+  end
+
+end

data/pluginator.gemspec

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "pluginator"
+  s.version = "0.9.0"
+  s.authors = ["Michal Papis"]
+  s.email = ["mpapis@gmail.com"]
+  s.homepage = "https://github.com/mpapis/pluginator"
+  s.summary = %q{Rubygesm plugin system using Gem.find_files.}
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.required_ruby_version = '>= 1.9.2'
+
+  #s.add_development_dependency "smf-gem"
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: pluginator
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
+platform: ruby
+authors:
+- Michal Papis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-14 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- mpapis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- lib/pluginator.rb
+- pluginator.gemspec
+homepage: https://github.com/mpapis/pluginator
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Rubygesm plugin system using Gem.find_files.
+test_files: []
+has_rdoc: