pluginator 0.11.5 → 0.11.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31df38c24119dd5089716ee8fc1edd0db9c191c6
-  data.tar.gz: bb973079ad24dbb9f3f2fcd6fb9366ed8c7ca907
+  metadata.gz: 8bf5fb904c3dd6374d8b286ee02881330767fbb1
+  data.tar.gz: cd84459dde760942dbd47898935f5237a486c89b
 SHA512:
-  metadata.gz: cce30736f9a11ae892b3306d33cfe5677f9f5257ce4b209986b19256187fe475314f3b096f2f53f1df5071b14b76779df86e5f161989514ecc19c95eaa5b6b12
-  data.tar.gz: c27a85f3351e352069ed30b462fb4931fed5833f942f8f47562256c1949260dc496fe9c4e45442278f2e1ad7af5ebebd1a78acd8baf0c99df60c021453ed7328
+  metadata.gz: c3e2d2144700cfa83112c44bc43a543ab28ba35e5eb5339a4eb26526e612c3560b006f586406eb89e58305675197cb14ef96070b8503be7c078302ee4916b4c7
+  data.tar.gz: d3a19e7482a755c39aaad4f582b290a8bf3c5b0afc3e522bdd537c330aa57e1d03dc56a4ebbb5a4fee3b24b8f97516fdcb13c5e26c143a78e2c99c256b266f9f

data/.gitignore

@@ -1,3 +1,5 @@
 /*.gem
 /Gemfile.lock
 /coverage
+/doc
+/.yardoc

data/README.md

@@ -1,8 +1,11 @@
 # Pluginator
 
+[![Gem Version](https://badge.fury.io/rb/pluginator.png)](http://rubygems.org/gems/pluginator)
 [![Code Climate](https://codeclimate.com/github/rvm/pluginator.png)](https://codeclimate.com/github/rvm/pluginator)
+[![Coverage Status](https://coveralls.io/repos/rvm/pluginator/badge.png?branch=master)](https://coveralls.io/r/rvm/pluginator?branch=master)
 [![Build Status](https://travis-ci.org/rvm/pluginator.png?branch=master)](https://travis-ci.org/rvm/pluginator)
 [![Dependency Status](https://gemnasium.com/rvm/pluginator.png)](https://gemnasium.com/rvm/pluginator)
+[Documentation](http://rubydoc.info/gems/pluginator/frames)
 
 Gem plugin system management, detects plugins using `Gem.find_file`.
 Is only supposed with ruby 2.0.0+ (requires keyword arguments)
@@ -53,6 +56,15 @@ plugins.types     => Array of types
 
 Pluginator comes with few handful extensions.
 
+### Class exist
+
+Check if plugin with given class name exist.
+
+```ruby
+plugins = Pluginator.find("<group>", extends: %i{class_exist})
+plugins.class_exist?( "<type>", "<name>") => true or false
+```
+
 ### First ask
 
 Call a method on plugin and return first one that returns `true`.

data/lib/pluginator.rb

@@ -1,12 +1,13 @@
 require_relative "pluginator/extendable_autodetect"
 require_relative "pluginator/version"
 
+# A simple plugin system based on Gem.find_files
 module Pluginator
   # Find plugins for the given group
   #
   # @param group [String] name of plugins group
-  # @param type [String] optional name of type to load
-  # @param extends optional list of extension to extend into pluginator instance
+  # @option type [String] name of type to load
+  # @option extend [Array of/or Symbol] list of extension to extend into pluginator instance
   # @return instance of Pluginator
   def self.find(group, type: nil, extends: [])
     Pluginator::ExtendableAutodetect.new(group, type: type, extends: extends)

data/lib/pluginator/autodetect.rb

@@ -3,12 +3,14 @@ require_relative "group"
 require_relative "name_converter"
 
 module Pluginator
+  # Add autodetection capabilities to Group
+  # @see Group
   class Autodetect < Group
 
     # Automatically load plugins for given group (and type)
     #
     # @param group [String] name of the plugins group
-    # @param type [String] optional name of the plugin type
+    # @option type [String] name of the plugin type
     def initialize(group, type: nil)
       super(group)
       setup_autodetect(type)

data/lib/pluginator/extendable_autodetect.rb

@@ -1,14 +1,23 @@
 require_relative "autodetect"
 
 module Pluginator
+  # Container for all Pluginator extensions,
+  # they are loaded in `ExtendableAutodetect`
+  # @see ExtendableAutodetect#extend_plugins
+  module Extensions
+  end
+
+  # Add extendability to Atudetect / Group
+  # @see Autodetect
+  # @see Group
   class ExtendableAutodetect < Autodetect
 
     # Automatically load plugins for given group (and type)
     # Extend instance with extensions if given.
     #
     # @param group [String] name of the plugins group
-    # @param type [String] optional name of the plugin type
-    # @param extends optional list of extension to extend into pluginator instance
+    # @option type [String] name of type to load
+    # @option extend [Array of/or Symbol] list of extension to extend into pluginator instance
     def initialize(group, type: nil, extends: [])
       super(group, type: type)
       extend_plugins(extends)

data/lib/pluginator/group.rb

@@ -1,4 +1,5 @@
 module Pluginator
+  # Initial data for pluginator, includes group name and plugins
   class Group
     # Group name used for plugins
     attr_reader :group

data/lib/pluginator/name_converter.rb

@@ -1,4 +1,5 @@
 module Pluginator
+  # a helper for handling name / file / class conversions
   module NameConverter
   private
 

data/lib/pluginator/version.rb

@@ -1,4 +1,4 @@
 module Pluginator
   # Version of Pluginator
-  VERSION = "0.11.5"
+  VERSION = "0.11.6"
 end

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

@@ -0,0 +1,20 @@
+require_relative "plugins_map"
+require_relative "conversions"
+
+module Pluginator::Extensions
+  # Extension to check if plugin for given class name exist
+  module ClassExist
+
+    include PluginsMap
+    include Conversions
+
+    # Check if plugin for given name exists.
+    #
+    # @param type [String] name of type to search for plugins
+    # @param klass [Symbol or String] name of the searched class
+    # @return [Boolean] klass exists
+    def class_exist?(type, klass)
+      !!(plugins_map(type) || {})[string2class(klass)]
+    end
+  end
+end

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

@@ -1,4 +1,5 @@
 module Pluginator::Extensions
+  # a placeholder for methods to convert strings
   module Conversions
 
     # converts class name to a file name

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

@@ -1,14 +1,16 @@
 require_relative "plugins_map"
 
 module Pluginator::Extensions
+  # Extension to find first plugin that answers the question with true
   module FirstAsk
+
     include PluginsMap
 
     # Call a method on plugin and return first one that returns `true`.
     #
     # @param type [String] name of type to search for plugins
     # @param method_name [Symbol] name of the method to execute
-    # @param *params [Array] params to pass to the called method
+    # @param params [Array] params to pass to the called method
     # @return The first plugin that method call returns true
     def first_ask(type, method_name, *params)
       @plugins[type] or return nil

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

@@ -2,7 +2,9 @@ require_relative "plugins_map"
 require_relative "conversions"
 
 module Pluginator::Extensions
+  # Extension to find first plugin that class matches the string
   module FirstClass
+
     include PluginsMap
     include Conversions
 

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

@@ -2,6 +2,7 @@ require_relative "plugins_map"
 require_relative "conversions"
 
 module Pluginator::Extensions
+  # Extension to select plugins that class name matches the list of string
   module Matching
     include PluginsMap
     include Conversions

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

@@ -1,4 +1,5 @@
 module Pluginator::Extensions
+  # extend Pluginator with map of plugins: name => klass
   module PluginsMap
     # provide extra map of plugins with symbolized names as keys
     #

data/pluginator.gemspec

@@ -10,9 +10,9 @@ Gem::Specification.new do |s|
   s.version = Pluginator::VERSION
   s.files = `git ls-files`.split("\n")
   s.required_ruby_version = ">= 1.9.3"
-  s.add_development_dependency("rake")
-  s.add_development_dependency("minitest")
-  s.add_development_dependency("simplecov")
+  %w{rake minitest simplecov coveralls redcarpet}.each do |name|
+    s.add_development_dependency(name)
+  end
   # 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_test.rb

@@ -1,8 +1,8 @@
 require 'test_helper'
 require 'pluginator'
 
-describe Pluginator do
-  it "loads plugins automatically for group" do
+class PluginatorTest < MiniTest::Unit::TestCase
+  def test_loads_plugins_automatically_for_group
     pluginator = Pluginator.find("something")
     pluginator.types.must_include('stats')
     pluginator.types.must_include('math')
@@ -14,13 +14,13 @@ describe Pluginator do
     plugins.wont_include("Something::Math::Add")
   end
 
-  it "loads plugins automatically for group/type" do
+  def test_loads_plugins_automatically_for_group_type
     pluginator = Pluginator.find("something", type: "stats")
     pluginator.types.must_include('stats')
     pluginator.types.size.must_equal(1)
   end
 
-  it "loads existing extensions - symbol" do
+  def test_loads_existing_extensions_symbol
     pluginator = Pluginator.find("something", extends: :conversions)
     pluginator.public_methods.must_include(:class2string)
     pluginator.public_methods.must_include(:string2class)

data/test/plugins/extensions/class_exist_test.rb

@@ -0,0 +1,29 @@
+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
+end
+
+class Pluginator::Extensions::ClassExistTest < MiniTest::Unit::TestCase
+  def setup
+    @tester = ClassExistTester.new
+    @tester.plugins = { "stats" => [
+      Something::Stats::Max
+    ] }
+  end
+
+  def test_plugin_exist
+    @tester.class_exist?("stats", "max").must_equal( true )
+  end
+
+  def test_plugin_missing
+    @tester.class_exist?("stats", "min").must_equal( false )
+  end
+end

data/test/test_helper.rb

@@ -1,8 +1,17 @@
-require 'simplecov'
-SimpleCov.command_name "Unit Tests"
+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/"
 end
 
+Coveralls.noisy = true unless ENV['CI']
+
 require 'minitest/autorun'
+require 'minitest/unit'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pluginator
 version: !ruby/object:Gem::Version
-  version: 0.11.5
+  version: 0.11.6
 platform: ruby
 authors:
 - Michal Papis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-12 00:00:00.000000000 Z
+date: 2013-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -52,6 +52,34 @@ dependencies:
     - - '>='
       - !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'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  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: 
 email:
 - mpapis@gmail.com
@@ -74,6 +102,7 @@ files:
 - lib/pluginator/group.rb
 - lib/pluginator/name_converter.rb
 - lib/pluginator/version.rb
+- lib/plugins/pluginator/extensions/class_exist.rb
 - lib/plugins/pluginator/extensions/conversions.rb
 - lib/plugins/pluginator/extensions/first_ask.rb
 - lib/plugins/pluginator/extensions/first_class.rb
@@ -85,6 +114,7 @@ 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
@@ -120,6 +150,7 @@ 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