plugin-loader 0.0.1 → 0.2.0

data/lib/plugin/loader.rb

@@ -56,6 +56,7 @@ module Plugin
 			@plugin_dir = opts[:plugin_dir] || "#{@data_dir}/plugins"
 			@script_dir = opts[:script_dir] || "#{@data_dir}/scripts"
 			@plugins = {}
+			@etc = {}
 		end
 		#Loads a plugin called 'name' of type 'type'.
 		#It does this by reading the metadata file: "#{@plugin_dir}/name.type".
@@ -74,30 +75,44 @@ module Plugin
 		#If the format is not available or is not allowed (see: initailize), an exception is raised.
 		#See Plugin::Format for more details on plugin formats.
 		#The '$' key can be any data structure (most commonly a string) and is used by the format declaration to excecute a plugin. See the individual format declarations in plugin/format/*.rb for details of individual formats. If the '$' key is missing, an exception is raised.
+		#
+		#load returns any extra data keys in the JSON file as a hash.
 		def load name, type
 			File.open "#{@plugin_dir}/#{name}.#{type}" do |f|
 				data = JSON.parse(f.read)
 				unless data.has_key? '$'
-					raise "Plugin #{type} plugin '#{name}' has an invalid metadata file. It is missing the required '$' key!"
+					raise "#{type} plugin '#{name}' has an invalid metadata file. It is missing the required '$' key!"
 				end
 				unless data.has_key? 'format'
-					raise "Plugin #{type} plugin '#{name}' has an invalid metadata file. It is missing the required 'format' key!"
+					raise "#{type} plugin '#{name}' has an invalid metadata file. It is missing the required 'format' key!"
 				end
 				unless @plugins.has_key? type
 					@plugins[type] = {}
 				end
-				format = Format[data['format']]
+				unless @etc.has_key? type
+					@etc[type] = {}
+				end
+				fmt = data.delete 'format'
+				format = Format[fmt]
 				if format.nil?
-					raise "Plugin format #{data['format']} does not exist or is disabled!"
+					raise "Plugin format #{fmt} does not exist or is disabled!"
 				end
-				@plugins[type][name] = format.new data['$'],
+				@plugins[type][name] = format.new data.delete('$'),
 					:script_dir => @script_dir,
 					:data_dir => @data_dir,
 					:plugin_dir => @plugin_dir
+				@etc[type][name] = data
 			end
 		end
+		#Returns a hash of any extra keys in the plugin metadata file of
+		#the plugin with type 'type' and name 'name'. The plugin needs
+		#to be loaded for this to work.
+		def etc name, type
+			@etc[type][name]
+		end
 		#Unloads a plugin of name 'name' and type 'type'.
 		def unload name, type
+			@etc[type].delete name
 			@plugins[type].delete name
 		end
 		#Loads all plugins of type 'type'.
@@ -108,6 +123,7 @@ module Plugin
 		end
 		#Unloads all plugins of type 'type'.
 		def unload_type type
+			@etc.delete type
 			@plugins.delete type
 		end
 		#Loads all plugins.
@@ -118,6 +134,7 @@ module Plugin
 		end
 		#Unloads all plugins.
 		def unload_all
+			@etc.clear
 			@plugins.clear
 		end
 		#Excecutes the plugin of type 'type' called 'name', passing in any other arguments.
@@ -125,6 +142,17 @@ module Plugin
 		def run name, type, *args
 			@plugins[type][name].call *args
 		end
+		#Returns a list of the loaded types
+		def types
+			@plugins.keys
+		end
+		#Returns a list of the plugins of type 'type'
+		def plugins type
+			unless @plugins.has_key? type
+				return []
+			end
+			@plugins[type].keys
+		end
 	end
 
 end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: plugin-loader
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - David Green
@@ -9,39 +15,51 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-25 00:00:00 +01:00
+date: 2010-09-29 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: dbus
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: escape
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id003
 description: |-
   plugin-loader can be used to extend a program written in ruby by using plugins. 
   	Plugins can be written in ruby or can be external resources.
@@ -70,21 +88,29 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 53
+      segments: 
+      - 1
+      - 8
+      - 1
       version: 1.8.1
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Library for creating extensible ruby applications