pluginator 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6ff46b640ad85f210acebe6882c7ea4cbdf1c0c
-  data.tar.gz: 447d3308d735dd4383a3300294c67ba065d7b986
+  metadata.gz: 283439793e08107d8bae13b5f46fc0da05785dd8
+  data.tar.gz: 80576d911e37400591f350ad35249ba3dbe0d7ec
 SHA512:
-  metadata.gz: 40ea8041c8c585023ef5bc68c623765ca25dc4f002f851bd7a4308f78fd9f6e8865f57f0c6d934720009594e5c6bb05bb2fc4f5539c1f274961212e41e13ce66
-  data.tar.gz: 83d9f189e3b9ab2beb65d87b6da06198a191bdf6e3e5841260295273c08180aaa1e783a4c241ba69810de86989e687d820bb05cd6868cecb8c0cd3d122c0fff7
+  metadata.gz: '094f7696b9db9e54bf55da059a5c0ab0b184d05c78caf2ec3ab288dd4cb63d8893f632654ead6c5dee696823f2893216e779d79775f37ccded0c5d7438fdb2f2'
+  data.tar.gz: a059c11a3ebd3e61093bf37e068c3fde86ff7b7efcb05af3ea5f840bcee515acabb5e7e91d8c74e5817f7430c7aecb031c6a258116893277382cc4e45400a2ab

data/Changelog.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 1.4.0
+date: 2017-05-14
+
+- reworked finding plugins, now also searches `$LOADED_FEATURES`
+
+## 1.3.0
+date: 2014-10-20
+
+- simplified detection of gems/plugins to load, improved tests
+
 ## 1.2.0
 date: 2014-09-24
 

data/README.md

@@ -9,8 +9,10 @@
 [![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/github/rvm/pluginator/master/frames)
 [![Github Code](http://img.shields.io/badge/github-code-blue.svg)](https://github.com/rvm/pluginator)
 
-Gem plugin system management, detects plugins using `Gem.find_file`.
-Is only supposed to work with ruby 1.9.3+ (some tests fail on 1.9.2)
+Gem plugin system management, detects plugins using `Gem.find_file`,
+`$LOAD_PATH` and `$LOADED_FEATURES`.
+
+It is only supposed to work with ruby 1.9.3+ (some tests fail on 1.9.2)
 
 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,
@@ -21,7 +23,7 @@ you decide what methods to define and how to find them.
 create a gem with a path:
 
 ```ruby
-plugins/<group>/<type>/<name>.rb
+lib/plugins/<group>/<type>/<name>.rb
 ```
 
 with a class inside:
@@ -133,7 +135,7 @@ plugins.first_one("<type>") => first_plugin # nil when none
 
 ## Versioning plugins
 
-In case plugin gets moved to other gem you can sdpecify which gem to
+In case plugin gets moved to other gem you can specify which gem to
 use for loading the plugin by specifying plugin version in gems gemspec
 metadata:
 
@@ -213,7 +215,7 @@ NOEXEC_DISABLE=1 rake test
 
 ## License
 
-Copyright 2013 Michal Papis <mpapis@gmail.com>
+Copyright 2013-2017 Michal Papis <mpapis@gmail.com>
 
 pluginator is free software: you can redistribute it and/or modify
 it under the terms of the GNU Lesser General Public License as published

data/lib/pluginator/autodetect/finder.rb

@@ -0,0 +1,85 @@
+=begin
+Copyright 2017 Michal Papis <mpapis@gmail.com>
+
+This file is part of pluginator.
+
+pluginator is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published
+by the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+pluginator is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with pluginator.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
+module Pluginator
+  class Autodetect
+
+    # Find plugins
+    class Finder
+
+      attr_reader :loaded_plugins_path, :load_path_plugins_paths, :gem_plugins_paths
+
+      # Automatically load plugins for given group (and type)
+      #
+      # @param group      [String] name of the plugins group
+      # @param force_type [String] name of the plugin type if forcing
+      def initialize(group, force_type)
+        @group      = group
+        @force_type = force_type
+        @pattern    = file_name_pattern(@group, @force_type)
+        find_paths
+      end
+
+    private
+
+      # group => pattern
+      def file_name_pattern(group, type=nil)
+        "plugins/#{group}/#{type || "**"}/*.rb"
+      end
+
+      def find_paths
+        @loaded_plugins_path     =  find_loaded_plugins
+        @load_path_plugins_paths =  find_load_path_plugins - @loaded_plugins_path
+        @gem_plugins_paths       =  find_gem_plugins       - @load_path_plugins_paths - @loaded_plugins_path
+      end
+
+      def find_loaded_plugins
+        split_file_names(
+          $LOADED_FEATURES
+        ).compact
+      end
+
+      def find_load_path_plugins
+        split_file_names(
+          Gem.find_files_from_load_path(@pattern)
+        )
+      end
+
+      def find_gem_plugins
+        split_file_names(
+          Gem.find_files(@pattern, false)
+        )
+      end
+
+      def split_file_names(file_names)
+        file_names.map do |file_name|
+          split_file_name(file_name, @group, @force_type)
+        end
+      end
+
+      # file_name, group, type => [ path, full_name, type ]
+      def split_file_name(file_name, group, type=nil)
+        type ||= ".*"
+        match = file_name.match(%r{.*/(plugins/(#{group}/(#{type})/[^/]*)\.rb)$})
+        match[1..3] if match
+      end
+
+    end
+  end
+end

data/lib/pluginator/autodetect/formatted_finder.rb

@@ -0,0 +1,110 @@
+=begin
+Copyright 2017 Michal Papis <mpapis@gmail.com>
+
+This file is part of pluginator.
+
+pluginator is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published
+by the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+pluginator is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with pluginator.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
+require "pluginator/autodetect/finder"
+
+module Pluginator
+  class Autodetect
+
+    # Categorize plugins
+    # @see: Finder
+    class FormattedFinder < Finder
+
+      # Reformat plugin lists
+      def initialize(group, force_type)
+        super
+        map_loaded_plugins
+        map_gem_plugins
+      end
+
+    private
+
+      def gem_has_method?(name)
+        Gem.methods.map(&:to_sym).include?(name)
+      end
+
+      def map_loaded_plugins
+        @loaded_plugins_path.map! do |_path, name, type|
+          [name, type]
+        end
+      end
+
+      def map_gem_plugins
+        gem_specifications = find_gem_specifications
+        @gem_plugins_paths.map! do |path, name, type|
+          gemspec = gemspec_for_path(path, gem_specifications)
+          [gemspec, path, name, type] if gemspec
+        end.compact
+      end
+
+      def find_gem_specifications
+        if
+          gem_has_method?(:gemdeps) && Gem.gemdeps
+        then
+          # :nocov: only testable with using rubygems's gemdeps feature
+          Gem.loaded_specs.values
+          # :nocov:
+        else
+          specs = Gem::Specification._all
+          specs = (Gem.loaded_specs.values + specs).uniq if gem_has_method?(:loaded_specs)
+          specs
+        end
+      end
+
+      def gemspec_for_path(path, specifications)
+        gemspecs = gemspecs_for_path(path, specifications)
+        case
+          gemspecs.size
+        when 0
+          nil
+        when 1
+          gemspecs.first
+        else
+          find_latest_plugin_version(gemspecs, path)
+        end
+      end
+
+      def gemspecs_for_path(path, specifications)
+        specifications.reject do |spec|
+          Dir.glob( File.join( spec.lib_dirs_glob, path ) ).empty?
+        end
+      end
+
+      def find_latest_plugin_version(gemspecs, path)
+        active_or_latest_gemspec(gemspecs_sorted_by_metadata_and_version(gemspecs, path))
+      end
+
+      # find active or latest gem in given set
+      def active_or_latest_gemspec(specifications)
+        specifications.find(&:activated) || specifications.last
+      end
+
+      def gemspecs_sorted_by_metadata_and_version(gemspecs, path)
+        gemspecs.sort_by do |spec|
+          [calculate_plugin_version(spec.metadata, path), spec.name, spec.version]
+        end
+      end
+
+      def calculate_plugin_version(metadata, path)
+        ( (metadata || {})[path] || "0" ).to_i
+      end
+
+    end
+  end
+end

data/lib/pluginator/autodetect.rb

@@ -1,5 +1,5 @@
 =begin
-Copyright 2013 Michal Papis <mpapis@gmail.com>
+Copyright 2013-2017 Michal Papis <mpapis@gmail.com>
 
 This file is part of pluginator.
 
@@ -22,18 +22,38 @@ require "pluginator/group"
 require "pluginator/name_converter"
 
 module Pluginator
-  # Add autodetection capabilities to Group
-  # @see Group
   class Autodetect < Group
+  end
+end
+
+require "pluginator/autodetect/formatted_finder"
+
+module Pluginator
+  # Add autodetection capabilities to Group
+  # @see Group, FormattedFinder
+  class Autodetect
 
     # Automatically load plugins for given group (and type)
     #
     # @param group   [String] name of the plugins group
     # @param options [Hash]   options to pass to creating Pluginator instance
     # @option type   [String] name of the plugin type
-    def initialize(group, options = {})
+    def initialize(group, options={})
       super(group)
-      setup_autodetect(options[:type])
+      @force_type = options[:type]
+      refresh
+    end
+
+    # Initiate another lookup for plugins
+    # - does not clean the state
+    # - does not resolve all gems, only the new ones
+    #
+    # Use it after gem list change, for example after `Gem.install("new_gem")`
+    def refresh
+      plugin_lists = FormattedFinder.new(@group, @force_type)
+      register_plugins(plugin_lists.loaded_plugins_path)
+      load_plugins(plugin_lists.load_path_plugins_paths)
+      activate_plugins(plugin_lists.gem_plugins_paths)
     end
 
     # Return the forced type
@@ -45,39 +65,33 @@ module Pluginator
 
     include NameConverter
 
-    def setup_autodetect(type)
-      force_type(type)
-      load_files(find_files)
-    end
-
-    def force_type(type)
-      @force_type = type
-    end
-
-    def find_files
-      Gem.find_files(file_name_pattern(@group, @force_type))
+    def register_plugins(plugins_to_register)
+      plugins_to_register.each do |name, type|
+        register_plugin(type, name2class(name))
+      end
     end
 
-    def load_files(file_names)
-      unique_gemspec_paths(file_names).each do |gemspec, path, name, type|
-        gemspec.activate
-        load_plugin(path) and
+    def load_plugins(plugins_to_load)
+      plugins_to_load.each do |path, name, type|
+        require path
         register_plugin(type, name2class(name))
       end
     end
 
-    def unique_gemspec_paths(file_names)
-      all = gemspec_and_paths(file_names)
-      selected = active_or_latest_gems_matching(all.map(&:first))
-      all.select do |gemspec, path, name, type|
-        selected.include?(gemspec)
+    def activate_plugins(plugins_to_activate)
+      selected = active_or_latest_gems_matching(plugins_to_activate.map(&:first).compact)
+      plugins_to_activate.each do |gemspec, path, name, type|
+        next unless selected.include?(gemspec)
+        gemspec.activate
+        require path
+        register_plugin(type, name2class(name))
       end
     end
 
     # filter active / latest gem versions
     def active_or_latest_gems_matching(specifications)
-      specifications.group_by(&:name).map do |name, specifications|
-        active_or_latest_gemspec(specifications.sort)
+      specifications.group_by(&:name).map do |_name, plugin_specifications|
+        active_or_latest_gemspec(plugin_specifications.sort)
       end
     end
 
@@ -86,51 +100,5 @@ module Pluginator
       specifications.find(&:activated) || specifications.last
     end
 
-    def gemspec_and_paths(file_names)
-      unique_parsed_paths(file_names).map do |path, name, type|
-        gemspec = gemspec_for_path(path)
-        [gemspec, path, name, type] if gemspec
-      end.compact
-    end
-
-    def unique_parsed_paths(file_names)
-      file_names.map do |file_name|
-        split_file_name(file_name, @group)
-      end.sort.uniq
-    end
-
-    def gemspec_for_path(path)
-      gemspecs = Gem::Specification._all.reject do |spec|
-        Dir.glob( File.join( spec.lib_dirs_glob, path ) ).empty?
-      end
-      case gemspecs.size
-      when 0
-        nil
-      when 1
-        gemspecs.first
-      else
-        find_latest_plugin_version(gemspecs, path)
-      end
-    end
-
-    def find_latest_plugin_version(gemspecs, path)
-      active_or_latest_gemspec(gemspecs_sorted_by_metadata_and_version(gemspecs, path))
-    end
-
-    def gemspecs_sorted_by_metadata_and_version(gemspecs, path)
-      gemspecs.sort_by do |spec|
-        [calculate_plugin_version(spec.metadata, path), spec.name, spec.version]
-      end
-    end
-
-    def calculate_plugin_version(metadata, path)
-      ((metadata||{})[path]||"0").to_i
-    end
-
-    def load_plugin(path)
-      require path
-      true
-    end
-
   end
 end

data/lib/pluginator/errors.rb

@@ -1,5 +1,5 @@
 =begin
-Copyright 2013 Michal Papis <mpapis@gmail.com>
+Copyright 2013-2017 Michal Papis <mpapis@gmail.com>
 
 This file is part of pluginator.
 
@@ -22,8 +22,9 @@ module Pluginator
   # base error for all Pluginator errors
   class PluginatorError < RuntimeError
   private
+
     def list_to_s(list)
-      list.map{|e| e.to_s.inspect }.join(", ")
+      list.map { |plugin| plugin.to_s.inspect }.join(", ")
     end
   end
 

data/lib/pluginator/extendable_autodetect.rb

@@ -1,5 +1,5 @@
 =begin
-Copyright 2013 Michal Papis <mpapis@gmail.com>
+Copyright 2013-2017 Michal Papis <mpapis@gmail.com>
 
 This file is part of pluginator.
 
@@ -38,9 +38,9 @@ module Pluginator
     # @param options  [Hash]   options to pass to creating Pluginator instance
     # @option type    [String] name of type to load
     # @option extends [Array<Symbol>|Symbol] list of extension to extend into pluginator instance
-    def initialize(group, options = {})
+    def initialize(group, options={})
       super(group, options)
-      extend_plugins(options[:extends]||[])
+      extend_plugins(options[:extends] || [])
     end
 
     # Extend pluginator instance with given extensions
@@ -54,11 +54,6 @@ module Pluginator
 
   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")
@@ -68,7 +63,8 @@ module Pluginator
     end
 
     def extensions_matching(extends)
-      pluginator_plugins.matching!("extensions", flatten_and_stringify(extends))
+      extends = [extends].flatten.map(&:to_s)
+      pluginator_plugins.matching!("extensions", extends)
     end
 
   end

data/lib/pluginator/name_converter.rb

@@ -1,5 +1,5 @@
 =begin
-Copyright 2013 Michal Papis <mpapis@gmail.com>
+Copyright 2013-2017 Michal Papis <mpapis@gmail.com>
 
 This file is part of pluginator.
 
@@ -22,24 +22,14 @@ 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, type=nil)
-      "plugins/#{group}/#{type || "**"}/*.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 )
-      }
+      name.to_s.split(%r{/}).each do |part|
+        klass = klass.const_get(
+          part.capitalize.gsub(/_(.)/) { |match| match[1].upcase }
+        )
+      end
       klass
     end
 

data/lib/pluginator/version.rb

@@ -1,5 +1,5 @@
 =begin
-Copyright 2013 Michal Papis <mpapis@gmail.com>
+Copyright 2013-2017 Michal Papis <mpapis@gmail.com>
 
 This file is part of pluginator.
 
@@ -19,5 +19,5 @@ along with pluginator.  If not, see <http://www.gnu.org/licenses/>.
 
 module Pluginator
   # Version of Pluginator
-  VERSION = "1.3.0"
+  VERSION = "1.4.0".freeze
 end

data/lib/pluginator.rb

@@ -1,5 +1,5 @@
 =begin
-Copyright 2013 Michal Papis <mpapis@gmail.com>
+Copyright 2013-2017 Michal Papis <mpapis@gmail.com>
 
 This file is part of pluginator.
 
@@ -29,7 +29,7 @@ module Pluginator
   # @option type   [String] name of type to load
   # @option extend [Array<Symbol>|Symbol] list of extension to extend into pluginator instance
   # @return [Pluginator::ExtendableAutodetect] instance of Pluginator
-  def self.find(group, options = {})
+  def self.find(group, options={})
     Pluginator::ExtendableAutodetect.new(group, options)
   end
 end

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

@@ -1,5 +1,5 @@
 =begin
-Copyright 2013 Michal Papis <mpapis@gmail.com>
+Copyright 2013-2017 Michal Papis <mpapis@gmail.com>
 
 This file is part of pluginator.
 
@@ -24,20 +24,23 @@ module Pluginator::Extensions
     # converts class name to a file name
     # @param klass [String] class like string
     # @return      [String] file like string
-    def class2string( klass )
-      klass.to_s.gsub(/([A-Z])/m){|match| "_#{$1.downcase}" }[1..-1]
+
+    def class2string(klass)
+      klass.to_s.gsub(/([A-Z])/m) { |match| "_#{match.downcase}" }[1..-1]
     end
 
     # converts file name to a class name
     # @param str [String] file like string
     # @return    [String] class like string
-    def string2class( str )
-      str.to_s.capitalize.gsub(/_(.)/){ $1.upcase }
+
+    def string2class(str)
+      str.to_s.capitalize.gsub(/_(.)/) { |match| match[1].upcase }
     end
 
     # gets class name last part
     # @param klass [Class]  class to read
     # @return      [String] the class name only without nesting
+
     def class2name(klass)
       klass.name.split("::").last
     end

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

@@ -1,5 +1,5 @@
 =begin
-Copyright 2013 Michal Papis <mpapis@gmail.com>
+Copyright 2013-2017 Michal Papis <mpapis@gmail.com>
 
 This file is part of pluginator.
 
@@ -53,7 +53,7 @@ module Pluginator::Extensions
 
     def try_to_find(type, method_name, params)
       @plugins[type].detect do |plugin|
-        has_public_method?(plugin, method_name) &&
+        has_public_method?(plugin, method_name) and
         plugin.send(method_name.to_sym, *params)
       end
     end

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

@@ -21,13 +21,13 @@ require "plugins/pluginator/extensions/plugins_map"
 require "plugins/pluginator/extensions/conversions"
 
 module Pluginator::Extensions
-  # Extension to find first plugin that class matches the string
+  # Extension to find first plugin whose class matches the string
   module FirstClass
 
     include PluginsMap
     include Conversions
 
-    # Find first plugin that clas matches the given name.
+    # Find first plugin whose class matches the given name.
     #
     # @param type  [String] name of type to search for plugins
     # @param klass [Symbol|String] name of the searched class
@@ -36,7 +36,7 @@ module Pluginator::Extensions
       (plugins_map(type) || {})[string2class(klass)]
     end
 
-    # Find first plugin that clas matches the given name.
+    # Find first plugin whose class matches the given name.
     # Behaves like `first_class` but throws exceptions if can not find anything.
     # @param type  [String] name of type to search for plugins
     # @param klass [Symbol|String] name of the searched class

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

@@ -1,5 +1,5 @@
 =begin
-Copyright 2013 Michal Papis <mpapis@gmail.com>
+Copyright 2013-2017 Michal Papis <mpapis@gmail.com>
 
 This file is part of pluginator.
 
@@ -28,10 +28,15 @@ module Pluginator::Extensions
     #
     # @param type [String] name of type to generate the map for
     # @return [Hash] map of the names and plugin classes
-    def plugins_map( type )
+
+    def plugins_map(type)
       @plugins_map ||= {}
       type = type.to_s
-      @plugins_map[type] ||= Hash[ @plugins[type].map{|plugin| [class2name(plugin), plugin] } ]
+      @plugins_map[type] ||= Hash[
+        @plugins[type].map do |plugin|
+          [class2name(plugin), plugin]
+        end
+      ]
     end
   end
 end