pluginator 0.9.3 → 0.10.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4c2d1a80503ff918471f6e8477ac36987d7ae8bf
+  data.tar.gz: 0902865fc2f708aeb692a647cb4c0a8af808ecc1
+SHA512:
+  metadata.gz: ef24dd58904758e1ab42b0f8db5c6677b4c5d3ac0aca1551984c294cc06c0138282de6a5aaecb2e73540b8941399ebfd9e8352f221cc84dcb431e79f33c54c4b
+  data.tar.gz: 297af16db59fb91ae6b9fa1c66bff269bb38da2be00e13c87050ef1fa48f706af74deae591be4d0ef2ac7cd772d9bd9de8c2c91bd39a9db6eca14107b8705d73

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - rbx-19mode
+notifications:
+  irc:
+    channels:
+      - "irc.freenode.org#rvm-test"
+  email:
+    recipients:
+      - mpapis@gmail.com
+    on_failure: change

data/Gemfile

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

data/README.md

@@ -1,7 +1,7 @@
 # Pluginator
 
 Gem plugin system management, detects plugins using `Gem.find_file`.
-Is only supposed with ruby 1.9.2+
+Is only supposed with ruby 1.9.3+
 
 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,
@@ -12,13 +12,13 @@ you decide what methods to define and how to find them.
 crate a gem with a path:
 
 ```ruby
-plugins/<prefix>/<type>/<name>.rb
+plugins/<group>/<type>/<name>.rb
 ```
 
 with a class inside:
 
 ```ruby
-<prefix>::<type>::<name>
+<group>::<type>::<name>
 ```
 
 where `<type>` can be nested
@@ -26,7 +26,7 @@ where `<type>` can be nested
 ## Loading plugins
 
 ```ruby
-rvm2plugins = Pluginator.new("<prefix>")
+rvm2plugins = Pluginator::Autodetect.new("<group>")
 type_plugins = rvm2plugins["<type>"]
 types = rvm2plugins.types
 ```
@@ -55,7 +55,7 @@ Now the plugin can be used:
 ```ruby
 require 'pluginator'
 
-rvm2plugins = Pluginator.new("rvm2")
+rvm2plugins = Pluginator::Autodetect.new("rvm2")
 plugin = rvm2plugins["cli"].first{ |plugin|
   plugin.question?('echo')
 }
@@ -79,7 +79,7 @@ and using hooks:
 ```ruby
 require 'pluginator'
 
-rvm2plugins = Pluginator.new("rvm2")
+rvm2plugins = Pluginator::Autodetect.new("rvm2")
 plugin = rvm2plugins["hooks/after_install"].each{ |plugin|
   plugin.execute(name, path)
 }

data/Rakefile

@@ -1,4 +1,9 @@
 require "rake/testtask"
+
 task :default => [:test]
-task :spec => :test
-Rake::TestTask.new { |t| t.verbose, t.pattern = true, "test/**/test_*.rb" }
+
+Rake::TestTask.new do |t|
+  t.verbose = true
+  t.libs.push("demo")
+  t.pattern = "test/**/*_test.rb"
+end

data/demo/plugins/pluginator/math/decrease.rb

@@ -0,0 +1,8 @@
+class Pluginator::Math::Decrease
+  def self.type
+    "decrease"
+  end
+  def self.action(number)
+    number - 1
+  end
+end

data/demo/plugins/pluginator/math/increase.rb

@@ -0,0 +1,8 @@
+class Pluginator::Math::Increase
+  def self.type
+    "increase"
+  end
+  def self.action(number)
+    number + 1
+  end
+end

data/lib/pluginator/autodetect.rb

@@ -0,0 +1,35 @@
+require_relative "group"
+require_relative "name_converter"
+
+module Pluginator
+  class Autodetect < Group
+
+    def initialize(group)
+      super(group)
+      load_files(find_files)
+    end
+
+  private
+
+    include NameConverter
+
+    def load_files(file_names)
+      file_names.each do |file_name|
+        path, name, type = split_file_name(file_name, @group)
+        load_plugin path
+        register_plugin(type, name2class(name))
+      end
+    end
+
+    def find_files
+      Gem.find_files(file_name_pattern(@group))
+    end
+
+    def load_plugin(path)
+      gemspec = Gem::Specification.find_by_path(path)
+      gemspec.activate if gemspec && !gemspec.activated?
+      require path
+    end
+
+  end
+end

data/lib/pluginator/group.rb

@@ -0,0 +1,30 @@
+module Pluginator
+  class Group
+    attr_reader :group
+
+    def initialize(group)
+      setup(group)
+    end
+
+    def [](type)
+      @plugins[type.to_s]
+    end
+
+    def types
+      @plugins.keys
+    end
+
+    def register_plugin(type, klass)
+      type = type.to_s
+      @plugins[type] ||= []
+      @plugins[type].push(klass)
+    end
+
+  private
+
+    def setup(group)
+      @plugins = {}
+      @group = group
+    end
+  end
+end

data/lib/pluginator/name_converter.rb

@@ -0,0 +1,27 @@
+module Pluginator
+  module NameConverter
+  private
+
+    # file_name, group => [ path, full_name, type ]
+    def split_file_name(file_name, group)
+      file_name.match(/.*\/(plugins\/(#{group}\/(.*)\/[^\/]*)\.rb)$/)[1..3]
+    end
+
+    # group => pattern
+    def file_name_pattern(group)
+      "plugins/#{group}/**/*.rb"
+    end
+
+    # full_name => class
+    def name2class(name)
+      klass = Kernel
+      name.to_s.split(/\//).map{ |part|
+        part.capitalize.gsub(/_(.)/){ $1.upcase }
+      }.each{|part|
+        klass = klass.const_get( part )
+      }
+      klass
+    end
+
+  end
+end

data/lib/pluginator/version.rb

@@ -0,0 +1,3 @@
+module Pluginator
+  VERSION = "0.10.0"
+end

data/lib/pluginator.rb

@@ -1,94 +1,2 @@
-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
-
-  def register_plugin_class type, klass
-    type = type.to_s
-    name = class2name(klass)
-    @plugins[type] ||= {}
-    if @plugins[type][name].nil?
-      @plugins[type][name] = klass
-    end
-  end
-
-private
-
-  def detect
-    Gem.find_files("plugins/#{@plugins_name}/*/*.rb").each do |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?
-      @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
-
-  def class2name klass
-    klass.gsub(/([A-Z])/){|x| "_#{x.downcase}"}.gsub(/(^_|::_)/,"/")[1..-1]
-  end
-end
+require_relative "pluginator/autodetect"
+require_relative "pluginator/version"

data/pluginator.gemspec

@@ -1,18 +1,19 @@
 #!/usr/bin/env ruby
 # -*- encoding: utf-8 -*-
 
+require File.expand_path("../lib/pluginator/version.rb", __FILE__)
+
 Gem::Specification.new do |s|
   s.email = ["mpapis@gmail.com"]
   s.authors = ["Michal Papis"]
   s.name = "pluginator"
-  s.version = "0.9.3"
+  s.version = Pluginator::VERSION
   s.files = `git ls-files`.split("\n")
-  s.required_ruby_version = ">= 1.9.2"
-  s.add_development_dependency("simplecov")
+  s.required_ruby_version = ">= 1.9.3"
   s.add_development_dependency("rake")
   s.add_development_dependency("minitest")
   # s.add_development_dependency("smf-gem")
-  s.homepage = "https://github.com/mpapis/pluginator"
+  s.homepage = "https://github.com/rvm/pluginator"
   s.summary = "Rubygems plugin system using Gem.find_files."
   s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
 end

data/test/autodetect_test.rb

@@ -0,0 +1,75 @@
+require 'minitest/autorun'
+require 'pluginator/autodetect'
+
+def demo_file(path)
+  File.expand_path(File.join("..", "..", "demo", path), __FILE__)
+end
+
+def demo_files(*paths)
+  paths.flatten.map{|path| demo_file(path) }
+end
+
+module Pluginator::Math; end
+
+describe Pluginator::Autodetect do
+  before do
+    @demo_files = demo_files("plugins/pluginator/math/increase.rb", "plugins/pluginator/math/decrease.rb")
+  end
+
+  describe "separate" do
+    before do
+      @pluginator = Pluginator::Autodetect.allocate
+      @pluginator.send(:setup, "pluginator")
+    end
+
+    it "has name" do
+      @pluginator.group.must_equal("pluginator")
+    end
+
+    it "has demo file" do
+      File.exists?(demo_file("plugins/pluginator/math/increase.rb")).must_equal(true)
+    end
+
+    it "loads file" do
+      @pluginator.send(:load_plugin, "plugins/pluginator/math/increase.rb")
+    end
+
+    it "finds files" do
+      @pluginator.send(:find_files).sort.must_equal(@demo_files.sort)
+    end
+
+    it "loads plugins" do
+      @pluginator.send(:load_files, @demo_files)
+      @pluginator.types.must_include('math')
+      plugins = @pluginator["math"].map(&:to_s)
+      plugins.size.must_equal(2)
+      plugins.must_include("Pluginator::Math::Increase")
+      plugins.must_include("Pluginator::Math::Decrease")
+      plugins.wont_include("Pluginator::Math::Substract")
+    end
+  end
+
+  it "loads plugins automatically" do
+    pluginator = Pluginator::Autodetect.new("pluginator")
+    pluginator.types.must_include('math')
+    plugins = pluginator["math"].map(&:to_s)
+    plugins.size.must_equal(2)
+    plugins.must_include("Pluginator::Math::Increase")
+    plugins.must_include("Pluginator::Math::Decrease")
+    plugins.wont_include("Pluginator::Math::Add")
+  end
+
+  it "makes plugins work" do
+    pluginator = Pluginator::Autodetect.new("pluginator")
+    pluginator["math"].detect{|plugin| plugin.type == "increase" }.action(2).must_equal(3)
+    pluginator["math"].detect{|plugin| plugin.type == "decrease" }.action(5).must_equal(4)
+  end
+
+  it "hides methods" do
+    pluginator = Pluginator::Autodetect.new("pluginator")
+    pluginator.public_methods.must_include(:register_plugin)
+    pluginator.public_methods.wont_include(:load_plugins)
+    pluginator.public_methods.wont_include(:split_file_name)
+  end
+
+end

data/test/group_test.rb

@@ -0,0 +1,25 @@
+require 'minitest/autorun'
+require 'pluginator/group'
+
+describe Pluginator::Group do
+  it "has name" do
+    Pluginator::Group.new("something").group.must_equal("something")
+  end
+
+  describe "plugins list" do
+    before do
+      @group = Pluginator::Group.new("something")
+    end
+
+    it "adds type" do
+      @group.register_plugin("type1", nil)
+      @group.types.must_include("type1")
+      @group.types.wont_include("type2")
+    end
+    it "adds plugin" do
+      @group.register_plugin("type1", "test1")
+      @group["type1"].must_include("test1")
+      @group["type1"].wont_include("test2")
+    end
+  end
+end

data/test/name_converter_test.rb

@@ -0,0 +1,24 @@
+require 'minitest/autorun'
+require 'pluginator/name_converter'
+
+class Converter
+  extend Pluginator::NameConverter
+end
+
+describe Pluginator::NameConverter do
+  describe "files" do
+    it "extracts file name components" do
+      Converter.send(:split_file_name, "/path/to/plugins/group1/type1/name1.rb", "group1").
+        must_equal(["plugins/group1/type1/name1.rb", "group1/type1/name1", "type1"])
+    end
+    it "builds group pattern" do
+      Converter.send(:file_name_pattern, "group2").must_equal("plugins/group2/**/*.rb")
+    end
+  end
+
+  describe "classes" do
+    it "builds class" do
+      Converter.send(:name2class, "Converter").must_equal(Converter)
+    end
+  end
+end

metadata

@@ -1,62 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: pluginator
 version: !ruby/object:Gem::Version
-  version: 0.9.3
-  prerelease: 
+  version: 0.10.0
 platform: ruby
 authors:
 - Michal Papis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-14 00:00:00.000000000 Z
+date: 2013-05-09 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -67,37 +46,45 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .rvmrc
+- .travis.yml
 - Gemfile
 - README.md
 - Rakefile
+- demo/plugins/pluginator/math/decrease.rb
+- demo/plugins/pluginator/math/increase.rb
 - lib/pluginator.rb
-- lib/pluginator/plugin_handler.rb
+- lib/pluginator/autodetect.rb
+- lib/pluginator/group.rb
+- lib/pluginator/name_converter.rb
+- lib/pluginator/version.rb
 - pluginator.gemspec
-- test/test_paginator.rb
-homepage: https://github.com/mpapis/pluginator
+- test/autodetect_test.rb
+- test/group_test.rb
+- test/name_converter_test.rb
+homepage: https://github.com/rvm/pluginator
 licenses: []
+metadata: {}
 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
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Rubygems plugin system using Gem.find_files.
 test_files:
-- test/test_paginator.rb
+- test/autodetect_test.rb
+- test/group_test.rb
+- test/name_converter_test.rb

data/.rvmrc

@@ -1 +0,0 @@
-rvm use ruby-1.9.3-p327@pluginator --create

data/lib/pluginator/plugin_handler.rb

@@ -1,69 +0,0 @@
-require 'pluginator'
-
-class Pluginator
-  class UnknownPlugin < StandardError
-    def initialize(plugin_type, handler)
-      super "Unknown #{plugin_type}: #{handler}"
-    end
-  end
-
-  module ExtraNames
-    def last_name
-      self.name.split(/::/).last
-    end
-    def last_name_to_sym
-      class2file(last_name).to_sym
-    end
-    def first_name
-      self.name.split(/::/).first
-    end
-    def first_name_to_sym
-      class2file(first_name).to_sym
-    end
-    def class2file(klass)
-      klass.gsub(/([A-Z])/){|x| "_#{x.downcase}"}[1..-1]
-    end
-  end
-
-  class PluginHandler
-    extend ExtraNames
-
-    class Abstract
-      extend ExtraNames
-      def self.handles
-        last_name_to_sym
-      end
-    end
-
-    class << self
-      attr_accessor :plugin_prefix
-      attr_accessor :plugin_type
-    end
-
-    def self.first(handler)
-      result = plugins[@plugin_type].detect{ |_,plugin| plugin.handles == handler }
-      result = result.last unless result.nil?
-      result
-    end
-
-    def self.first!(handler)
-      found = first(handler)
-      raise UnknownPlugin.new(@plugin_type, handler) if found.nil?
-      found
-    end
-
-    def self.register_class(klass)
-      plugins.register_plugin_class(@plugin_type, klass)
-    end
-
-    def self.plugins
-      @plugin_prefix ||= first_name_to_sym
-      @plugin_type   ||= last_name_to_sym
-      @plugins       ||= Pluginator.new(@plugin_prefix)
-    end
-
-    def self.extend_abstract(&block)
-      self.const_get(:Abstract).class_eval(&block)
-    end
-  end
-end