plugman 0.2 → 1.0
Sign up to get free protection for your applications and to get access to all the features.
- data/CHANGES +26 -0
- data/Gemfile +15 -0
- data/README.md +165 -22
- data/Rakefile +6 -22
- data/lib/plugman.rb +23 -87
- data/lib/plugman/config_loader.rb +22 -0
- data/lib/plugman/plugin_base.rb +0 -38
- data/lib/plugman/version.rb +3 -0
- data/{test/plugin → spec/plugins}/bar.rb +0 -0
- data/{test/plugin → spec/plugins}/baz.rb +0 -0
- data/spec/plugins/hello.rb +15 -0
- data/spec/plugman_spec.rb +57 -0
- metadata +15 -17
- data/COPYING +0 -339
- data/lib/plugman/finder.rb +0 -3
- data/lib/plugman/finder/simple.rb +0 -13
- data/lib/plugman/finder/standard.rb +0 -25
- data/test/test_plugman.rb +0 -24
data/CHANGES
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
2012-08-17: version 1.0
|
2
|
+
|
3
|
+
- Special thanks to Avid Grim <http://avdi.org> for valuable input
|
4
|
+
|
5
|
+
- Big rewrite.
|
6
|
+
|
7
|
+
- By default it no longer uses Rubygems to automatically find all
|
8
|
+
plugins matching a pattern. You need instead to provide a list with
|
9
|
+
the names of the plugins that you want to load.
|
10
|
+
|
11
|
+
- The plugman initializer has changed it's parameters.
|
12
|
+
|
13
|
+
- You now notify plugins when events happens via Plugman's
|
14
|
+
#notify. The old mechanism is deprecated.
|
15
|
+
|
16
|
+
- Added a lot of documentation to the README
|
17
|
+
|
18
|
+
- Changed to MIT license
|
19
|
+
|
20
|
+
2011-06-01: version 0.1.1
|
21
|
+
|
22
|
+
- Made Finder::Standard the default
|
23
|
+
|
24
|
+
2011-05-30: version 0.1
|
25
|
+
|
26
|
+
- Initial release
|
data/Gemfile
ADDED
data/README.md
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
Plugman
|
1
|
+
Plugman [![Build Status](https://secure.travis-ci.org/kjellm/plugman.png)](http://travis-ci.org/kjellm/plugman) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/kjellm/plugman)
|
2
2
|
=======
|
3
3
|
|
4
4
|
Plugman is a plugin manager that supports event driven communication
|
@@ -6,6 +6,20 @@ with plugins. It handles the loading, initialization and all
|
|
6
6
|
communications with the plugins.
|
7
7
|
|
8
8
|
|
9
|
+
Why use plugman?
|
10
|
+
----------------
|
11
|
+
|
12
|
+
Plugman's event driven approach lets you completely decouple the
|
13
|
+
application from the plugins. This is in my opinion a major advantage
|
14
|
+
because it lets you factor out functionality into plugins without much
|
15
|
+
added complexity.
|
16
|
+
|
17
|
+
There are several plugin managers available from RubyGems.org, but
|
18
|
+
none seems to let you use events as the means of communication. (The
|
19
|
+
ones that I have looked at are: plugin, gem\_plugin, little\_plugger,
|
20
|
+
plugin\_manager, and plugin-loader)
|
21
|
+
|
22
|
+
|
9
23
|
Installation
|
10
24
|
------------
|
11
25
|
|
@@ -13,43 +27,172 @@ The easiest way to get plugman is through rubygems
|
|
13
27
|
|
14
28
|
gem install plugman
|
15
29
|
|
16
|
-
|
17
|
-
|
18
|
-
git clone git://github.com/kjellm/plugman.git
|
19
|
-
gem build plugman.gemspec
|
20
|
-
gem install plugman-XXX.gem
|
30
|
+
or you can get it from <https://github.com/kjellm/plugman>.
|
21
31
|
|
22
32
|
|
23
33
|
Usage
|
24
34
|
-----
|
25
35
|
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
36
|
+
### Minimal Example
|
37
|
+
|
38
|
+
```ruby
|
39
|
+
require 'plugman'
|
40
|
+
|
41
|
+
class APlugin
|
42
|
+
|
43
|
+
def hello_world
|
44
|
+
puts "Hello World!"
|
45
|
+
end
|
46
|
+
|
47
|
+
end
|
48
|
+
|
49
|
+
class TheApp
|
50
|
+
|
51
|
+
def initialize
|
52
|
+
@plugman = Plugman.new(plugins: [APlugin.new])
|
53
|
+
end
|
54
|
+
|
55
|
+
def main
|
56
|
+
@plugman.notify :hello_world
|
57
|
+
end
|
58
|
+
|
59
|
+
end
|
60
|
+
```
|
61
|
+
|
62
|
+
### Using a Loader to load plugins
|
63
|
+
|
64
|
+
Note: Plugins that are to be loaded by plugman need to extend
|
65
|
+
Plugman::PluginBase.
|
66
|
+
|
67
|
+
In the minimal example, the application did all the loading and
|
68
|
+
initialization of the plugins. This is not very flexible. What you
|
69
|
+
usually would rather do is to initialize Plugman with a Loader to
|
70
|
+
handle all this.
|
71
|
+
|
72
|
+
Here's an example using the provided ConfigLoader:
|
73
|
+
|
74
|
+
```yaml
|
75
|
+
# $HOME/.app.yml
|
76
|
+
---
|
77
|
+
:plugins : ['app/plugin/logger']
|
78
|
+
```
|
79
|
+
|
80
|
+
```ruby
|
81
|
+
# app/lib/app.rb
|
82
|
+
require 'plugman'
|
83
|
+
require 'yaml'
|
84
|
+
|
85
|
+
class App
|
86
|
+
|
87
|
+
def initialize
|
88
|
+
rc = YAML.load_file("#{ENV['HOME']}/.app.yml")
|
89
|
+
@plugman = Plugman.new(loader: Plugman::ConfigLoader.new(rc[:plugins]))
|
90
|
+
@plugman.load_plugins
|
91
|
+
end
|
92
|
+
|
93
|
+
def main
|
94
|
+
@plugman.notify :system_launched
|
95
|
+
# ...
|
96
|
+
end
|
97
|
+
|
98
|
+
end
|
99
|
+
```
|
100
|
+
|
101
|
+
```ruby
|
102
|
+
# app-plugin-logger/lib/app/plugin/logger.rb
|
103
|
+
require 'logger'
|
104
|
+
|
105
|
+
class App
|
106
|
+
module Plugin
|
107
|
+
class Logger < Plugman::PluginBase
|
108
|
+
|
109
|
+
def initialize
|
110
|
+
@logger = ::Logger.new(STDERR)
|
111
|
+
end
|
112
|
+
|
113
|
+
def system_launched
|
114
|
+
@logger.info "The system has launched!"
|
115
|
+
end
|
116
|
+
|
117
|
+
end
|
118
|
+
end
|
119
|
+
end
|
120
|
+
```
|
121
|
+
|
122
|
+
### Passing extra information to the plugins when you notify them about events
|
123
|
+
|
124
|
+
Plugman lets you send arguments and/or blocks to plugins when calling #notify.
|
125
|
+
Here is how it works:
|
126
|
+
|
127
|
+
```ruby
|
128
|
+
# In a plugin:
|
129
|
+
def hello(world="")
|
130
|
+
str = "Hello" << world
|
131
|
+
str << yield if block_given?
|
132
|
+
puts str
|
133
|
+
end
|
134
|
+
|
135
|
+
# Somewhere in the app:
|
136
|
+
@plugman.notify(:hello) # => "Hello"
|
137
|
+
@plugman.notify(:hello, " world") # => "Hello world"
|
138
|
+
@plugman.notify(:hello, " world") { "!" } # => "Hello world!"
|
139
|
+
@plugman.notify(:hello) { "!" } # => "Hello!"
|
140
|
+
```
|
141
|
+
|
142
|
+
### Creating your own loader
|
143
|
+
|
144
|
+
You can easily create your own loader as a Loader is nothing but an
|
145
|
+
callable object (it responds to #call.)
|
146
|
+
|
147
|
+
Here is one that loads all ruby files in a directory:
|
148
|
+
|
149
|
+
```ruby
|
150
|
+
->(a) { Dir.glob('/plugins/are/here/*.rb').each {|f| require f}}
|
151
|
+
```
|
152
|
+
|
153
|
+
And here is one that uses Gem.find_files
|
154
|
+
|
155
|
+
```ruby
|
156
|
+
->(a) do
|
157
|
+
seen = {}
|
158
|
+
Gem.find_files('the_app/plugin/*', true).each do |f|
|
159
|
+
name = File.basename(f)
|
160
|
+
require name unless seen[f]
|
161
|
+
seen[f] = true
|
162
|
+
end
|
163
|
+
end
|
164
|
+
```
|
37
165
|
|
38
166
|
|
39
167
|
Bugs
|
40
168
|
----
|
41
169
|
|
42
|
-
Report bugs to <
|
170
|
+
Report bugs to <https://github.com/kjellm/plugman/issues>.
|
43
171
|
|
44
172
|
|
45
173
|
Author
|
46
174
|
------
|
47
175
|
|
48
|
-
Kjell-Magne Øierud <kjellm AT
|
49
|
-
|
176
|
+
Kjell-Magne Øierud <kjellm AT oierud DOT net>
|
50
177
|
|
51
178
|
License
|
52
179
|
-------
|
53
180
|
|
54
|
-
|
55
|
-
|
181
|
+
(The MIT License)
|
182
|
+
|
183
|
+
Copyright © 2011-2012 Kjell-Magne Øierud
|
184
|
+
|
185
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
|
186
|
+
associated documentation files (the ‘Software’), to deal in the Software without restriction, including
|
187
|
+
without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
188
|
+
copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to
|
189
|
+
the following conditions:
|
190
|
+
|
191
|
+
The above copyright notice and this permission notice shall be included in all copies or substantial
|
192
|
+
portions of the Software.
|
193
|
+
|
194
|
+
THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
|
195
|
+
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
|
196
|
+
NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
197
|
+
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
198
|
+
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/Rakefile
CHANGED
@@ -1,24 +1,8 @@
|
|
1
|
-
|
1
|
+
require 'rspec/core/rake_task'
|
2
|
+
require 'bundler/gem_tasks'
|
2
3
|
|
3
|
-
|
4
|
-
|
4
|
+
desc 'Default: run specs.'
|
5
|
+
task :default => :spec
|
5
6
|
|
6
|
-
|
7
|
-
|
8
|
-
task :default => ['test']
|
9
|
-
|
10
|
-
namespace 'build' do
|
11
|
-
|
12
|
-
Rake::GemPackageTask.new(Spec) do |pkg|
|
13
|
-
pkg.need_tar = true
|
14
|
-
end
|
15
|
-
|
16
|
-
end
|
17
|
-
|
18
|
-
Rake::TestTask.new do |t|
|
19
|
-
t.name = :test
|
20
|
-
t.test_files = FileList['test/*.rb']
|
21
|
-
end
|
22
|
-
|
23
|
-
desc 'Remove generated files and folders'
|
24
|
-
task :clean => ['build:clobber_package']
|
7
|
+
desc "Run specs"
|
8
|
+
RSpec::Core::RakeTask.new
|
data/lib/plugman.rb
CHANGED
@@ -1,111 +1,47 @@
|
|
1
1
|
# encoding: utf-8
|
2
2
|
|
3
|
-
require 'plugman/finder'
|
4
|
-
require 'plugman/plugin_base'
|
5
3
|
require 'logger'
|
6
|
-
require '
|
7
|
-
|
8
|
-
#
|
9
|
-
# Plugman is a plugin manager that supports event driven communication
|
10
|
-
# with plugins. It handles the loading, initialization and all
|
11
|
-
# communications with the plugins.
|
12
|
-
#
|
13
|
-
# To call a method on the registered plugins, call plugman with a
|
14
|
-
# method name matching
|
15
|
-
#
|
16
|
-
# /^signal_(before|after|at)/
|
17
|
-
#
|
18
|
-
# plugman will then call similar named (without signal_) methods on all
|
19
|
-
# plugins which responds to the method.
|
20
|
-
#
|
21
|
-
# === Example
|
22
|
-
#
|
23
|
-
# Put some plugins in lib/your_app/plugin/. For documentation on
|
24
|
-
# writing plugins, see link:Plugman/PluginBase.html
|
25
|
-
#
|
26
|
-
# require 'plugman'
|
27
|
-
#
|
28
|
-
# class YourApp
|
29
|
-
#
|
30
|
-
# def initialize
|
31
|
-
# @pm = Plugman.new('your_app')
|
32
|
-
# @pm.load_plugins
|
33
|
-
# end
|
34
|
-
#
|
35
|
-
# def main
|
36
|
-
# @pm.signal_at_starup
|
37
|
-
#
|
38
|
-
# # ...
|
39
|
-
#
|
40
|
-
# @pm.signal_before_bar
|
41
|
-
# end
|
42
|
-
#
|
4
|
+
require 'plugman/config_loader'
|
5
|
+
require 'plugman/plugin_base'
|
43
6
|
|
44
7
|
class Plugman
|
45
8
|
|
46
|
-
def initialize(
|
47
|
-
self.finder = finder_or_name
|
48
|
-
@plugins = []
|
49
|
-
@log = StringIO.new("")
|
50
|
-
@logger = Logger.new(@log)
|
9
|
+
def initialize(args)
|
51
10
|
Plugman::PluginBase.manager = self
|
52
|
-
end
|
53
11
|
|
54
|
-
|
55
|
-
@
|
56
|
-
|
12
|
+
@plugins = args[:plugins] || []
|
13
|
+
@logger = args[:logger]
|
14
|
+
@loader = args[:loader]
|
57
15
|
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
@finder.plugin_files.each do |f|
|
62
|
-
require_plugin(f)
|
16
|
+
if @logger.nil?
|
17
|
+
@logger = Logger.new(STDERR)
|
18
|
+
@logger.level = Logger::WARN
|
63
19
|
end
|
20
|
+
end
|
64
21
|
|
65
|
-
|
66
|
-
|
67
|
-
# plugin. inherited() will in turn call register_plugin()
|
68
|
-
|
69
|
-
@plugins = @plugins.select {|p| p.state_ok? }
|
22
|
+
def load_plugins
|
23
|
+
@loader.call(@logger)
|
70
24
|
end
|
71
25
|
|
72
|
-
|
73
|
-
|
74
|
-
|
75
|
-
|
76
|
-
@logger.debug("Sending #{method} to plugins")
|
77
|
-
@plugins.select {|p| p.respond_to?(method)}.each do |p|
|
78
|
-
p.send(method, *arguments)
|
79
|
-
end
|
80
|
-
else
|
81
|
-
super
|
26
|
+
def notify(event, *arguments, &block)
|
27
|
+
@logger.debug("Sending #{event} to plugins")
|
28
|
+
@plugins.select {|p| p.respond_to?(event)}.each do |p|
|
29
|
+
notify_plugin(p, event, *arguments, &block)
|
82
30
|
end
|
31
|
+
true
|
83
32
|
end
|
84
33
|
|
34
|
+
# Called from Plugman::PluginBase when inherited
|
85
35
|
def register_plugin(klass)
|
86
36
|
@plugins.push(klass.new)
|
87
37
|
end
|
88
38
|
|
89
|
-
|
39
|
+
private
|
90
40
|
|
91
|
-
|
92
|
-
|
93
|
-
|
94
|
-
|
95
|
-
@finder = Finder::Standard.new(finder_or_name)
|
96
|
-
elsif finder_or_name.respond_to?(:plugin_files)
|
97
|
-
@finder = finder_or_name
|
98
|
-
else
|
99
|
-
raise ArgumentError 'Require a string or an object repsonding to plugin_files()'
|
100
|
-
end
|
41
|
+
def notify_plugin(plugin, event, *arguments, &block)
|
42
|
+
plugin.send(event, *arguments, &block)
|
43
|
+
rescue e
|
44
|
+
@logger.error(e)
|
101
45
|
end
|
102
46
|
|
103
|
-
def require_plugin(f)
|
104
|
-
@logger.debug "Requiering #{f}"
|
105
|
-
require f
|
106
|
-
rescue => e
|
107
|
-
@logger.error(e.class.to_s + ": " + e.message)
|
108
|
-
end
|
109
|
-
|
110
|
-
|
111
47
|
end
|
@@ -0,0 +1,22 @@
|
|
1
|
+
class Plugman
|
2
|
+
class ConfigLoader
|
3
|
+
|
4
|
+
def initialize(config)
|
5
|
+
@config = config
|
6
|
+
end
|
7
|
+
|
8
|
+
def call(logger)
|
9
|
+
@config.each { |f| require_plugin(logger, f) }
|
10
|
+
end
|
11
|
+
|
12
|
+
private
|
13
|
+
|
14
|
+
def require_plugin(logger, f)
|
15
|
+
logger.info "Requiering #{f}"
|
16
|
+
require f
|
17
|
+
rescue => e
|
18
|
+
logger.error(e.class.to_s + ": " + e.message)
|
19
|
+
end
|
20
|
+
|
21
|
+
end
|
22
|
+
end
|
data/lib/plugman/plugin_base.rb
CHANGED
@@ -1,38 +1,4 @@
|
|
1
|
-
|
2
1
|
class Plugman
|
3
|
-
|
4
|
-
#
|
5
|
-
# Plugins need to inherit this class for plugman to be able register
|
6
|
-
# them.
|
7
|
-
#
|
8
|
-
# A typical plugin will look like something like this:
|
9
|
-
#
|
10
|
-
# require 'plugman/plugin_base'
|
11
|
-
#
|
12
|
-
# class YourApp
|
13
|
-
# module Plugin
|
14
|
-
# class CoolPlugin < Plugman::PluginBase
|
15
|
-
#
|
16
|
-
# def at_startup
|
17
|
-
# puts "Whoa, it worked!"
|
18
|
-
# end
|
19
|
-
#
|
20
|
-
# def before_bar
|
21
|
-
# puts "foo"
|
22
|
-
# end
|
23
|
-
#
|
24
|
-
# end
|
25
|
-
# end
|
26
|
-
# end
|
27
|
-
#
|
28
|
-
# After a plugin is initialized, plugman will call state_ok?(). Only
|
29
|
-
# plugins who return true in this method will be registered by
|
30
|
-
# plugman.
|
31
|
-
#
|
32
|
-
# For documentation on method names, see the documentation for
|
33
|
-
# link:Plugman.html
|
34
|
-
#
|
35
|
-
|
36
2
|
class PluginBase
|
37
3
|
|
38
4
|
def self.manager=(obj)
|
@@ -43,9 +9,5 @@ class Plugman
|
|
43
9
|
@@manager.register_plugin(klass)
|
44
10
|
end
|
45
11
|
|
46
|
-
# Just returns true. Define this in your plugin class if you need
|
47
|
-
# to verify that your plugin state is ok after initialization.
|
48
|
-
def state_ok?; true; end
|
49
|
-
|
50
12
|
end
|
51
13
|
end
|
File without changes
|
File without changes
|
@@ -0,0 +1,57 @@
|
|
1
|
+
require 'plugman'
|
2
|
+
|
3
|
+
describe Plugman do
|
4
|
+
|
5
|
+
# Before each won't work because the plugins can only be required
|
6
|
+
# once per process. FIXME maybe a bug?
|
7
|
+
before(:all) do
|
8
|
+
@log = StringIO.new("")
|
9
|
+
loader = ->(a) { Dir.glob(File.dirname(__FILE__) + '/plugins/*').each {|f| require f}}
|
10
|
+
@plugman = Plugman.new(loader: loader, logger: Logger.new(@log))
|
11
|
+
@plugman.load_plugins
|
12
|
+
end
|
13
|
+
|
14
|
+
it "should send events to plugins" do
|
15
|
+
str = ""
|
16
|
+
@plugman.notify :before_big_bang, str
|
17
|
+
|
18
|
+
str.should =~ /WHOOOP/
|
19
|
+
str.should =~ /WHIIIIIIIIIIZZZZZZZZ/
|
20
|
+
end
|
21
|
+
|
22
|
+
context "different arguments to #notify" do
|
23
|
+
it "should handle no arguments" do
|
24
|
+
str = ""
|
25
|
+
@plugman.notify :reset_hello, str
|
26
|
+
@plugman.notify :hello
|
27
|
+
str.should == "Hello"
|
28
|
+
end
|
29
|
+
|
30
|
+
it "should pass on arguments" do
|
31
|
+
str = ""
|
32
|
+
@plugman.notify :reset_hello, str
|
33
|
+
@plugman.notify :hello, " world"
|
34
|
+
str.should == "Hello world"
|
35
|
+
end
|
36
|
+
|
37
|
+
it "should pass on arguments and block" do
|
38
|
+
str = ""
|
39
|
+
@plugman.notify :reset_hello, str
|
40
|
+
@plugman.notify(:hello, " world") { "!" }
|
41
|
+
str.should == "Hello world!"
|
42
|
+
end
|
43
|
+
|
44
|
+
it "should pass on block" do
|
45
|
+
str = ""
|
46
|
+
@plugman.notify :reset_hello, str
|
47
|
+
@plugman.notify(:hello) { "!" }
|
48
|
+
str.should == "Hello!"
|
49
|
+
end
|
50
|
+
|
51
|
+
end
|
52
|
+
|
53
|
+
it "should not fail when signaling an event no plugins can respond to" do
|
54
|
+
expect { @plugman.notify(:there_should_be_non_plugins_responding_to_this_event) }.to_not raise_error
|
55
|
+
end
|
56
|
+
|
57
|
+
end
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: plugman
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: '0
|
4
|
+
version: '1.0'
|
5
5
|
prerelease:
|
6
6
|
platform: ruby
|
7
7
|
authors:
|
@@ -9,29 +9,28 @@ authors:
|
|
9
9
|
autorequire:
|
10
10
|
bindir: bin
|
11
11
|
cert_chain: []
|
12
|
-
date:
|
13
|
-
default_executable:
|
12
|
+
date: 2012-08-17 00:00:00.000000000 Z
|
14
13
|
dependencies: []
|
15
14
|
description: Plugman is a plugin manager that supports event driven communication
|
16
15
|
with plugins. It handles the loading, initialization and all communications with
|
17
16
|
the plugins.
|
18
|
-
email: kjellm@
|
17
|
+
email: kjellm@oierud.net
|
19
18
|
executables: []
|
20
19
|
extensions: []
|
21
20
|
extra_rdoc_files: []
|
22
21
|
files:
|
23
|
-
- lib/plugman/
|
22
|
+
- lib/plugman/config_loader.rb
|
24
23
|
- lib/plugman/plugin_base.rb
|
25
|
-
- lib/plugman/
|
26
|
-
- lib/plugman/finder/simple.rb
|
24
|
+
- lib/plugman/version.rb
|
27
25
|
- lib/plugman.rb
|
28
|
-
-
|
29
|
-
-
|
30
|
-
-
|
31
|
-
-
|
26
|
+
- spec/plugins/bar.rb
|
27
|
+
- spec/plugins/baz.rb
|
28
|
+
- spec/plugins/hello.rb
|
29
|
+
- spec/plugman_spec.rb
|
30
|
+
- CHANGES
|
31
|
+
- Gemfile
|
32
32
|
- README.md
|
33
|
-
-
|
34
|
-
has_rdoc: true
|
33
|
+
- Rakefile
|
35
34
|
homepage: http://github.com/kjellm/plugman
|
36
35
|
licenses: []
|
37
36
|
post_install_message:
|
@@ -43,17 +42,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
43
42
|
requirements:
|
44
43
|
- - ! '>='
|
45
44
|
- !ruby/object:Gem::Version
|
46
|
-
version: 1.
|
45
|
+
version: 1.9.2
|
47
46
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
48
47
|
none: false
|
49
48
|
requirements:
|
50
49
|
- - ! '>='
|
51
50
|
- !ruby/object:Gem::Version
|
52
51
|
version: '0'
|
53
|
-
requirements:
|
54
|
-
- none
|
52
|
+
requirements: []
|
55
53
|
rubyforge_project:
|
56
|
-
rubygems_version: 1.
|
54
|
+
rubygems_version: 1.8.24
|
57
55
|
signing_key:
|
58
56
|
specification_version: 3
|
59
57
|
summary: A plugin manager.
|
data/COPYING
DELETED
@@ -1,339 +0,0 @@
|
|
1
|
-
GNU GENERAL PUBLIC LICENSE
|
2
|
-
Version 2, June 1991
|
3
|
-
|
4
|
-
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
|
5
|
-
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
6
|
-
Everyone is permitted to copy and distribute verbatim copies
|
7
|
-
of this license document, but changing it is not allowed.
|
8
|
-
|
9
|
-
Preamble
|
10
|
-
|
11
|
-
The licenses for most software are designed to take away your
|
12
|
-
freedom to share and change it. By contrast, the GNU General Public
|
13
|
-
License is intended to guarantee your freedom to share and change free
|
14
|
-
software--to make sure the software is free for all its users. This
|
15
|
-
General Public License applies to most of the Free Software
|
16
|
-
Foundation's software and to any other program whose authors commit to
|
17
|
-
using it. (Some other Free Software Foundation software is covered by
|
18
|
-
the GNU Lesser General Public License instead.) You can apply it to
|
19
|
-
your programs, too.
|
20
|
-
|
21
|
-
When we speak of free software, we are referring to freedom, not
|
22
|
-
price. Our General Public Licenses are designed to make sure that you
|
23
|
-
have the freedom to distribute copies of free software (and charge for
|
24
|
-
this service if you wish), that you receive source code or can get it
|
25
|
-
if you want it, that you can change the software or use pieces of it
|
26
|
-
in new free programs; and that you know you can do these things.
|
27
|
-
|
28
|
-
To protect your rights, we need to make restrictions that forbid
|
29
|
-
anyone to deny you these rights or to ask you to surrender the rights.
|
30
|
-
These restrictions translate to certain responsibilities for you if you
|
31
|
-
distribute copies of the software, or if you modify it.
|
32
|
-
|
33
|
-
For example, if you distribute copies of such a program, whether
|
34
|
-
gratis or for a fee, you must give the recipients all the rights that
|
35
|
-
you have. You must make sure that they, too, receive or can get the
|
36
|
-
source code. And you must show them these terms so they know their
|
37
|
-
rights.
|
38
|
-
|
39
|
-
We protect your rights with two steps: (1) copyright the software, and
|
40
|
-
(2) offer you this license which gives you legal permission to copy,
|
41
|
-
distribute and/or modify the software.
|
42
|
-
|
43
|
-
Also, for each author's protection and ours, we want to make certain
|
44
|
-
that everyone understands that there is no warranty for this free
|
45
|
-
software. If the software is modified by someone else and passed on, we
|
46
|
-
want its recipients to know that what they have is not the original, so
|
47
|
-
that any problems introduced by others will not reflect on the original
|
48
|
-
authors' reputations.
|
49
|
-
|
50
|
-
Finally, any free program is threatened constantly by software
|
51
|
-
patents. We wish to avoid the danger that redistributors of a free
|
52
|
-
program will individually obtain patent licenses, in effect making the
|
53
|
-
program proprietary. To prevent this, we have made it clear that any
|
54
|
-
patent must be licensed for everyone's free use or not licensed at all.
|
55
|
-
|
56
|
-
The precise terms and conditions for copying, distribution and
|
57
|
-
modification follow.
|
58
|
-
|
59
|
-
GNU GENERAL PUBLIC LICENSE
|
60
|
-
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
61
|
-
|
62
|
-
0. This License applies to any program or other work which contains
|
63
|
-
a notice placed by the copyright holder saying it may be distributed
|
64
|
-
under the terms of this General Public License. The "Program", below,
|
65
|
-
refers to any such program or work, and a "work based on the Program"
|
66
|
-
means either the Program or any derivative work under copyright law:
|
67
|
-
that is to say, a work containing the Program or a portion of it,
|
68
|
-
either verbatim or with modifications and/or translated into another
|
69
|
-
language. (Hereinafter, translation is included without limitation in
|
70
|
-
the term "modification".) Each licensee is addressed as "you".
|
71
|
-
|
72
|
-
Activities other than copying, distribution and modification are not
|
73
|
-
covered by this License; they are outside its scope. The act of
|
74
|
-
running the Program is not restricted, and the output from the Program
|
75
|
-
is covered only if its contents constitute a work based on the
|
76
|
-
Program (independent of having been made by running the Program).
|
77
|
-
Whether that is true depends on what the Program does.
|
78
|
-
|
79
|
-
1. You may copy and distribute verbatim copies of the Program's
|
80
|
-
source code as you receive it, in any medium, provided that you
|
81
|
-
conspicuously and appropriately publish on each copy an appropriate
|
82
|
-
copyright notice and disclaimer of warranty; keep intact all the
|
83
|
-
notices that refer to this License and to the absence of any warranty;
|
84
|
-
and give any other recipients of the Program a copy of this License
|
85
|
-
along with the Program.
|
86
|
-
|
87
|
-
You may charge a fee for the physical act of transferring a copy, and
|
88
|
-
you may at your option offer warranty protection in exchange for a fee.
|
89
|
-
|
90
|
-
2. You may modify your copy or copies of the Program or any portion
|
91
|
-
of it, thus forming a work based on the Program, and copy and
|
92
|
-
distribute such modifications or work under the terms of Section 1
|
93
|
-
above, provided that you also meet all of these conditions:
|
94
|
-
|
95
|
-
a) You must cause the modified files to carry prominent notices
|
96
|
-
stating that you changed the files and the date of any change.
|
97
|
-
|
98
|
-
b) You must cause any work that you distribute or publish, that in
|
99
|
-
whole or in part contains or is derived from the Program or any
|
100
|
-
part thereof, to be licensed as a whole at no charge to all third
|
101
|
-
parties under the terms of this License.
|
102
|
-
|
103
|
-
c) If the modified program normally reads commands interactively
|
104
|
-
when run, you must cause it, when started running for such
|
105
|
-
interactive use in the most ordinary way, to print or display an
|
106
|
-
announcement including an appropriate copyright notice and a
|
107
|
-
notice that there is no warranty (or else, saying that you provide
|
108
|
-
a warranty) and that users may redistribute the program under
|
109
|
-
these conditions, and telling the user how to view a copy of this
|
110
|
-
License. (Exception: if the Program itself is interactive but
|
111
|
-
does not normally print such an announcement, your work based on
|
112
|
-
the Program is not required to print an announcement.)
|
113
|
-
|
114
|
-
These requirements apply to the modified work as a whole. If
|
115
|
-
identifiable sections of that work are not derived from the Program,
|
116
|
-
and can be reasonably considered independent and separate works in
|
117
|
-
themselves, then this License, and its terms, do not apply to those
|
118
|
-
sections when you distribute them as separate works. But when you
|
119
|
-
distribute the same sections as part of a whole which is a work based
|
120
|
-
on the Program, the distribution of the whole must be on the terms of
|
121
|
-
this License, whose permissions for other licensees extend to the
|
122
|
-
entire whole, and thus to each and every part regardless of who wrote it.
|
123
|
-
|
124
|
-
Thus, it is not the intent of this section to claim rights or contest
|
125
|
-
your rights to work written entirely by you; rather, the intent is to
|
126
|
-
exercise the right to control the distribution of derivative or
|
127
|
-
collective works based on the Program.
|
128
|
-
|
129
|
-
In addition, mere aggregation of another work not based on the Program
|
130
|
-
with the Program (or with a work based on the Program) on a volume of
|
131
|
-
a storage or distribution medium does not bring the other work under
|
132
|
-
the scope of this License.
|
133
|
-
|
134
|
-
3. You may copy and distribute the Program (or a work based on it,
|
135
|
-
under Section 2) in object code or executable form under the terms of
|
136
|
-
Sections 1 and 2 above provided that you also do one of the following:
|
137
|
-
|
138
|
-
a) Accompany it with the complete corresponding machine-readable
|
139
|
-
source code, which must be distributed under the terms of Sections
|
140
|
-
1 and 2 above on a medium customarily used for software interchange; or,
|
141
|
-
|
142
|
-
b) Accompany it with a written offer, valid for at least three
|
143
|
-
years, to give any third party, for a charge no more than your
|
144
|
-
cost of physically performing source distribution, a complete
|
145
|
-
machine-readable copy of the corresponding source code, to be
|
146
|
-
distributed under the terms of Sections 1 and 2 above on a medium
|
147
|
-
customarily used for software interchange; or,
|
148
|
-
|
149
|
-
c) Accompany it with the information you received as to the offer
|
150
|
-
to distribute corresponding source code. (This alternative is
|
151
|
-
allowed only for noncommercial distribution and only if you
|
152
|
-
received the program in object code or executable form with such
|
153
|
-
an offer, in accord with Subsection b above.)
|
154
|
-
|
155
|
-
The source code for a work means the preferred form of the work for
|
156
|
-
making modifications to it. For an executable work, complete source
|
157
|
-
code means all the source code for all modules it contains, plus any
|
158
|
-
associated interface definition files, plus the scripts used to
|
159
|
-
control compilation and installation of the executable. However, as a
|
160
|
-
special exception, the source code distributed need not include
|
161
|
-
anything that is normally distributed (in either source or binary
|
162
|
-
form) with the major components (compiler, kernel, and so on) of the
|
163
|
-
operating system on which the executable runs, unless that component
|
164
|
-
itself accompanies the executable.
|
165
|
-
|
166
|
-
If distribution of executable or object code is made by offering
|
167
|
-
access to copy from a designated place, then offering equivalent
|
168
|
-
access to copy the source code from the same place counts as
|
169
|
-
distribution of the source code, even though third parties are not
|
170
|
-
compelled to copy the source along with the object code.
|
171
|
-
|
172
|
-
4. You may not copy, modify, sublicense, or distribute the Program
|
173
|
-
except as expressly provided under this License. Any attempt
|
174
|
-
otherwise to copy, modify, sublicense or distribute the Program is
|
175
|
-
void, and will automatically terminate your rights under this License.
|
176
|
-
However, parties who have received copies, or rights, from you under
|
177
|
-
this License will not have their licenses terminated so long as such
|
178
|
-
parties remain in full compliance.
|
179
|
-
|
180
|
-
5. You are not required to accept this License, since you have not
|
181
|
-
signed it. However, nothing else grants you permission to modify or
|
182
|
-
distribute the Program or its derivative works. These actions are
|
183
|
-
prohibited by law if you do not accept this License. Therefore, by
|
184
|
-
modifying or distributing the Program (or any work based on the
|
185
|
-
Program), you indicate your acceptance of this License to do so, and
|
186
|
-
all its terms and conditions for copying, distributing or modifying
|
187
|
-
the Program or works based on it.
|
188
|
-
|
189
|
-
6. Each time you redistribute the Program (or any work based on the
|
190
|
-
Program), the recipient automatically receives a license from the
|
191
|
-
original licensor to copy, distribute or modify the Program subject to
|
192
|
-
these terms and conditions. You may not impose any further
|
193
|
-
restrictions on the recipients' exercise of the rights granted herein.
|
194
|
-
You are not responsible for enforcing compliance by third parties to
|
195
|
-
this License.
|
196
|
-
|
197
|
-
7. If, as a consequence of a court judgment or allegation of patent
|
198
|
-
infringement or for any other reason (not limited to patent issues),
|
199
|
-
conditions are imposed on you (whether by court order, agreement or
|
200
|
-
otherwise) that contradict the conditions of this License, they do not
|
201
|
-
excuse you from the conditions of this License. If you cannot
|
202
|
-
distribute so as to satisfy simultaneously your obligations under this
|
203
|
-
License and any other pertinent obligations, then as a consequence you
|
204
|
-
may not distribute the Program at all. For example, if a patent
|
205
|
-
license would not permit royalty-free redistribution of the Program by
|
206
|
-
all those who receive copies directly or indirectly through you, then
|
207
|
-
the only way you could satisfy both it and this License would be to
|
208
|
-
refrain entirely from distribution of the Program.
|
209
|
-
|
210
|
-
If any portion of this section is held invalid or unenforceable under
|
211
|
-
any particular circumstance, the balance of the section is intended to
|
212
|
-
apply and the section as a whole is intended to apply in other
|
213
|
-
circumstances.
|
214
|
-
|
215
|
-
It is not the purpose of this section to induce you to infringe any
|
216
|
-
patents or other property right claims or to contest validity of any
|
217
|
-
such claims; this section has the sole purpose of protecting the
|
218
|
-
integrity of the free software distribution system, which is
|
219
|
-
implemented by public license practices. Many people have made
|
220
|
-
generous contributions to the wide range of software distributed
|
221
|
-
through that system in reliance on consistent application of that
|
222
|
-
system; it is up to the author/donor to decide if he or she is willing
|
223
|
-
to distribute software through any other system and a licensee cannot
|
224
|
-
impose that choice.
|
225
|
-
|
226
|
-
This section is intended to make thoroughly clear what is believed to
|
227
|
-
be a consequence of the rest of this License.
|
228
|
-
|
229
|
-
8. If the distribution and/or use of the Program is restricted in
|
230
|
-
certain countries either by patents or by copyrighted interfaces, the
|
231
|
-
original copyright holder who places the Program under this License
|
232
|
-
may add an explicit geographical distribution limitation excluding
|
233
|
-
those countries, so that distribution is permitted only in or among
|
234
|
-
countries not thus excluded. In such case, this License incorporates
|
235
|
-
the limitation as if written in the body of this License.
|
236
|
-
|
237
|
-
9. The Free Software Foundation may publish revised and/or new versions
|
238
|
-
of the General Public License from time to time. Such new versions will
|
239
|
-
be similar in spirit to the present version, but may differ in detail to
|
240
|
-
address new problems or concerns.
|
241
|
-
|
242
|
-
Each version is given a distinguishing version number. If the Program
|
243
|
-
specifies a version number of this License which applies to it and "any
|
244
|
-
later version", you have the option of following the terms and conditions
|
245
|
-
either of that version or of any later version published by the Free
|
246
|
-
Software Foundation. If the Program does not specify a version number of
|
247
|
-
this License, you may choose any version ever published by the Free Software
|
248
|
-
Foundation.
|
249
|
-
|
250
|
-
10. If you wish to incorporate parts of the Program into other free
|
251
|
-
programs whose distribution conditions are different, write to the author
|
252
|
-
to ask for permission. For software which is copyrighted by the Free
|
253
|
-
Software Foundation, write to the Free Software Foundation; we sometimes
|
254
|
-
make exceptions for this. Our decision will be guided by the two goals
|
255
|
-
of preserving the free status of all derivatives of our free software and
|
256
|
-
of promoting the sharing and reuse of software generally.
|
257
|
-
|
258
|
-
NO WARRANTY
|
259
|
-
|
260
|
-
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
|
261
|
-
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
|
262
|
-
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
|
263
|
-
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
|
264
|
-
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
265
|
-
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
|
266
|
-
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
|
267
|
-
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
|
268
|
-
REPAIR OR CORRECTION.
|
269
|
-
|
270
|
-
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
271
|
-
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
|
272
|
-
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
273
|
-
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
|
274
|
-
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
|
275
|
-
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
|
276
|
-
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
|
277
|
-
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
|
278
|
-
POSSIBILITY OF SUCH DAMAGES.
|
279
|
-
|
280
|
-
END OF TERMS AND CONDITIONS
|
281
|
-
|
282
|
-
How to Apply These Terms to Your New Programs
|
283
|
-
|
284
|
-
If you develop a new program, and you want it to be of the greatest
|
285
|
-
possible use to the public, the best way to achieve this is to make it
|
286
|
-
free software which everyone can redistribute and change under these terms.
|
287
|
-
|
288
|
-
To do so, attach the following notices to the program. It is safest
|
289
|
-
to attach them to the start of each source file to most effectively
|
290
|
-
convey the exclusion of warranty; and each file should have at least
|
291
|
-
the "copyright" line and a pointer to where the full notice is found.
|
292
|
-
|
293
|
-
<one line to give the program's name and a brief idea of what it does.>
|
294
|
-
Copyright (C) <year> <name of author>
|
295
|
-
|
296
|
-
This program is free software; you can redistribute it and/or modify
|
297
|
-
it under the terms of the GNU General Public License as published by
|
298
|
-
the Free Software Foundation; either version 2 of the License, or
|
299
|
-
(at your option) any later version.
|
300
|
-
|
301
|
-
This program is distributed in the hope that it will be useful,
|
302
|
-
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
303
|
-
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
304
|
-
GNU General Public License for more details.
|
305
|
-
|
306
|
-
You should have received a copy of the GNU General Public License along
|
307
|
-
with this program; if not, write to the Free Software Foundation, Inc.,
|
308
|
-
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
309
|
-
|
310
|
-
Also add information on how to contact you by electronic and paper mail.
|
311
|
-
|
312
|
-
If the program is interactive, make it output a short notice like this
|
313
|
-
when it starts in an interactive mode:
|
314
|
-
|
315
|
-
Gnomovision version 69, Copyright (C) year name of author
|
316
|
-
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
317
|
-
This is free software, and you are welcome to redistribute it
|
318
|
-
under certain conditions; type `show c' for details.
|
319
|
-
|
320
|
-
The hypothetical commands `show w' and `show c' should show the appropriate
|
321
|
-
parts of the General Public License. Of course, the commands you use may
|
322
|
-
be called something other than `show w' and `show c'; they could even be
|
323
|
-
mouse-clicks or menu items--whatever suits your program.
|
324
|
-
|
325
|
-
You should also get your employer (if you work as a programmer) or your
|
326
|
-
school, if any, to sign a "copyright disclaimer" for the program, if
|
327
|
-
necessary. Here is a sample; alter the names:
|
328
|
-
|
329
|
-
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
|
330
|
-
`Gnomovision' (which makes passes at compilers) written by James Hacker.
|
331
|
-
|
332
|
-
<signature of Ty Coon>, 1 April 1989
|
333
|
-
Ty Coon, President of Vice
|
334
|
-
|
335
|
-
This General Public License does not permit incorporating your program into
|
336
|
-
proprietary programs. If your program is a subroutine library, you may
|
337
|
-
consider it more useful to permit linking proprietary applications with the
|
338
|
-
library. If this is what you want to do, use the GNU Lesser General
|
339
|
-
Public License instead of this License.
|
data/lib/plugman/finder.rb
DELETED
@@ -1,25 +0,0 @@
|
|
1
|
-
require 'rubygems'
|
2
|
-
|
3
|
-
class Plugman
|
4
|
-
module Finder
|
5
|
-
class Standard
|
6
|
-
|
7
|
-
def initialize(name)
|
8
|
-
@glob = "#{name}/plugin/*"
|
9
|
-
end
|
10
|
-
|
11
|
-
def plugin_files
|
12
|
-
# FIX assuming here that array is sorted correctly. Assumption correct?
|
13
|
-
seen = {}
|
14
|
-
files = []
|
15
|
-
Gem.find_files(@glob, true).each do |p|
|
16
|
-
name = File.basename(p)
|
17
|
-
files << p unless seen[name]
|
18
|
-
seen[name] = true
|
19
|
-
end
|
20
|
-
files
|
21
|
-
end
|
22
|
-
|
23
|
-
end
|
24
|
-
end
|
25
|
-
end
|
data/test/test_plugman.rb
DELETED
@@ -1,24 +0,0 @@
|
|
1
|
-
require 'plugman'
|
2
|
-
require 'plugman/finder'
|
3
|
-
require 'test/unit'
|
4
|
-
|
5
|
-
class TestPlugman < Test::Unit::TestCase
|
6
|
-
|
7
|
-
def test_it
|
8
|
-
pm = Plugman.new(Plugman::Finder::Simple.new(File.dirname(__FILE__) + '/plugin'))
|
9
|
-
pm.load_plugins
|
10
|
-
|
11
|
-
str = ""
|
12
|
-
pm.signal_before_big_bang(str)
|
13
|
-
print pm.log
|
14
|
-
|
15
|
-
assert(str =~ /WHOOOP/)
|
16
|
-
assert(str =~ /WHIIIIIIIIIIZZZZZZZZ/)
|
17
|
-
|
18
|
-
assert_raise NoMethodError do
|
19
|
-
pm.this_should_be_missing
|
20
|
-
end
|
21
|
-
end
|
22
|
-
|
23
|
-
end
|
24
|
-
|