gviz 0.0.7 → 0.0.8

data/lib/gviz/core.rb

@@ -47,15 +47,33 @@ class Gviz
   # When `id` includes '*'(asterisk), multiple edges are updated.
   #
   #   add(:a => [:b, :c])
-  #   edge(:a_*, arrowhead:'none')
+  #   edge('a_*', arrowhead:'none')
   #
   # is equivalent to:
   #
   #   edge(:a_b, arrowhead:'none')
   #   edge(:a_c, arrowhead:'none')
+  #
+  # You can draw two or more edges between a pair of nodes,
+  # by adding a identifier with a underscore after the edge id.
+  #
+  #   gv.edge(:a_b)
+  #   gv.edge(:a_b_1)
+  #
+  # This create two nodes between a, b nodes.
+  #
+  # You can define a endpoint to a node, by adding a point identifier
+  # with a colon after the each node. You must specify the identifiers
+  # it the label of the corresponding nodes.
+  #
+  #   gv.edge("a:x_b:y")
+  #   gv.node(:a, label:"<x> 1 | 2 | 3")
+  #   gv.node(:b, label:"4 | 5 |<y> 6")
+  #
+  # The edge 'a-b' joins 1 of the node 'a' with 6 of the node 'b'.
   def edge(id, attrs={})
     if md = id.match(/\*/)
-      return multiple_edge(md, attrs)
+      return multi_edge(md, attrs)
     end
 
     Edge[id, attrs].tap do |edge|
@@ -227,8 +245,8 @@ class Gviz
     join ? '[' + arr.join(',') + ']' : arr
   end
 
-  def multiple_edge(md, attrs)
-    st = [md.pre_match, md.post_match].detect { |e| !e.empty? }.delete('_')
+  def multi_edge(md, attrs)
+    st = (md.pre_match + md.post_match).delete('_')
     edges = edgeset.select { |edge| edge.nodes.include? st.intern }
     edges.each { |eg| edge eg.id, attrs }
   end

data/lib/gviz/system_extension.rb

@@ -1,4 +1,13 @@
 class Numeric
+  # Return a normalized value of the receiver between 0.0 to 1.0.
+  #
+  #   5.norm(0..10).should eql 0.5
+  #   7.norm(5..10).should eql 0.4
+  #
+  # When the target range specified, the result is adjusted to the range.
+  #
+  #   5.norm(0..10, 0..20).should eql 10.0
+  #
   def norm(range, tgr=0.0..1.0)
     unit = (self - range.min) / (range.max - range.min).to_f
     unit * (tgr.max - tgr.min) + tgr.min
@@ -6,6 +15,8 @@ class Numeric
 end
 
 class Object
+  # Returns a uniq number of the object in symbol form.
+  # This is used for creating ids of node or edge.
   def to_id
     to_s.hash.to_s.intern
   end

data/lib/gviz/version.rb

@@ -1,3 +1,3 @@
 class Gviz
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gviz
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-16 00:00:00.000000000 Z
+date: 2012-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec