graphy 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5855af538a3e42839fb6291076af3a81d7d6e117624e0ff912dfb537599b1d78
-  data.tar.gz: 43f3be7f19de34cf97743b03bdab151ae7cbc3d8fbe970802434dc11618dca33
+  metadata.gz: 90422fd37ee6183c87ab531c8841bfea10d9da59385f10f9d440b4095aeb24a8
+  data.tar.gz: 8bcb771712386cbeb5f9d2fb2e9e76030c9a6a18e79d8550f3bf28610d7d4624
 SHA512:
-  metadata.gz: 811d052517b6a4a32b354818976a62f6fd38dc695ad7df03b21601b58793f923909d7337aa1968547d55eb4e6c5a4f7f92213740210a63396376a1485de22bd1
-  data.tar.gz: 51c60f6b786035b87ee4357358db75b7edab3d7f0ffd6f605412b3d221081fc598f12ac4261cc7e02cc80685f779f3eba53c0788830c9794c078b6746042229d
+  metadata.gz: 5980d5b6a4c0ef3ef5867a11cf91b8c927431803c8f2d74b6b091b2d789b06fa1715cce4b6b6db927708bafb61c405e47027945388a087fc4e1c35232401d102
+  data.tar.gz: 3526fbda93e7ad3a960eb4e722024a89d1633414f45eeac5309ca7f8f2d7e223c9a900954d9ef05db4de543e256fc0d437ed33ec9bb3084f0e8daa92a08ac3cd

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+Gemfile.lock

data/README.md

@@ -1,6 +1,6 @@
 # Graphy
 
-Create any diagram as code
+DSL to create graph diagrams as code
 
 ## Installation
 
@@ -23,7 +23,7 @@ Or install it yourself as:
 ### Module
 
 ```ruby
-Graphy.define 'UML View' do
+Graphy.define 'Life View' do
   entity 'Friendly'
   namespace "Animal Kingdom" do
     entity 'Animal' do
@@ -31,12 +31,12 @@ Graphy.define 'UML View' do
     end
 
     entity 'Dog', 'Animal' do
-      attributes :color
+      attrs :color
       uses 'Friendly'
     end
 
     entity 'Cat', 'Animal' do
-      attributes :scratch
+      meths :scratch
     end
   end
 
@@ -44,10 +44,13 @@ Graphy.define 'UML View' do
 end
 ```
 
+![example02.png](https://github.com/3zcurdia/graphy/blob/master/examples/example02.rb.png)
+
+
 ### State machine
 
 ```ruby
-Graphy.define 'State machine' do
+Graphy.define 'State machine', orientation: :horizontal  do
   node 'A'
   node 'B', shape: 'diamond'
   node 'C'
@@ -62,6 +65,7 @@ Graphy.define 'State machine' do
   write(png: 'steps.png')
 end
 ```
+![example01.png](https://github.com/3zcurdia/graphy/blob/master/examples/example01.rb.png)
 
 ## Development
 

data/examples/example00.rb

@@ -2,12 +2,12 @@ require 'bundler/setup'
 require 'graphviz/dsl'
 
 digraph :example do
-   cluster_0 do
-      graph[label: 'Animal Kingdom']
-      animal << dog
-      animal << cat
-   end
-   friendly << dog
+  cluster_0 do
+    graph[label: 'Animal Kingdom']
+    animal << dog
+    animal << cat
+  end
+  friendly << dog
 
-   output(png: "#{$0}.png")
+  output(png: "#{$0}.png")
 end

data/examples/example01.rb

@@ -1,7 +1,7 @@
 require 'bundler/setup'
 require 'graphy'
 
-Graphy.define do
+Graphy.define 'State machine', orientation: :horizonal do
   node 'A'
   node 'B', shape: 'diamond'
   node 'C'

data/examples/example02.rb

@@ -2,18 +2,17 @@ require 'bundler/setup'
 require 'graphy'
 
 Graphy.define 'Life View' do
-  entity 'Friendly'
   entity 'Animal' do
-    attributes :name, :other
+    attrs :name, :other
   end
 
   entity 'Dog', 'Animal' do
-    attributes :color
+    attrs :color
     uses 'Friendly'
   end
 
   entity 'Cat', 'Animal' do
-    attributes :scratch
+    meths :scratch
   end
 
   write png: "#{$0}.png"

data/examples/example03.rb

@@ -0,0 +1,15 @@
+require 'bundler/setup'
+require 'graphy'
+
+Graphy.define 'Life View' do
+  entity 'Friendly'
+  namespace 'Animal Kingdom' do
+    entity 'Animal'
+    entity 'Dog', 'Animal' do
+      uses 'Friendly'
+    end
+    entity 'Cat', 'Animal'
+  end
+
+  write png: "#{$0}.png"
+end

data/lib/graphy.rb

@@ -1,8 +1,9 @@
 require 'graphviz'
 require 'graphy/node'
 require 'graphy/entity'
-require 'graphy/dependency'
+require 'graphy/diagram'
 require 'graphy/dsl'
+require 'graphy/registry'
 require 'graphy/version'
 
 module Graphy

data/lib/graphy/diagram.rb

@@ -0,0 +1,75 @@
+module Graphy
+  ## GraphViz wrapper
+  class Diagram
+    attr_accessor :graph, :edges
+
+    GRAPH_ATTRIBUTES = {
+      ranksep:     0.5,
+      nodesep:     0.4,
+      pad:         '0.4,0.4',
+      margin:      '0,0',
+      concentrate: true,
+      labelloc:    :t,
+      fontsize:    14,
+      fontname:    'Arial BoldMT',
+      splines:     'spline'
+    }
+
+    NODE_ATTRIBUTES = {
+      shape:    "Mrecord",
+      fontsize: 12,
+      fontname: "ArialMT",
+      margin:   "0.07,0.05",
+      penwidth: 1.0
+    }
+
+    EDGE_ATTRIBUTES = {
+      fontname:      "ArialMT",
+      fontsize:      10,
+      arrowsize:     0.9,
+      penwidth:      1.0,
+      labelangle:    32,
+      labeldistance: 1.8,
+    }
+
+    def initialize(name, options = {})
+      graph_opts = {
+        parent: options[:parent],
+        type: options[:parent]&.type
+      }.compact
+      @graph = GraphViz.new(name, **graph_opts)
+
+      GRAPH_ATTRIBUTES.each { |attribute, value| @graph[attribute] = value }
+      NODE_ATTRIBUTES.each  { |attribute, value| @graph.node[attribute] = value }
+      EDGE_ATTRIBUTES.each  { |attribute, value| @graph.edge[attribute] = value }
+
+      @graph[:rankdir] = options[:orientation] == :horizonal ? :LR : :TB
+      @graph[:label] = "#{name}\\n\\n"
+      @edges = []
+    end
+
+    def get_node(name)
+      graph.search_node(name)
+    end
+
+    def node_exists?(name)
+      !!get_node(name)
+    end
+
+    def draw_node(name, options = {})
+      graph.add_nodes(name, options)
+    end
+
+    def draw_edge(from, to, options)
+      graph.add_edges(from, to, options)
+    end
+
+    def draw_graph(diagram)
+      graph.add_graph(diagram.graph)
+    end
+
+    def write(options = {})
+      graph.output(options)
+    end
+  end
+end

data/lib/graphy/dsl.rb

@@ -1,24 +1,14 @@
 module Graphy
   class Dsl
-    @registry = {}
-    @edges = []
-
-    def self.registry
-      @registry
-    end
-
-    def self.edges
-      @edges
-    end
+    attr_accessor :diagram
 
     def initialize(name, options = {}, &block)
-      @graph = GraphViz.new(name, map_options(options.merge(label: name)))
-      instance_eval(&block) if block
+      @diagram = Diagram.new(name, options, &block)
+      instance_eval(&block) if block_given?
     end
 
     def namespace(name, &block)
-      opts = { parent: graph, type: graph.type }
-      graph.add_graph(Dsl.new(name, opts, &block).graph)
+      diagram.draw_graph(Dsl.new(name, { parent: diagram.graph }, &block).diagram)
     end
 
     def component(name, &block)
@@ -30,55 +20,22 @@ module Graphy
     end
 
     def node(name, shape: 'circle', &block)
-      return graph.get_node(name) unless graph.get_node(name.to_s).nil?
-
-      node = Node.new(name, graph: graph, shape: shape)
-      node.instance_eval(&block) if block_given?
-      Dsl.registry[name] = node
+      options = {diagram: diagram, shape: shape}
+      Node.for(name, **options).build(&block)
     end
 
     def entity(name, parent = nil, &block)
-      return graph.get_node(name) unless graph.get_node(name.to_s).nil?
-
-      entity = Entity.new(name, graph: graph)
-      entity.add_dependency(parent, type: :parent) if parent
-      entity.instance_eval(&block) if block_given?
-      Dsl.registry[name] = entity
-    end
-
-    def step(from, to:, options: {})
-      return if Dsl.edges.any? { |x| [from, to] == x }
-      source = Dsl.registry[from].graph_node
-      dest = Dsl.registry[to].graph_node
-      return if source.nil? || dest.nil?
-
-      Dsl.edges << [from, to]
-      graph.add_edge(source, dest, options)
+      entity = Entity.new(name: name, diagram: diagram)
+      entity.build(&block)
+      entity.add_dependency(parent, color: 'blue') if parent
     end
 
-    def graph
-      build
-      @graph
+    def step(from, to:, **options)
+      Node.for(from, diagram: diagram).add_dependency(to, **options)
     end
 
     def write(options = {})
-      graph.output(options)
-    end
-
-    private
-
-    def build
-      Dsl.registry.each do |name, node|
-        node.dependencies.each do |dep|
-          step(dep.ref, to: name, options: dep.edge_attributes)
-        end
-      end
-    end
-
-    def map_options(options = {})
-      align = options.delete(:align)
-      rankdir = align == :horizontal ? 'LR' : nil
-      options.merge(rankdir: rankdir).compact
+      diagram.write(options)
     end
   end
 end

data/lib/graphy/entity.rb

@@ -1,16 +1,24 @@
 module Graphy
   class Entity < Node
-    def initialize(name, graph:)
-      super(name, graph: graph, shape: 'record')
+    def initialize(**params)
+      super(**params.merge(shape: 'Mrecord'))
       @attributes = []
     end
 
-    def attributes(*values)
+    def attrs(*values)
       @attributes = values
     end
 
+    def meths(*values)
+      @attributes << values.map { |x| "#{x}()"}
+    end
+
     protected
 
+    def draw_edge(dependency, **options)
+      diagram.draw_edge(dependency.gnode, gnode, options)
+    end
+
     def label
       "{ #{name} #{attributes_label} }"
     end
@@ -19,7 +27,7 @@ module Graphy
 
     def attributes_label
       return if @attributes.empty?
-      "| #{@attributes.join("\n")}" 
+      "| #{@attributes.join("\n")}"
     end
   end
 end

data/lib/graphy/node.rb

@@ -1,38 +1,68 @@
 module Graphy
   class Node
-    attr_accessor :graph, :name, :shape, :penwidth, :fontsize, :style, :fillcolor, :dependencies
-    def initialize(name, graph:, shape: 'circle')
-      @name = name
-      @graph = graph
-      @shape = shape
-      @dependencies = []
+    attr_accessor :name, :shape, :diagram
+
+    def self.for(node, **params)
+      case node
+      when Entity, Node
+        node
+      when String
+        self.new(**params.merge(name: node))
+      else
+        raise 'Invalid node class'
+      end
     end
 
-    def graph_node
-      @graph_node ||= graph.add_nodes(name, node_attributes)
+    def initialize(**params)
+      @name = params[:name].to_s
+      @diagram = params[:diagram]
+      @shape = params.fetch(:shape, 'circle')
     end
 
-    def add_dependency(dependency, type: nil)
-      @dependencies << Dependency.for(dependency, type: type)
+    def add_dependency(dependency, **options)
+      dependency = self.class.for(dependency, diagram: diagram)
+      return if Registry.edge?(self, dependency)
+
+      Registry.add_edge(self, dependency)
+      draw_edge(dependency, **options)
     end
     alias :uses :add_dependency
 
+    def build(&block)
+      instance_eval(&block) if block_given?
+      gnode
+    end
+
+    def gnode
+      @gnode ||= find_or_draw
+    end
+
+    def to_s
+      "#{self.class}<#{name}>"
+    end
+
     protected
 
-    def node_attributes
+    def draw_edge(dependency, **options)
+      diagram.draw_edge(gnode, dependency.gnode, options)
+    end
+
+    def node_params
       {
-        shape: shape,
-        penwidth: penwidth,
-        fontsize: fontsize,
-        fontname: 'Helvetica',
-        style: style,
-        fillcolor: fillcolor,
-        label: label
-      }.compact
+        label: label,
+        shape: shape
+      }
     end
 
     def label
       "#{name}\n"
     end
+
+    private
+
+    def find_or_draw
+      return diagram.get_node(name) if diagram.node_exists?(name)
+      diagram.draw_node(name, node_params)
+    end
   end
 end

data/lib/graphy/registry.rb

@@ -0,0 +1,28 @@
+require 'singleton'
+
+module Graphy
+  class Registry
+    include Singleton
+    attr_accessor :edges
+
+    def self.edge?(source, destiny)
+      instance.edge?(source, destiny)
+    end
+
+    def self.add_edge(source, destiny)
+      instance.add_edge(source, destiny)
+    end
+
+    def initialize
+      @edges = {}
+    end
+
+    def edge?(source, destiny)
+      edges.key?("#{source}->#{destiny}")
+    end
+
+    def add_edge(source, destiny, options = {})
+      self.edges["#{source}->#{destiny}"] = options
+    end
+  end
+end

data/lib/graphy/version.rb

@@ -1,3 +1,3 @@
 module Graphy
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphy
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Luis Ezcurdia Razo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-21 00:00:00.000000000 Z
+date: 2020-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-graphviz
@@ -35,7 +35,6 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -47,12 +46,15 @@ files:
 - examples/example01.rb.png
 - examples/example02.rb
 - examples/example02.rb.png
+- examples/example03.rb
+- examples/example03.rb.png
 - graphy.gemspec
 - lib/graphy.rb
-- lib/graphy/dependency.rb
+- lib/graphy/diagram.rb
 - lib/graphy/dsl.rb
 - lib/graphy/entity.rb
 - lib/graphy/node.rb
+- lib/graphy/registry.rb
 - lib/graphy/version.rb
 homepage: https://github.com/3zcurdia/graphy
 licenses:

data/Gemfile.lock

@@ -1,25 +0,0 @@
-PATH
-  remote: .
-  specs:
-    arq (0.1.0)
-      ruby-graphviz (~> 1.2.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    minitest (5.14.2)
-    rake (12.3.3)
-    rexml (3.2.4)
-    ruby-graphviz (1.2.5)
-      rexml
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  arq!
-  minitest (~> 5.0)
-  rake (~> 12.0)
-
-BUNDLED WITH
-   2.1.4

data/lib/graphy/dependency.rb

@@ -1,29 +0,0 @@
-module Graphy
-  class Dependency
-    def self.for(reference, type: nil)
-      case type
-      when :parent
-        Parent
-      else
-        Default
-      end.new(reference)
-    end
-
-    class Default
-      attr_accessor :ref
-      def initialize(ref)
-        @ref = ref
-      end
-
-      def edge_attributes
-        {}
-      end
-    end
-
-    class Parent < Default
-      def edge_attributes
-        { style: 'dotted', color: 'blue' }
-      end
-    end
-  end
-end