use_case_diagram 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 --- 
 SHA1: 
-  metadata.gz: 7cb0a1b24c6a4f7893337480579677fb697fdd48
-  data.tar.gz: 0e3d5f298934ee0b888b6b49678ffdd4d77b80eb
+  metadata.gz: f3e98ef474368401223c80c0162fa7c7bb044028
+  data.tar.gz: 056206cf7cca3167924a1bf13f6ec7b611dc050a
 SHA512: 
-  metadata.gz: 29219f1c48533930623dbe93733ee629b60577745cf523fbae4155057290181c2dc58220613a1773dda8ee2b3bc261cc752a46ccd4a23aa57eaae0b462283a29
-  data.tar.gz: 5304397c25394106241d7924d4fc1383eaf8376647e1d2d12bb7c80cb52dc8da8646f862cd73055cb8e624ed681c8bbe34b211b1cab8cf4e90d519bdd8c10ad5
+  metadata.gz: 9bf28abe869f01bc31560e2d96fc82d2a33f06976cee9733a07ec2e71e5e0aef3a6fb839c875d005d9ef8a91a46251719c26212e97d76efd450086e2b7c625ef
+  data.tar.gz: 068b097e8f59bf4aecf53d8fbf74b08bf00fe1e1c7bd8865613431d6caa7f9e8f999ecf30ca1782a80980ba1ffbceb23aec207b2197207370d66b0c871a7a5d2

data/bin/use_case_diagram

@@ -3,28 +3,72 @@
 require 'use_case_diagram'
 
 def help
-	puts "Usage: $0 description_file"
+	puts "Usage: $0 [-p] [-f] description_files"
 end
 
+                 
+to_screen=true
+if ARGV.index('-f')
+  ARGV.delete('-f')
+  to_screen=false
+end
+
+process_dot=false
+if ARGV.index('-p')
+  ARGV.delete('-p')
+  process_dot=true
+  
+  if !system('dot -V')
+    puts "ERROR. You need to install graphviz or dot to get pdfs"
+    exit
+  end
+  
+  to_screen=false
+end
 
-input_file=ARGV.shift
 
-if input_file.nil? || !File.exists?(input_file)
-	puts "Need input file"
+if ARGV.empty?
+	puts "Need at least one input file"
 	help
 	exit
 end
 
 
-cont=File.read(input_file)
+# the other arguments are files, or must be
+ARGV.each do |input_file|
+  if !File.exists?(input_file)
+    puts "Not an input file: #{input_file}"
+    next
+  end
+  
+  base_name=File.basename(input_file,File.extname(input_file))
+  
+  cont=File.read(input_file)
 
-parse_result=Parser.parse(cont)
+  parse_result=Parser.parse(cont)
 
-# puts parse_result.obj.inspect
+  # puts parse_result.obj.inspect
 
 
-if !parse_result.nil?
-	puts parse_result.obj.to_dot
-else
-  raise "No dot file produced"
+  if !parse_result.nil?
+    res=parse_result.to_dot
+    if to_screen
+  	  puts res
+  	else
+  	  f=File.open("#{base_name}.dot",'w')
+  	  f.puts res
+  	  f.close
+	  end
+  else
+    raise "No dot file produced"
+  end
+  
+  
+  if process_dot
+     system("dot -Tpdf -o \"#{base_name}.pdf\"  \"#{base_name}.dot\"")
+  end
+  
 end
+
+
+

data/lib/use_case_diagram/actors.rb

@@ -16,13 +16,15 @@ class Actor
   #-----------------------------------------
   def initialize(name)
     @name=name.to_s
-    @description=nil
+    if !@name.nil?
+      @description=@name.gsub('_',' ')
+    end
     
   end  
   
   def to_dot
        res=ACTOR_TPL
-       res=res.gsub('#NAME#',@name)
+       res=res.gsub('#NAME#',@name.dquote)
        lab=''
        if !@description.nil?
          lab=' , label="'+@description.to_s+'"'
@@ -59,8 +61,14 @@ class Actors
       end
       
       @actors<<a
+  end    
+  
+  def find(name)
+    res=@actors.find{|e| e.name.to_sym==name}
+    return res
   end
   
+  
   def to_dot
      res=ACTORS_TPL
      @actors.each do |actor|

data/lib/use_case_diagram/diagram.rb

@@ -87,7 +87,7 @@ class Diagram
      res=''
      relations.each do |from_use,to_use|
        to_use.each do |to_u|
-        res += "#{from_use} -> #{to_u};\n"        
+        res += "#{from_use.to_s.dquote} -> #{to_u.to_s.dquote};\n"        
        end
      end
      
@@ -110,10 +110,29 @@ class Diagram
   def generalises_to_dot
     return relations_to_dot(@generalises)
   end
+   
+  def fill_nodes_from(hash)
+    hash.to_a.flatten.each do |node|
+      if (!@nodes.find(node) && !@actors.find(node))
+         @nodes.add(node)
+      end
+    end
+  end
+     
+  # fill nodes not defined by node a line
+  def fill_nodes
+    fill_nodes_from(@uses)
+    fill_nodes_from(@extends)
+    fill_nodes_from(@includes)
+    fill_nodes_from(@generalises)
+  end
 
   
   def to_dot
-    res=DIAG_TPL;
+    
+    fill_nodes
+    
+    res=DIAG_TPL
     
     res=res.gsub('#ACTORS#',@actors.to_dot)
     res=res.gsub('#NODES#',@nodes.to_dot)

data/lib/use_case_diagram/nodes.rb

@@ -8,7 +8,10 @@ class Node
   #-----------------------------------------
   def initialize(name)
     @name=name.to_s
-    @description=nil
+    if !@name.nil?
+      @description=@name.gsub('_','\n')
+    end
+    
   end  
   
 end
@@ -45,6 +48,24 @@ class Nodes
       
   end
   
+  def find(name)
+    # puts "="*20
+    # puts "FIND #{name},#{name.class}, count:#{@nodes.count}:"
+    # res=nil
+    # @nodes.each do |n|
+    #    puts "- #{n.name}"
+    #    if n.name.to_sym==name
+    #     res=n
+    #     puts "*** FOUND #{res.name}."
+    #     
+    #     break
+    #   end
+    # end
+    #     
+    res=@nodes.find{|e| e.name.to_sym==name}
+    return res
+  end
+  
   def to_dot
      res=NODES_TPL
      @nodes.each do |node|
@@ -52,7 +73,7 @@ class Nodes
        if !node.description.nil?
          desc=' [label="'+node.description+'"]'
        end
-       res=res.gsub('#NODE#',node.name+"#{desc};\n#NODE#")
+       res=res.gsub('#NODE#',node.name.dquote+"#{desc};\n#NODE#")
      end
      
      res=res.gsub('#NODE#',"")

data/lib/use_case_diagram/parser.rb

@@ -37,7 +37,11 @@ class Parser
       raise Exception, "Parse error at offset: #{@@parser.index}"
     end
     
-    return tree
+    diag=tree.obj
+    
+    diag.fill_nodes
+    
+    return diag
   end
 
 end

data/lib/use_case_diagram/support_nodes.rb

@@ -30,3 +30,14 @@ end
 
 class Expression < Treetop::Runtime::SyntaxNode
 end
+
+class String
+  
+  def dquote
+     return "\""+self+"\""
+  end
+  def squote
+     return "'"+self+"'"
+  end
+  
+end

data/lib/use_case_diagram/version.rb

@@ -1,3 +1,3 @@
 module UseCaseDiagram
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/lib/use_case_diagram/ej1.txt

@@ -1,10 +1,8 @@
 actor :user 
- actor :admin "Admin name"
+actor :admin "Admin name"
 
-node :login
-  node :logout
-node :other 
 node :askpassword "Ask password"
+node :login
 
 :user uses :login, :other
 
@@ -13,5 +11,5 @@ node :askpassword "Ask password"
 :login includes :askpassword, :askname
 
 :logout extended :extend1_logout, :extend2_logout
-:askname includes :askfirstname
+:askname includes :askfirstname?
 :askname extended :asksecondname

data/test/lib/use_case_diagram/test_version.rb

@@ -8,55 +8,57 @@ class TestUseCase < Test::Unit::TestCase
   def test_parse_empty
     res=Parser.parse("")
 
-    assert(res.obj.is_a?(Diagram))
+    assert(res.is_a?(Diagram))
     
-    assert_equal(res.obj.actors.count,0)
-    assert_equal(res.obj.nodes.count,0)
-    # assert_equal(res.obj.uses.count,0)
-    # assert_equal(res.obj.includes.count,0)
-    # assert_equal(res.obj.extends.count,0)
+    assert_equal(res.actors.count,0)
+    assert_equal(res.nodes.count,0)
+    # assert_equal(res.uses.count,0)
+    # assert_equal(res.includes.count,0)
+    # assert_equal(res.extends.count,0)
         
   end
 
   def test_parse_actor
     res=Parser.parse("actor :dario\n")
 
-    assert(res.obj.is_a?(Diagram))
+    assert(res.is_a?(Diagram))
     
-    assert_equal(res.obj.actors.count,1)
-    assert_equal(res.obj.nodes.count,0)
+    assert_equal(res.actors.count,1)
+    assert_equal(res.nodes.count,0)
         
   end
   
   def test_parse_node
     res=Parser.parse("node :login\n")
 
-    assert(res.obj.is_a?(Diagram))
+    assert(res.is_a?(Diagram))
     
-    assert_equal(res.obj.actors.count,0)
-    assert_equal(res.obj.nodes.count,1)
+    assert_equal(res.actors.count,0)
+    assert_equal(res.nodes.count,1)
         
   end
   
   def test_parse
     res=Parser.parse("actor :dario\n node :login \n node :logout\n")
 
-    assert(res.obj.is_a?(Diagram))
+    assert(res.is_a?(Diagram))
     
-    assert_equal(res.obj.actors.count,1)
-    assert_equal(res.obj.nodes.count,2)
+    assert_equal(res.actors.count,1)
+    assert_equal(res.nodes.count,2)
         
   end
 
   def test_uses
     cont=File.read(File.join(@@base_path,'ej1.txt'))
     res=Parser.parse(cont)
-
-    assert(res.obj.is_a?(Diagram))
     
-    assert_equal(res.obj.actors.count,2)
-    assert_equal(res.obj.nodes.count,4)
-
+    assert(res.is_a?(Diagram))
+       
+    assert_equal(res.actors.count,2)
+    assert_equal(res.nodes.count,9)
+    
+    puts res.to_dot
+      
   end
   
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: use_case_diagram
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Dario Guerrero
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-05-21 00:00:00 Z
+date: 2013-05-23 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: treetop
@@ -71,7 +71,7 @@ files:
 - test/lib/use_case_diagram/ej1.txt
 - test/lib/use_case_diagram/test_version.rb
 - test/test_helper.rb
-- use_case.gemspec
+- use_case_diagram.gemspec
 homepage: ""
 licenses: 
 - MIT