pluginator 0.11.1 → 0.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 177ed9844b5c23c064d42ea785fd4aa27a5a3b2a
-  data.tar.gz: 59b7f79ca608cfa3471462d527f9e6c85a8de2ad
+  metadata.gz: f705fb41a885499f22f36ff1790aee25a172d3b3
+  data.tar.gz: 7ab13d20196c4e9a88a7847d3348dce7c926e1f1
 SHA512:
-  metadata.gz: 17326a839cf7457e8d29096404a28f543340e44693a8615fb59b2eeb45676b56d47fbb97b8d3c463c5c97b67a454eb3fa08dcef4fb27edd88545d10480b735a8
-  data.tar.gz: f19ec0686a73d26bf399dc3ccfd0969fbddef6a0156e000573187dc3334bd32e3e250ae325bbe5a547716c4a62bd51c43830dafceaf55d380f78687fd7a14b70
+  metadata.gz: b9c9ec1df7f0bb5b9f1645c53dfd40e822a10ad4373742b14ebcfdd2fa273444e6277a729e2fc8732ade2563b47ec66bb0b54c575522895682d12821e9d3b6ee
+  data.tar.gz: 46d993a9bc68ddd98539932ed2f430e50d1170239001665770c7cc20a869652db1d2f2345145468a81c9508247be560d9e68e97ed2a8504398fa5b91360bbaff

data/README.md

@@ -35,12 +35,42 @@ type_plugins = rvm2plugins["<type>"]
 types = rvm2plugins.types
 ```
 
-## Loading plugins of single type
+## Usage
 
 ```ruby
-rvm2plugins = Pluginator.find("<group>", "<type>")
-type_plugins = rvm2plugins["<type>"]
-rvm2plugins.types => ["<type>"]
+Pluginator.find("<group>") => Pluginator object
+plugins = Pluginator.find("<group>", type: "<type>", extends: %i{<extensions>})
+plugins["<type>"] => Array of plugins
+plugins.type      => Array of plugins for type defined with `type: "<type>"`
+plugins.types     => Array of types
+```
+
+- `"<group>"` - Load plugins for given group.
+- `type: "<type>"` - Load plugins only of given type, makes `type` method accessible.
+- `extends: %i{<extensions>}` - Extend pluginator with given extensions.
+
+## Extensions
+
+Pluginator comes with few handful extensions.
+
+### First ask
+
+Call a method on plugin and return first one that returns `true`.
+
+```ruby
+plugins = Pluginator.find("<group>", extends: %i{first_ask})
+plugins.first_ask( "<type>", "method_to_call", *params) => plugin or nil
+plugins.first_ask!("<type>", "method_to_call", *params) => plugin or exception PluginatorError
+```
+
+### Matching
+
+Map array of names to available plugins.
+
+```ruby
+plugins = Pluginator.find("<group>", extends: %i{matching})
+plugins.matching( "<type>", [<array_of_names>]) => [plugins] # nil for missing ones
+plugins.matching!("<type>", [<array_of_names>]) => [plugins] or exception PluginatorError
 ```
 
 ## Examples

data/lib/pluginator/autodetect.rb

@@ -10,19 +10,24 @@ module Pluginator
       setup_autodetect(type)
     end
 
-    def type
-      @plugins[@force_type]
-    end
-
   private
 
     include NameConverter
 
     def setup_autodetect(type)
-      @force_type = type
+      force_type(type)
       load_files(find_files)
     end
 
+    def force_type(type)
+      @force_type = type
+      unless @force_type.nil?
+        define_singleton_method(:type) do
+          @plugins[@force_type]
+        end
+      end
+    end
+
     def find_files
       Gem.find_files(file_name_pattern(@group, @force_type))
     end

data/lib/pluginator/extendable_autodetect.rb

@@ -30,7 +30,7 @@ module Pluginator
     end
 
     def extensions_matching(extends)
-      pluginator_plugins.filter!("extensions", flatten_and_stringify(extends))
+      pluginator_plugins.matching!("extensions", flatten_and_stringify(extends))
     end
 
   end

data/lib/pluginator/version.rb

@@ -1,3 +1,3 @@
 module Pluginator
-  VERSION = "0.11.1"
+  VERSION = "0.11.2"
 end

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

@@ -6,13 +6,13 @@ module Pluginator::Extensions
     include PluginsMap
     include Conversions
 
-    def filter(type, list)
+    def matching(type, list)
       list.map do |plugin|
         (plugins_map(type) || {})[string2class(plugin)]
       end
     end
 
-    def filter!(type, list)
+    def matching!(type, list)
       @plugins[type] or raise Pluginator::MissingType.new(type, @plugins.types)
       list.map do |plugin|
         plugin = string2class(plugin)

data/test/autodetect_test.rb

@@ -53,7 +53,7 @@ describe Pluginator::Autodetect do
     end
 
     it "finds files group and existing type" do
-      @pluginator.instance_variable_set(:@force_type, "math")
+      @pluginator.send(:force_type, "math")
       @pluginator.type.must_equal( @pluginator["math"] )
     end
 
@@ -95,8 +95,15 @@ describe Pluginator::Autodetect do
   it "hides methods" do
     pluginator = Pluginator::Autodetect.new("something")
     pluginator.public_methods.must_include(:register_plugin)
+    pluginator.public_methods.wont_include(:type)
     pluginator.public_methods.wont_include(:load_plugins)
     pluginator.public_methods.wont_include(:split_file_name)
   end
 
+  it "defines type method dynamically" do
+    Pluginator::Autodetect.new("something").public_methods.wont_include(:type)
+    Pluginator::Autodetect.new("something", type: 'math').public_methods.must_include(:type)
+    Pluginator::Autodetect.new("something").public_methods.wont_include(:type)
+  end
+
 end

data/test/plugins/extensions/matching_test.rb

@@ -17,20 +17,20 @@ describe Pluginator::Extensions::Matching do
   end
 
   it "finds existing plugin" do
-    @tester.filter("extensions", ["plugins_map"]).must_equal( [Pluginator::Extensions::PluginsMap] )
+    @tester.matching("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] )
+    @tester.matching!("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] )
+    @tester.matching("extensions", ["plugins_map2"]).must_equal( [nil] )
   end
 
   it "finds existing plugin" do
     lambda {
-      @tester.filter!("extensions", ["plugins_map2"])
+      @tester.matching!("extensions", ["plugins_map2"])
     }.must_raise(Pluginator::MissingPlugin)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pluginator
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.11.2
 platform: ruby
 authors:
 - Michal Papis