pluginator 0.10.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59d64edff8d110c4973f3904dc82b87169e5df85
-  data.tar.gz: bfcaaf2bd8c78b659be273bef544cfaa11d5b852
+  metadata.gz: 0db9991966679d973e056d3fc78fdc31f6ee06ba
+  data.tar.gz: 8e7f9c12a90c8799dc1b8cb901ccda0a3794bddb
 SHA512:
-  metadata.gz: b7a922e4fc107b5ba0a0c13e5f07747bb586bf4c013e1c4d2c9bc8c7756ebab49697875a93c06e6e90e3b41174688754036811f918496f77bb5ebf492973a7f8
-  data.tar.gz: 7379ef2083b122ece8b36b9a38924438257246c16d3e8e3582252789e9c26d4555844bfcc8d4b2080b0a8add52a58349f5eb7aa9da3cfea8d4223d1cc7a228fc
+  metadata.gz: c8c4125ef8eb09e0b54d4c01be7c836310ed687874ab9c6cf09d20df00e972975b6a8581a836bcc5adcef4d6dce973da82e2602cd91039379a567164ec55a1bc
+  data.tar.gz: d782e278f8563218cabacab95c09c259b98dec719dc532ecb3edc8656b5e54ded69a4457ba7f5b572ccd8b5128e5828c616645566c8f91b2dd05841035c84c8d

data/.travis.yml

@@ -1,9 +1,6 @@
 language: ruby
 rvm:
-  - 1.9.3
   - 2.0.0
-  - jruby-19mode
-  - rbx-19mode
 notifications:
   irc:
     channels:

data/README.md

@@ -5,7 +5,7 @@
 [![Dependency Status](https://gemnasium.com/rvm/pluginator.png)](https://gemnasium.com/rvm/pluginator)
 
 Gem plugin system management, detects plugins using `Gem.find_file`.
-Is only supposed with ruby 1.9.3+
+Is only supposed with ruby 2.0.0+ (requires keyword arguments)
 
 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,
@@ -30,7 +30,7 @@ where `<type>` can be nested
 ## Loading plugins
 
 ```ruby
-rvm2plugins = Pluginator::Autodetect.new("<group>")
+rvm2plugins = Pluginator.find("<group>")
 type_plugins = rvm2plugins["<type>"]
 types = rvm2plugins.types
 ```
@@ -38,9 +38,9 @@ types = rvm2plugins.types
 ## Loading plugins of single type
 
 ```ruby
-rvm2plugins = Pluginator::Autodetect.new("<group>", "<type>")
+rvm2plugins = Pluginator.find("<group>", "<type>")
 type_plugins = rvm2plugins["<type>"]
-types = rvm2plugins.types
+rvm2plugins.types => ["<type>"]
 ```
 
 ## Examples
@@ -67,13 +67,22 @@ Now the plugin can be used:
 ```ruby
 require 'pluginator'
 
-rvm2plugins = Pluginator::Autodetect.new("rvm2")
+rvm2plugins = Pluginator.find("rvm2")
 plugin = rvm2plugins["cli"].first{ |plugin|
   plugin.question?('echo')
 }
 plugin.new.answer("Hello world")
 ```
 
+Or using extensions:
+
+```ruby
+require 'pluginator'
+
+plugin = Pluginator.find("rvm2", extends: %i{first_ask}).first_ask("cli", &:question?, 'echo')
+plugin.new.answer("Hello world")
+```
+
 ### Example 2 - hook plugins
 
 `plugins/rvm2/hooks/after_install/show.rb`:
@@ -91,8 +100,7 @@ and using hooks:
 ```ruby
 require 'pluginator'
 
-rvm2plugins = Pluginator::Autodetect.new("rvm2")
-plugin = rvm2plugins["hooks/after_install"].each{ |plugin|
+Pluginator.find("rvm2", type: "hooks/after_install").type.each{ |plugin|
   plugin.execute(name, path)
 }
 ```

data/demo/plugins/{pluginator → something}/math/decrease.rb

@@ -1,4 +1,4 @@
-class Pluginator::Math::Decrease
+class Something::Math::Decrease
   def self.type
     "decrease"
   end

data/demo/plugins/{pluginator → something}/math/increase.rb

@@ -1,4 +1,4 @@
-class Pluginator::Math::Increase
+class Something::Math::Increase
   def self.type
     "increase"
   end

data/demo/plugins/something/stats/max.rb

@@ -0,0 +1,10 @@
+class Something::Stats::Max
+
+  def self.handles?(what)
+    %w{ max maximum }.include?(what)
+  end
+
+  def self.action
+    42
+  end
+end

data/lib/pluginator/autodetect.rb

@@ -1,19 +1,32 @@
+require_relative "errors"
 require_relative "group"
 require_relative "name_converter"
 
 module Pluginator
   class Autodetect < Group
 
-    def initialize(group, type=nil)
+    def initialize(group, type: nil)
       super(group)
-      @force_type = type
-      load_files(find_files)
+      setup_autodetect(type)
+    end
+
+    def type
+      @plugins[@force_type]
     end
 
   private
 
     include NameConverter
 
+    def setup_autodetect(type)
+      @force_type = type
+      load_files(find_files)
+    end
+
+    def find_files
+      Gem.find_files(file_name_pattern(@group, @force_type))
+    end
+
     def load_files(file_names)
       file_names.each do |file_name|
         path, name, type = split_file_name(file_name, @group)
@@ -22,10 +35,6 @@ module Pluginator
       end
     end
 
-    def find_files
-      Gem.find_files(file_name_pattern(@group, @force_type))
-    end
-
     def load_plugin(path)
       gemspec = Gem::Specification.find_by_path(path)
       gemspec.activate if gemspec && !gemspec.activated?

data/lib/pluginator/errors.rb

@@ -0,0 +1,18 @@
+module Pluginator
+  class PluginatorError < RuntimeError
+  end
+
+  class MissingPlugin < PluginatorError
+    def initialize(type, name, list)
+      list = list.map{|e| "'#{e}'" }.join(", ")
+      super("Can not find plugin '#{name}' in #{list} for type '#{type}'.")
+    end
+  end
+
+  class MissingType < PluginatorError
+    def initialize(type, list)
+      list = list.map{|e| "'#{e}'" }.join(", ")
+      super("Can not find type '#{type}' in #{list}.")
+    end
+  end
+end

data/lib/pluginator/extendable_autodetect.rb

@@ -0,0 +1,37 @@
+require_relative "autodetect"
+
+module Pluginator
+  class ExtendableAutodetect < Autodetect
+
+    def initialize(group, type: nil, extends: [])
+      super(group, type: type)
+      extend_plugins(extends)
+    end
+
+    def extend_plugins(extends)
+      extensions_matching(extends).each do |plugin|
+        extend plugin
+      end
+    end
+
+  private
+
+    def flatten_and_stringify(extends)
+      extends = [extends].flatten.map(&:to_s)
+      extends
+    end
+
+    def pluginator_plugins
+      @pluginator_plugins ||= begin
+        plugins = Pluginator::Autodetect.new("pluginator")
+        plugins.extend(Pluginator::Extensions::Matching)
+        plugins
+      end
+    end
+
+    def extensions_matching(extends)
+      pluginator_plugins.filter!("extensions", flatten_and_stringify(extends))
+    end
+
+  end
+end

data/lib/pluginator/group.rb

@@ -3,7 +3,7 @@ module Pluginator
     attr_reader :group
 
     def initialize(group)
-      setup(group)
+      setup_group(group)
     end
 
     def [](type)
@@ -22,7 +22,7 @@ module Pluginator
 
   private
 
-    def setup(group)
+    def setup_group(group)
       @plugins = {}
       @group = group
     end

data/lib/pluginator/version.rb

@@ -1,3 +1,3 @@
 module Pluginator
-  VERSION = "0.10.1"
+  VERSION = "0.11.0"
 end

data/lib/pluginator.rb

@@ -1,2 +1,8 @@
-require_relative "pluginator/autodetect"
+require_relative "pluginator/extendable_autodetect"
 require_relative "pluginator/version"
+
+module Pluginator
+  def self.group(group, type: nil, extends: [])
+    Pluginator::ExtendableAutodetect.new(group, type: type, extends: extends)
+  end
+end

data/lib/plugins/pluginator/extensions/conversions.rb

@@ -0,0 +1,10 @@
+module Pluginator::Extensions
+  module Conversions
+    def class2string( klass )
+      klass.to_s.gsub(/([A-Z])/m){|match| "_#{$1.downcase}" }[1..-1]
+    end
+    def string2class( str )
+      str.to_s.capitalize.gsub(/_(.)/){ $1.upcase }
+    end
+  end
+end

data/lib/plugins/pluginator/extensions/first_ask.rb

@@ -0,0 +1,23 @@
+require_relative "plugins_map"
+
+module Pluginator::Extensions
+  module FirstAsk
+    include PluginsMap
+
+    def first_ask(type, method_name, *params)
+      @plugins[type] or return nil
+      @plugins[type].detect do |plugin|
+        plugin.public_send(method_name, *params)
+      end
+    end
+
+    def first_ask!(type, method_name, *params)
+      @plugins[type] or raise Pluginator::MissingType.new(type, @plugins.types)
+      @plugins[type].detect do |plugin|
+        plugin.public_send(method_name, *params)
+      end or
+        raise Pluginator::MissingPlugin.new(type, "first_ask: #{method_name}", plugins_map(type).keys)
+    end
+
+  end
+end

data/lib/plugins/pluginator/extensions/matching.rb

@@ -0,0 +1,24 @@
+require_relative "plugins_map"
+require_relative "conversions"
+
+module Pluginator::Extensions
+  module Matching
+    include PluginsMap
+    include Conversions
+
+    def filter(type, list)
+      list.map do |plugin|
+        (plugins_map(type) || {})[string2class(plugin)]
+      end
+    end
+
+    def filter!(type, list)
+      @plugins[type] or raise Pluginator::MissingType.new(type, @plugins.types)
+      list.map do |plugin|
+        plugin = string2class(plugin)
+        plugins_map(type)[plugin] or
+          raise Pluginator::MissingPlugin.new(type, plugin, plugins_map(type).keys)
+      end
+    end
+  end
+end

data/lib/plugins/pluginator/extensions/plugins_map.rb

@@ -0,0 +1,9 @@
+module Pluginator::Extensions
+  module PluginsMap
+    def plugins_map( type )
+      @plugins_map ||= {}
+      type = type.to_s
+      @plugins_map[type] ||= Hash[ @plugins[type].map{|plugin| [plugin.name.split('::').last, plugin] } ]
+    end
+  end
+end

data/test/autodetect_test.rb

@@ -1,8 +1,10 @@
 require 'minitest/autorun'
 require 'pluginator/autodetect'
 
-module Pluginator::Math; end
-module Pluginator::Stats; end
+module Something
+  module Math; end
+  module Stats; end
+end
 
 def demo_file(path)
   File.expand_path(File.join("..", "..", "demo", path), __FILE__)
@@ -14,40 +16,45 @@ end
 
 describe Pluginator::Autodetect do
   before do
-    @math_files = demo_files("plugins/pluginator/math/increase.rb", "plugins/pluginator/math/decrease.rb")
-    @all_files = demo_files("plugins/pluginator/math/increase.rb", "plugins/pluginator/math/decrease.rb", "plugins/pluginator/stats/max.rb")
+    @math_files = demo_files("plugins/something/math/increase.rb", "plugins/something/math/decrease.rb")
+    @all_files = demo_files("plugins/something/math/increase.rb", "plugins/something/math/decrease.rb", "plugins/something/stats/max.rb")
   end
 
   describe "separate" do
     before do
       @pluginator = Pluginator::Autodetect.allocate
-      @pluginator.send(:setup, "pluginator")
+      @pluginator.send(:setup_group, "something")
     end
 
     it "has name" do
-      @pluginator.group.must_equal("pluginator")
+      @pluginator.group.must_equal("something")
     end
 
     it "has demo file" do
-      File.exists?(demo_file("plugins/pluginator/math/increase.rb")).must_equal(true)
+      File.exists?(demo_file("plugins/something/math/increase.rb")).must_equal(true)
     end
 
     it "loads plugin" do
-      @pluginator.send(:load_plugin, "plugins/pluginator/math/increase.rb")
+      @pluginator.send(:load_plugin, "plugins/something/math/increase.rb")
     end
 
     it "finds files existing group" do
       @pluginator.send(:find_files).sort.must_equal(@all_files.sort)
     end
 
+    it "finds files group and missing type" do
+      @pluginator.instance_variable_set(:@force_type, "none")
+      @pluginator.send(:find_files).must_equal([])
+    end
+
     it "finds files group and existing type" do
       @pluginator.instance_variable_set(:@force_type, "math")
       @pluginator.send(:find_files).sort.must_equal(@math_files.sort)
     end
 
-    it "finds files group and missing type" do
-      @pluginator.instance_variable_set(:@force_type, "none")
-      @pluginator.send(:find_files).must_equal([])
+    it "finds files group and existing type" do
+      @pluginator.instance_variable_set(:@force_type, "math")
+      @pluginator.type.must_equal( @pluginator["math"] )
     end
 
     it "loads files" do
@@ -55,38 +62,38 @@ describe Pluginator::Autodetect do
       @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")
+      plugins.must_include("Something::Math::Increase")
+      plugins.must_include("Something::Math::Decrease")
+      plugins.wont_include("Something::Math::Substract")
     end
   end
 
   it "loads plugins automatically for group" do
-    pluginator = Pluginator::Autodetect.new("pluginator")
+    pluginator = Pluginator::Autodetect.new("something")
     pluginator.types.must_include('stats')
     pluginator.types.must_include('math')
     pluginator.types.size.must_equal(2)
     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")
+    plugins.must_include("Something::Math::Increase")
+    plugins.must_include("Something::Math::Decrease")
+    plugins.wont_include("Something::Math::Add")
   end
 
   it "loads plugins automatically for group/type" do
-    pluginator = Pluginator::Autodetect.new("pluginator", "stats")
+    pluginator = Pluginator::Autodetect.new("something", type: "stats")
     pluginator.types.must_include('stats')
     pluginator.types.size.must_equal(1)
   end
 
   it "makes group plugins work" do
-    pluginator = Pluginator::Autodetect.new("pluginator")
+    pluginator = Pluginator::Autodetect.new("something")
     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 = Pluginator::Autodetect.new("something")
     pluginator.public_methods.must_include(:register_plugin)
     pluginator.public_methods.wont_include(:load_plugins)
     pluginator.public_methods.wont_include(:split_file_name)

data/test/extendable_autodetect_test.rb

@@ -0,0 +1,24 @@
+require 'minitest/autorun'
+require 'pluginator/extendable_autodetect'
+
+describe Pluginator::ExtendableAutodetect do
+  it "loads existing extensions - array" do
+    pluginator = Pluginator::ExtendableAutodetect.new("something", extends: %i{conversions})
+    pluginator.public_methods.must_include(:class2string)
+    pluginator.public_methods.must_include(:string2class)
+    pluginator.public_methods.wont_include(:plugins_map)
+  end
+
+  it "loads existing extensions - symbol" do
+    pluginator = Pluginator::ExtendableAutodetect.new("something", extends: :conversions)
+    pluginator.public_methods.must_include(:class2string)
+    pluginator.public_methods.must_include(:string2class)
+    pluginator.public_methods.wont_include(:plugins_map)
+  end
+
+  it "fails to load missing extension" do
+    lambda {
+      Pluginator::ExtendableAutodetect.new("something", extends: %i{missing_conversions})
+    }.must_raise(Pluginator::MissingPlugin)
+  end
+end

data/test/plugins/extensions/conversions_test.rb

@@ -0,0 +1,15 @@
+require 'minitest/autorun'
+require 'plugins/pluginator/extensions/conversions'
+
+class ConversionsTester
+  extend Pluginator::Extensions::Conversions
+end
+
+describe Pluginator::Extensions::Conversions do
+  it "class2string" do
+    ConversionsTester.class2string('SomethingLong').must_match('something_long')
+  end
+  it "string2class" do
+    ConversionsTester.string2class('something_long').must_match('SomethingLong')
+  end
+end

data/test/plugins/extensions/first_ask_test.rb

@@ -0,0 +1,39 @@
+require 'minitest/autorun'
+require 'plugins/pluginator/extensions/first_ask'
+require 'plugins/something/stats/max'
+
+module Something
+  module Stats; end
+end
+
+class FirstAskTester
+  attr_accessor :plugins
+  include Pluginator::Extensions::FirstAsk
+end
+
+describe Pluginator::Extensions::FirstAsk do
+  before do
+    @tester = FirstAskTester.new
+    @tester.plugins = { "stats" => [
+      Something::Stats::Max
+    ] }
+  end
+
+  it "finds existing plugin" do
+    @tester.first_ask("stats", "handles?", "max").must_equal( Something::Stats::Max )
+  end
+
+  it "finds existing plugin - no exception" do
+    @tester.first_ask!("stats", "handles?", "max").must_equal( Something::Stats::Max )
+  end
+
+  it "does not find missing plugin - no exception" do
+    @tester.first_ask("stats", "handles?", "min").must_equal( nil )
+  end
+
+  it "finds existing plugin" do
+    lambda {
+      @tester.first_ask!("stats", "handles?", "min")
+    }.must_raise(Pluginator::MissingPlugin)
+  end
+end

data/test/plugins/extensions/matching_test.rb

@@ -0,0 +1,36 @@
+require 'minitest/autorun'
+require 'plugins/pluginator/extensions/matching'
+
+class MatchingTester
+  attr_accessor :plugins
+  include Pluginator::Extensions::Matching
+end
+
+describe Pluginator::Extensions::Matching do
+  before do
+    @tester = MatchingTester.new
+    @tester.plugins = { "extensions" => [
+      Pluginator::Extensions::PluginsMap,
+      Pluginator::Extensions::Conversions,
+      Pluginator::Extensions::Matching
+    ] }
+  end
+
+  it "finds existing plugin" do
+    @tester.filter("extensions", ["plugins_map"]).must_equal( [Pluginator::Extensions::PluginsMap] )
+  end
+
+  it "finds existing plugin - no exception" do
+    @tester.filter!("extensions", ["plugins_map"]).must_equal( [Pluginator::Extensions::PluginsMap] )
+  end
+
+  it "does not find missing plugin - no exception" do
+    @tester.filter("extensions", ["plugins_map2"]).must_equal( [nil] )
+  end
+
+  it "finds existing plugin" do
+    lambda {
+      @tester.filter!("extensions", ["plugins_map2"])
+    }.must_raise(Pluginator::MissingPlugin)
+  end
+end

data/test/plugins/extensions/plugins_map_test.rb

@@ -0,0 +1,16 @@
+require 'minitest/autorun'
+require 'plugins/pluginator/extensions/plugins_map'
+
+class PluginsMapTester
+  attr_accessor :plugins
+  include Pluginator::Extensions::PluginsMap
+end
+
+describe Pluginator::Extensions::PluginsMap do
+  it "creates map" do
+    tester = PluginsMapTester.new
+    tester.plugins = { "extensions" => [Pluginator::Extensions::PluginsMap] }
+    expected = { "PluginsMap" => Pluginator::Extensions::PluginsMap }
+    tester.plugins_map("extensions").must_equal( expected )
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pluginator
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.11.0
 platform: ruby
 authors:
 - Michal Papis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-09 00:00:00.000000000 Z
+date: 2013-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -50,18 +50,29 @@ files:
 - Gemfile
 - README.md
 - Rakefile
-- demo/plugins/pluginator/math/decrease.rb
-- demo/plugins/pluginator/math/increase.rb
-- demo/plugins/pluginator/stats/max.rb
+- demo/plugins/something/math/decrease.rb
+- demo/plugins/something/math/increase.rb
+- demo/plugins/something/stats/max.rb
 - lib/pluginator.rb
 - lib/pluginator/autodetect.rb
+- lib/pluginator/errors.rb
+- lib/pluginator/extendable_autodetect.rb
 - lib/pluginator/group.rb
 - lib/pluginator/name_converter.rb
 - lib/pluginator/version.rb
+- lib/plugins/pluginator/extensions/conversions.rb
+- lib/plugins/pluginator/extensions/first_ask.rb
+- lib/plugins/pluginator/extensions/matching.rb
+- lib/plugins/pluginator/extensions/plugins_map.rb
 - pluginator.gemspec
 - test/autodetect_test.rb
+- test/extendable_autodetect_test.rb
 - test/group_test.rb
 - test/name_converter_test.rb
+- test/plugins/extensions/conversions_test.rb
+- test/plugins/extensions/first_ask_test.rb
+- test/plugins/extensions/matching_test.rb
+- test/plugins/extensions/plugins_map_test.rb
 homepage: https://github.com/rvm/pluginator
 licenses: []
 metadata: {}
@@ -87,5 +98,11 @@ specification_version: 4
 summary: Rubygems plugin system using Gem.find_files.
 test_files:
 - test/autodetect_test.rb
+- test/extendable_autodetect_test.rb
 - test/group_test.rb
 - test/name_converter_test.rb
+- test/plugins/extensions/conversions_test.rb
+- test/plugins/extensions/first_ask_test.rb
+- test/plugins/extensions/matching_test.rb
+- test/plugins/extensions/plugins_map_test.rb
+has_rdoc: 

data/demo/plugins/pluginator/stats/max.rb

@@ -1,5 +0,0 @@
-class Pluginator::Stats::Max
-  def self.action
-    42
-  end
-end