ucd 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20a0c5aea325b83fbc5a0f08bb4a45aefe97a399
-  data.tar.gz: a8b2aa083f8f4fdbc5cf0106a0e2b61be3da753c
+  metadata.gz: 51f6cac1d8dcdafd6a3eb3ea5a6bff3de73d9f01
+  data.tar.gz: cf78554c75c52b667d85f53736532c72dbad7b83
 SHA512:
-  metadata.gz: a7436fac89357c2ad5acf494f81608f56396bbbb24d0a8cc0251c4606456ca3afa55478397dc4826d6f3786d30684c99d86d14b9d6bdba8cc3679ee461cc3d72
-  data.tar.gz: 2b71e4c7632308f556b71f9cf835850ddd33e423f24e84dd69e5fe6c73cf416ce198b9bec8f07b65a820197cdad4a0a9802f4e3b75e62680e3c5dbfc6f5b9c90
+  metadata.gz: bc0fac2e3548521b2caf6029570af69c61c80ef976825966a45f744d62f83725ae41e7a553974de8a854becfc1b5355cef7787f62ecd24e8c880f79ca27a215c
+  data.tar.gz: 5241b9c7058b17535f35a0c6827240451c840cb0058b87752ab8a5613898c2fb13b15ea93bd33b8e6a03fc29a818001f09a9376c08596f767d5c2d185c35ce2a

data/TODO.md

@@ -2,3 +2,82 @@
 
 * Atom, VIM, etc color schemes/snippets
 * Use https://github.com/glejeune/Ruby-Graphviz
+* "interface class" feels weird.
+* Pass multiple types:
+  ucd examples/alias.ucd -o examples -t png,dot,svg
+* Reopen class:
+  class Foo {
+    field name: String
+  }
+  class Foo {
+    field email: String
+  }
+* Define outside class:
+  class Foo
+  interface class Bar
+  Foo field name : String
+  Foo realizes Bar
+* Auto define missing classes
+* Empty classes
+  Right now: class A {}
+  TODO: class A
+* Pass formatter arguments to formatter
+  Graphviz: Graph, node, edge attributes..
+* System and user config files, mostly for formatter default settings
+* Comments
+  * Support all 3 styles: #, //, /* ... \*/
+    * Pros
+      * Users can guess and always be correct
+    * Cons
+      * Looks messy
+      * More complex parser definition
+* Option to add relationship's fields and methods (Not class relationships)
+  * class Animal {
+      field name : String
+    }
+
+    class Dog {
+      method bark
+
+      generalizes Animal
+    }
+
+    dog.methods => [:name, :bark]
+
+* Aliases?
+  * Pros
+    * Less to type
+  * Cons
+    * No autocomplete for defined aliases in editors
+  * Examples
+    * alias name_field as field name : String
+
+      class Cat {
+        name_field
+      }
+
+      class Dog {
+        name_field
+      }
+* Macros?
+
+  * Examples
+    * macro has_many(name, type) {
+        field {{name}} : Array({{type}})
+
+        aggregation {{type}} {{name}} *
+      }
+
+      class Dog {
+        has_many toys, Toy
+      }
+
+      # Same as:
+      # class Dog {
+      #   field toys : Array(Toy)
+      #
+      #   aggregation Toy toys *
+      # }
+
+      class Toy {
+      }

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.1.4

data/examples/composite.dot

@@ -62,5 +62,5 @@ digraph G {
   ClassLeaf -> ClassComponent [arrowhead="onormal"]
   ClassComposite -> ClassComponent [arrowhead="onormal"]
 
-  ClassComposite -> ClassComponent [dir="back" arrowtail="odiamond" headlabel="*"]
-}
+  ClassComposite -> ClassComponent [dir="back" taillabel="1" headlabel="*" arrowtail="odiamond"]
+}

data/examples/composite.ucd

@@ -13,5 +13,5 @@ class Composite {
   method getChild(index : Integer) : Component
 
   generalizes Component
-  aggregation Component *
+  aggregation Component 1 *
 }

data/examples/generic.dot

@@ -38,4 +38,4 @@ digraph G {
   ClassTexture -> ClassAssetT [arrowhead="onormal"]
 
 
-}
+}

data/examples/relationships.dot

@@ -0,0 +1,111 @@
+digraph G {
+  graph [splines="ortho" rankdir="BT"]
+  edge [color="gray50"]
+  node [shape="plain"]
+
+  ClassNode [label=<
+    <TABLE BORDER="0" CELLBORDER="1" CELLSPACING="0">
+      <TR>
+        <TD><B>Node</B></TD>
+      </TR>
+      <TR>
+        <TD></TD>
+      </TR>
+      <TR>
+        <TD></TD>
+      </TR>
+    </TABLE>
+  >]
+
+  ClassA [label=<
+    <TABLE BORDER="0" CELLBORDER="1" CELLSPACING="0">
+      <TR>
+        <TD><B>A</B></TD>
+      </TR>
+      <TR>
+        <TD></TD>
+      </TR>
+      <TR>
+        <TD></TD>
+      </TR>
+    </TABLE>
+  >]
+
+  ClassB [label=<
+    <TABLE BORDER="0" CELLBORDER="1" CELLSPACING="0">
+      <TR>
+        <TD><B>B</B></TD>
+      </TR>
+      <TR>
+        <TD></TD>
+      </TR>
+      <TR>
+        <TD></TD>
+      </TR>
+    </TABLE>
+  >]
+
+  ClassC [label=<
+    <TABLE BORDER="0" CELLBORDER="1" CELLSPACING="0">
+      <TR>
+        <TD><B>C</B></TD>
+      </TR>
+      <TR>
+        <TD></TD>
+      </TR>
+      <TR>
+        <TD></TD>
+      </TR>
+    </TABLE>
+  >]
+
+  ClassD [label=<
+    <TABLE BORDER="0" CELLBORDER="1" CELLSPACING="0">
+      <TR>
+        <TD><B>D</B></TD>
+      </TR>
+      <TR>
+        <TD></TD>
+      </TR>
+      <TR>
+        <TD></TD>
+      </TR>
+    </TABLE>
+  >]
+
+  ClassE [label=<
+    <TABLE BORDER="0" CELLBORDER="1" CELLSPACING="0">
+      <TR>
+        <TD><B>E</B></TD>
+      </TR>
+      <TR>
+        <TD></TD>
+      </TR>
+      <TR>
+        <TD></TD>
+      </TR>
+    </TABLE>
+  >]
+
+  ClassF [label=<
+    <TABLE BORDER="0" CELLBORDER="1" CELLSPACING="0">
+      <TR>
+        <TD><B>F</B></TD>
+      </TR>
+      <TR>
+        <TD></TD>
+      </TR>
+      <TR>
+        <TD></TD>
+      </TR>
+    </TABLE>
+  >]
+
+  ClassNode -> ClassA [arrowhead="onormal" style="dashed"]
+  ClassNode -> ClassB [arrowhead="onormal"]
+
+  ClassNode -> ClassC [style="dashed"]
+  ClassNode -> ClassD
+  ClassNode -> ClassE [dir="back" arrowtail="odiamond"]
+  ClassNode -> ClassF [dir="back" arrowtail="diamond"]
+}

data/examples/relationships.ucd

@@ -0,0 +1,15 @@
+class Node {
+  realizes    A
+  generalizes B
+  dependency  C
+  association D
+  aggregation E
+  composition F
+}
+
+class A {}
+class B {}
+class C {}
+class D {}
+class E {}
+class F {}

data/lib/ucd.rb

@@ -1,5 +1,6 @@
 require "version"
 require "ucd/parser"
+require "ucd/attribute_parser"
 require "ucd/formatter/graphviz"
 
 module UCD

data/lib/ucd/attribute_parser.rb

@@ -0,0 +1,46 @@
+require "parslet"
+
+module UCD
+  class AttributeParser < Parslet::Parser
+
+    class Transform < Parslet::Transform
+      rule(:integer => simple(:x)) { Integer(x) }
+      rule(:float => simple(:x)) { Float(x) }
+      rule(:string => simple(:x)) { String(x) }
+    end
+
+    def self.parse(io, options={})
+      new.parse(io, options)
+    end
+
+    def parse(io, options={})
+      tree = Transform.new.apply(super)
+      tree = tree[:assignments].each_with_object({}) { |assignment, memo| memo[assignment[:name].to_s] = assignment[:value] }
+
+      tree
+    end
+
+    rule(:spaces) { match("\s").repeat(1) }
+    rule(:spaces?) { spaces.maybe }
+
+    rule(:digits) { match["0-9"].repeat(1) }
+
+    rule(:integer) { (str("-").maybe >> digits >> str(".").absent?).as(:integer) }
+    rule(:float) { (str("-").maybe >> digits >> str(".") >> digits).as(:float) }
+
+    rule(:string_single_quoted) { str(%q{'}) >> (str(%q{'}).absent? >> any).repeat.as(:string) >> str(%q{'}) }
+    rule(:string_double_quoted) { str(%q{"}) >> (str(%q{"}).absent? >> any).repeat.as(:string) >> str(%q{"}) }
+
+    rule(:string) { string_single_quoted | string_double_quoted }
+
+    rule(:assignment_name) { (match["=\s"].absent? >> any).repeat.as(:name) }
+    rule(:assignment_value) { (integer | float | string).as(:value) }
+    rule(:assignment) { assignment_name >> spaces? >> str("=") >> spaces? >> assignment_value }
+
+    rule(:attribute) { spaces? >> assignment >> spaces? }
+    rule(:attributes) { (attribute >> (str(",") >> attribute).repeat).repeat.as(:assignments) }
+
+    root(:attributes)
+
+  end
+end

data/lib/ucd/formatter/graphviz.rb

@@ -22,22 +22,22 @@ module UCD
       def initialize(attributes={})
         super
 
-        @graph_attributes = Attributes.new
-        @graph_attributes["splines"] = "ortho"
-        @graph_attributes["rankdir"] = "BT"
+        @graph = Attributes.new
+        @graph["splines"] = "ortho"
+        @graph["rankdir"] = "BT"
 
-        @edge_attributes = Attributes.new
-        @edge_attributes["color"] = "gray50"
+        @edge = Attributes.new
+        @edge["color"] = "gray50"
 
-        @node_attributes = Attributes.new
-        @node_attributes["shape"] = "plain"
+        @node = Attributes.new
+        @node["shape"] = "plain"
 
         @type = :dot
       end
 
-      attr_reader :graph_attributes
-      attr_reader :edge_attributes
-      attr_reader :node_attributes
+      attr_reader :graph
+      attr_reader :edge
+      attr_reader :node
 
       def type=(value)
         super
@@ -76,23 +76,29 @@ module UCD
       end
 
       def format_relationship(node)
-        arrow = "diamond" if "composition"
-        arrow = "odiamond" if "aggregation"
-        dir = "back" if %w[aggregation composition].include?(node.type)
+        dir       = "back" if %w[aggregation composition].include?(node.type)
         arrow_key = dir == "back" ? "arrowtail" : "arrowhead"
+        from_key  = dir == "back" ? "taillabel" : "headlabel"
+        to_key    = dir == "back" ? "headlabel" : "taillabel"
 
         attributes = Attributes.new
 
-        attributes["style"] = "dashed" if node.type == "dependency"
-        attributes["dir"] = dir if dir
-        attributes[arrow_key] = arrow
-        attributes["headlabel"] = node.from if node.from
-        attributes["taillabel"] = node.to if node.to
+        attributes["style"]   = "dashed"  if node.type == "dependency"
+        attributes["dir"]     = dir       if dir
+        attributes[from_key]  = node.from if node.from
+        attributes[to_key]    = node.to   if node.to
+
+        if %w[aggregation composition].include?(node.type)
+          arrow     = "diamond"  if node.type == "composition"
+          arrow     = "odiamond" if node.type == "aggregation"
+          attributes[arrow_key] = arrow
+        end
 
         graph_parent_name = generate_graph_name(node.parent.name)
-        graph_node_name = generate_graph_name(node.name)
+        graph_node_name   = generate_graph_name(node.name)
+        graph_attributes  = " [#{attributes}]" unless attributes.empty?
 
-        %Q{Class#{graph_parent_name} -> Class#{graph_node_name} [#{attributes}]}
+        %Q{Class#{graph_parent_name} -> Class#{graph_node_name}#{graph_attributes}}
       end
 
       def format_class_relationship(node)
@@ -110,6 +116,7 @@ module UCD
       def format_class(node)
         name = "<B>#{node.name}</B>"
         name = "«abstract»<BR/><I>#{name}</I>" if node.modifier == "abstract"
+        name = "«interface»<BR/>#{name}" if node.modifier == "interface"
 
         unless node.fields.empty?
           field_rows  = node.fields.map { |field| %Q{<TR><TD ALIGN="LEFT">#{format_field(field)}</TD></TR>}}
@@ -167,9 +174,9 @@ Class#{graph_node_name} [label=<
 
         <<-HEREDOC
 digraph G {
-  graph [#{@graph_attributes}]
-  edge [#{@edge_attributes}]
-  node [#{@node_attributes}]
+  graph [#{@graph}]
+  edge [#{@edge}]
+  node [#{@node}]
 
 #{classes}
 

data/lib/ucd/interface/command_line.rb

@@ -2,6 +2,7 @@ require "optparse"
 require "pathname"
 require "ucd/interface/base"
 require "ucd/parser"
+require "ucd/attribute_parser"
 require "ucd/formatter"
 
 module UCD
@@ -12,9 +13,11 @@ module UCD
       class FileError < Error; end
 
       def initialize(attributes={})
-        @formatter = Formatter::Graphviz.new
-        @verbose   = false
-        setup_parser
+        @formatter     = Formatter::Graphviz.new
+        @verbose       = false
+        @option_parser = OptionParser.new
+
+        setup_parser_options
 
         super
       end
@@ -36,8 +39,12 @@ module UCD
       end
 
       def run
+        args = ARGV.dup # TODO: This is hacky
+        @option_parser.parse!(args) rescue nil
+        setup_parser_formatter_options
         @option_parser.parse!
-        self.paths = ARGV
+
+        self.paths      = ARGV
         @formatter.type = @type
 
         raise Error, "Output path must be a directory if multiple input files are given" if @output_path && @output_path.file? && @paths.length > 1
@@ -90,76 +97,106 @@ module UCD
         "\e[0m"
       end
 
-      def setup_parser
-        @option_parser = OptionParser.new do |parser|
-          parser.banner = <<~BANNER
-            #{text_bold("Usage:")} ucd [options] PATHS
+      def setup_parser_options
+        @option_parser.banner = ""
+        @option_parser.on("-f", "--formatter VALUE", "The output formatter (Default: '#{@formatter.name}')") { |value| self.formatter = value }
+        @option_parser.on("-t", "--type VALUE",      "The output format type") { |value| @type = value }
+        @option_parser.on("-o", "--output VALUE",    "The output path") { |value| self.output_path = value }
+        @option_parser.on("-h", "--help",            "Prints this help") do
+          print_help
+
+          exit
+        end
+      end
+
+      def setup_parser_formatter_options
+        case @formatter.name
+        when :graphviz
+          @option_parser.on("-g", "--graph VALUE") do |value|
+            AttributeParser.parse(value).each { |key, value| @formatter.graph[key] = value }
+          end
+
+          @option_parser.on("-e", "--edge VALUE") do |value|
+            AttributeParser.parse(value).each { |key, value| @formatter.edge[key] = value }
+          end
+
+          @option_parser.on("-n", "--node VALUE") do |value|
+            AttributeParser.parse(value).each { |key, value| @formatter.node[key] = value }
+          end
 
-            #{text_bold("Overview:")} Generate output from UML Class Diagram language files
+          @option_parser.on("-a", "--all VALUE") do |value|
+            AttributeParser.parse(value).each do |key, value|
+              @formatter.graph[key] = value
+              @formatter.edge[key] = value
+              @formatter.node[key] = value
+            end
+          end
+        end
+      end
 
-            #{text_bold("Options:")}
+      def print_help
+        puts <<~HELP
+          #{text_bold("Usage:")} ucd [options] PATHS
 
-          BANNER
+          #{text_bold("Overview:")} Generate output from UML Class Diagram language files
 
-          parser.on("-f", "--formatter VALUE", "The output formatter (Default: '#{@formatter.name}')") { |value| self.formatter = value }
-          parser.on("-t", "--type VALUE", "The output format type") { |value| @type = value }
-          parser.on("-o", "--output VALUE", "The output path") { |value| self.output_path = value }
-          parser.on("-h", "--help", "Prints this help") do
-            puts parser
-            puts <<~HELP
+          #{text_bold("Options:")}
+          #{@option_parser}
+          #{text_bold("Paths:")}
 
-              #{text_bold("Paths:")}
+              UCD can accept multiple paths for parsing for easier batch processing.
 
-                  UCD can accept multiple paths for parsing for easier batch processing.
+              The location of the output by default is standard output.
 
-                  The location of the output by default is standard output.
+              The output can be directed to a path with #{text_bold_italic("--output")}, which can be a file or a directory.
+              If the output path is a directory, then the filename will be the same as the input filename,
+                with it's file extension substituted with the #{text_bold_italic("--type")}.
 
-                  The output can be directed to a path with #{text_bold_italic("--output")}, which can be a file or a directory.
-                  If the output path is a directory, then the filename will be the same as the input filename,
-                    with it's file extension substituted with the #{text_bold_italic("--type")}.
+              #{text_underline("Examples")}
 
-                  #{text_underline("Examples")}
+                  `ucd project.ucd`
 
-                      `ucd project.ucd`
+                      Produces DOT notation, sent to standard output
 
-                          Produces DOT notation, sent to standard output
+                  `ucd -o . project.ucd`
 
-                      `ucd -o . project.ucd`
+                      Produces DOT notation, written to #{text_italic("./project.dot")}
 
-                          Produces DOT notation, written to #{text_italic("./project.dot")}
+                  `ucd -o ./diagram.dot project.ucd`
 
-                      `ucd -o ./diagram.dot project.ucd`
+                      Produces DOT notation, written to #{text_italic("./diagram.dot")}
 
-                          Produces DOT notation, written to #{text_italic("./diagram.dot")}
+                  `ucd -o ./diagram.png project.ucd`
 
-                      `ucd -o ./diagram.png project.ucd`
+                      Produces PNG image, written to #{text_italic("./diagram.png")}
 
-                          Produces PNG image, written to #{text_italic("./diagram.png")}
+                  `ucd -t png -o . project.ucd`
 
-                      `ucd -t png -o . project.ucd`
+                      Produces PNG image, written to #{text_italic("./project.png")}
 
-                          Produces PNG image, written to #{text_italic("./project.png")}
+                  `ucd -t png -o . project.ucd core_ext.ucd`
 
-                      `ucd -t png -o . project.ucd core_ext.ucd`
+                      Produces PNG images, written to #{text_italic("./project.png")} and #{text_italic("./core_ext.png")}
 
-                          Produces PNG images, written to #{text_italic("./project.png")} and #{text_italic("./core_ext.png")}
+          #{text_bold("Formatters:")}
 
-              #{text_bold("Formatters:")}
+              #{text_underline("Graphviz")}
 
-                  #{text_underline("Graphviz")}
+                Generates DOT notation and can use the DOT notation to generate any format Graphviz can produce.
 
-                    Generates DOT notation and can use the DOT notation to generate any format Graphviz can produce.
+                The output format is based on #{text_bold_italic("--type")}, which by default is "dot".
+                If #{text_bold_italic("--type")} is not given and #{text_bold_italic("--output")} is, the file extension of the #{text_bold_italic("--output")} path will be used.
 
-                    The output format is based on #{text_bold_italic("--type")}, which by default is "dot".
-                    If #{text_bold_italic("--type")} is not given and #{text_bold_italic("--output")} is, the file extension of the #{text_bold_italic("--output")} path will be used.
+                Valid types/extensions are: #{Formatter::Graphviz::VALID_TYPES.join(", ")}
 
-                    Valid types/extensions are: #{Formatter::Graphviz::VALID_TYPES.join(", ")}
+                #{text_bold("Options:")}
 
-            HELP
+                    -g, --graph VALUE                The graph attributes
+                    -e, --edge VALUE                 The edge attributes
+                    -n, --node VALUE                 The node attributes
+                    -a, --all VALUE                  Set attributes for graph, edge, and node
 
-            exit
-          end
-        end
+        HELP
       end
 
     end

data/lib/ucd/parser.rb

@@ -77,8 +77,8 @@ module UCD
 
     rule(:relationship_directionality) { (kw_relationship_directionality.as(:directionality) >> spaces).maybe }
     rule(:relationship_type)           { kw_relationship_type.as(:type) >> spaces }
-    rule(:relationship_from)           { (spaces >> (name.as(:name) | str("*").repeat(1)).as(:from)).maybe }
-    rule(:relationship_to)             { (spaces >> (name.as(:name) | str("*").repeat(1)).as(:to)).maybe }
+    rule(:relationship_from)           { (spaces >> (name | str("*").repeat(1)).as(:from)).maybe }
+    rule(:relationship_to)             { (spaces >> (name | str("*").repeat(1)).as(:to)).maybe }
     rule(:relationship_definition)     { (relationship_directionality >> relationship_type >> class_name.as(:name) >> relationship_from >> relationship_to).as(:relationship) }
 
     # -- Class

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ucd
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Ryan Scott Lewis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-23 00:00:00.000000000 Z
+date: 2017-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet
@@ -101,15 +101,18 @@ files:
 - VERSION
 - bin/console
 - bin/setup
-- examples/composite - minimal.ucd
 - examples/composite.dot
 - examples/composite.png
 - examples/composite.ucd
 - examples/generic.dot
 - examples/generic.png
 - examples/generic.ucd
+- examples/relationships.dot
+- examples/relationships.png
+- examples/relationships.ucd
 - exe/ucd
 - lib/ucd.rb
+- lib/ucd/attribute_parser.rb
 - lib/ucd/formatter.rb
 - lib/ucd/formatter/base.rb
 - lib/ucd/formatter/graphviz.rb

data/examples/composite - minimal.ucd

@@ -1,17 +0,0 @@
-abstract class Component {
-  method operation
-}
-
-class Leaf {
-  generalizes Component
-}
-
-class Composite {
-  protected field children
-  method addChild(child)
-  method removeChild(child)
-  method getChild(index)
-
-  generalizes Component
-  aggregation Component
-}