drawio_dsl 0.8.4 → 0.8.5

data/lib/drawio_dsl/dom_builder_shapes.rb

@@ -2,7 +2,7 @@
 
 # :nocov:
 module DrawioDsl
-  # DrawioDsl is a DSL for draw-io diagrams.
+  # Builder methods for each shape, line and text element to attach to DomBuilder.
   module DomBuilderShapes
     def add_line(id = nil, **opts, &block)
       opts = { id: id }.merge(opts) if id
@@ -142,6 +142,12 @@ module DrawioDsl
       add_shape(database)
     end
 
+    def add_db_json(id = nil, **opts, &block)
+      opts = { id: id }.merge(opts) if id
+      db_json = DrawioDsl::Schema::DbJson.new(current_page, **opts, &block)
+      add_shape(db_json)
+    end
+
     def add_diamond(id = nil, **opts, &block)
       opts = { id: id }.merge(opts) if id
       diamond = DrawioDsl::Schema::Diamond.new(current_page, **opts, &block)

data/lib/drawio_dsl/drawio.rb

@@ -67,23 +67,4 @@ module DrawioDsl
       self
     end
   end
-
-  # DrawioDsl::DrawioPage is created when you call .page on the draw-io DSL.
-  class DrawioPage < KDirector::Directors::ChildDirector
-    include DrawioDsl::DrawioShapes
-
-    def initialize(parent, **opts)
-      super(parent, **opts)
-
-      builder.add_page(**opts)
-    end
-
-    def grid_layout(**opts)
-      builder.add_grid_layout(**opts)
-    end
-
-    def flex_layout(**opts)
-      builder.add_flex_layout(**opts)
-    end
-  end
 end

data/lib/drawio_dsl/drawio_extensions.rb

@@ -2,8 +2,9 @@
 
 module DrawioDsl
   # :nocov:
-  class DrawIoExtensions
-    include DrawioDsl::DrawIoExtensionsActive
+  # 1000's of extension shapes derived from Extensions.js that can be used via the add_shape method
+  class DrawioExtensions
+    include DrawioDsl::DrawioExtensionsActive
 
     attr_reader :sections
     attr_reader :current_section

data/lib/drawio_dsl/drawio_extensions_active.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module DrawioDsl
-  module DrawIoExtensionsActive
+  module DrawioExtensionsActive
     def apply_active_flags
       sections.each do |section|
         section[:shapes].each do |shape|

data/lib/drawio_dsl/drawio_page.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DrawioDsl
+  # DrawioDsl::DrawioPage is created when you call .page on the draw-io DSL.
+  class DrawioPage < KDirector::Directors::ChildDirector
+    include DrawioDsl::DrawioShapes
+
+    def initialize(parent, **opts)
+      super(parent, **opts)
+
+      builder.add_page(**opts)
+    end
+
+    def grid_layout(**opts)
+      builder.add_grid_layout(**opts)
+    end
+
+    def flex_layout(**opts)
+      builder.add_flex_layout(**opts)
+    end
+  end
+end

data/lib/drawio_dsl/drawio_shapes.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 module DrawioDsl
-  # DrawioDsl::Shapes is a list of DSL methods (one per shape)
+  # List of DSL methods for each common shape
   # :nocov:
   module DrawioShapes
     def random(**opts)
-      case rand(42)
+      case rand(43)
       when 0
         line(**opts)
       when 1
@@ -53,42 +53,44 @@ module DrawioDsl
       when 22
         database(**opts)
       when 23
-        diamond(**opts)
+        db_json(**opts)
       when 24
-        document(**opts)
+        diamond(**opts)
       when 25
-        ellipse(**opts)
+        document(**opts)
       when 26
-        hexagon(**opts)
+        ellipse(**opts)
       when 27
-        interface(**opts)
+        hexagon(**opts)
       when 28
-        klass(**opts)
+        interface(**opts)
       when 29
-        note(**opts)
+        klass(**opts)
       when 30
-        process(**opts)
+        note(**opts)
       when 31
-        rectangle(**opts)
+        process(**opts)
       when 32
-        rectangle2(**opts)
+        rectangle(**opts)
       when 33
-        square(**opts)
+        rectangle2(**opts)
       when 34
-        step(**opts)
+        square(**opts)
       when 35
-        tick(**opts)
+        step(**opts)
       when 36
-        todo(**opts)
+        tick(**opts)
       when 37
-        face(**opts)
+        todo(**opts)
       when 38
-        triangle(**opts)
+        face(**opts)
       when 39
-        embed_row(**opts)
+        triangle(**opts)
       when 40
-        embed_col50(**opts)
+        embed_row(**opts)
       when 41
+        embed_col50(**opts)
+      when 42
         embed_col200(**opts)
       end
     end
@@ -185,6 +187,10 @@ module DrawioDsl
       builder.add_database(id, **opts, &block)
     end
 
+    def db_json(id = nil, **opts, &block)
+      builder.add_db_json(id, **opts, &block)
+    end
+
     def diamond(id = nil, **opts, &block)
       builder.add_diamond(id, **opts, &block)
     end

data/lib/drawio_dsl/formatters/base_formatter.rb

@@ -4,7 +4,7 @@
 module DrawioDsl
   # HTML formatters can be used on shapes to render HTML using a DSL
   module Formatters
-    # Create an instance of a HTML formatter on the shape
+    # Base for any HTML formatter
     class BaseFormatter
       attr_reader :html
 

data/lib/drawio_dsl/formatters/html_builder.rb

@@ -4,7 +4,7 @@
 module DrawioDsl
   # HTML formatters can be used on shapes to render HTML using a DSL
   module Formatters
-    # Create an instance of a HTML formatter on the shape
+    # HTML builder has methods for common HTML elements that get written sequentially
     class HtmlBuilder
       attr_reader :element_style_defaults
 

data/lib/drawio_dsl/formatters/interface_formatter.rb

@@ -4,7 +4,7 @@
 module DrawioDsl
   # HTML formatters can be used on shapes to render HTML using a DSL
   module Formatters
-    # Create an instance of a HTML formatter on the shape
+    # Format the HTML to display an interface on a class diagram
     class InterfaceFormatter < BaseFormatter
       def initialize
         super({ p: { margin: '0px', margin_left: '4px', margin_top: '4px' } })

data/lib/drawio_dsl/formatters/klass_formatter.rb

@@ -4,7 +4,7 @@
 module DrawioDsl
   # HTML formatters can be used on shapes to render HTML using a DSL
   module Formatters
-    # Create an instance of a HTML formatter on the shape
+    # Format the HTML to display an class on a class diagram
     class KlassFormatter < BaseFormatter
       def initialize
         super({ p: { margin: '0px', margin_left: '4px', margin_top: '4px' } })

data/lib/drawio_dsl/formatters/style_builder.rb

@@ -4,7 +4,7 @@
 module DrawioDsl
   # HTML formatters can be used on shapes to render HTML using a DSL
   module Formatters
-    # Create an instance of a HTML formatter on the shape
+    # Build the style attribute for a HTML element
     class StyleBuilder
       MAPPINGS = {
         margin: 'margin',

data/lib/drawio_dsl/schema/_.rb

@@ -35,6 +35,7 @@ require_relative 'shapes/container4'
 require_relative 'shapes/cross'
 require_relative 'shapes/envelop'
 require_relative 'shapes/database'
+require_relative 'shapes/db_json'
 require_relative 'shapes/diamond'
 require_relative 'shapes/document'
 require_relative 'shapes/ellipse'

data/lib/drawio_dsl/schema/shapes/db_json.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DrawioDsl
+  module Schema
+    class DbJson < Shape
+      configure_shape(:db_json)
+    end
+  end
+end

data/lib/drawio_dsl/schema/shapes/shape.rb

@@ -119,8 +119,8 @@ module DrawioDsl
       # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
       def as_xml(xml)
-        log.error category
-        log.error type
+        # log.error category
+        # log.error type
         draw_element(xml) if category == :element
         draw_line(xml)    if category == :line
       end

data/lib/drawio_dsl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DrawioDsl
-  VERSION = '0.8.4'
+  VERSION = '0.8.5'
 end

data/lib/drawio_dsl/xml_builder.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module DrawioDsl
-  # DrawioDsl is a DSL for draw-io diagrams.
+  # Build the DrawioDsl XML file that is the basis of any draw-io diagrams.
   class XmlBuilder
     include KLog::Logging
 

data/lib/drawio_dsl.rb

@@ -21,6 +21,7 @@ require_relative 'drawio_dsl/layout_engine'
 require_relative 'drawio_dsl/drawio_shapes'
 require_relative 'drawio_dsl/drawio_extensions_active'
 require_relative 'drawio_dsl/drawio_extensions'
+require_relative 'drawio_dsl/drawio_page'
 require_relative 'drawio_dsl/drawio'
 
 module DrawioDsl

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "drawio_dsl",
-  "version": "0.8.4",
+  "version": "0.8.5",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "drawio_dsl",
-      "version": "0.8.4",
+      "version": "0.8.5",
       "devDependencies": {
         "@klueless-js/semantic-release-rubygem": "github:klueless-js/semantic-release-rubygem",
         "@semantic-release/changelog": "^6.0.1",

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "drawio_dsl",
-  "version": "0.8.4",
+  "version": "0.8.5",
   "description": "DrawIO DSL can build DrawIO diagrams using a Domain Specific Language",
   "scripts": {
     "release": "semantic-release"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: drawio_dsl
 version: !ruby/object:Gem::Version
-  version: 0.8.4
+  version: 0.8.5
 platform: ruby
 authors:
 - David Cruwys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-17 00:00:00.000000000 Z
+date: 2022-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: k_config
@@ -89,6 +89,8 @@ files:
 - ".builders/generators/10-transform-drawio-js.rb"
 - ".builders/generators/20-drawio-extensions.rb"
 - ".builders/generators/domain_diagram.rb"
+- ".builders/generators/parking-map.png"
+- ".builders/generators/parking_app.rb"
 - ".builders/generators/printspeak-architecture-generator.rb"
 - ".builders/generators/project-plan.rb"
 - ".builders/generators/sample_diagrams/05-samples.rb"
@@ -113,8 +115,11 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- docs/domain.drawio
-- docs/domain_model.svg
+- docs/domain-modal.md
+- docs/domain-modal/domain_model.drawio
+- docs/domain-modal/domain_model.svg
+- docs/domain-modal/domain_model_custom.drawio
+- docs/domain-modal/domain_model_custom.png
 - docs/extensions.md
 - docs/extensions/analyti_cs.svg
 - docs/extensions/android_inputs.svg
@@ -269,6 +274,10 @@ files:
 - docs/extensions/venn_gradient.svg
 - docs/extensions/venn_plain.svg
 - docs/extensions/vessels.svg
+- docs/parking_app.drawio
+- docs/parking_app.svg
+- docs/printspeak-architecture-generator.drawio
+- docs/printspeak-architecture-generator.svg
 - docs/project-plan.md
 - docs/project-plan/project.drawio
 - docs/project-plan/project_done.svg
@@ -301,6 +310,7 @@ files:
 - lib/drawio_dsl/drawio_extensions.json
 - lib/drawio_dsl/drawio_extensions.rb
 - lib/drawio_dsl/drawio_extensions_active.rb
+- lib/drawio_dsl/drawio_page.rb
 - lib/drawio_dsl/drawio_shapes.rb
 - lib/drawio_dsl/formatters/_.rb
 - lib/drawio_dsl/formatters/base_formatter.rb
@@ -334,6 +344,7 @@ files:
 - lib/drawio_dsl/schema/shapes/container4.rb
 - lib/drawio_dsl/schema/shapes/cross.rb
 - lib/drawio_dsl/schema/shapes/database.rb
+- lib/drawio_dsl/schema/shapes/db_json.rb
 - lib/drawio_dsl/schema/shapes/diamond.rb
 - lib/drawio_dsl/schema/shapes/document.rb
 - lib/drawio_dsl/schema/shapes/ellipse.rb

data/docs/domain.drawio

@@ -1,31 +0,0 @@
-<mxfile host="65bd71144e">
-    <diagram id="X2d" name="Style-Plain">
-        <mxGraphModel dx="862" dy="583" grid="0" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="1169" pageHeight="827" background="#fafafa" math="0" shadow="0">
-            <root>
-                <mxCell id="page_root_X2d"/>
-                <mxCell id="node_root_X2d" parent="page_root_X2d"/>
-                <mxCell id="X2d-2" value="&lt;p style=&quot;margin:0px;margin-left:4px;margin-top:4px;text-align:center&quot;&gt;&lt;b&gt;Container&lt;/b&gt;&lt;/p&gt;&lt;hr size=&quot;1&quot;/&gt;" style="whiteSpace=wrap;html=1;rounded=0;fillColor=#ffe6cc;strokeColor=#d79b00;fontColor=#333333;align=left;overflow=fill;fontSize=12;fontFamily=Helvetica" parent="node_root_X2d" vertex="1">
-                    <mxGeometry x="30" y="30" width="160" height="160" as="geometry"/>
-                </mxCell>
-                <mxCell id="X2d-3" value="&lt;p style=&quot;margin:0px;margin-left:4px;margin-top:4px;text-align:center&quot;&gt;&lt;i&gt;&amp;lt;&amp;lt; MixIn &amp;gt;&amp;gt;&lt;/i&gt;&lt;/p&gt;&lt;p style=&quot;margin:0px;margin-left:4px;margin-top:4px;text-align:center&quot;&gt;&lt;b&gt;Block Processor&lt;/b&gt;&lt;/p&gt;&lt;hr size=&quot;1&quot;/&gt;" style="whiteSpace=wrap;html=1;rounded=0;fillColor=#dae8fc;strokeColor=#6c8ebf;fontColor=#333333;align=left;overflow=fill;fontSize=12;fontFamily=Helvetica" parent="node_root_X2d" vertex="1">
-                    <mxGeometry x="250" y="30" width="160" height="160" as="geometry"/>
-                </mxCell>
-                <mxCell id="X2d-4" value="Documents" style="whiteSpace=wrap;html=1;rounded=0;fillColor=#f5f5f5;strokeColor=#666666;fontColor=#333333" parent="node_root_X2d" vertex="1">
-                    <mxGeometry x="470" y="30" width="160" height="160" as="geometry"/>
-                </mxCell>
-                <mxCell id="X2d-5" value="&lt;p style=&quot;margin:0px;margin-left:4px;margin-top:4px;text-align:center&quot;&gt;&lt;i&gt;&amp;lt;&amp;lt; MixIn &amp;gt;&amp;gt;&lt;/i&gt;&lt;/p&gt;&lt;p style=&quot;margin:0px;margin-left:4px;margin-top:4px;text-align:center&quot;&gt;&lt;b&gt;Block Processor&lt;/b&gt;&lt;/p&gt;&lt;hr size=&quot;1&quot;/&gt;&lt;p style=&quot;margin:0px;margin-left:4px;margin-top:4px&quot;&gt;block: proc&lt;/p&gt;&lt;p style=&quot;margin:0px;margin-left:4px;margin-top:4px&quot;&gt;block_state: symbol&lt;/p&gt;&lt;hr size=&quot;1&quot;/&gt;&lt;p style=&quot;margin:0px;margin-left:4px;margin-top:4px&quot;&gt;depend_on()&lt;/p&gt;" style="whiteSpace=wrap;html=1;rounded=0;fillColor=#dae8fc;strokeColor=#6c8ebf;fontColor=#333333;align=left;overflow=fill;fontSize=12;fontFamily=Helvetica" parent="node_root_X2d" vertex="1">
-                    <mxGeometry x="690" y="30" width="160" height="160" as="geometry"/>
-                </mxCell>
-                <mxCell id="4tbYCbTjaN7O87TdMOiT-0" value="&lt;div style=&quot;color: rgb(212 , 212 , 212) ; background-color: rgb(30 , 30 , 30) ; font-family: &amp;#34;menlo&amp;#34; , &amp;#34;monaco&amp;#34; , &amp;#34;courier new&amp;#34; , monospace ; line-height: 18px&quot;&gt;&lt;span style=&quot;color: #ce9178&quot;&gt;db_schema.json&lt;/span&gt;&lt;/div&gt;" style="shape=cylinder3;whiteSpace=wrap;html=1;boundedLbl=1;backgroundOutline=1;size=15;" vertex="1" parent="node_root_X2d">
-                    <mxGeometry x="50" y="199" width="60" height="80" as="geometry"/>
-                </mxCell>
-                <mxCell id="4tbYCbTjaN7O87TdMOiT-1" value="11111111" style="shape=datastore;whiteSpace=wrap;html=1;" vertex="1" parent="node_root_X2d">
-                    <mxGeometry x="182" y="112" width="60" height="60" as="geometry"/>
-                </mxCell>
-                <mxCell id="4tbYCbTjaN7O87TdMOiT-2" value="db_schema.json" style="strokeWidth=1;html=1;shape=mxgraph.flowchart.database;whiteSpace=wrap;" vertex="1" parent="node_root_X2d">
-                    <mxGeometry x="193" y="249" width="138" height="60" as="geometry"/>
-                </mxCell>
-            </root>
-        </mxGraphModel>
-    </diagram>
-</mxfile>

data/docs/domain_model.svg

@@ -1,3 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
-<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="822px" height="162px" viewBox="-0.5 -0.5 822 162"><defs/><g><rect x="0" y="0" width="160" height="160" fill="#ffe6cc" stroke="#d79b00" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe flex-start; width: 162px; height: 160px; padding-top: 0px; margin-left: 0px;"><div data-drawio-colors="color: #333333; " style="box-sizing: border-box; font-size: 0px; text-align: left; width: 160px; height: 160px; overflow: hidden;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(51, 51, 51); line-height: 1.2; pointer-events: all; width: 100%; height: 100%; white-space: normal; overflow-wrap: normal;"><p style="margin: 0px ; margin-left: 4px ; margin-top: 4px ; text-align: center"><b>Container</b></p><hr size="1" /></div></div></div></foreignObject><text x="0" y="84" fill="#333333" font-family="Helvetica" font-size="12px">Container</text></switch></g><rect x="220" y="0" width="160" height="160" fill="#dae8fc" stroke="#6c8ebf" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe flex-start; width: 162px; height: 160px; padding-top: 0px; margin-left: 220px;"><div data-drawio-colors="color: #333333; " style="box-sizing: border-box; font-size: 0px; text-align: left; width: 160px; height: 160px; overflow: hidden;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(51, 51, 51); line-height: 1.2; pointer-events: all; width: 100%; height: 100%; white-space: normal; overflow-wrap: normal;"><p style="margin: 0px ; margin-left: 4px ; margin-top: 4px ; text-align: center"><i>&lt;&lt; MixIn &gt;&gt;</i></p><p style="margin: 0px ; margin-left: 4px ; margin-top: 4px ; text-align: center"><b>Block Processor</b></p><hr size="1" /></div></div></div></foreignObject><text x="220" y="84" fill="#333333" font-family="Helvetica" font-size="12px">&lt;&lt; MixIn &gt;&gt;...</text></switch></g><rect x="440" y="0" width="160" height="160" fill="#f5f5f5" stroke="#666666" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 158px; height: 1px; padding-top: 80px; margin-left: 441px;"><div data-drawio-colors="color: #333333; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(51, 51, 51); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">Documents</div></div></div></foreignObject><text x="520" y="84" fill="#333333" font-family="Helvetica" font-size="12px" text-anchor="middle">Documents</text></switch></g><rect x="660" y="0" width="160" height="160" fill="#dae8fc" stroke="#6c8ebf" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe flex-start; width: 162px; height: 160px; padding-top: 0px; margin-left: 660px;"><div data-drawio-colors="color: #333333; " style="box-sizing: border-box; font-size: 0px; text-align: left; width: 160px; height: 160px; overflow: hidden;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(51, 51, 51); line-height: 1.2; pointer-events: all; width: 100%; height: 100%; white-space: normal; overflow-wrap: normal;"><p style="margin: 0px ; margin-left: 4px ; margin-top: 4px ; text-align: center"><i>&lt;&lt; MixIn &gt;&gt;</i></p><p style="margin: 0px ; margin-left: 4px ; margin-top: 4px ; text-align: center"><b>Block Processor</b></p><hr size="1" /><p style="margin: 0px ; margin-left: 4px ; margin-top: 4px">block: proc</p><p style="margin: 0px ; margin-left: 4px ; margin-top: 4px">block_state: symbol</p><hr size="1" /><p style="margin: 0px ; margin-left: 4px ; margin-top: 4px">depend_on()</p></div></div></div></foreignObject><text x="660" y="84" fill="#333333" font-family="Helvetica" font-size="12px">&lt;&lt; MixIn &gt;&gt;...</text></switch></g></g><switch><g requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"/><a transform="translate(0,-5)" xlink:href="https://www.diagrams.net/doc/faq/svg-export-text-problems" target="_blank"><text text-anchor="middle" font-size="10px" x="50%" y="100%">Text is not SVG - cannot display</text></a></switch></svg>