gviz 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6238dfcf0f09e9b3afd83cb9a4815af62b517f2
-  data.tar.gz: cc3d2435e20ad0a9b3c83f73e87ba06bb096e4d8
+  metadata.gz: 9143e573c91a80a888a66007403500d36f5406dc
+  data.tar.gz: d8512ead6616fd21edd84d61730ec0c70af97682
 SHA512:
-  metadata.gz: 05045c7c238b0687ec198fa275880abd944eb6311c78dff31a49e822ccf97f6a360680e1b84d479574e746582816d88d0a829e24fbc5758e84f4cd624439d9cc
-  data.tar.gz: 5b84db6cbc2b4baf86d005726490ded619dd0fab929e7334ad791d873bad875e5202aeaf88198293787b45ef972d44578114e100622b61d12ac217022432f0dd
+  metadata.gz: 8c9af9c343b65c8d03669d4b604934fcbb3c0e65a88f2da3701be27f87acc2a199bcdb83237cdb6492736c419661438d5157a50e63d9349d6ec81622102e9586
+  data.tar.gz: cf4ee9d30253268b5c6115491ec7f2f136f89f5d82667cfbd41e69b3d06ba13da4e7c8ecbd5547b32767142cbb05365ed1d4e6af4b950da0445b27bf338b17fb

data/README.md

@@ -118,14 +118,12 @@ Example of graph.ru:
 
 Usage:
 
-      gviz [options] <graph filename>
+      gviz build [FILE] [options]
 
 where [options] are:
 
     --name,   -n :   Graph name (default: G)
     --type,   -t :   Graph type (default: digraph)
-    --version, -v:   Print version and exit
-    --help,    -h:   Show this message
 
 ## Contributing
 

data/bin/gviz

@@ -1,91 +1,4 @@
 #!/usr/bin/env ruby
 require "gviz"
-require "trollop"
 
-class OptionParser
-  class << self
-    def parse!
-      opts = build_opts
-      if man = opts[:man]
-        print_manual(man)
-      else
-        draw_graph(opts)
-      end
-    end
-
-    def build_opts
-      Trollop::options do
-        version "Gviz #{Gviz::VERSION} (c) 2012 kyoendo"
-        banner ~<<-EOS
-          Gviz is a tool for generating graphviz dot data with simple Ruby's syntax.
-          It works with a graph spec file in which a graph spec describes with 
-          several gviz commands. If 'graph.ru' file exist on a directory of the 
-          execution, it will be automatically loaded as a graph spec file.
-
-          Example of graph.ru:
-
-                route :main => [:init, :parse, :cleanup, :printf]
-                route :init => :make, :parse => :execute
-                route :execute => [:make, :compare, :printf]
-
-                save(:sample, :png)
-
-          Usage:
-
-                gviz [options] <graph filename>
-
-          where [options] are:
-          EOS
-
-        opt :name, "Graph name", :default => 'G'
-        opt :type, "Graph type", :default => 'digraph'
-        opt :file, "Graph file", :default => 'graph.ru'
-        opt :man, "Show Graphviz attributes (ex. node, shapes, color_names)", :type => :string
-      end
-    end
-
-    def draw_graph(opts)
-      Graph(opts[:name], opts[:type]) { instance_eval ::File.read(opts[:file]) }
-    rescue Errno::ENOENT
-      abort "graph file `#{opts[:file]}` not found"
-    end
-
-    def print_manual(man)
-      attrs = %w(graph node edge subgraph cluster)
-      consts = %w(color_names color_schemes full_color_names
-                  full_color_schemes arrows shapes layouts
-                  output_formats svg_color_names dark_colors)
-      man_man = ~<<-EOS
-        \e[35m--man(-m) accepts any of them:\e[0m
-          graph, node, edge, subgraph, cluster,
-          arrows, shapes, layouts, output_formats
-          color_names, color_schemes,
-          full_color_names, full_color_schemes,
-          svg_color_names, dark_colors
-        EOS
-
-      res =
-        case man.downcase
-        when 'man'
-          man_man
-        when *attrs
-          format_attrs(man)
-        when *consts
-          ["\e[35m#{man.capitalize.gsub('_', ' ')}:\e[0m"] +
-          Gviz.const_get(man.upcase).join_by(", ", 70).map { |l| "  " + l }
-        else
-          "Error: unknown subcommand '#{man}' for --man\n" + man_man
-        end
-      puts res
-    end
-
-    def format_attrs(target)
-      header = ["\e[35m#{target.capitalize} attributes (type|default|minimum|notes):\e[0m"]
-      attrs = Gviz.ATTR(target).map { |attr, desc| "  #{attr} (#{desc.join(" | ")})" }
-      [header] + attrs
-    end
-  end
-  private_class_method :build_opts, :draw_graph, :print_manual, :format_attrs
-end
-
-OptionParser.parse!
+Gviz::Command.start(ARGV)

data/gviz.gemspec

@@ -18,5 +18,5 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.required_ruby_version = '>=1.9.3'
   gem.add_development_dependency 'rspec'
-  gem.add_dependency 'trollop'
+  gem.add_dependency 'thor'
 end

data/lib/gviz.rb

@@ -7,6 +7,6 @@ def Graph(name=:G, type=:digraph, &blk)
   Gviz.new(name, type).graph(&blk)
 end
 
-%w(core node edge version system_extension graphviz_attrs).each do |lib|
+%w(core node edge version system_extension graphviz_attrs command).each do |lib|
   require_relative 'gviz/' + lib
 end

data/lib/gviz/command.rb

@@ -0,0 +1,76 @@
+require "thor"
+
+class Gviz::Command < Thor
+  
+  desc "build [FILE]", "Build a graphviz dot data based on a file"
+  option :name, aliases:"-n", default:"G"
+  option :type, aliases:"-t", default:"digraph"
+  def build(file='graph.ru')
+    Graph(options[:name], options[:type]) { instance_eval ::File.read(file) }
+  rescue Errno::ENOENT
+    abort "graph file `#{file}` not found"
+  end
+
+  desc "version", "Show Gviz version"
+  def version
+    puts "Gviz #{Gviz::VERSION} (c) 2012-2013 kyoendo"
+  end
+  map "-v" => :version
+
+  desc "banner", "Describe Gviz usage", hide:true
+  def banner
+    banner = ~<<-EOS
+    Gviz is a tool for generating graphviz dot data with simple Ruby's syntax.
+    It works with a graph spec file (defaulting to load 'graph.ru').
+
+    Example of graph.ru:
+
+      route :main => [:init, :parse, :cleanup, :printf]
+      route :init => :make, :parse => :execute
+      route :execute => [:make, :compare, :printf]
+
+      save(:sample, :png)
+
+    EOS
+    puts banner
+    help
+  end
+  default_task :banner
+  map "-h" => :banner
+
+  desc "man [NAME]", "Show available attributes, constants, colors for graphviz"
+  def man(name='')
+    attrs = %w(graph node edge subgraph cluster)
+    consts = %w(arrows shapes layouts output_formats)
+    colors = %w(color_names color_schemes full_color_names
+               full_color_schemes svg_color_names dark_colors)
+    name = name.downcase
+    case name
+    when *attrs then puts format_attr(name)
+    when *consts then puts consts.map { |c| format_const c }
+    when *colors then puts format_const(name)
+    when /color/ then puts colors.map { |c| format_const c }
+    else
+      puts ~<<-EOS
+        Specify any of:
+          #{attrs.join(', ')}
+          #{consts.join(', ')}
+          #{colors.join(', ')}
+      EOS
+    end
+  end
+
+  no_commands do
+    def format_attr(target)
+      header = ["\e[35m#{target.capitalize} attributes (type|default|minimum|notes):\e[0m"]
+      attrs = Gviz.ATTR(target).map { |attr, desc| "  #{attr} (#{desc.join(" | ")})" }
+      [header] + attrs
+    end
+
+    def format_const(target)
+      header = ["\e[35m#{target.capitalize.gsub('_', ' ')}:\e[0m"]
+      consts = Gviz.const_get(target.upcase).join_by(", ", 70).map { |l| "  " + l }        
+      [header] + consts
+    end
+  end
+end

data/lib/gviz/core.rb

@@ -115,7 +115,7 @@ class Gviz
     end
   end
   
-  # +graph+ is a shorcut method.
+  # +graph+ is a shortcut method.
   #
   #   gv = Gviz.new
   #   gv.graph do

data/lib/gviz/version.rb

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

data/spec/gviz_command_spec.rb

@@ -1,89 +1,112 @@
 require_relative "spec_helper"
 
-ROOT = File.expand_path(File.dirname(__FILE__) + "/..")
-
-describe "gviz command" do
-  context "when a graph file exist" do
-    subject { syscmd "#{ROOT}/bin/gviz -f spec/graph.ru" }
-    it do
-      should eql ~<<-EOS
-        digraph G {
-          a;
-          b;
-          a -> b;
-        }
-        EOS
-    end
+describe Gviz::Command do
+  before(:each) do
+    $stdout, $stderr = StringIO.new, StringIO.new
+    @original_dir = Dir.pwd
+    Dir.chdir(source_root)
   end
 
-  context "when a graph file not exist" do
-    subject { syscmd "#{ROOT}/bin/gviz", :err }
-    it { should eql "graph file `graph.ru` not found\n" }
+  after(:each) do
+    $stdout, $stderr = STDOUT, STDERR
+    Dir.chdir(@original_dir)
   end
 
-  context "when a name option passed" do
-    subject { syscmd "#{ROOT}/bin/gviz -n ABC -f spec/graph.ru" }
-    it do
-      should eql ~<<-EOS
-        digraph ABC {
-          a;
-          b;
-          a -> b;
-        }
+  describe '#build' do
+    context 'with a graph file' do
+      it 'output a dot data' do
+        Gviz::Command.start(['build', 'graph.ru'])
+        expect($stdout.string).to eq ~<<-EOS
+          digraph G {
+            a;
+            b;
+            a -> b;
+          }
         EOS
+      end
     end
-  end
 
-  context "when a type option passed" do
-    subject { syscmd "#{ROOT}/bin/gviz -t graph -f spec/graph.ru" }
-    it do
-      should eql ~<<-EOS
-        graph G {
-          a;
-          b;
-          a -> b;
-        }
+    context 'without a graph file' do
+      it 'read "graph.ru" as a graph file' do
+        Gviz::Command.start(['build'])
+        expect($stdout.string).to eq ~<<-EOS
+          digraph G {
+            a;
+            b;
+            a -> b;
+          }
         EOS
+      end
     end
-  end
 
-  context "when -m with correct attr passed" do
-    subject { syscmd("#{ROOT}/bin/gviz -m arrows") }
-    it do
-      should eql ~<<-EOS
-        \e[35mArrows:\e[0m
-          box, lbox, rbox, obox, olbox, orbox, crow, lcrow, rcrow, diamond, ldiamond, rdiamond
-          oldiamond, ordiamond, dot, odot, inv, linv, rinv, oinv, olinv, orinv, none, normal, lnormal
-      EOS
+    context 'when no graph file found' do
+      it 'abort the process' do
+        file = "no_existing_file"
+        expect{ Gviz::Command.start(['build', file]) }.to raise_error(SystemExit, "graph file `#{file}` not found")
+      end
     end
-  end
 
-  context "when -m with man word passed" do
-    subject { syscmd "#{ROOT}/bin/gviz -m man" }
-    it do
-      should eql ~<<-EOS
-        \e[35m--man(-m) accepts any of them:\e[0m
-          graph, node, edge, subgraph, cluster,
-          arrows, shapes, output_formats
-          color_names, color_schemes,
-          full_color_names, full_color_schemes,
-          svg_color_names, dark_colors
-        EOS
+    context "name option" do
+      it 'set a graph name' do
+        Gviz::Command.start(['build', '--name', 'ABC'])
+        expect($stdout.string).to eq ~<<-EOS
+          digraph ABC {
+            a;
+            b;
+            a -> b;
+          }
+          EOS
+      end
+    end
+  
+    context "type option" do
+      it 'set a graph type' do
+        Gviz::Command.start(['build', '--type', 'graph'])
+        expect($stdout.string).to eq ~<<-EOS
+          graph G {
+            a;
+            b;
+            a -> b;
+          }
+          EOS
+      end
     end
   end
 
-  context "when -m with incorrect attr passed" do
-    subject { syscmd "#{ROOT}/bin/gviz -m abc" }
-    it do
-      should eql ~<<-EOS
-        Error: unknown subcommand 'abc' for --man
-        \e[35m--man(-m) accepts any of them:\e[0m
-          graph, node, edge, subgraph, cluster,
-          arrows, shapes, output_formats
-          color_names, color_schemes,
-          full_color_names, full_color_schemes,
-          svg_color_names, dark_colors
-        EOS
+  describe '#man' do
+    it 'shows arguments list without argument' do
+      Gviz::Command.start(['man'])
+      expect($stdout.string).to match /Specify any of/
+    end
+
+    it "shows Graph's attributes" do
+      Gviz::Command.start(['man', 'graph'])
+      expect($stdout.string).to match /Graph attributes/
+    end
+
+    it "shows Node's attributes" do
+      Gviz::Command.start(['man', 'node'])
+      expect($stdout.string).to match /Node attributes/
+    end
+
+    it "shows Arrow types" do
+      Gviz::Command.start(['man', 'arrows'])
+      expect($stdout.string).to match /Arrows/
+    end
+
+    it "shows Output formats" do
+      Gviz::Command.start(['man', 'output_formats'])
+      expect($stdout.string).to match /Output formats/
+    end
+
+    it "shows Color names" do
+      Gviz::Command.start(['man', 'color_names'])
+      expect($stdout.string).to match /Color names/
+    end
+
+    it "shows Colors" do
+      Gviz::Command.start(['man', 'colors'])
+      expect($stdout.string).to match /Color/
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,9 +1,13 @@
 require "gviz"
 require "rspec"
 require "stringio"
-require "open3"
 
-def syscmd(cmd, io=:out)
-  idx = [:stdin, :stdout, :stderr].index { |st| st.match /#{io}/ }
-  Open3.popen3(cmd)[idx].read
+module Helpers
+  def source_root
+    File.join(File.dirname(__FILE__), 'fixtures')
+  end
+end
+
+RSpec.configure do |c|
+  c.include Helpers
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gviz
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - kyoendo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-01 00:00:00.000000000 Z
+date: 2013-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: trollop
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -61,13 +61,14 @@ files:
 - examples/shapes.rb
 - gviz.gemspec
 - lib/gviz.rb
+- lib/gviz/command.rb
 - lib/gviz/core.rb
 - lib/gviz/edge.rb
 - lib/gviz/graphviz_attrs.rb
 - lib/gviz/node.rb
 - lib/gviz/system_extension.rb
 - lib/gviz/version.rb
-- spec/graph.ru
+- spec/fixtures/graph.ru
 - spec/gviz_command_spec.rb
 - spec/gviz_edge_spec.rb
 - spec/gviz_node_spec.rb
@@ -98,10 +99,11 @@ signing_key:
 specification_version: 4
 summary: Ruby's interface of graphviz. It generate a dot file with simple ruby's syntax.
 test_files:
-- spec/graph.ru
+- spec/fixtures/graph.ru
 - spec/gviz_command_spec.rb
 - spec/gviz_edge_spec.rb
 - spec/gviz_node_spec.rb
 - spec/gviz_spec.rb
 - spec/spec_helper.rb
 - spec/system_extension_spec.rb
+has_rdoc: