graph 2.5.1 → 2.5.2

data/History.txt

@@ -1,3 +1,9 @@
+=== 2.5.2 / 2013-02-07
+
+* 1 minor enhancement:
+
+  * Improved doco. I'd be at 100% if rdoc wasn't so borked. :(
+
 === 2.5.1 / 2012-06-27
 
 * 1 bug fix:

data/lib/dep_analyzer.rb

@@ -2,12 +2,23 @@ require 'graph'
 require 'set'
 require 'tsort'
 
+##
+# A simple file caching mechanism with automatic timeout.
+
 class Cache
+
+  ##
+  # Create a cache at +cache+ path for a given +timeout+ (in hours).
+
   def initialize(cache, timeout=24)
     @cache = cache
     @timeout = timeout
   end
 
+  ##
+  # Add a cached item to +id+. Value is returned either from the cache
+  # if it is new enough or by yielding.
+
   def cache(id, timeout=@timeout)
     Dir.mkdir @cache unless test ?d, @cache
     path = File.join @cache, id
@@ -28,7 +39,11 @@ class Cache
   end
 end
 
-class Set
+class Set # :nodoc:
+
+  ##
+  # A simple batch-add to Set. Bad API is bad. Thank god for open classes.
+
   def push *v
     v.each do |o|
       add(o)
@@ -36,7 +51,7 @@ class Set
   end
 end
 
-class Hash
+class Hash # :nodoc:
   include TSort
 
   alias tsort_each_node each_key
@@ -45,6 +60,10 @@ class Hash
     fetch(node).each(&block)
   end
 
+  ##
+  # Return the #inverse of a hash, allowing for multiple keys having
+  # the same values.
+
   def minvert
     r = Hash.new { |h,k| h[k] = [] }
     invert.each do |keys, val|
@@ -58,6 +77,9 @@ class Hash
     r
   end
 
+  ##
+  # Calculate the transitive closure of the hash.
+
   def transitive
     r = Hash.new { |h,k| h[k] = [] }
     each do |k,v|
@@ -66,6 +88,9 @@ class Hash
     r
   end
 
+  ##
+  # Calculates the (transitive) set of dependencies for a given key.
+
   def t(k)
     r = Set.new
     self[k].each do |v|
@@ -75,30 +100,51 @@ class Hash
   end
 end
 
+##
+# Abstract class to analyze dependencies. Intended to be subclassed
+# for a given dependency system (eg rubygems). Subclasses must
+# implement #deps, #installed, and #outdated at the very least.
+
 class DepAnalyzer < Cache
-  attr_accessor :g
+  attr_accessor :g # :nodoc:
 
-  def initialize
+  def initialize # :nodoc:
     super ".#{self.class}.cache"
     @g = Graph.new
   end
 
+  ##
+  # Allows your subclass to add extra fancy stuff to the graph when
+  # analysis is finished.
+
   def decorate
     # nothing to do by default
   end
 
+  ##
+  # Return the dependencies for a given port.
+
   def deps port
     raise NotImplementedError, "subclass responsibility"
   end
 
+  ##
+  # Return all installed items on the system.
+
   def installed
     raise NotImplementedError, "subclass responsibility"
   end
 
+  ##
+  # Return all outdated items currently installed.
+
   def outdated
     raise NotImplementedError, "subclass responsibility"
   end
 
+  ##
+  # Do the actual work.
+
   def run(argv = ARGV)
     setup
 
@@ -163,8 +209,10 @@ class DepAnalyzer < Cache
     g
   end
 
+  ##
+  # Allows subclasses to do any preparation before the run.
+
   def setup
     # nothing to do by default
   end
 end
-

data/lib/freebsd_analyzer.rb

@@ -1,5 +1,7 @@
 require 'dep_analyzer'
 
+# :stopdoc:
+
 class FreebsdAnalyzer < DepAnalyzer
   def installed
     # don't cache so it updates every delete

data/lib/graph.rb

@@ -7,7 +7,9 @@ require "enumerator"
 # dot format.
 
 class Graph
-  VERSION = "2.5.1" # :nodoc:
+  VERSION = "2.5.2" # :nodoc:
+
+  # :stopdoc:
 
   LIGHT_COLORS = %w(gray lightblue lightcyan lightgray lightpink
                     lightslategray lightsteelblue white)
@@ -79,6 +81,8 @@ class Graph
     define_method(method_name) { arrowhead name }
   end
 
+  # :startdoc:
+
   ##
   # A parent graph, if any. Only used for subgraphs.
 
@@ -167,22 +171,31 @@ class Graph
     nodes[name]
   end
 
+  ##
+  # Shortcut method for creating an arrowhead attribute.
+
   def arrowhead shape
     raise ArgumentError, "Bad arrow shape: #{shape}" unless shape =~ ARROW_RE
     Attribute.new "arrowhead = #{shape}"
   end
 
+  ##
+  # Shortcut method for creating an arrowtail attribute.
+
   def arrowtail shape
     raise ArgumentError, "Bad arrow shape: #{shape}" unless shape =~ ARROW_RE
     Attribute.new "arrowtail = #{shape}"
   end
 
+  ##
+  # Shortcut method for creating an arrowsize attribute.
+
   def arrowsize size
     Attribute.new "arrowsize = #{size}"
   end
 
   ##
-  # A convenience method to set the global node attributes to use boxes.
+  # Shortcut method to set the global node attributes to use boxes.
 
   def boxes
     node_attribs << shape("box")
@@ -203,6 +216,9 @@ class Graph
 
   attr_accessor :scheme
 
+  ##
+  # Shortcut method to create and set the graph to use a colorscheme.
+
   def colorscheme name, n = nil
     self.scheme = Attribute.new "colorscheme = #{name}#{n}"
     max = COLOR_SCHEME_MAX[name.to_sym]
@@ -265,6 +281,9 @@ class Graph
     Attribute.new "fontname = #{name.inspect}"
   end
 
+  ##
+  # Shortcut method to create a new fontsize Attribute instance.
+
   def fontsize size
     Attribute.new "fontsize = #{size}"
   end
@@ -423,15 +442,25 @@ class Graph
     end
   end
 
+  ##
+  # An attribute... that's compound. So much for self-documenting code. :(
+
   class CompoundAttribute < Attribute
-    def initialize attr = []
+    def initialize attr = [] # :nodoc:
       super
     end
 
+    ##
+    # Push an attribute into the list o' attributes.
+
     def push attrib
       attr.push attrib
     end
 
+    ##
+    # "Paint" a thingy with an attribute. Applies the attribute to the
+    # thingy. In this case, does it recursively.
+
     def << thing
       attr.each do |subattr|
         subattr << thing # allows for recursive compound attributes
@@ -439,13 +468,18 @@ class Graph
       self
     end
 
-    def to_s
+    def to_s # :nodoc:
       attr.join ", "
     end
   end
 
+  ##
+  # You know... THINGY!
+  #
+  # Has a pointer back to its graph parent and attributes.
+
   class Thingy < Struct.new :graph, :attributes
-    def initialize graph
+    def initialize graph # :nodoc:
       super graph, []
     end
 
@@ -476,7 +510,7 @@ class Graph
 
   class Edge < Thingy
 
-    attr_accessor :from, :to
+    attr_accessor :from, :to # :nodoc:
 
     ##
     # Create a new edge in +graph+ from +from+ to +to+.
@@ -505,7 +539,10 @@ class Graph
 
   class Node < Thingy
 
-    attr_accessor :name
+    attr_accessor :name # :nodoc:
+
+    ##
+    # Is this node connected to the graph?
 
     def connected?
       edges = graph.edges
@@ -513,6 +550,9 @@ class Graph
       edges.include?(name) or edges.any? { |from, deps| deps.include? name }
     end
 
+    ##
+    # Is this node an orphan? (ie, not connected?)
+
     def orphan?
       not connected?
     end
@@ -556,6 +596,7 @@ class Graph
   end
 end
 
+class Object # :nodoc:
 ##
 # Convenience method to create a new graph. Used for DSL-style:
 #
@@ -566,3 +607,4 @@ end
 def digraph name = nil, &block
   Graph.new name, &block
 end
+end

data/lib/homebrew_analyzer.rb

@@ -1,5 +1,7 @@
 require 'dep_analyzer'
 
+# :stopdoc:
+
 class HomebrewAnalyzer < DepAnalyzer
   def installed
     # don't cache so it updates every delete

data/lib/macports_analyzer.rb

@@ -1,5 +1,7 @@
 require 'dep_analyzer'
 
+# :stopdoc:
+
 class MacportsAnalyzer < DepAnalyzer
   def installed
     # don't cache so it updates every delete

data/lib/rake_analyzer.rb

@@ -1,6 +1,8 @@
 require "rubygems"
 require 'dep_analyzer'
 
+# :stopdoc:
+
 class RakeAnalyzer < DepAnalyzer
   def run
     digraph do

data/lib/rubygems/commands/graph_command.rb

@@ -1,7 +1,9 @@
 require 'rubygems/command'
 require 'rubygems_analyzer'
 
-class Gem::Commands::GraphCommand < Gem::Command
+# :stopdoc:
+
+class Gem::Commands::GraphCommand < Gem::Command # :nodoc: all
 
   def initialize
     super 'graph', 'Graph dependency relationships of installed gems'
@@ -13,6 +15,4 @@ class Gem::Commands::GraphCommand < Gem::Command
 
     say "Graph saved to:\n\tRubygemsAnalyzer.png"
   end
-
 end
-

data/lib/rubygems_analyzer.rb

@@ -1,5 +1,7 @@
 require 'dep_analyzer'
 
+# :stopdoc:
+
 $a ||= false
 
 class RubygemsAnalyzer < DepAnalyzer

data/lib/rubygems_plugin.rb

@@ -1,4 +1,3 @@
 require 'rubygems/command_manager'
 
 Gem::CommandManager.instance.register_command :graph
-

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: graph
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: 
   segments: 
   - 2
   - 5
-  - 1
-  version: 2.5.1
+  - 2
+  version: 2.5.2
 platform: ruby
 authors: 
 - Ryan Davis
@@ -36,7 +36,7 @@ cert_chain:
   FBHgymkyj/AOSqKRIpXPhjC6
   -----END CERTIFICATE-----
 
-date: 2012-06-27 00:00:00 Z
+date: 2013-02-07 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: minitest
@@ -46,11 +46,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 7
+        hash: 17
         segments: 
-        - 3
-        - 0
-        version: "3.0"
+        - 4
+        - 5
+        version: "4.5"
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -76,11 +76,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 7
+        hash: 13
         segments: 
         - 3
-        - 0
-        version: "3.0"
+        - 5
+        version: "3.5"
   type: :development
   version_requirements: *id003
 description: |-
@@ -164,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: seattlerb
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Graph is a type of hash that outputs in graphviz's dot format