RubyGems - gem_plugin - Versions diffs - 0.1 → 0.2 - Mend

gem_plugin 0.1 → 0.2

Files changed (33) hide show

data/Rakefile +15 -9
data/bin/gpgen +60 -0
data/doc/rdoc/classes/GemPlugin.html +3 -2
data/doc/rdoc/classes/GemPlugin.src/M000001.html +5 -5
data/doc/rdoc/classes/GemPlugin/Base.html +1 -1
data/doc/rdoc/classes/GemPlugin/Base.src/M000002.html +6 -6
data/doc/rdoc/classes/GemPlugin/Base.src/M000003.html +4 -4
data/doc/rdoc/classes/GemPlugin/Base.src/M000004.html +4 -4
data/doc/rdoc/classes/GemPlugin/Manager.html +107 -8
data/doc/rdoc/classes/GemPlugin/Manager.src/M000005.html +9 -5
data/doc/rdoc/classes/GemPlugin/Manager.src/M000006.html +30 -29
data/doc/rdoc/classes/GemPlugin/Manager.src/M000007.html +5 -5
data/doc/rdoc/classes/GemPlugin/Manager.src/M000008.html +15 -15
data/doc/rdoc/classes/GemPlugin/Manager.src/M000009.html +5 -5
data/doc/rdoc/classes/GemPlugin/Manager.src/M000010.html +28 -0
data/doc/rdoc/classes/GemPlugin/Manager.src/M000011.html +28 -0
data/doc/rdoc/classes/GemPlugin/PluginNotLoaded.html +111 -0
data/doc/rdoc/created.rid +1 -1
data/doc/rdoc/files/README.html +3 -6
data/doc/rdoc/files/lib/gem_plugin_rb.html +1 -1
data/doc/rdoc/fr_class_index.html +1 -0
data/doc/rdoc/fr_method_index.html +3 -1
data/lib/gem_plugin.rb +89 -13
data/resources/COPYING +1 -0
data/resources/LICENSE +1 -0
data/resources/README +5 -0
data/resources/Rakefile +37 -0
data/resources/lib/project/init.rb +6 -0
data/resources/resources/defaults.yaml +2 -0
data/resources/tools/rakehelp.rb +105 -0
data/test/test_plugins.rb +3 -4
data/tools/rakehelp.rb +5 -11
metadata +36 -11

data/doc/rdoc/classes/GemPlugin/Manager.src/M000008.html CHANGED

@@ -10,20 +10,20 @@
   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre>     <span class="ruby-comment cmt"># File lib/gem_plugin.rb, line 133</span>
-133:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">options</span> = {})
-134:       <span class="ruby-identifier">last_slash</span> = <span class="ruby-identifier">name</span>.<span class="ruby-identifier">rindex</span>(<span class="ruby-value str">&quot;/&quot;</span>)
-135:       <span class="ruby-identifier">category</span> = <span class="ruby-identifier">name</span>[<span class="ruby-value">0</span> <span class="ruby-operator">...</span> <span class="ruby-identifier">last_slash</span>]
-136:       <span class="ruby-identifier">plugin</span> = <span class="ruby-identifier">name</span>[<span class="ruby-identifier">last_slash</span> <span class="ruby-operator">..</span> <span class="ruby-value">-1</span>]
-137:
-138:       <span class="ruby-identifier">map</span> = <span class="ruby-ivar">@plugins</span>[<span class="ruby-identifier">category</span>]
-139:       <span class="ruby-keyword kw">if</span> <span class="ruby-keyword kw">not</span> <span class="ruby-identifier">map</span>
-140:         <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;Plugin category #{category} does not exist&quot;</span>
-141:       <span class="ruby-keyword kw">elsif</span> <span class="ruby-keyword kw">not</span> <span class="ruby-identifier">map</span>.<span class="ruby-identifier">has_key?</span> <span class="ruby-identifier">plugin</span>
-142:         <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;Plugin #{plugin} does not exist in category #{category}&quot;</span>
-143:       <span class="ruby-keyword kw">else</span>
-144:         <span class="ruby-identifier">map</span>[<span class="ruby-identifier">plugin</span>].<span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>)
-145:       <span class="ruby-keyword kw">end</span>
-146:     <span class="ruby-keyword kw">end</span></pre>
+  <pre>     <span class="ruby-comment cmt"># File lib/gem_plugin.rb, line 145</span>
+145:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">options</span> = {})
+146:       <span class="ruby-identifier">last_slash</span> = <span class="ruby-identifier">name</span>.<span class="ruby-identifier">rindex</span>(<span class="ruby-value str">&quot;/&quot;</span>)
+147:       <span class="ruby-identifier">category</span> = <span class="ruby-identifier">name</span>[<span class="ruby-value">0</span> <span class="ruby-operator">...</span> <span class="ruby-identifier">last_slash</span>]
+148:       <span class="ruby-identifier">plugin</span> = <span class="ruby-identifier">name</span>[<span class="ruby-identifier">last_slash</span> <span class="ruby-operator">..</span> <span class="ruby-value">-1</span>]
+149:
+150:       <span class="ruby-identifier">map</span> = <span class="ruby-ivar">@plugins</span>[<span class="ruby-identifier">category</span>]
+151:       <span class="ruby-keyword kw">if</span> <span class="ruby-keyword kw">not</span> <span class="ruby-identifier">map</span>
+152:         <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;Plugin category #{category} does not exist&quot;</span>
+153:       <span class="ruby-keyword kw">elsif</span> <span class="ruby-keyword kw">not</span> <span class="ruby-identifier">map</span>.<span class="ruby-identifier">has_key?</span> <span class="ruby-identifier">plugin</span>
+154:         <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;Plugin #{plugin} does not exist in category #{category}&quot;</span>
+155:       <span class="ruby-keyword kw">else</span>
+156:         <span class="ruby-identifier">map</span>[<span class="ruby-identifier">plugin</span>].<span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>)
+157:       <span class="ruby-keyword kw">end</span>
+158:     <span class="ruby-keyword kw">end</span></pre>
 </body>
 </html>

data/doc/rdoc/classes/GemPlugin/Manager.src/M000009.html CHANGED

@@ -5,14 +5,14 @@
 <html>
 <head>
-  <title>available (GemPlugin::Manager)</title>
+  <title>loaded? (GemPlugin::Manager)</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre>     <span class="ruby-comment cmt"># File lib/gem_plugin.rb, line 151</span>
-151:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">available</span>
-152:       <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@plugins</span>
-153:     <span class="ruby-keyword kw">end</span></pre>
+  <pre>     <span class="ruby-comment cmt"># File lib/gem_plugin.rb, line 162</span>
+162:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">loaded?</span>(<span class="ruby-identifier">gem_name</span>)
+163:       <span class="ruby-ivar">@gems</span>.<span class="ruby-identifier">has_key?</span> <span class="ruby-identifier">gem_name</span>
+164:     <span class="ruby-keyword kw">end</span></pre>
 </body>
 </html>

data/doc/rdoc/classes/GemPlugin/Manager.src/M000010.html ADDED

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+  <title>resource (GemPlugin::Manager)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre>     <span class="ruby-comment cmt"># File lib/gem_plugin.rb, line 185</span>
+185:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">resource</span>(<span class="ruby-identifier">gem_name</span>, <span class="ruby-identifier">path</span>)
+186:       <span class="ruby-keyword kw">if</span> <span class="ruby-keyword kw">not</span> <span class="ruby-identifier">loaded?</span> <span class="ruby-identifier">gem_name</span>
+187:         <span class="ruby-identifier">raise</span> <span class="ruby-constant">PluginNotLoaded</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">&quot;Plugin #{gem_name} not loaded when getting resource #{path}&quot;</span>)
+188:       <span class="ruby-keyword kw">end</span>
+189:
+190:       <span class="ruby-identifier">file</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-ivar">@gems</span>[<span class="ruby-identifier">gem_name</span>], <span class="ruby-value str">&quot;resources&quot;</span>, <span class="ruby-identifier">path</span>)
+191:
+192:       <span class="ruby-keyword kw">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span> <span class="ruby-identifier">file</span>
+193:         <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">file</span>
+194:       <span class="ruby-keyword kw">else</span>
+195:         <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span>
+196:       <span class="ruby-keyword kw">end</span>
+197:     <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/rdoc/classes/GemPlugin/Manager.src/M000011.html ADDED

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+  <title>config (GemPlugin::Manager)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre>     <span class="ruby-comment cmt"># File lib/gem_plugin.rb, line 218</span>
+218:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">config</span>(<span class="ruby-identifier">gem_name</span>, <span class="ruby-identifier">options</span>={})
+219:       <span class="ruby-identifier">config_file</span> = <span class="ruby-constant">Manager</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">resource</span>(<span class="ruby-identifier">gem_name</span>, <span class="ruby-value str">&quot;/defaults.yaml&quot;</span>)
+220:       <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">config_file</span>
+221:         <span class="ruby-keyword kw">begin</span>
+222:           <span class="ruby-identifier">defaults</span> = <span class="ruby-constant">YAML</span>.<span class="ruby-identifier">load_file</span>(<span class="ruby-identifier">config_file</span>)
+223:           <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">defaults</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">options</span>)
+224:         <span class="ruby-keyword kw">rescue</span>
+225:           <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;Error loading config #{config_file} for gem #{gem_name}&quot;</span>
+226:         <span class="ruby-keyword kw">end</span>
+227:       <span class="ruby-keyword kw">else</span>
+228:         <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">options</span>
+229:       <span class="ruby-keyword kw">end</span>
+230:     <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/rdoc/classes/GemPlugin/PluginNotLoaded.html ADDED

@@ -0,0 +1,111 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: GemPlugin::PluginNotLoaded</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">GemPlugin::PluginNotLoaded</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/gem_plugin_rb.html">
+                lib/gem_plugin.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                StandardError
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+   </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>

data/doc/rdoc/created.rid CHANGED

	@@ -1 +1 @@
1	- ~~Mon~~ Mar 06 00:45~~:39~~ EST 2006
1	+ Sat Mar 11 22:25:45 EST 2006

data/doc/rdoc/files/README.html CHANGED

@@ -92,9 +92,7 @@ only have to require &#8216;gem_plugin&#8217; and then use the <a
 href="../classes/GemPlugin/Manager.html#M000008">GemPlugin::Manager.create</a>,
 <a
 href="../classes/GemPlugin/Manager.html#M000006">GemPlugin::Manager.load</a>,
-and <a
-href="../classes/GemPlugin/Manager.html#M000009">GemPlugin::Manager.available</a>
-methods to work with them.
+and GemPlugin::Manager.available methods to work with them.
 </p>
 <ul>
 <li><a
@@ -108,9 +106,8 @@ href="../classes/GemPlugin/Manager.html#M000008">GemPlugin::Manager.create</a>
 &#8212; Takes a URI style name and some options then creates one for you.
 </li>
-<li><a
-href="../classes/GemPlugin/Manager.html#M000009">GemPlugin::Manager.available</a>
-&#8212; Lets you inspect and mess with the internal plugin registry.
+<li>GemPlugin::Manager.available &#8212; Lets you inspect and mess with the
+internal plugin registry.
 </li>
 </ul>

data/doc/rdoc/files/lib/gem_plugin_rb.html CHANGED

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Sun Mar 05 22:03:34 EST 2006</td>
+      <td>Sat Mar 11 21:19:15 EST 2006</td>
     </tr>
     </table>
   </div>

data/doc/rdoc/fr_class_index.html CHANGED

@@ -23,6 +23,7 @@
     <a href="classes/GemPlugin.html">GemPlugin</a><br />
     <a href="classes/GemPlugin/Base.html">GemPlugin::Base</a><br />
     <a href="classes/GemPlugin/Manager.html">GemPlugin::Manager</a><br />
+    <a href="classes/GemPlugin/PluginNotLoaded.html">GemPlugin::PluginNotLoaded</a><br />
   </div>
 </div>
 </body>

data/doc/rdoc/fr_method_index.html CHANGED

@@ -21,14 +21,16 @@
   <h1 class="section-bar">Methods</h1>
   <div id="index-entries">
     <a href="classes/GemPlugin.html#M000001">Plugin (GemPlugin)</a><br />
-    <a href="classes/GemPlugin/Manager.html#M000009">available (GemPlugin::Manager)</a><br />
     <a href="classes/GemPlugin/Base.html#M000003">category= (GemPlugin::Base)</a><br />
+    <a href="classes/GemPlugin/Manager.html#M000011">config (GemPlugin::Manager)</a><br />
     <a href="classes/GemPlugin/Manager.html#M000008">create (GemPlugin::Manager)</a><br />
     <a href="classes/GemPlugin/Base.html#M000002">inherited (GemPlugin::Base)</a><br />
     <a href="classes/GemPlugin/Manager.html#M000006">load (GemPlugin::Manager)</a><br />
+    <a href="classes/GemPlugin/Manager.html#M000009">loaded? (GemPlugin::Manager)</a><br />
     <a href="classes/GemPlugin/Manager.html#M000005">new (GemPlugin::Manager)</a><br />
     <a href="classes/GemPlugin/Base.html#M000004">new (GemPlugin::Base)</a><br />
     <a href="classes/GemPlugin/Manager.html#M000007">register (GemPlugin::Manager)</a><br />
+    <a href="classes/GemPlugin/Manager.html#M000010">resource (GemPlugin::Manager)</a><br />
   </div>
 </div>
 </body>

data/lib/gem_plugin.rb CHANGED

@@ -20,9 +20,9 @@ require 'rubygems'
 # gems based on what they also depend on, thus letting you load these gems when appropriate.
 #
 # Since this system was written originally for the Mongrel project that'll be the
-# best examle of using it.
+# best example of using it.
 #
-# Imagine you have a neat plugin for Mongrel called snazzy_command that give the
+# Imagine you have a neat plugin for Mongrel called snazzy_command that gives the
 # mongrel_rails a new command snazzy (like:  mongrel_rails snazzy).  You'd like
 # people to be able to grab this plugin if they want and use it, because it's snazzy.
 #
@@ -51,6 +51,9 @@ module GemPlugin
   EXCLUDE = true
   INCLUDE = false
+  class PluginNotLoaded < StandardError; end
   # This class is used by people who use gem plugins (but don't necessarily make them)
   # to add plugins to their own systems.  It provides a way to load plugins, list them,
@@ -59,10 +62,17 @@ module GemPlugin
   # It is a singleton so you use like this:  GemPlugins::Manager.instance.load
   class Manager
     include Singleton
+    attr_reader :plugins
+    attr_reader :gems
     def initialize
+      # plugins that have been loaded
       @plugins = {}
-      @loaded_gems = []
+      # keeps track of gems which have been loaded already by the manager *and*
+      # where they came from so that they can be referenced later
+      @gems = {}
     end
@@ -95,7 +105,7 @@ module GemPlugin
       gems.each do |path, gem|
         # don't load gems more than once
-        next if @loaded_gems.include? gem.name
+        next if @gems.has_key? gem.name
         check = needs.dup
         # rolls through the depends and inverts anything it finds
@@ -110,11 +120,12 @@ module GemPlugin
         # makes them false so we'll skip this gem if any excludes are found
         if (check.select {|name,test| !test}).length == 0
           # looks like no needs were set to false, so it's good
-          require_gem gem.name
-          @loaded_gems << gem.name
+          require "#{gem.name}/init"
+          @gems[gem.name] = File.join(Gem.dir, "gems", "#{gem.name}-#{gem.version}")
         end
       end
+      return nil
     end
@@ -125,7 +136,8 @@ module GemPlugin
       @plugins[category] ||= {}
       @plugins[category][name.downcase] = klass
     end
     # Resolves the given name (should include /category/name) to
     # find the plugin class and create an instance.  You can
     # pass a second hash option that is then given to the Plugin
@@ -146,15 +158,79 @@ module GemPlugin
     end
-    # Returns a map of URIs->{"name" => Plugin} that you can
-    # use to investigate available handlers.
-    def available
-      return @plugins
+    # Simply says whether the given gem has been loaded yet or not.
+    def loaded?(gem_name)
+      @gems.has_key? gem_name
     end
+    # GemPlugins can have a 'resources' directory which is packaged with them
+    # and can hold any data resources the plugin may need.  The main problem
+    # is that it's difficult to figure out where these resources are
+    # actually located on the file system.  The resource method tries to
+    # locate the real path for a given resource path.
+    #
+    # Let's say you have a 'resources/stylesheets/default.css' file in your
+    # gem distribution, then finding where this file really is involves:
+    #
+    #   Manager.instance.resource("mygem", "/stylesheets/default.css")
+    #
+    # You either get back the full path to the resource or you get a nil
+    # if it doesn't exist.
+    #
+    # If you request a path for a GemPlugin that hasn't been loaded yet
+    # then it will throw an PluginNotLoaded exception.  The gem may be
+    # present on your system in this case, but you just haven't loaded
+    # it with Manager.instance.load properly.
+    def resource(gem_name, path)
+      if not loaded? gem_name
+        raise PluginNotLoaded.new("Plugin #{gem_name} not loaded when getting resource #{path}")
+      end
+      file = File.join(@gems[gem_name], "resources", path)
+      if File.exist? file
+        return file
+      else
+        return nil
+      end
+    end
+    # While Manager.resource will find arbitrary resources, a special
+    # case is when you need to load a set of configuration defaults.
+    # GemPlugin normalizes this to be if you have a file "resources/defaults.yaml"
+    # then you'll be able to load them via Manager.config.
+    #
+    # How you use the method is you get the options the user wants set, pass
+    # them to Manager.instance.config, and what you get back is a new Hash
+    # with the user's settings overriding the defaults.
+    #
+    #   opts = Manager.instance.config "mygem", :age => 12, :max_load => .9
+    #
+    # In the above case, if defaults had {:age => 14} then it would be
+    # changed to 12.
+    #
+    # This loads the .yaml file on the fly every time, so doing it a
+    # whole lot is very stupid.  If you need to make frequent calls to
+    # this, call it once with no options (Manager.instance.config) then
+    # use the returned defaults directly from then on.
+    def config(gem_name, options={})
+      config_file = Manager.instance.resource(gem_name, "/defaults.yaml")
+      if config_file
+        begin
+          defaults = YAML.load_file(config_file)
+          return defaults.merge(options)
+        rescue
+          raise "Error loading config #{config_file} for gem #{gem_name}"
+        end
+      else
+        return options
+      end
+    end
   end
-  # This base class for plugins reallys does nothing
+  # This base class for plugins really does nothing
   # more than wire up the new class into the right category.
   # It is not thread-safe yet but will be soon.
   class Base