pluginator 0.12.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a56ec0232b4b0d3bff76ca136b14b33b0d7b232
-  data.tar.gz: 208b160fb4e716d43afe4ed4abb7ce6fcd5efb92
+  metadata.gz: b70400f4d804c2f5916e9e68056db1287345f508
+  data.tar.gz: 5ebb958035ec8e95699a3ce44b86327acd8276c4
 SHA512:
-  metadata.gz: d0551d4d9f432d29e2b36912817f9b4a8a738762b3cf18ba7f1c5eb565894ce9abcfc0b1358d8b5f0f4ed75348e79e61dea0bf0f34e444367fe4926e3c366341
-  data.tar.gz: 3d33a4462c1c6f900470189c73c7dba418809264ba1cf1c45590dd71d08994e5bae676d2984e0df5ad7aa361a7bad319c5ab85fffbab71dc4c22c762d840da3e
+  metadata.gz: 6c51706e34d5d00c1e60406cb5c897d4e726159ee368aa7929ecd8cf2a08c911e5c05e79acc603e8eedcd63a21e2491e30e07320ae423e102e2a1d4e3335ce3d
+  data.tar.gz: 3f19a9c45614acaa882c289155cf0686970fbeda14390483f526573fcf87c61b4baf9547c9e15ccd5c7c1b2cf11662859d067ec8bce792154dd9e048cde0986d

data/.travis.yml

@@ -6,6 +6,7 @@ rvm:
   - 2.0.0
   - 1.9.3
   - 1.9.2
+  - 1.8.7
   - rbx
 notifications:
   irc:
@@ -16,7 +17,4 @@ notifications:
       - mpapis@gmail.com
     on_failure: change
 matrix:
-  allow_failures:
-    - rvm: 1.9.2
-    - rvm: rbx
   fast_finish: true

data/Gemfile

@@ -1,12 +1,14 @@
 source "https://rubygems.org"
 
-#ruby=2.1.0
+#ruby=2.0.0
 
 gemspec
 
 group :development do
-  # documentation formatting
-  gem "redcarpet", :platforms => [:ruby]
+  # statistics only on MRI 2.0 - avoid problems on older rubies
+  gem "redcarpet", :platforms => [:mri_20]
+  gem "simplecov", :platforms => [:mri_20]
+  gem "coveralls", :platforms => [:mri_20]
 
   # rubinius support
   gem "rubysl-json",      :platforms => [:rbx]

data/README.md

@@ -95,6 +95,34 @@ plugins.matching( "<type>", [<array_of_names>]) => [plugins] # nil for missing o
 plugins.matching!("<type>", [<array_of_names>]) => [plugins] or exception PluginatorError
 ```
 
+### Your own ones
+
+You can define your own extensions for `pluginator`, for example:
+
+```shell
+plugins/pluginator/extensions/first_one.rb
+```
+
+with:
+
+```ruby
+module Pluginator::Extensions
+  class FirstOne
+    def first_one(type)
+      @plugins[type].first
+    end
+  end
+end
+```
+
+And now you can use it:
+
+```ruby
+plugins = Pluginator.find("<group>", extends: %i{first_one})
+plugins.first_one("<type>") => first_plugin # nil when none
+```
+
+
 ## Exceptions
 
 - `PluginatorError` - base error for all Pluginator errors

data/demo/plugins/something/nested/structure/test.rb

@@ -0,0 +1,6 @@
+class Something::Nested::Structure::Test
+
+  def self.action
+    42
+  end
+end

data/lib/pluginator/autodetect.rb

@@ -1,6 +1,6 @@
-require_relative "errors"
-require_relative "group"
-require_relative "name_converter"
+require "pluginator/errors"
+require "pluginator/group"
+require "pluginator/name_converter"
 
 module Pluginator
   # Add autodetection capabilities to Group
@@ -16,6 +16,10 @@ module Pluginator
       setup_autodetect(options[:type])
     end
 
+    def type
+      @plugins[@force_type] unless @force_type.nil?
+    end
+
   private
 
     include NameConverter
@@ -27,11 +31,6 @@ module Pluginator
 
     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

data/lib/pluginator/extendable_autodetect.rb

@@ -1,4 +1,4 @@
-require_relative "autodetect"
+require "pluginator/autodetect"
 
 module Pluginator
   # Container for all Pluginator extensions,

data/lib/pluginator/version.rb

@@ -1,4 +1,4 @@
 module Pluginator
   # Version of Pluginator
-  VERSION = "0.12.1"
+  VERSION = "1.0.0"
 end

data/lib/pluginator.rb

@@ -1,5 +1,5 @@
-require_relative "pluginator/extendable_autodetect"
-require_relative "pluginator/version"
+require "pluginator/extendable_autodetect"
+require "pluginator/version"
 
 # A simple plugin system based on Gem.find_files
 module Pluginator

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

@@ -1,5 +1,5 @@
-require_relative "plugins_map"
-require_relative "conversions"
+require "plugins/pluginator/extensions/plugins_map"
+require "plugins/pluginator/extensions/conversions"
 
 module Pluginator::Extensions
   # Extension to check if plugin for given class name exist

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

@@ -1,4 +1,4 @@
-require_relative "plugins_map"
+require "plugins/pluginator/extensions/plugins_map"
 
 module Pluginator::Extensions
   # Extension to find first plugin that answers the question with true
@@ -15,8 +15,8 @@ module Pluginator::Extensions
     def first_ask(type, method_name, *params)
       @plugins[type] or return nil
       @plugins[type].detect do |plugin|
-        plugin.respond_to?(method_name.to_sym) &&
-        plugin.public_send(method_name.to_sym, *params)
+        plugin.public_methods.map(&:to_sym).include?(method_name.to_sym) &&
+        plugin.send(method_name.to_sym, *params)
       end
     end
 
@@ -25,8 +25,8 @@ module Pluginator::Extensions
     def first_ask!(type, method_name, *params)
       @plugins[type] or raise Pluginator::MissingType.new(type, @plugins.keys)
       @plugins[type].detect do |plugin|
-        plugin.respond_to?(method_name.to_sym) &&
-        plugin.public_send(method_name, *params)
+        plugin.public_methods.map(&:to_sym).include?(method_name.to_sym) &&
+        plugin.send(method_name, *params)
       end or
         raise Pluginator::MissingPlugin.new(type, "first_ask: #{method_name}", plugins_map(type).keys)
     end

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

@@ -1,5 +1,5 @@
-require_relative "plugins_map"
-require_relative "conversions"
+require "plugins/pluginator/extensions/plugins_map"
+require "plugins/pluginator/extensions/conversions"
 
 module Pluginator::Extensions
   # Extension to find first plugin that class matches the string

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

@@ -1,5 +1,5 @@
-require_relative "plugins_map"
-require_relative "conversions"
+require "plugins/pluginator/extensions/plugins_map"
+require "plugins/pluginator/extensions/conversions"
 
 module Pluginator::Extensions
   # Extension to select plugins that class name matches the list of string

data/pluginator.gemspec

@@ -9,10 +9,9 @@ Gem::Specification.new do |s|
   s.name = "pluginator"
   s.version = Pluginator::VERSION
   s.files = `git ls-files`.split("\n")
-  s.required_ruby_version = ">= 1.9.2"
-  %w{rake minitest simplecov coveralls}.each do |name|
-    s.add_development_dependency(name)
-  end
+  s.required_ruby_version = ">= 1.8.7"
+  s.add_development_dependency("rake")
+  s.add_development_dependency("minitest")
   # s.add_development_dependency("smf-gem")
   s.homepage = "https://github.com/rvm/pluginator"
   s.summary = "Rubygems plugin system using Gem.find_files."

data/test/pluginator/autodetect_test.rb

@@ -1,11 +1,6 @@
 require 'test_helper'
 require 'pluginator/autodetect'
 
-module Something
-  module Math; end
-  module Stats; end
-end
-
 def demo_file(path)
   File.expand_path(File.join("..", "..", "..", "demo", path), __FILE__)
 end
@@ -17,7 +12,10 @@ end
 describe Pluginator::Autodetect do
   before do
     @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")
+    @all_files = demo_files(
+      "plugins/something/math/increase.rb", "plugins/something/math/decrease.rb",
+      "plugins/something/nested/structure/test.rb", "plugins/something/stats/max.rb"
+    )
   end
 
   describe "separate" do
@@ -72,7 +70,7 @@ describe Pluginator::Autodetect do
     pluginator = Pluginator::Autodetect.new("something")
     pluginator.types.must_include('stats')
     pluginator.types.must_include('math')
-    pluginator.types.size.must_equal(2)
+    pluginator.types.size.must_equal(3)
     plugins = pluginator["math"].map(&:to_s)
     plugins.size.must_equal(2)
     plugins.must_include("Something::Math::Increase")
@@ -81,7 +79,7 @@ describe Pluginator::Autodetect do
   end
 
   it "loads plugins automatically for group/type" do
-    pluginator = Pluginator::Autodetect.new("something", type: "stats")
+    pluginator = Pluginator::Autodetect.new("something", :type => "stats")
     pluginator.types.must_include('stats')
     pluginator.types.size.must_equal(1)
   end
@@ -94,16 +92,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)
+    pluginator.public_methods.map(&:to_sym).must_include(:register_plugin)
+    pluginator.public_methods.map(&:to_sym).wont_include(:load_plugins)
+    pluginator.public_methods.map(&:to_sym).wont_include(:split_file_name)
+    pluginator.type.must_equal(nil)
   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)
+    pluginator = Pluginator::Autodetect.new("something", :type => 'math')
+    pluginator.type.must_equal(pluginator['math'])
   end
 
 end

data/test/pluginator/extendable_autodetect_test.rb

@@ -4,16 +4,16 @@ require 'pluginator/extendable_autodetect'
 describe Pluginator::ExtendableAutodetect do
   it "loads existing extensions - array" 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)
+    pluginator.public_methods.map(&:to_sym).must_include(:class2string)
+    pluginator.public_methods.map(&:to_sym).must_include(:string2class)
+    pluginator.public_methods.map(&:to_sym).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)
+    pluginator.public_methods.map(&:to_sym).must_include(:class2string)
+    pluginator.public_methods.map(&:to_sym).must_include(:string2class)
+    pluginator.public_methods.map(&:to_sym).wont_include(:plugins_map)
   end
 
   it "fails to load missing extension" do

data/test/pluginator_test.rb

@@ -6,7 +6,8 @@ class PluginatorTest < MiniTest::Unit::TestCase
     pluginator = Pluginator.find("something")
     pluginator.types.must_include('stats')
     pluginator.types.must_include('math')
-    pluginator.types.size.must_equal(2)
+    pluginator.types.must_include('nested/structure')
+    pluginator.types.size.must_equal(3)
     plugins = pluginator["math"].map(&:to_s)
     plugins.size.must_equal(2)
     plugins.must_include("Something::Math::Increase")
@@ -15,15 +16,23 @@ class PluginatorTest < MiniTest::Unit::TestCase
   end
 
   def test_loads_plugins_automatically_for_group_type
-    pluginator = Pluginator.find("something", type: "stats")
+    pluginator = Pluginator.find("something", :type => "stats")
     pluginator.types.must_include('stats')
     pluginator.types.size.must_equal(1)
   end
 
   def test_loads_existing_extensions_symbol
-    pluginator = Pluginator.find("something", extends: :conversions)
-    pluginator.public_methods.must_include(:class2string)
-    pluginator.public_methods.must_include(:string2class)
-    pluginator.public_methods.wont_include(:plugins_map)
+    pluginator = Pluginator.find("something", :extends => :conversions)
+    pluginator.public_methods.map(&:to_sym).must_include(:class2string)
+    pluginator.public_methods.map(&:to_sym).must_include(:string2class)
+    pluginator.public_methods.map(&:to_sym).wont_include(:plugins_map)
+  end
+
+  def test_loads_nested_plugins
+    pluginator = Pluginator.find("something")
+    pluginator.types.must_include('nested/structure')
+    plugins = pluginator["nested/structure"].map(&:to_s)
+    plugins.size.must_equal(1)
+    plugins.must_include("Something::Nested::Structure::Test")
   end
 end

data/test/{plugins → plugins_test}/extensions/class_exist_test.rb

@@ -2,10 +2,6 @@ require 'test_helper'
 require 'plugins/pluginator/extensions/class_exist'
 require 'plugins/something/stats/max'
 
-module Something
-  module Stats; end
-end
-
 class ClassExistTester
   attr_accessor :plugins
   include Pluginator::Extensions::ClassExist

data/test/{plugins → plugins_test}/extensions/first_ask_test.rb

@@ -2,10 +2,6 @@ require 'test_helper'
 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

data/test/{plugins → plugins_test}/extensions/first_class_test.rb

@@ -2,10 +2,6 @@ require 'test_helper'
 require 'plugins/pluginator/extensions/first_class'
 require 'plugins/something/stats/max'
 
-module Something
-  module Stats; end
-end
-
 class FirstClassTester
   attr_accessor :plugins
   include Pluginator::Extensions::FirstClass

data/test/test_helper.rb

@@ -1,17 +1,29 @@
-require "coveralls"
-require "simplecov"
+if
+  RUBY_VERSION == "2.0.0" # check Gemfile
+then
+  require "coveralls"
+  require "simplecov"
 
-SimpleCov.start do
-  formatter SimpleCov::Formatter::MultiFormatter[
-    SimpleCov::Formatter::HTMLFormatter,
-    Coveralls::SimpleCov::Formatter,
-  ]
-  command_name "Unit Tests"
-  add_filter "/test/"
-  add_filter "/demo/"
+  SimpleCov.start do
+    formatter SimpleCov::Formatter::MultiFormatter[
+      SimpleCov::Formatter::HTMLFormatter,
+      Coveralls::SimpleCov::Formatter,
+    ]
+    command_name "Unit Tests"
+    add_filter "/test/"
+    add_filter "/demo/"
+  end
+
+  Coveralls.noisy = true unless ENV['CI']
 end
 
-Coveralls.noisy = true unless ENV['CI']
+module Something
+  module Math; end
+  module Stats; end
+  module Nested
+    module Structure; end
+  end
+end
 
 require 'minitest/autorun'
 require 'minitest/unit'

metadata

@@ -1,69 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: pluginator
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Michal Papis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-18 00:00:00.000000000 Z
+date: 2013-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -73,13 +45,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
+- .gitignore
+- .travis.yml
 - Gemfile
 - README.md
 - Rakefile
 - demo/plugins/something/math/decrease.rb
 - demo/plugins/something/math/increase.rb
+- demo/plugins/something/nested/structure/test.rb
 - demo/plugins/something/stats/max.rb
 - lib/pluginator.rb
 - lib/pluginator/autodetect.rb
@@ -100,12 +73,12 @@ files:
 - test/pluginator/group_test.rb
 - test/pluginator/name_converter_test.rb
 - test/pluginator_test.rb
-- test/plugins/extensions/class_exist_test.rb
-- test/plugins/extensions/conversions_test.rb
-- test/plugins/extensions/first_ask_test.rb
-- test/plugins/extensions/first_class_test.rb
-- test/plugins/extensions/matching_test.rb
-- test/plugins/extensions/plugins_map_test.rb
+- test/plugins_test/extensions/class_exist_test.rb
+- test/plugins_test/extensions/conversions_test.rb
+- test/plugins_test/extensions/first_ask_test.rb
+- test/plugins_test/extensions/first_class_test.rb
+- test/plugins_test/extensions/matching_test.rb
+- test/plugins_test/extensions/plugins_map_test.rb
 - test/test_helper.rb
 homepage: https://github.com/rvm/pluginator
 licenses: []
@@ -116,17 +89,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Rubygems plugin system using Gem.find_files.
@@ -136,10 +109,10 @@ test_files:
 - test/pluginator/group_test.rb
 - test/pluginator/name_converter_test.rb
 - test/pluginator_test.rb
-- test/plugins/extensions/class_exist_test.rb
-- test/plugins/extensions/conversions_test.rb
-- test/plugins/extensions/first_ask_test.rb
-- test/plugins/extensions/first_class_test.rb
-- test/plugins/extensions/matching_test.rb
-- test/plugins/extensions/plugins_map_test.rb
+- test/plugins_test/extensions/class_exist_test.rb
+- test/plugins_test/extensions/conversions_test.rb
+- test/plugins_test/extensions/first_ask_test.rb
+- test/plugins_test/extensions/first_class_test.rb
+- test/plugins_test/extensions/matching_test.rb
+- test/plugins_test/extensions/plugins_map_test.rb
 - test/test_helper.rb