diagrams-rb 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca6654ecfc36d63b19a5081d1cd9bc05fc071bd78539da3ee0a37776eaf1508e
-  data.tar.gz: a1509778ac0d02b70017f2e5eb7cb736843d73ad2842aadafad24f7c6387e323
+  metadata.gz: 35a88b43b3643bbb75a44ca94744b7cfe4a617cb6f5439520edd899d32d55757
+  data.tar.gz: 272798c4dcf1f125604ac817121a61d76f346fc521fcd98d2f0d6e53f7b42999
 SHA512:
-  metadata.gz: 46125e7f16938e35d0141c0f8d954b08d7fc5da41fb5f3d6d3860295a0aaca13610dc4dc84f6c1551a82720f74719e533a0b94850ce1d18306722ba2f3e16e0d
-  data.tar.gz: eee3bba493ed460caf6dde29078950ae14bacba44f898e5df2ed08003c02651e0c7605005ee96a672637ea57ea6913c5d02370676407c65c669f6896281df0bc
+  metadata.gz: 0b408960a0da513d5f87935ea8db6bbedb69b734318675352adb69d9bf175345871dc3047eda9d6b927b014dfce916f91decacb8ec35c87a1cc07e163dd96fbf
+  data.tar.gz: 5ff6dbb9349aa5bdda6e4c63f95dc7a52ea34bc699aca4e75fb01d8b6280e4825ffeb89cb722408716fe1c7a94225e8d3c1fd5365f1ff1e0a6463908affbb7c2

data/lib/diagrams/dot.rb

@@ -4,73 +4,73 @@ require 'open3'
 require 'tempfile'
 
 module Diagrams
-  class Dot
-    GRAPH_DEFAULTS = {
-      pad: '2.0',
-      splines: 'ortho',
-      nodesep: '0.60',
-      ranksep: '0.75',
-      rankdir: 'TB',
-      fontname: '"Sans-Serif"',
-      fontsize: '15',
-      fontcolor: '"#2D3436"'
-    }.freeze
-
-    NODE_DEFAULTS = {
-      shape: 'box',
-      style: 'rounded',
-      fixedsize: 'true',
-      width: '1.4',
-      height: '1.4',
-      labelloc: 'b',
-      imagescale: 'true',
-      penwidth: '0',
-      fontname: '"Sans-Serif"',
-      fontsize: '13',
-      fontcolor: '"#2D3436"'
-    }.freeze
-
-    CLUSTER_DEFAULTS = {
-      shape: 'box',
-      style: 'rounded',
-      labeljust: 'l',
-      pencolor: '"#AEB6BE"'
-    }.freeze
-
-    CLUSTER_BGCOLORS = %w[#E5F5FD #EBF3E7 #ECE8F6 #FDF7E3].freeze
+  class Dot # rubocop:disable Metrics/ClassLength
+    DEFAULTS = {
+
+      GRAPH: {
+        pad: '2.0',
+        splines: 'ortho',
+        nodesep: '0.60',
+        ranksep: '0.75',
+        rankdir: 'TB',
+        fontname: '"Sans-Serif"',
+        fontsize: '15',
+        fontcolor: '"#2D3436"'
+      },
+
+      NODE: {
+        shape: 'box',
+        style: 'rounded',
+        fixedsize: 'true',
+        width: '1.4',
+        height: '1.4',
+        labelloc: 'b',
+        imagescale: 'true',
+        penwidth: '0',
+        fontname: '"Sans-Serif"',
+        fontsize: '13',
+        fontcolor: '"#2D3436"'
+      },
+
+      CLUSTER: {
+        shape: 'box',
+        style: 'rounded',
+        labeljust: 'l',
+        pencolor: '"#AEB6BE"'
+      },
+
+      CLUSTER_BGCOLORS: %w[#E5F5FD #EBF3E7 #ECE8F6 #FDF7E3],
+
+      EDGE: {
+        color: '"#7B8894"',
+        fontcolor: '"#2D3436"',
+        fontname: '"Sans-Serif"',
+        fontsize: '13'
+      },
+
+      PADDING: 0.45
 
-    EDGE_DEFAULTS = {
-      color: '"#7B8894"',
-      fontcolor: '"#2D3436"',
-      fontname: '"Sans-Serif"',
-      fontsize: '13'
     }.freeze
 
-    attr_accessor :dot_output, :format, :space, :clen
+    attr_accessor :format, :space, :bg_color_len
 
     def initialize(**attrs)
-      @dot_output = "digraph G {\n".dup
       @format = attrs.delete(:format) || 'png'
-      GRAPH_DEFAULTS.merge(attrs).each do |key, value|
-        @dot_output << "    #{key}=#{value};\n"
-      end
+      @test = attrs.delete(:test)
       @space = '  '
-      @clen = CLUSTER_BGCOLORS.length
+      @bg_color_len = DEFAULTS[:CLUSTER_BGCOLORS].length
       @depth = 0
       @cluster_idx = -1
-    end
-
-    def indent
-      space * @depth
+      write_digraph_default(attrs)
     end
 
     def add_node(id, label: '', icon: nil, **attrs)
-      attributes = NODE_DEFAULTS.merge(attrs).map { |k, v| "#{k}=#{v}" }.join(',')
+      attributes = DEFAULTS[:NODE].merge(attrs.merge(height: node_height(label))).map { |k, v| "#{k}=#{v}" }.join(',')
       dot_output << "#{indent}    #{id} [label=\"#{label}\", image=\"#{icon}\", #{attributes}];\n"
     end
 
     def add_edge(from, to:, **attrs)
-      attributes = EDGE_DEFAULTS.merge(attrs).map { |k, v| "#{k}=#{v}" }.join(',')
+      attributes = DEFAULTS[:EDGE].merge(attrs).map { |k, v| "#{k}=#{v}" }.join(',')
       dot_output << "    #{from} -> #{to} [#{attributes}];\n"
     end
 
@@ -79,11 +79,12 @@ module Diagrams
 
       dot_output << "#{indent}subgraph cluster_#{identifier(cluster_label)} {\n"
       dot_output << "#{indent}    label=\"#{label}\";\n"
-      dot_output << "#{indent}    bgcolor=\"#{CLUSTER_BGCOLORS[@depth % clen]}\";\n"
-      CLUSTER_DEFAULTS.merge(attrs).each do |key, value|
-        dot_output << "#{indent}   #{key}=#{value};\n"
+      dot_output << "#{indent}    bgcolor=\"#{DEFAULTS[:CLUSTER_BGCOLORS][@depth % bg_color_len]}\";\n"
+      DEFAULTS[:CLUSTER].merge(attrs).each do |key, value|
+        dot_output << "#{indent}    #{key}=#{value};\n"
       end
       @depth += 1
+      @dot_output
     end
 
     def end_cluster
@@ -91,13 +92,38 @@ module Diagrams
       @depth -= 1
     end
 
+    def generate_image
+      dot_output << "}\n"
+      return dot_output if @test
+
+      write_output
+    end
+
+    private
+
+    def dot_output
+      @dot_output ||= "digraph G {\n".dup
+    end
+
+    def write_digraph_default(attrs)
+      DEFAULTS[:GRAPH].merge(attrs).each do |key, value|
+        dot_output << "    #{key}=#{value};\n"
+      end
+    end
+
+    def indent
+      space * @depth
+    end
+
+    def node_height(label)
+      (DEFAULTS[:NODE][:height].to_f + (DEFAULTS[:PADDING] * label.split("\\n").size)).round(1).to_s
+    end
+
     def identifier(string)
       string.gsub(/\s+/, '_')
     end
 
-    def generate_image
-      output_path = caller_locations.last.path.gsub('.rb', ".#{format}")
-      dot_output << "}\n"
+    def write_output
       Tempfile.open('temp.dot') do |file|
         File.write(file.path, dot_output)
 
@@ -106,5 +132,9 @@ module Diagrams
         puts stderr unless status.success?
       end
     end
+
+    def output_path
+      caller_locations.last.path.gsub('.rb', ".#{format}")
+    end
   end
 end

data/lib/diagrams/resources.rb

@@ -16,7 +16,6 @@ module Diagrams
 
           current_module = self
           path_parts.each do |part|
-            # Create or get the submodule dynamically
             submodule = current_module.const_get(part.capitalize) rescue nil
             unless submodule
               submodule = Module.new

data/lib/diagrams/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Diagrams
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: diagrams-rb
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Gerard O'Mahony
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-03 00:00:00.000000000 Z
+date: 2024-11-09 00:00:00.000000000 Z
 dependencies: []
 description: |-
   This Ruby-based DSL allows you to create complex Graphviz DOT diagrams programmatically.
@@ -25,7 +25,6 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - LICENSE
-- LICENSE.txt
 - README.md
 - Rakefile
 - lib/diagrams-rb.rb

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2024 TODO: Write your name
-
-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.