uml_architect 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e3e99db12409ac2ec2f6368b6840caff915de1d
-  data.tar.gz: d36b07f16eaca893037cc8d9eaf8828b8cf22810
+  metadata.gz: fcf588256acefa798a448fa32320d55ee3f05a55
+  data.tar.gz: c1e2454709dac2ab62e0b19e314c4116769829fa
 SHA512:
-  metadata.gz: 536c4249dacecd20bf502b79e91e916c7727eed00c346eed208d4f704d57b6e56dafcde93824f7d0bf172d94a25e675fd2e871ce428a99a60bbea3a3f1a4274a
-  data.tar.gz: 51382b513dd71f722c7ed95baf6a58cc9138f9ffec02b18376a368bb736db5c60e8b693539c1553ed2cc462d33b346a77d6e081270811f493c93cb7d46ca61be
+  metadata.gz: 4f9ebbe1d97f49c96afd4fad7daeaecaaae01aa2c21525ab05a52b17c1d039d064195cbd60cc0fe256a3bb2bafa52b929e6423b87ccf21f0668a703da08ee3cc
+  data.tar.gz: 508072ac21f5e4223c247b2fdd07aaf58e4ffeb6e2d97748b90d843011fc024f66c7112f2408292474dd7faa92b5d9d38da1c169738cbca2335246a16e33a6c7

data/.gitignore

@@ -16,3 +16,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+/*.svg

data/README.md

@@ -9,9 +9,47 @@ Create UML Class diagrams using a [yUML](http://yuml.me/diagram/scruffy/class/sa
 
 ## Usage
 
-    $ architect file
+    $ architect [file ...]
     
-For what should be in the input file check out yUML samples above.
+This generates a output file with a svg extension with the same base name as the
+input file.
+
+## Examples
+
+### Simple Class
+    [User]
+![Simple Class](http://whistler.github.io/architect/examples/simple_class.svg)
+    
+### Class with methods and attributes
+    [User|+Firstname;+Lasname;-Password;|+Login();+Logout()]
+![Class with details](http://whistler.github.io/architect/examples/class_with_details.svg)
+    
+### Simple Association
+    [User]-[Tweet]
+![Simple Association](http://whistler.github.io/architect/examples/simple_association.svg)
+
+### Inheritance
+    [Animal]^-[Cat]
+    [Animal]^-[Dog]
+![Inheritance](http://whistler.github.io/architect/examples/inheritance.svg)
+    
+### Composition and Aggregation
+    [Car]++0..1-1[Carburetor]
+    [Pong]+0..1-0..*[Duck]
+![Composition and Aggregation](http://whistler.github.io/architect/examples/composition_and_aggregation.svg)
+    
+### Directional Association
+    [Order]-billing >[Address], [Order]-shipping >[Address]
+![Directional Association](http://whistler.github.io/architect/examples/directional_association.svg)
+
+### Dependency
+    [REST]uses-.->[HTTP]
+![Dependency](http://whistler.github.io/architect/examples/dependancy.svg)
+
+### Notes
+    [note: this is a note]
+    [note: This is a note about user]-.-[User]
+![Notes](http://whistler.github.io/architect/examples/notes.svg)
 
 ## Contributing
 

data/architect.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "ruby-graphviz"
+  spec.add_dependency "libxslt-ruby"
   spec.add_dependency "listen", "2.0"
 
   spec.add_development_dependency "bundler", "~> 1.3"

data/bin/architect

@@ -2,13 +2,14 @@
 $: << "./lib"
 require 'architect/runner'
 
-if ARGV.count != 1
-  puts "usage: architect file"
+if ARGV.count == 0
+  puts "usage: architect [file ...]"
 else
-  file = ARGV[0]
-  if File.exists?(file)
-    Architect::Runner.new(file, 'png')
-  else
-    puts file + " does not exist"
+  ARGV.each do |file|
+    if File.exists?(file)
+      Architect::Runner.new(file, 'svg')
+    else
+      puts file + ": file does not exist"
+    end
   end
-end
+end

data/examples/class_with_details.yuml

@@ -1 +1 @@
-[User|+Forename+;Surname;+HashedPassword;-Salt|+Login();+Logout()]
+[User|+Firstname;+Lasname;-Password;|+Login();+Logout()]

data/examples/composition_and_aggregation.yuml

@@ -0,0 +1,2 @@
+[Car]++0..1-1[Carburetor]
+[Pong]+0..1-0..*[Duck]

data/examples/dependancy.yuml

@@ -0,0 +1 @@
+[Service]uses-.->[HTTP]

data/examples/inheritance.yuml

@@ -0,0 +1,2 @@
+[Animal]^-[Cat]
+[Animal]^-[Dog]

data/examples/notes.yuml

@@ -1 +1,2 @@
-[Customer]<>1->*[Order], [Customer]-[note: Aggregate Root{bg:cornsilk}]
+[note: this is a note]
+[note: This is a note about user]-.-[User]

data/examples/simple_association.yuml

@@ -1 +1 @@
-[Customer]->[Billing Address]
+[User]-[Tweet]

data/lib/architect.rb

@@ -1,5 +1,5 @@
 require "architect/version"
 
 module Architect
-  # Your code goes here...
+
 end

data/lib/architect/association.rb

@@ -3,16 +3,16 @@ require_relative 'edge'
 
 module Architect
   
+  ## Association between two classes
   class Association < Edge
     
-    attr_accessor :attributes, :graph
-
     TYPES = {
       "<>" => "odiamond",
       "+"  => "odiamond",
       "++" => "diamond",
       ""   => "none",
-      ">"  => "vee"
+      ">"  => "vee",
+      "^"  => "empty"
     }
     
     def initialize(node1, node2, markup="->")
@@ -21,16 +21,20 @@ module Architect
     end
     
     def parse_markup(markup)
-      matches = /(.*)-(.*)/.match(markup)
+      matches = /(.*)-\.-(.*)/.match(markup)
+      matches = /(.*)-(.*)/.match(markup) if matches == nil
       left = matches[1]
       right = matches[2]
+      style = get_linestyle(markup)
       {arrowhead: get_arrow(right), arrowtail: get_arrow(left), 
-       headlabel: strip_arrow(right), taillabel: strip_arrow(left),
-       dir: "both"}
+       headlabel: " " + get_label(right) + " ", 
+       taillabel: " " + get_label(left) + " ",
+       dir: "both", style: style}
     end
     
+    # Return the type of arrow contained in the markup
     def get_arrow(string)
-      tokens = /([<>+]+)/.match(string)
+      tokens = /([<>+\^]+)/.match(string)
       if tokens == nil
         return "none"
       else
@@ -38,7 +42,8 @@ module Architect
       end
     end
     
-    def strip_arrow(string)
+    # Remove the arrow to get label
+    def get_label(string)
       return "" if string == nil
       TYPES.keys.each do |arrow|
         string = string.gsub(arrow, "")
@@ -46,6 +51,15 @@ module Architect
       return string
     end
     
+    def get_linestyle(string)
+      if /-\.-/.match(string) == nil
+        return "solid"
+      else
+        return "dashed"
+      end
+    end
+    
+    # Add associations to Graphviz
     def graph(g)
       g.add_edges(@node1.graphnode, @node2.graphnode, @attributes)
     end

data/lib/architect/class.rb

@@ -2,8 +2,8 @@ require_relative 'node'
 
 module Architect
   
+  # Class in a class diagram
   class Class < Architect::Node
-    
     attr_accessor :graphnode, :markup
     
     def initialize(markup)
@@ -21,6 +21,7 @@ module Architect
       return "{" + markup.gsub(";", "\\n") + "}"
     end
     
+    # Add class to Graphviz
     def graph(g)
       @graphnode = g.add_nodes(@markup, @style)
     end

data/lib/architect/diagram.rb

@@ -2,21 +2,22 @@ require 'graphviz'
 require_relative 'parser'
 
 module Architect
-  ##
+
   # Diagram is the base class for generating any diagram. 
   class Diagram
+    
     # Draw
     # [diagram] string containing the markup of the diagram
-    def draw(diagram, output = "class_diagram.png", ext = 'png')
+    def draw(diagram, output = "class_diagram.svg", ext = 'svg')
       parser = Parser.new
       elements = parser.parse(diagram)
       graph = GraphViz.new("ClassDiagram", type: "digraph")
-      graph.node["fillcolor"] = "gray95"
+      graph.node["fillcolor"] = "lightgrey"
       graph.node["style"] = "filled"
       elements.each do |element|
         element.graph(graph)
       end
-      graph.output(ext.to_sym => output)
+      graph.output(ext.to_sym => output, nothugly: true)
     end
     
   end

data/lib/architect/edge.rb

@@ -2,7 +2,6 @@ require_relative 'node'
 
 module Architect
   
-  ###
   # This is a generic edge in a graph which connects two nodes
   class Edge
     attr_accessor :from, :to

data/lib/architect/node.rb

@@ -1,6 +1,5 @@
 module Architect
   
-  ##
   # Generic class to create a graph node
   class Node 
     

data/lib/architect/note.rb

@@ -0,0 +1,17 @@
+module Architect
+  
+  # A note in a class diagram
+  class Note < Architect::Node
+    attr_accessor :graphnode
+    
+    def initialize(markup)
+      matches = /note:(.+)/i.match(markup)
+      @markup = matches[1].strip
+      @style = {shape: "note", style: "filled", fillcolor: "lightgrey"}
+    end
+    
+    def graph(g)
+       @graphnode = g.add_nodes(@markup, @style)
+    end
+  end
+end

data/lib/architect/parser.rb

@@ -1,8 +1,9 @@
 require_relative 'class'
+require_relative 'note'
 require_relative 'association'
 
 module Architect  
-  ##
+  
   # Parses yUML files
   class Parser
     
@@ -36,18 +37,29 @@ module Architect
     # [statement] String containing statement
     # Returns a list of classes markup and association markup in the statement
     def parse_statement(statement)
-      pattern = /\[(?<class1>.+?)\](?<association>.+?)\[(?<class2>.+)\]/ 
+      pattern = /\[(?<node1>.+?)\](?<association>.+?)\[(?<node2>.+)\]/ 
       tokens = pattern.match(statement)
       if tokens
-        class1 = Class.new(tokens[:class1])
-        class2 = Class.new(tokens[:class2])
-        association = Association.new(class1, class2, tokens[:association])
-        return [class1, class2, association]
+        node1 = get_node(tokens[:node1])
+        node2 = get_node(tokens[:node2])
+        association = Association.new(node1, node2, tokens[:association])
+        return [node1, node2, association]
       else
-        tokens = /\[(?<class1>.*)\]/.match(statement)
-        class1 = Class.new(tokens[:class1])
-        return [class1]
+        tokens = /\[(?<node1>.*)\]/.match(statement)
+        node1 = get_node(tokens[:node1])
+        return [node1]
       end
     end
+    
+    # [markup] string containing content inside square brackets
+    # Returns Note or Class
+    def get_node(markup)
+      if /^note/i.match(markup) != nil
+        return Note.new(markup)
+      else
+        return Class.new(markup)
+      end
+    end
+    
   end
 end

data/lib/architect/runner.rb

@@ -2,6 +2,7 @@ require 'architect/diagram'
 
 module Architect
   
+  # Draws a diagram from a file
   class Runner
     
     def initialize(file, ext)

data/lib/architect/version.rb

@@ -1,3 +1,3 @@
 module Architect
-  VERSION = "0.0.2"
+  VERSION = "0.0.4"
 end

data/spec/lib/association_spec.rb

@@ -10,12 +10,13 @@ describe Architect::Association do
   end
   
   it "parses simple association" do
-    @association.attributes[:arrowhead].should == "none"
+    attributes = @association.instance_eval("@attributes")
+    attributes[:arrowhead].should == "none"
   end
   
   it "parses association markup" do
     dot = {arrowhead: "vee", arrowtail: "odiamond", 
-     headlabel: "n", taillabel: "1", dir: "both"}
+     headlabel: " n ", taillabel: " 1 ", dir: "both", style: "solid"}
     @association.parse_markup("<>1-n>").should == dot
   end
   
@@ -24,7 +25,12 @@ describe Architect::Association do
   end
   
   it "strips arrows from strings" do
-    @association.strip_arrow(">1").should == "1"
+    @association.get_label(">1").should == "1"
+  end
+  
+  it "can draw dashed and solid lines" do
+    @association.get_linestyle("-").should == "solid"
+    @association.get_linestyle("-.-").should == "dashed"
   end
   
 end

data/spec/lib/diagram_spec.rb

@@ -8,19 +8,23 @@ describe Architect::Diagram do
   end
   
   it "can draw a class" do
-    @diagram.send("draw", "[User]", "class.png")
+    @diagram.send("draw", "[User]", "class.svg")
   end
   
   it "can draw an association" do
-    @diagram.send("draw", "[User]-[Pet]", "association.png")
+    @diagram.send("draw", "[User]-[Pet]", "association.svg")
   end
   
   it "can draw a class with attributes and methods" do
-    @diagram.send("draw", "[User|name; age; height|login(); logout()]-[Pet]", "record.png")    
+    @diagram.send("draw", "[User|name; age; height|login(); logout()]-[Pet]", "record.svg")    
   end
   
   it "can draw a diagram with composition" do
-    @diagram.send("draw", "[Pond]<>0..1-0..*[Duck]", "composition.png")
+    @diagram.send("draw", "[Pond]<>0..1-0..*[Duck]", "composition.svg")
+  end
+  
+  it "can draw a note" do
+    @diagram.send("draw", "[note: This is a note about user]-.-[User]\n[note: this is a note]", "note.svg")
   end
   
 end

data/spec/lib/note_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+require 'note'
+
+describe Architect::Note do
+  it "can create note from markup" do
+    note = Architect::Note.new("note: hello world")
+    g = double()
+    g.should_receive(:add_nodes).with("hello world", {style: "filled", 
+      shape: "note", fillcolor: "lightgrey"})
+    note.graph(g)
+  end
+end

data/spec/lib/parser_spec.rb

@@ -28,4 +28,9 @@ describe Architect::Parser do
     elements[0].name == "User"
   end
   
+  it "can parse a note" do
+    note = @parser.parse_statement("[Note: Hello]").first
+    note.class == Architect::Note
+  end
+  
 end

data/spec/lib/runner_spec.rb

@@ -7,12 +7,12 @@ describe Architect::Runner do
   it "should draw from file" do
     Architect::Diagram.any_instance.should_receive(:draw)
     Kernel.stub_chain(:open, :read).and_return("[User]")
-    architect = Architect::Runner.new("tmp/example.yuml", 'png', false)
+    architect = Architect::Runner.new("tmp/example.yuml", 'png')
   end
   
   it "should be able to change extension" do
     Kernel.stub_chain(:open, :read).and_return("[User]")
-    architect = Architect::Runner.new("test.yuml", "png", false)
+    architect = Architect::Runner.new("test.yuml", "png")
     architect.send(:change_extension, "test.yuml", "png").should == "test.png"
   end
   

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uml_architect
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Ibrahim Muhammad
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-10 00:00:00.000000000 Z
+date: 2013-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-graphviz
@@ -24,6 +24,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: libxslt-ruby
+  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'
 - !ruby/object:Gem::Dependency
   name: listen
   requirement: !ruby/object:Gem::Requirement
@@ -125,27 +139,26 @@ files:
 - Rakefile
 - architect.gemspec
 - bin/architect
-- examples/aggregation.yuml
-- examples/cardinality.yuml
-- examples/class.yuml
 - examples/class_with_details.yuml
-- examples/color_and_utf8.yuml
-- examples/composition.yuml
-- examples/dependancies.yuml
+- examples/composition_and_aggregation.yuml
+- examples/dependancy.yuml
 - examples/directional_association.yuml
 - examples/inheritance.yuml
-- examples/interface.yuml
-- examples/interface_inheritance.yuml
-- examples/international_characters.yuml
 - examples/notes.yuml
+- examples/pending/color_and_utf8.yuml
+- examples/pending/interface.yuml
+- examples/pending/interface_inheritance.yuml
+- examples/pending/international_characters.yuml
+- examples/pending/something_meaty.yuml
 - examples/simple_association.yuml
-- examples/something_meaty.yuml
+- examples/simple_class.yuml
 - lib/architect.rb
 - lib/architect/association.rb
 - lib/architect/class.rb
 - lib/architect/diagram.rb
 - lib/architect/edge.rb
 - lib/architect/node.rb
+- lib/architect/note.rb
 - lib/architect/parser.rb
 - lib/architect/runner.rb
 - lib/architect/version.rb
@@ -154,6 +167,7 @@ files:
 - spec/lib/diagram_spec.rb
 - spec/lib/edge_spec.rb
 - spec/lib/node_spec.rb
+- spec/lib/note_spec.rb
 - spec/lib/parser_spec.rb
 - spec/lib/runner_spec.rb
 - spec/spec_helper.rb
@@ -187,6 +201,7 @@ test_files:
 - spec/lib/diagram_spec.rb
 - spec/lib/edge_spec.rb
 - spec/lib/node_spec.rb
+- spec/lib/note_spec.rb
 - spec/lib/parser_spec.rb
 - spec/lib/runner_spec.rb
 - spec/spec_helper.rb

data/examples/aggregation.yuml

@@ -1 +0,0 @@
-[Company]<>-1>[Location], [Location]+->[Point]

data/examples/cardinality.yuml

@@ -1 +0,0 @@
-[Customer]1-0..*[Address]

data/examples/composition.yuml

@@ -1 +0,0 @@
-[Company]++-1>[Location]

data/examples/dependancies.yuml

@@ -1 +0,0 @@
-[HttpContext]uses -.->[Response]