Module: Plugin

Extended by:
Plugin
Included in:
Plugin
Defined in:
lib/plugin.rb

Overview

Plugin Handler

Find plugins across various library managers.

All plugins are expected to be within a libraries designated loadpath(s) under a plugin/ subdirectory. By using this assigned space, ie. <tt>plugin/<tt>, plugins are kept isolated from normal libary scripts. This helps prevent inadvertent name clashes.

How To Use

Usage is very simple. Just supply a glob to the Plugin.find function.

Plugin.find('syckle/*')

A shortcut is provided with [].

Plugin['syckle/*']

A Note on RubyGems

A way has not yet been devised to isolate the actived version of a gem from the latest inactive version. Therefore some overlap can occur if an older version of a plugin-containing gem has been activated prior to calling Plugin.find(). Such an occurance will be rare (considering the use cases of plugins), so it is nothing to be overly concerned about. Moreover, it is a long-way from the offical Gems plugin policy which is to find all matching files from all versions using Gem.find_files(). I quote Eric Hodel, “It’s an encouragement to make your plugin files as light as possible, such as requiring an additional file or calling some very stable API.” While an understandable encouragment, ultimately it is not a robust solution.

Constant Summary collapse

DIRECTORY = 
'plugin'

Instance Method Summary collapse

Instance Method Details

#find(match) ⇒ Object Also known as: []

Find plugins, searching through standard $LOAD_PATH, Roll Libraries and RubyGems.

Provide a match file glob to find plugins.

Plugins.find('syckle/*')



50
51
52
53
54
55
56
 
# File 'lib/plugin.rb', line 50

def find(match)
  plugins = []
  plugins.concat find_roll(match)
  plugins.concat find_loadpath(match)
  plugins.concat find_gems(match)
  plugins.uniq
end

#find_gems(match) ⇒ Object

Search latest gem versions.

TODO: Is there anyway to skip active gems?



102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/plugin.rb', line 102

def find_gems(match)
  plugins = []
  if defined?(::Gem)
    ::Gem.latest_load_paths do |path|
      list = Dir.glob(File.join(path, DIRECTORY, match))
      list = list.map{ |d| d.chomp('/') }
      plugins.concat(list)
    end
  end
  plugins
end

#find_loadpath(match) ⇒ Object

Search standard $LOAD_PATH.

Activated gem versions are in here too.



87
88
89
90
91
92
93
94
95
96
 
# File 'lib/plugin.rb', line 87

def find_loadpath(match)
  plugins = []
  $LOAD_PATH.uniq.each do |path|
    list = Dir.glob(File.join(path, DIRECTORY, match))
    #dirs = dirs.select{ |d| File.directory?(d) }
    list = list.map{ |d| d.chomp('/') }
    plugins.concat(list)
  end
  plugins
end

#find_roll(match) ⇒ Object

Search roll for current or latest libraries.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/plugin.rb', line 67

def find_roll(match)
  plugins = []
  if defined?(::Roll)
    ::Roll::Library.ledger.each do |name, lib|
      lib = lib.sort.first if Array===lib
      lib.loadpath.each do |path|
        find = File.join(lib.location, path, DIRECTORY, match)
        list = Dir.glob(find)
        list = list.map{ |d| d.chomp('/') }
        plugins.concat(list)
      end
    end
  end
  plugins
end