gviz 0.0.6 → 0.0.7

data/lib/gviz.rb

@@ -2,6 +2,7 @@
 class Gviz
 end
 
+# +Graph+ fuction is a shortcut method of `Gviz#graph`.
 def Graph(name=:G, type=:digraph, &blk)
   Gviz.new(name, type).graph(&blk)
 end

data/lib/gviz/core.rb

@@ -11,16 +11,22 @@ class Gviz
     @ranks = []
   end
   
+  # Access to all defined node objects.
   def nodeset
     @nodes.values
   end
 
+  # Access to all defined edge objects.
   def edgeset
     @edges.values
   end
 
+  # Define a node or update a node attributes.
+  # The first argument is `id` of the node which must a symbol form.
+  #
+  #   node(:a, color:'red', shape:'circle')
+  #
   def node(id, attrs={})
-    raise ArgumentError, '`id` must a symbol' unless id.is_a?(Symbol)
     Node[id, attrs].tap do |node|
       if exist = @nodes[node.id]
         exist.attrs.update(node.attrs)
@@ -30,11 +36,29 @@ class Gviz
     end
   end
 
+  # Difine a edge or update a edge attributes.
+  # The first argument is `id` of the edge, which is a symbol or string constructed
+  # from two nodes joined with '_'(underscore).
+  #
+  #   edge(:a_b, color:'red')
+  #
+  # The corresponding nodes will be defined if these are not exist.
+  #
+  # When `id` includes '*'(asterisk), multiple edges are updated.
+  #
+  #   add(:a => [:b, :c])
+  #   edge(:a_*, arrowhead:'none')
+  #
+  # is equivalent to:
+  #
+  #   edge(:a_b, arrowhead:'none')
+  #   edge(:a_c, arrowhead:'none')
   def edge(id, attrs={})
-    unless id.match(/._./)
-      raise ArgumentError, '`id` must a symbol in which node names joined with "_"'
+    if md = id.match(/\*/)
+      return multiple_edge(md, attrs)
     end
-    Edge[id.intern, attrs].tap do |edge|
+
+    Edge[id, attrs].tap do |edge|
       if exist = @edges[id.intern]
         exist.attrs.update(edge.attrs)
       else
@@ -44,18 +68,28 @@ class Gviz
     end
   end
 
+  # Define all nodes attributes.
   def nodes(attrs)
     @gnode_attrs.update(attrs)
   end
 
+  # Define all edges attributes.
   def edges(attrs)
     @gedge_attrs.update(attrs)
   end
 
+  # Define graph global attributes.
   def global(attrs)
     @graph_attrs.update(attrs)
   end
 
+  # Define subgraph.
+  #
+  #   subgraph do
+  #     global label:sub1
+  #     add :a => :b
+  #   end
+  #
   def subgraph(&blk)
     Gviz.new("cluster#{subgraphs.size}", :subgraph).tap do |graph|
       subgraphs << graph
@@ -63,18 +97,52 @@ class Gviz
     end
   end
   
+  # +graph+ is a shorcut method.
+  #
+  #   gv = Gviz.new
+  #   gv.graph do
+  #     add :a => :b
+  #     node :a, color:'red'
+  #   end
+  #
+  # is equivalent to:
+  #
+  #   gv = Gviz.new
+  #   gv.add :a => :b
+  #   gv.node :a, color:'red'
+  #
   def graph(&blk)
     instance_eval(&blk)
     self
   end
 
+  # Define nodes or routes(node-edge combinaitons).
+  # When an argument is a symbol, a node is defined.
+  #
+  #   add :a, :b
+  #
+  # is equivalent to:
+  #
+  #   node :a
+  #   node :b
+  #
+  # When an argument is a hash, edges are defined.
+  #
+  #   add :a => [:b, :c], :c => :d
+  #
+  # is equivalent to:
+  #
+  #   edge :a_b
+  #   edge :a_c
+  #   edge :c_d
+  #
   def add(*nodes_or_routes)
     nodes_or_routes.each do |unit|
       case unit
       when Hash
         unit.each do |sts, eds|
           Array(sts).product(Array(eds))
-                    .each { |st, ed| edge([st,ed].join('_').intern) }
+                    .each { |st, ed| edge "#{st}_#{ed}" }
         end
       when Symbol
         node(unit)
@@ -86,6 +154,11 @@ class Gviz
   end
   alias :route :add
 
+  # Define a rank to nodes.
+  # :same, :min, :max, :source and :sink are acceptable types.
+  #
+  #   rank(:same, :a, :b)
+  #
   def rank(type, *nodes)
     types = [:same, :min, :max, :source, :sink]
     unless types.include?(type)
@@ -133,6 +206,8 @@ class Gviz
     result.join("\n")
   end
 
+  # Create a graphviz dot file. When an image type is specified,
+  # the image is also created.
   def save(path, type=nil)
     File.open("#{path}.dot", "w") { |f| f.puts self }
     system "dot -T#{type} #{path}.dot -o #{path}.#{type}" if type
@@ -151,4 +226,10 @@ class Gviz
     arr = attrs.map { |k, v| %(#{k}="#{v}").gsub("\n", "\\n") }
     join ? '[' + arr.join(',') + ']' : arr
   end
+
+  def multiple_edge(md, attrs)
+    st = [md.pre_match, md.post_match].detect { |e| !e.empty? }.delete('_')
+    edges = edgeset.select { |edge| edge.nodes.include? st.intern }
+    edges.each { |eg| edge eg.id, attrs }
+  end
 end

data/lib/gviz/edge.rb

@@ -1,7 +1,7 @@
 class Gviz::Edge < Struct.new(:id, :attrs)
   attr_reader :st, :ed, :seq, :st_port, :ed_port
   def initialize(id, attrs={})
-    raise ArgumentError, "`attrs` must a hash" unless attrs.is_a?(Hash)
+    raise ArgumentError, "edge `attrs` must a hash" unless attrs.is_a?(Hash)
     id, @st, @ed, @seq, @st_port, @ed_port = parse_id(id)
     super(id, attrs)
   end
@@ -18,11 +18,16 @@ class Gviz::Edge < Struct.new(:id, :attrs)
 
   private
   def parse_id(id)
-    raise ArgumentError, "id must not include other than words or a colon" if id.match(/[^\w:]/)
+    unless id.match(/._./)
+      raise ArgumentError, 'edge `id` must a symbol in which node names joined with "_"'
+    end
+    if id.match(/[^\d\w:-]/)
+      raise ArgumentError, "edge `id` must not include other than ASCII words, colon or minus"
+    end
     st, ed, seq = "#{id}".split('_')
     st, st_port = st.split(':').map(&:intern)
     ed, ed_port = ed.split(':').map(&:intern)
-    id = (seq ? [st, ed, seq] : [st, ed]).join('_').intern
+    id = seq ? :"#{st}_#{ed}_#{seq}" : :"#{st}_#{ed}"
     [id, st, ed, seq.to_i, st_port, ed_port]
   end
 end

data/lib/gviz/node.rb

@@ -1,6 +1,7 @@
 class Gviz::Node < Struct.new(:id, :attrs)
   def initialize(id, attrs={})
-    raise ArgumentError, "`id` must not include underscores" if id.match(/_/)
+    raise ArgumentError, 'node `id` must a symbol' unless id.is_a?(Symbol)
+    raise ArgumentError, "node `id` must not include underscores" if id.match(/_/)
     super
   end
 

data/lib/gviz/system_extension.rb

@@ -4,3 +4,9 @@ class Numeric
     unit * (tgr.max - tgr.min) + tgr.min
   end
 end
+
+class Object
+  def to_id
+    to_s.hash.to_s.intern
+  end
+end

data/lib/gviz/version.rb

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

data/spec/gviz_edge_spec.rb

@@ -58,10 +58,30 @@ describe Gviz::Edge do
       its(:attrs) { should eq opts }
     end
 
+    context "when a number string passed" do
+      subject { Gviz::Edge.new('1234_1235') }
+      its(:id) { should be :'1234_1235' }
+      its(:st) { should be :'1234' }
+      its(:ed) { should be :'1235' }
+    end
+
+    context "when a string with minus sign" do
+      subject { Gviz::Edge.new('-123_124') }
+      its(:id) { should be :'-123_124' }
+      its(:st) { should be :'-123' }
+      its(:ed) { should be :'124' }
+    end
+
     context "when a string with other than words or colon passed" do
       it "raise an error" do
         ->{ Gviz::Edge.new('a!b_c') }.should raise_error(ArgumentError)
       end
     end
+
+    context "when a symbol without underscore passed" do
+      it "raise an error" do
+        ->{ Gviz::Edge.new(:abc) }.should raise_error(ArgumentError)
+      end
+    end
   end
 end

data/spec/gviz_node_spec.rb

@@ -10,13 +10,6 @@ describe Gviz::Node do
       its(:attrs) { should be_empty }
     end
     
-    context "when only a string passed" do
-      subject { Gviz::Node.new('a') }
-      it { should be_a_instance_of Gviz::Node }
-      its(:id) { should eq 'a' }
-      its(:attrs) { should be_empty }
-    end
-
     context "when a symbol and hash options passed" do
       opts = { shape:'circle', style:'filled' }
       subject { Gviz::Node.new(:a, opts) }
@@ -29,6 +22,12 @@ describe Gviz::Node do
         ->{ Gviz::Node.new(:a_b) }.should raise_error(ArgumentError)
       end
     end
+
+    context "when a string passed" do
+      it "raise an error" do
+        ->{ Gviz::Node.new('a') }.should raise_error(ArgumentError)
+      end
+    end
   end
 
   describe "#to_s" do

data/spec/gviz_spec.rb

@@ -36,6 +36,17 @@ describe Gviz do
       it { should be { color:'blue', label:'hello', shape:'box' } }
     end
 
+    context "update node attrs which node is created by add method" do
+      before do
+        name = 'hello'
+        gv.add(:a => name.to_id)
+        gv.node(name.to_id, color:'red')
+        gv.nodeset.map(&:id)
+      end
+      subject { gv.nodeset.map(&:attrs) }
+      it { should eql [{}, {color:'red'}] }
+    end
+
     context "when pass a string" do
       it "raise an error" do
         ->{ gv.node('a') }.should raise_error(ArgumentError)
@@ -74,6 +85,25 @@ describe Gviz do
       subject { gv.edgeset }
       its(:size) { should eql 2 }
     end
+
+    context "when a string with *(asterisk) passed" do
+      before do
+        gv.add(:a => [:b, :c], :c => :d)
+        gv.edge('a_*', color:'red')
+      end
+      subject { gv.edgeset.map(&:attrs) }
+      it { should eql [{ color:'red' }, { color:'red' }, {}] }
+    end
+
+    context "when a string with *(asterisk) passed 2" do
+      before do
+        gv.add(:main => [:a, :b], :main2 => :sub)
+        gv.add(:main => :sub)
+        gv.edge('*_main', color:'red')
+      end
+      subject { gv.edgeset.map(&:attrs) }
+      it { should eql [{color:'red'}, {color:'red'}, {}, {color:'red'}] }
+    end
   end
 
   describe "#add" do

data/spec/system_extension_spec.rb

@@ -1,33 +1,59 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+# encoding: UTF-8
+require_relative 'spec_helper'
 
 describe Numeric do
-  context "norm" do
-    it "normalize a integer into range of 0.0-1.0" do
-      5.norm(0..10).should eql 0.5
-      2.norm(0..10).should eql 0.2
-      0.norm(0..10).should eql 0.0
-      10.norm(0..10).should eql 1.0
-      5.norm(5..10).should eql 0.0
-      10.norm(5..10).should eql 1.0
-      7.norm(5..10).should eql 0.4
+  describe "#norm" do
+    context "normalize into 0.0-1.0" do
+      it "works for integer" do
+        5.norm(0..10).should eql 0.5
+        2.norm(0..10).should eql 0.2
+        0.norm(0..10).should eql 0.0
+        10.norm(0..10).should eql 1.0
+        5.norm(5..10).should eql 0.0
+        10.norm(5..10).should eql 1.0
+        7.norm(5..10).should eql 0.4
+      end
+
+      it "works for float" do
+        2.5.norm(0..10).should eql 0.25
+        7.4.norm(0..10).should eql 0.74
+        0.0.norm(0..10).should eql 0.0
+        10.0.norm(0..10).should eql 1.0
+        15.0.norm(10..20).should eql 0.5
+      end
     end
-    
-    it "normalize a float into range of 0.0-1.0" do
-      2.5.norm(0..10).should eql 0.25
-      7.4.norm(0..10).should eql 0.74
-      0.0.norm(0..10).should eql 0.0
-      10.0.norm(0..10).should eql 1.0
-      15.0.norm(10..20).should eql 0.5
+
+    context "normalize into other than 0.0-1.0" do
+      it "works for integer" do
+        5.norm(0..10, 0..20).should eql 10.0
+        2.norm(0..10, 10..20).should eql 12.0
+        0.norm(0..10, 10..15).should eql 10.0
+        10.norm(0..10, 10..15).should eql 15.0
+        5.norm(0..10, 10..15).should eql 12.5
+      end
+
+      it "works for float" do
+        2.5.norm(0..10, 0..5).should eql 1.25
+        2.5.norm(0..10, 5..10).should eql 6.25
+      end
     end
+  end
+end
+
+describe Object do
+  describe "#to_id" do
+    describe "return a uniq symbol for node id" do
+      context "for integer" do
+        subject { 10.to_id }
+        it { should be_a_kind_of Symbol }
+        it { should be 10.to_id }
+      end
 
-    it "can take target range other than 0.0-1.0" do
-      5.norm(0..10, 0..20).should eql 10.0
-      2.norm(0..10, 10..20).should eql 12.0
-      0.norm(0..10, 10..15).should eql 10.0
-      10.norm(0..10, 10..15).should eql 15.0
-      5.norm(0..10, 10..15).should eql 12.5
-      2.5.norm(0..10, 0..5).should eql 1.25
-      2.5.norm(0..10, 5..10).should eql 6.25
+      context "for unicode" do
+        subject { "グラフ".to_id }
+        it { should be_a_kind_of Symbol }
+        it { should be "グラフ".to_id }
+      end
     end
   end
-end
+end

metadata

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