gviz 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9143e573c91a80a888a66007403500d36f5406dc
-  data.tar.gz: d8512ead6616fd21edd84d61730ec0c70af97682
+  metadata.gz: 65adf31d163c16b8127354d5529a1dada514fd8d
+  data.tar.gz: 0d5baf89bafd6865fd39d3904bcf3e1d528e57c4
 SHA512:
-  metadata.gz: 8c9af9c343b65c8d03669d4b604934fcbb3c0e65a88f2da3701be27f87acc2a199bcdb83237cdb6492736c419661438d5157a50e63d9349d6ec81622102e9586
-  data.tar.gz: cf4ee9d30253268b5c6115491ec7f2f136f89f5d82667cfbd41e69b3d06ba13da4e7c8ecbd5547b32767142cbb05365ed1d4e6af4b950da0445b27bf338b17fb
+  metadata.gz: 4a79d270bc63ea086223a6a8769a2e267f89d32c51528c6aced6a9c8fa6e7c528653b82fd7c55595a826dafa3a9bf0b02100f0663b716a80f6238a2c6900e6cb
+  data.tar.gz: 2a1dabc7ba08e9d49ff5e919b3d82f4a2dc0ca097b31e8685dda0bb1dbae2a21765ea18b9d085085a35aa56222d776cac22e2c938742fdbd7682f890c7779a40

data/README.md

@@ -48,7 +48,7 @@ Add some attributes to the graph, nodes, edges.
     ## add bgcolor to a graph(global method)
     require "gviz"
     
-    Graph.graph do
+    Graph do
       route :main => [:init, :parse, :cleanup, :printf]
       route :init => :make, :parse => :execute
       route :execute => [:make, :compare, :printf]
@@ -74,7 +74,7 @@ Modify some.
     ## define subgraph(subgraph method) 
     require "gviz"
     
-    Graph.graph do
+    Graph do
       route :main => [:init, :parse, :cleanup, :printf]
       route :init => :make, :parse => :execute
       route :execute => [:make, :compare, :printf]
@@ -102,6 +102,27 @@ This outputs below.
 
 ![sample3](http://github.com/melborne/Gviz/raw/master/examples/sample3.png)
 
+## Use for Drawing
+
+Gviz helps you easily to draw shapes on an exact position using shape-named methods.
+
+    require "gviz"
+
+    Graph do
+      line :a, from:[-100,0], to:[100,0]
+      line :b, from:[0,-100], to:[0,100]
+      circle :c
+      rect :d, x:50, y:50, fillcolor:"green", label:"Rect"
+      triangle :e, x:50, y:-50, fillcolor:"cyan"
+      diamond :f, x:-50, y:50, fillcolor:"magenta"
+      egg :g, x:-50, y:-50, fillcolor:"yellow", label:"Egg"
+
+      save :draw
+    end
+
+This outputs below(consider a scale if save to output formats).
+
+![sample4](http://github.com/melborne/Gviz/raw/drawing/examples/sample4.png)
 
 Another examples are at `examples` directory
 

data/gviz.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
-  gem.required_ruby_version = '>=1.9.3'
+  gem.required_ruby_version = '>=2.0.0'
   gem.add_development_dependency 'rspec'
   gem.add_dependency 'thor'
 end

data/lib/gviz.rb

@@ -1,5 +1,9 @@
 # encoding: UTF-8
+require "gviz/graphviz_attrs"
+require "gviz/draw"
+
 class Gviz
+  include Draw
 end
 
 # +Graph+ fuction is a shortcut method of `Gviz#graph`.
@@ -7,6 +11,6 @@ def Graph(name=:G, type=:digraph, &blk)
   Gviz.new(name, type).graph(&blk)
 end
 
-%w(core node edge version system_extension graphviz_attrs command).each do |lib|
-  require_relative 'gviz/' + lib
+%w(core node edge version system_extension command).each do |lib|
+  require 'gviz/' + lib
 end

data/lib/gviz/draw.rb

@@ -0,0 +1,64 @@
+# Draw module includes a set of methods for specific shapes.
+# Each methods defines with shape name and its positions.
+module Draw
+  # Define a node with ellipse shape.
+  def ellipse(id, x:0, y:0, **attrs)
+    draw_init
+    attrs = {label:"", color:"black", fillcolor:"#FFFFFF00"}.merge(attrs)
+    attrs.update(shape:"ellipse", pos:"#{x},#{y}!")
+    node(id, attrs)
+  end
+
+  # Define a node with circle shape.
+  def circle(id, x:0, y:0, r:0.5, **attrs)
+    attrs.update(width:r*2, height:r*2)
+    ellipse(id, x:x, y:y, **attrs)
+  end
+
+  # Define a node with square shape.
+  def square(id, x:0, y:0, **attrs)
+    w, h = %i(width height).map { |at| attrs.delete at }
+    size = w || h || 1
+    attrs.update(width:size, height:size)
+    rect(id, x:x, y:y, **attrs)
+  end
+
+  # Define a node with point shape.
+  def point(id, x:0, y:0, **attrs)
+    draw_init
+    attrs.update(shape:"point", pos:"#{x},#{y}!")
+    node(id, attrs)
+  end
+
+  # Define a line with an edge and two point nodes.
+  def line(id, from:[0,0], **attrs)
+    draw_init
+    unless to = attrs.delete(:to)
+      raise ArgumentError, "Argument 'to' is required"
+    end
+    n1_id, n2_id = [1, 2].map { |i| "#{id}#{i}".to_id }
+    point(n1_id, x:from[0], y:from[1],
+          color:"#FFFFFF00", fillcolor:"#FFFFFF00")
+    point(n2_id, x:to[0], y:to[1],
+          color:"#FFFFFF00", fillcolor:"#FFFFFF00")
+    attrs.update(arrowhead:"none")
+    edge(:"#{n1_id}_#{n2_id}", attrs)
+  end
+
+  # Define methods for other shapes
+  Gviz::SHAPES.each do |shape|
+    next if %w(ellipse circle square point plaintext none).include?(shape)
+    define_method(shape) do |id, x:0, y:0, **attrs|
+      draw_init
+      attrs = {label:"", color:"black", fillcolor:"#FFFFFF00"}.merge(attrs)
+      attrs.update(shape:shape, pos:"#{x},#{y}!")
+      node(id, attrs)
+    end
+  end
+
+  private
+  def draw_init
+    global(layout:"neato")
+    nodes(style:"filled")
+  end
+end

data/lib/gviz/version.rb

@@ -1,3 +1,3 @@
 class Gviz
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/gviz_draw_spec.rb

@@ -0,0 +1,157 @@
+require "spec_helper"
+
+describe Gviz do
+  let(:gv) { Gviz.new }
+
+  describe "#circle" do
+    let(:defo_attrs) { {shape:"ellipse", pos:"0,0!", width:1, height:1, label:"", color:"black", fillcolor:"#FFFFFF00"} }
+    context 'without attributes' do
+      it 'returns a circle node with default attributes' do
+        circle = gv.circle(:a)
+        expect(circle).to be_a_instance_of Gviz::Node
+        expect(circle.id).to eq :a
+        expect(circle.attrs).to eq defo_attrs
+      end
+    end
+
+    context 'with some attributes' do
+      it 'returns a circle node with attributes' do
+        circle = gv.circle(:a, x:10, y:-20, r:1, fillcolor:"green", label:"a")
+        attrs = defo_attrs.merge(pos:"10,-20!", width:2, height:2, label:"a", fillcolor:"green")
+        expect(circle.attrs).to eq attrs
+      end
+
+      it 'overwrites shape and pos attrs if they are passed' do
+        circle = gv.circle(:a, shape:"box", pos:"10,10!")
+        expect(circle.attrs).to eq defo_attrs
+      end
+    end
+  end
+
+  describe "#ellipse" do
+    let(:defo_attrs) { {shape:"ellipse", pos:"0,0!", label:"", color:"black", fillcolor:"#FFFFFF00"} }
+    context 'without attributes' do
+      it 'returns a ellipse node with default attributes' do
+        ellipse = gv.ellipse(:a)
+        expect(ellipse).to be_a_instance_of Gviz::Node
+        expect(ellipse.id).to eq :a
+        expect(ellipse.attrs).to eq defo_attrs
+      end
+    end
+
+    context 'with some attributes' do
+      it 'returns a ellipse node with attributes' do
+        ellipse = gv.ellipse(:a, x:10, y:-20, fillcolor:"green", label:"a", width:2, height:4)
+        attrs = defo_attrs.merge(pos:"10,-20!", width:2, height:4, label:"a", fillcolor:"green")
+        expect(ellipse.attrs).to eq attrs
+      end
+
+      it 'overwrites shape and pos attrs if they are passed' do
+        ellipse = gv.ellipse(:a, shape:"box", pos:"10,10!")
+        expect(ellipse.attrs).to eq defo_attrs
+      end
+    end
+  end
+
+  describe "#rect" do
+    let(:defo_attrs) { {shape:"rect", pos:"0,0!", label:"", color:"black", fillcolor:"#FFFFFF00"} }
+    context 'without attributes' do
+      it 'returns a rect node with default attributes' do
+        rect = gv.rect(:a)
+        expect(rect).to be_a_instance_of Gviz::Node
+        expect(rect.id).to eq :a
+        expect(rect.attrs).to eq defo_attrs
+      end
+    end
+
+    context 'with some attributes' do
+      it 'returns a rect node with attributes' do
+        rect = gv.rect(:a, x:10, y:-20, fillcolor:"green", label:"a", width:2, height:4)
+        attrs = defo_attrs.merge(pos:"10,-20!", width:2, height:4, label:"a", fillcolor:"green")
+        expect(rect.attrs).to eq attrs
+      end
+    end
+  end
+
+  describe "#square" do
+    let(:defo_attrs) { {shape:"rect", pos:"0,0!", width:1, height:1, label:"", color:"black", fillcolor:"#FFFFFF00"} }
+    context 'without attributes' do
+      it 'returns a square node with default attributes' do
+        square = gv.square(:a)
+        expect(square.attrs).to eq defo_attrs
+      end
+    end
+
+    context 'with some attributes' do
+      it 'returns a square node with attributes' do
+        square = gv.square(:a, x:10, y:-20, fillcolor:"green", label:"a", width:2)
+        attrs = defo_attrs.merge(pos:"10,-20!", width:2, height:2, label:"a", fillcolor:"green")
+        expect(square.attrs).to eq attrs
+      end
+    end
+  end
+
+  describe "#point" do
+    let(:defo_attrs) { {shape:"point", pos:"0,0!"} }
+    context 'without attributes' do
+      it 'returns a point node with default attributes' do
+        point = gv.point(:a)
+        expect(point.attrs).to eq defo_attrs
+      end
+    end
+
+    context 'with some attributes' do
+      it 'returns a point node with attributes' do
+        point = gv.point(:a, x:10, y:-20, color:"green", width:0.1)
+        attrs = defo_attrs.merge(pos:"10,-20!", width:0.1, color:"green")
+        expect(point.attrs).to eq attrs
+      end
+    end
+  end
+
+  describe "#line" do
+    it 'generate an edge between two points' do
+      line = gv.line(:a, from:[50,50], to:[100,100], color:"green")
+      expect(gv.nodeset.size).to eq 2
+      expect(gv.edgeset.size).to eq 1
+      n1, n2 = gv.nodeset
+      expect(n1.attrs).to eq(shape:"point", pos:"50,50!", color:"#FFFFFF00", fillcolor:"#FFFFFF00")
+      expect(n2.attrs).to eq(shape:"point", pos:"100,100!", color:"#FFFFFF00", fillcolor:"#FFFFFF00")
+      expect(line.id).to eq :"#{n1.id}_#{n2.id}"
+      expect(line.attrs).to eq(arrowhead:"none", color:"green")
+    end
+
+    context 'without from or to arguments' do
+      it 'returns [0,0] without "from" argument' do
+        line = gv.line(:a, to:[100,100])
+        n1, n2 = gv.nodeset
+        expect(n1.attrs).to eq(shape:"point", pos:"0,0!", color:"#FFFFFF00", fillcolor:"#FFFFFF00")
+        expect(n2.attrs).to eq(shape:"point", pos:"100,100!", color:"#FFFFFF00", fillcolor:"#FFFFFF00")
+      end
+
+      it 'raise an ArgumentError without "to" argument' do
+        expect{ gv.line(:a, from:[0,0]) }.to raise_error ArgumentError
+      end
+    end
+  end
+
+  describe "shapes" do
+    let(:defo_attrs) { {pos:"0,0!", label:"", color:"black", fillcolor:"#FFFFFF00"} }
+    context 'without attributes' do
+      it 'returns a egg node with default attributes' do
+        shape = gv.egg(:a)
+        expect(shape).to be_a_instance_of Gviz::Node
+        expect(shape.id).to eq :a
+        expect(shape.attrs).to eq defo_attrs.update(shape:"egg")
+      end
+    end
+
+    context 'with some attributes' do
+      it 'returns a egg node with attributes' do
+        shape = gv.egg(:a, x:10, y:-20, fillcolor:"green", label:"a", width:2, height:4)
+        attrs = defo_attrs.merge(pos:"10,-20!", width:2, height:4, label:"a", fillcolor:"green")
+        expect(shape.attrs).to eq attrs.update(shape:"egg")
+      end
+    end
+  end
+end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: gviz
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - kyoendo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-08 00:00:00.000000000 Z
+date: 2014-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby's interface of graphviz
@@ -46,7 +46,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -58,11 +58,13 @@ files:
 - examples/sample1.png
 - examples/sample2.png
 - examples/sample3.png
+- examples/sample4.png
 - examples/shapes.rb
 - gviz.gemspec
 - lib/gviz.rb
 - lib/gviz/command.rb
 - lib/gviz/core.rb
+- lib/gviz/draw.rb
 - lib/gviz/edge.rb
 - lib/gviz/graphviz_attrs.rb
 - lib/gviz/node.rb
@@ -70,6 +72,7 @@ files:
 - lib/gviz/version.rb
 - spec/fixtures/graph.ru
 - spec/gviz_command_spec.rb
+- spec/gviz_draw_spec.rb
 - spec/gviz_edge_spec.rb
 - spec/gviz_node_spec.rb
 - spec/gviz_spec.rb
@@ -84,23 +87,24 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Ruby's interface of graphviz. It generate a dot file with simple ruby's syntax.
 test_files:
 - spec/fixtures/graph.ru
 - spec/gviz_command_spec.rb
+- spec/gviz_draw_spec.rb
 - spec/gviz_edge_spec.rb
 - spec/gviz_node_spec.rb
 - spec/gviz_spec.rb