use_case_diagram 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA1: 
+  metadata.gz: 7cb0a1b24c6a4f7893337480579677fb697fdd48
+  data.tar.gz: 0e3d5f298934ee0b888b6b49678ffdd4d77b80eb
+SHA512: 
+  metadata.gz: 29219f1c48533930623dbe93733ee629b60577745cf523fbae4155057290181c2dc58220613a1773dda8ee2b3bc261cc752a46ccd4a23aa57eaae0b462283a29
+  data.tar.gz: 5304397c25394106241d7924d4fc1383eaf8376647e1d2d12bb7c80cb52dc8da8646f862cd73055cb8e624ed681c8bbe34b211b1cab8cf4e90d519bdd8c10ad5

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.DS_Store
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in use_case_diagram.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Dario Guerrero
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# use_case_diagram
+
+This gem can be used to generate use case diagrams in dot format by using a simpler syntaxis.
+
+## Installation
+
+gem install use_case_diagram 
+
+Or you may add this line to your application's Gemfile:
+
+    gem 'use_case_diagram'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install use_case_diagram
+
+## Usage
+
+Create a text file with the use_case_diagram description (ej1.txt):
+
+actor :user
+actor :admin
+
+node :login
+node :logout
+node :other
+node :askpassword "Ask password"
+
+:user uses :login, :other
+
+:admin uses :logout
+
+:login includes :askpassword, :askname
+
+:logout extended :extend1_logout, :extend2_logout
+:askname includes :askfirstname
+:askname extended :asksecondname
+
+Then you can parse it to create the dot file:
+
+use_case_diagram ej1.txt > ej1.dot
+
+and call dot to create a pdf or png:
+
+dot -Tpdf -o ej1.pdf ej1.dot
+
+Obviously, you need dot installed to make this conversion.
+
+
+You can also use it with pipes:
+
+use_case_diagram ej1.txt | dot -Tpdf -o ej1.pdf ej1.dot
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+ 
+Rake::TestTask.new do |t|
+  t.libs << 'lib/use_case_diagram'
+  t.test_files = FileList['test/lib/use_case_diagram/test_*.rb']
+  t.verbose = true
+end
+ 
+task :default => :test

data/bin/use_case_diagram

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require 'use_case_diagram'
+
+def help
+	puts "Usage: $0 description_file"
+end
+
+
+input_file=ARGV.shift
+
+if input_file.nil? || !File.exists?(input_file)
+	puts "Need input file"
+	help
+	exit
+end
+
+
+cont=File.read(input_file)
+
+parse_result=Parser.parse(cont)
+
+# puts parse_result.obj.inspect
+
+
+if !parse_result.nil?
+	puts parse_result.obj.to_dot
+else
+  raise "No dot file produced"
+end

data/lib/use_case_diagram/actors.rb

@@ -0,0 +1,75 @@
+actor_path=File.join(File.dirname(File.dirname(__FILE__)),'use_case_diagram','Actor.png')
+
+
+ACTOR_TPL =<<END                                                           
+
+#NAME# [shapefile="#{actor_path}", peripheries=0, style=solid, fixedsize=true, height=1.1, labeldistance=100, labelloc="b" #LABEL#];
+
+END
+
+class Actor
+  
+  attr_accessor :name, :description
+  
+  #-----------------------------------------
+  # 
+  #-----------------------------------------
+  def initialize(name)
+    @name=name.to_s
+    @description=nil
+    
+  end  
+  
+  def to_dot
+       res=ACTOR_TPL
+       res=res.gsub('#NAME#',@name)
+       lab=''
+       if !@description.nil?
+         lab=' , label="'+@description.to_s+'"'
+       end
+       res=res.gsub('#LABEL#',lab)
+       return res
+    
+  end
+  
+end
+
+ACTORS_TPL = <<END
+    /* Actor Nodes */
+
+      #ACTOR#
+
+END
+
+
+class Actors
+      
+  def initialize
+    @actors=[]
+  end
+               
+  def count
+    @actors.count
+  end
+  
+  def add(name)
+      a=name
+      if !a.is_a?(Actor)
+          a=Actor.new(name)
+      end
+      
+      @actors<<a
+  end
+  
+  def to_dot
+     res=ACTORS_TPL
+     @actors.each do |actor|
+       res=res.gsub('#ACTOR#',actor.to_dot+"\n#ACTOR#")
+      
+     end
+     res=res.gsub('#ACTOR#',"")
+     
+     return res
+  end
+  
+end

data/lib/use_case_diagram/cu_relations.rb

@@ -0,0 +1,15 @@
+
+class Relation
+  
+  attr_accessor :from_u, :to_u, :type
+  
+  #-----------------------------------------
+  # 
+  #-----------------------------------------
+  def initialize(type, from_u, to_u)
+    @from_u=from_u
+    @to_u=to_u
+    @type=type
+  end  
+  
+end

data/lib/use_case_diagram/diagram.rb

@@ -0,0 +1,129 @@
+
+DIAG_TPL = <<END
+digraph G {
+    rankdir=LR;
+    labelloc="b";
+    peripheries=0;
+
+    #ACTORS#
+    
+    #NODES#
+
+    edge [arrowhead=none];
+        
+    #USES#
+
+    edge [arrowhead=none, arrowtail=open, label="<<extend>>", style=dashed, dir=both];
+    
+    #EXTENDS#
+
+    edge [arrowhead=open, arrowtail=none, label="<<includes>>", style=dashed, dir=both];
+    
+    #INCLUDES#
+    
+    
+    
+//    #GENERALISES#
+    
+}
+END
+
+require 'actors.rb'
+require 'nodes.rb'
+require 'cu_relations'
+
+class Diagram
+  
+  attr_accessor :actors,:nodes
+   
+  def initialize(file=nil)
+    @file=file
+    @actors=Actors.new
+    @nodes=Nodes.new
+    @uses={}
+    @extends={}
+    @includes={}
+    @generalises={}
+    
+  end
+  
+  def inspect
+    puts "Actors:#{@actors.count}"
+    puts "Nodes:#{@nodes.count}"
+    puts "Uses:#{@uses.count}"
+    puts "Includes:#{@includes.count}"
+    puts "Extends:#{@extends.count}"
+    
+  end
+  
+  def relate(relation,from_u,to_u)
+    if relation[from_u].nil?
+      relation[from_u]=[]
+    end
+    
+    relation[from_u] << to_u
+    
+  end
+  
+  def uses(from_u,to_u)
+    relate(@uses,from_u,to_u)
+  end
+  
+  def extends(from_u,to_u)
+    relate(@extends,from_u,to_u)
+  end
+
+  def includes(from_u,to_u)
+    relate(@includes,from_u,to_u)
+  end
+
+  def generalises(from_u,to_u)
+    relate(@generalises,from_u,to_u)
+  end
+
+
+  
+  def relations_to_dot(relations)
+     res=''
+     relations.each do |from_use,to_use|
+       to_use.each do |to_u|
+        res += "#{from_use} -> #{to_u};\n"        
+       end
+     end
+     
+     return res
+  end
+  
+  def uses_to_dot
+    return relations_to_dot(@uses)
+  end
+
+  def extends_to_dot
+    return relations_to_dot(@extends)
+  end
+  
+  
+  def includes_to_dot
+    return relations_to_dot(@includes)
+  end
+
+  def generalises_to_dot
+    return relations_to_dot(@generalises)
+  end
+
+  
+  def to_dot
+    res=DIAG_TPL;
+    
+    res=res.gsub('#ACTORS#',@actors.to_dot)
+    res=res.gsub('#NODES#',@nodes.to_dot)
+    res=res.gsub('#USES#',uses_to_dot)
+
+    res=res.gsub('#EXTENDS#',extends_to_dot)
+    res=res.gsub('#INCLUDES#',includes_to_dot)
+    res=res.gsub('#GENERALISES#',generalises_to_dot)
+
+    return res
+  end
+  
+end

data/lib/use_case_diagram/nodes.rb

@@ -0,0 +1,63 @@
+class Node
+  
+  attr_accessor :name,:description
+  
+  
+  #-----------------------------------------
+  # 
+  #-----------------------------------------
+  def initialize(name)
+    @name=name.to_s
+    @description=nil
+  end  
+  
+end
+
+NODES_TPL = <<END
+    /* Use Case Nodes */
+
+    node [shape=ellipse, style=solid];
+    
+    #NODE#
+    
+END
+
+
+class Nodes
+          
+  def initialize
+    @nodes=[]
+  end
+  
+  def count
+    @nodes.count
+  end
+  
+  
+  def add(name) 
+
+    n=name
+    if !n.is_a?(Node)
+        n=Node.new(name)
+    end
+    @nodes<<n
+    
+      
+  end
+  
+  def to_dot
+     res=NODES_TPL
+     @nodes.each do |node|
+       desc=''
+       if !node.description.nil?
+         desc=' [label="'+node.description+'"]'
+       end
+       res=res.gsub('#NODE#',node.name+"#{desc};\n#NODE#")
+     end
+     
+     res=res.gsub('#NODE#',"")
+     
+     return res
+  end
+  
+end

data/lib/use_case_diagram/parser.rb

@@ -0,0 +1,43 @@
+require 'treetop'
+require 'use_case_diagram'
+require 'support_nodes'
+
+# Find out what our base path is
+base_path = File.expand_path(File.dirname(__FILE__))
+
+# Load our custom syntax node classes so the parser can use them
+# require File.join(base_path, 'node_extensions.rb')
+
+class Parser
+  
+  base_path = File.expand_path(File.dirname(__FILE__))
+                                                      
+  Treetop.load(File.join(base_path, 'use_case_diagram'))
+
+  # puts "- Grammar loaded"
+  @@parser = UCaseParser.new
+  
+  # puts "- Parser created loaded"
+                               
+  def self.parse(data)
+    
+    # Pass the data to the parser instance
+    tree = @@parser.parse(data)
+    # puts "- Data parsed"
+    
+    # If tree is nil then there was an error during parsing
+    # we need to report a simple error message to help the user
+    if(tree.nil?)
+      puts @@parser.failure_reason
+      puts @@parser.failure_line
+      puts @@parser.failure_column
+      
+      puts "LINE WITH ERROR:#{data.split("\n")[@@parser.failure_line]}"
+      
+      raise Exception, "Parse error at offset: #{@@parser.index}"
+    end
+    
+    return tree
+  end
+
+end

data/lib/use_case_diagram/support_nodes.rb

@@ -0,0 +1,32 @@
+class IntegerLiteral < Treetop::Runtime::SyntaxNode
+end
+
+class StringLiteral < Treetop::Runtime::SyntaxNode
+end
+
+class EmptyLine < Treetop::Runtime::SyntaxNode
+  def obj
+    nil
+  end
+end
+class CommentLine < Treetop::Runtime::SyntaxNode
+  
+  def obj
+    nil
+  end
+end
+
+class NewLine < Treetop::Runtime::SyntaxNode
+  def obj
+    nil
+  end
+end
+
+class Identifier < Treetop::Runtime::SyntaxNode
+  def obj
+    nil
+  end
+end
+
+class Expression < Treetop::Runtime::SyntaxNode
+end

data/lib/use_case_diagram/use_case_diagram.treetop

@@ -0,0 +1,181 @@
+grammar UCase
+
+	rule diagram
+	 (actor / node / uses / incl / extd / commentline / whiteline / newline)*
+		{
+			def obj                                
+				d=Diagram.new
+				elements.map{|e| e.obj}.compact.flatten.each do |e|
+					if e.is_a?(Actor) 
+				  	d.actors.add(e)
+				 	elsif e.is_a?(Node)
+						d.nodes.add(e)
+				 	elsif e.is_a?(Relation)
+							if e.type==:uses
+								d.uses(e.from_u,e.to_u)
+							elsif e.type==:includes
+								d.includes(e.from_u,e.to_u)
+							elsif e.type==:extended
+									d.extends(e.from_u,e.to_u)
+							end
+					else
+						 raise "Unknown element in parse tree"
+					end
+				end
+				
+				return d
+			end
+		}
+	end
+
+	rule actor
+		space? 'actor' space ident:identifier desc:node_description? space? newline
+		{
+			def obj
+			 n=Actor.new(ident.obj)
+			 if !desc.nil? && desc.respond_to?(:obj)
+			 	n.description=desc.obj
+			 end     
+			 return n
+			end
+		}
+	end
+	
+	rule node
+		space? 'node' space ident:identifier desc:node_description? space? newline
+		{
+			def obj
+			 n=Node.new(ident.obj)
+			 if !desc.nil? && desc.respond_to?(:obj)
+			 	n.description=desc.obj
+			 end     
+			
+			 return n
+			end
+		}
+	end
+	
+	rule node_description
+		space desc:quotedstring
+		{
+			def obj
+			   eval(desc.text_value)
+			end
+		}
+	end
+	
+	rule uses
+		space? id1:identifier space 'uses' space id2:identifier id3:id_list* space? newline
+		{
+			def obj
+			 r=[]
+			 r << Relation.new(:uses,id1.obj,id2.obj)
+			
+			 id3.elements.each do |rel|
+				r << Relation.new(:uses,id1.obj,rel.obj)
+			 end
+			 return r
+			end
+		}
+	end
+	
+	rule incl
+		space? id1:identifier space 'includes' space id2:identifier id3:id_list* space? newline
+		{
+			def obj
+			 r=[]
+			 r << Relation.new(:includes,id1.obj,id2.obj)
+			
+			 id3.elements.each do |rel|
+				r << Relation.new(:includes,id1.obj,rel.obj)
+			 end
+			 return r
+			end
+		}
+	end
+
+	rule extd
+		space? id1:identifier space 'extended' space id2:identifier id3:id_list* space? newline
+		{
+			def obj
+			 r=[]
+			 r << Relation.new(:extended,id1.obj,id2.obj)
+			
+			 id3.elements.each do |rel|
+				r << Relation.new(:extended,id1.obj,rel.obj)
+			 end
+			 return r
+			end
+		}
+	end
+	
+	
+	rule id_list
+		space? ',' space? id1:(identifier)
+		{
+			def obj
+			 id1.obj
+			end
+		}
+	end
+	
+	
+  # ':' ident:[a-zA-Z0-9_]+
+	rule identifier
+	  ':' ident:([^\s\n\,\;\:\-]+)
+		{
+			def obj
+				ident.text_value.to_sym
+			end
+		}
+	end
+	
+	rule commentline
+	   space? '#' (!"\n" .)+ newline
+		 {
+				def obj
+					nil
+				end
+
+		 }
+	end
+
+	
+	rule quotedstring
+	  '"' ('\"' / !'"' .)* '"'
+		{
+			def obj
+				nil
+			end
+		
+		}
+	end
+
+	rule space
+	  [ \t]+
+	end
+
+	rule whiteline
+		space newline
+		{
+			def obj
+				nil
+			end
+		}
+	end
+	
+	rule newline
+	  [\n]
+		{
+			def obj
+				nil
+			end
+		}
+  end
+
+	rule emptyline
+		''
+	end
+
+
+end

data/lib/use_case_diagram/version.rb

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

data/lib/use_case_diagram.rb

@@ -0,0 +1,10 @@
+# $: << File.dirname(__FILE__)
+$: << File.join(File.dirname(__FILE__),File.basename(__FILE__,File.extname(__FILE__)))		
+
+require "use_case_diagram/version"
+require "use_case_diagram/diagram"
+require "use_case_diagram/parser"
+
+module UseCaseDiagram
+  # Your code goes here...
+end

data/test/lib/use_case_diagram/ej1.txt

@@ -0,0 +1,17 @@
+actor :user 
+ actor :admin "Admin name"
+
+node :login
+  node :logout
+node :other 
+node :askpassword "Ask password"
+
+:user uses :login, :other
+
+:admin uses :logout
+
+:login includes :askpassword, :askname
+
+:logout extended :extend1_logout, :extend2_logout
+:askname includes :askfirstname
+:askname extended :asksecondname

data/test/lib/use_case_diagram/test_version.rb

@@ -0,0 +1,64 @@
+require File.dirname(__FILE__) + '/../../test_helper.rb'
+
+
+class TestUseCase < Test::Unit::TestCase
+
+  @@base_path=File.dirname(__FILE__)
+
+  def test_parse_empty
+    res=Parser.parse("")
+
+    assert(res.obj.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)
+        
+  end
+
+  def test_parse_actor
+    res=Parser.parse("actor :dario\n")
+
+    assert(res.obj.is_a?(Diagram))
+    
+    assert_equal(res.obj.actors.count,1)
+    assert_equal(res.obj.nodes.count,0)
+        
+  end
+  
+  def test_parse_node
+    res=Parser.parse("node :login\n")
+
+    assert(res.obj.is_a?(Diagram))
+    
+    assert_equal(res.obj.actors.count,0)
+    assert_equal(res.obj.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_equal(res.obj.actors.count,1)
+    assert_equal(res.obj.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)
+
+  end
+  
+  
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/use_case_diagram.rb'

data/use_case.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'use_case_diagram/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "use_case_diagram"
+  spec.version       = UseCaseDiagram::VERSION
+  spec.authors       = ["Dario Guerrero"]
+  spec.email         = ["dariogf@gmail.com"]
+  spec.description   = %q{A gem to generate user cases in UML using dot}
+  spec.summary       = %q{A gem to generate user cases in UML using dot}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib","lib/use_case_diagram"]
+  
+  spec.add_runtime_dependency(%q<treetop>, ["= 1.4.12"])
+  
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: use_case_diagram
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Dario Guerrero
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-05-21 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: treetop
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.4.12
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.3"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - &id004 
+      - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: A gem to generate user cases in UML using dot
+email: 
+- dariogf@gmail.com
+executables: 
+- use_case_diagram
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/use_case_diagram
+- lib/use_case_diagram.rb
+- lib/use_case_diagram/Actor.png
+- lib/use_case_diagram/actors.rb
+- lib/use_case_diagram/cu_relations.rb
+- lib/use_case_diagram/diagram.rb
+- lib/use_case_diagram/nodes.rb
+- lib/use_case_diagram/parser.rb
+- lib/use_case_diagram/support_nodes.rb
+- lib/use_case_diagram/use_case_diagram.treetop
+- lib/use_case_diagram/version.rb
+- test/lib/use_case_diagram/ej1.txt
+- test/lib/use_case_diagram/test_version.rb
+- test/test_helper.rb
+- use_case.gemspec
+homepage: ""
+licenses: 
+- MIT
+metadata: {}
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+- lib/use_case_diagram
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id004
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id004
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A gem to generate user cases in UML using dot
+test_files: 
+- test/lib/use_case_diagram/ej1.txt
+- test/lib/use_case_diagram/test_version.rb
+- test/test_helper.rb