drawio_dsl 0.8.2 → 0.8.5

data/lib/drawio_dsl/configuration_shapes.rb

@@ -3,11 +3,12 @@
 # Attach configuration to the DrawIO DSL module
 # :nocov:
 module DrawioDsl
-  # Used to attach configuration to KConfig module
+  # Attach predefined shapes DrawIO KConfig module
   module ConfigurationShapes
     ShapeDefaults = Struct.new(:type, :category, :x, :y, :w, :h, :style_modifiers, keyword_init: true)
     Shapes = Struct.new(
       :shape,
+      :line,
       :h1,
       :h2,
       :h3,
@@ -29,6 +30,8 @@ module DrawioDsl
       :container4,
       :cross,
       :envelop,
+      :database,
+      :db_json,
       :diamond,
       :document,
       :ellipse,
@@ -45,7 +48,6 @@ module DrawioDsl
       :todo,
       :face,
       :triangle,
-      :line,
       :embed_row,
       :embed_col50,
       :embed_col200,
@@ -55,6 +57,7 @@ module DrawioDsl
     def add_shapes
       @shapes = Shapes.new(
         shape: ShapeDefaults.new(type: :shape, category: :element, x: 0, y: 0, w: 20, h: 20, style_modifiers: ''),
+        line: ShapeDefaults.new(type: :line, x: 0, category: :line, y: 0, w: 50, h: 50, style_modifiers: 'edgeStyle=none;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0'),
         h1: ShapeDefaults.new(type: :h1, x: 0, category: :text, y: 0, w: 100, h: 50, style_modifiers: 'text;fontSize=89;fontColor=#ffffff;fontStyle=1;fillColor=none'),
         h2: ShapeDefaults.new(type: :h2, x: 0, category: :text, y: 0, w: 100, h: 50, style_modifiers: 'text;fontSize=67;fontColor=#ffffff;fontStyle=1;fillColor=none'),
         h3: ShapeDefaults.new(type: :h3, x: 0, category: :text, y: 0, w: 100, h: 50, style_modifiers: 'text;fontSize=50;fontColor=#ffffff;fontStyle=1;fillColor=none'),
@@ -76,6 +79,8 @@ module DrawioDsl
         container4: ShapeDefaults.new(type: :container4, x: 0, category: :element, y: 0, w: 160, h: 160, style_modifiers: 'swimlane;resizable=0'),
         cross: ShapeDefaults.new(type: :cross, x: 0, category: :element, y: 0, w: 50, h: 50, style_modifiers: 'verticalLabelPosition=bottom;verticalAlign=top;html=1;shape=mxgraph.basic.x'),
         envelop: ShapeDefaults.new(type: :envelop, x: 0, category: :element, y: 0, w: 160, h: 100, style_modifiers: 'shape=message'),
+        database: ShapeDefaults.new(type: :database, x: 0, category: :element, y: 0, w: 160, h: 80, style_modifiers: 'shape=mxgraph.flowchart.database;strokeWidth=1'),
+        db_json: ShapeDefaults.new(type: :db_json, x: 0, category: :element, y: 0, w: 160, h: 40, style_modifiers: 'shape=mxgraph.flowchart.database;strokeWidth=1'),
         diamond: ShapeDefaults.new(type: :diamond, x: 0, category: :element, y: 0, w: 100, h: 100, style_modifiers: 'rhombus'),
         document: ShapeDefaults.new(type: :document, x: 0, category: :element, y: 0, w: 160, h: 160, style_modifiers: 'shape=mxgraph.basic.document'),
         ellipse: ShapeDefaults.new(type: :ellipse, x: 0, category: :element, y: 0, w: 200, h: 120, style_modifiers: 'ellipse'),
@@ -92,7 +97,6 @@ module DrawioDsl
         todo: ShapeDefaults.new(type: :todo, x: 0, category: :element, y: 0, w: 300, h: 60, style_modifiers: ''),
         face: ShapeDefaults.new(type: :face, x: 0, category: :element, y: 0, w: 100, h: 100, style_modifiers: 'verticalLabelPosition=bottom;verticalAlign=top;shape=mxgraph.basic.smiley'),
         triangle: ShapeDefaults.new(type: :triangle, x: 0, category: :element, y: 0, w: 100, h: 100, style_modifiers: 'triangle'),
-        line: ShapeDefaults.new(type: :line, x: 0, category: :line, y: 0, w: 50, h: 50, style_modifiers: 'edgeStyle=entityRelationEdgeStyle;strokeWidth=1;elbow=vertical;startArrow=none;startFill=0;endArrow=block;endFill=0;targetPerimeterSpacing=0;shape=flexArrow;endSize=6;fillStyle=zigzag;'),
         embed_row: ShapeDefaults.new(type: :embed_row, x: 0, category: :element, y: 0, w: 200, h: 40, style_modifiers: 'shape=partialRectangle;collapsible=0;dropTarget=0;pointerEvents=0;top=0;left=0;bottom=1;right=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest'),
         embed_col50: ShapeDefaults.new(type: :embed_col50, x: 0, category: :element, y: 0, w: 50, h: 40, style_modifiers: 'shape=partialRectangle;connectable=0;top=0;left=0;bottom=0;right=0;fontStyle=1;overflow=hidden'),
         embed_col200: ShapeDefaults.new(type: :embed_col200, x: 0, category: :element, y: 0, w: 150, h: 40, style_modifiers: 'shape=partialRectangle;connectable=0;top=0;left=0;bottom=0;right=0;align=left;spacingLeft=6;overflow=hidden')

data/lib/drawio_dsl/dom_builder.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module DrawioDsl
-  # DrawioDsl is a DSL for draw-io diagrams.
+  # Build Document object model to represent DrawioDsl output file.
   class DomBuilder
     include DomBuilderShapes
 

data/lib/drawio_dsl/dom_builder_shapes.rb

@@ -2,8 +2,14 @@
 
 # :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
+      line = DrawioDsl::Schema::Line.new(current_page, **opts, &block)
+      add_shape(line)
+    end
+
     def add_h1(id = nil, **opts, &block)
       opts = { id: id }.merge(opts) if id
       h1 = DrawioDsl::Schema::H1.new(current_page, **opts, &block)
@@ -130,6 +136,18 @@ module DrawioDsl
       add_shape(envelop)
     end
 
+    def add_database(id = nil, **opts, &block)
+      opts = { id: id }.merge(opts) if id
+      database = DrawioDsl::Schema::Database.new(current_page, **opts, &block)
+      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)
@@ -226,12 +244,6 @@ module DrawioDsl
       add_shape(triangle)
     end
 
-    def add_line(id = nil, **opts, &block)
-      opts = { id: id }.merge(opts) if id
-      line = DrawioDsl::Schema::Line.new(current_page, **opts, &block)
-      add_shape(line)
-    end
-
     def add_embed_row(id = nil, **opts, &block)
       opts = { id: id }.merge(opts) if id
       embed_row = DrawioDsl::Schema::EmbedRow.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,96 +1,104 @@
 # 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(41)
+      case rand(43)
       when 0
-        h1(**opts)
+        line(**opts)
       when 1
-        h2(**opts)
+        h1(**opts)
       when 2
-        h3(**opts)
+        h2(**opts)
       when 3
-        h4(**opts)
+        h3(**opts)
       when 4
-        h5(**opts)
+        h4(**opts)
       when 5
-        h6(**opts)
+        h5(**opts)
       when 6
-        p(**opts)
+        h6(**opts)
       when 7
-        actor(**opts)
+        p(**opts)
       when 8
-        actor2(**opts)
+        actor(**opts)
       when 9
-        callout(**opts)
+        actor2(**opts)
       when 10
-        callout2(**opts)
+        callout(**opts)
       when 11
-        callout3(**opts)
+        callout2(**opts)
       when 12
-        callout4(**opts)
+        callout3(**opts)
       when 13
-        circle(**opts)
+        callout4(**opts)
       when 14
-        cloud(**opts)
+        circle(**opts)
       when 15
-        container(**opts)
+        cloud(**opts)
       when 16
-        container2(**opts)
+        container(**opts)
       when 17
-        container3(**opts)
+        container2(**opts)
       when 18
-        container4(**opts)
+        container3(**opts)
       when 19
-        cross(**opts)
+        container4(**opts)
       when 20
-        envelop(**opts)
+        cross(**opts)
       when 21
-        diamond(**opts)
+        envelop(**opts)
       when 22
-        document(**opts)
+        database(**opts)
       when 23
-        ellipse(**opts)
+        db_json(**opts)
       when 24
-        hexagon(**opts)
+        diamond(**opts)
       when 25
-        interface(**opts)
+        document(**opts)
       when 26
-        klass(**opts)
+        ellipse(**opts)
       when 27
-        note(**opts)
+        hexagon(**opts)
       when 28
-        process(**opts)
+        interface(**opts)
       when 29
-        rectangle(**opts)
+        klass(**opts)
       when 30
-        rectangle2(**opts)
+        note(**opts)
       when 31
-        square(**opts)
+        process(**opts)
       when 32
-        step(**opts)
+        rectangle(**opts)
       when 33
-        tick(**opts)
+        rectangle2(**opts)
       when 34
-        todo(**opts)
+        square(**opts)
       when 35
-        face(**opts)
+        step(**opts)
       when 36
-        triangle(**opts)
+        tick(**opts)
       when 37
-        line(**opts)
+        todo(**opts)
       when 38
-        embed_row(**opts)
+        face(**opts)
       when 39
-        embed_col50(**opts)
+        triangle(**opts)
       when 40
+        embed_row(**opts)
+      when 41
+        embed_col50(**opts)
+      when 42
         embed_col200(**opts)
       end
     end
 
+    def line(id = nil, **opts, &block)
+      builder.add_line(id, **opts, &block)
+    end
+
     def h1(id = nil, **opts, &block)
       builder.add_h1(id, **opts, &block)
     end
@@ -175,6 +183,14 @@ module DrawioDsl
       builder.add_envelop(id, **opts, &block)
     end
 
+    def database(id = nil, **opts, &block)
+      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
@@ -239,10 +255,6 @@ module DrawioDsl
       builder.add_triangle(id, **opts, &block)
     end
 
-    def line(id = nil, **opts, &block)
-      builder.add_line(id, **opts, &block)
-    end
-
     def embed_row(id = nil, **opts, &block)
       builder.add_embed_row(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

@@ -12,6 +12,7 @@ require_relative 'layouts/flex_layout'
 require_relative 'layouts/grid_layout'
 
 require_relative 'shapes/shape'
+require_relative 'shapes/line'
 require_relative 'shapes/h1'
 require_relative 'shapes/h2'
 require_relative 'shapes/h3'
@@ -33,6 +34,8 @@ require_relative 'shapes/container3'
 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'
@@ -49,7 +52,6 @@ require_relative 'shapes/tick'
 require_relative 'shapes/todo'
 require_relative 'shapes/face'
 require_relative 'shapes/triangle'
-require_relative 'shapes/line'
 require_relative 'shapes/embed_row'
 require_relative 'shapes/embed_col50'
 require_relative 'shapes/embed_col200'

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

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

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

@@ -47,6 +47,9 @@ module DrawioDsl
       attr_accessor :h
       attr_accessor :style_modifiers
 
+      attr_accessor :source
+      attr_accessor :target
+
       def initialize(page, **args, &block)
         args[:classification] = :shape
         super(page, **args)
@@ -83,6 +86,9 @@ module DrawioDsl
         @h                = args[:h]                || shape_defaults.h
         @style_modifiers  = args[:style_modifiers]  || shape_defaults.style_modifiers
 
+        @source           = args[:source]
+        @target           = args[:target]
+
         @fill_color       = args[:fill_color]       || (category == :text ? nil : theme_palette.fill_color)
         @stroke_color     = args[:stroke_color]     || (category == :text ? nil : theme_palette.stroke_color)
         @gradient         = args[:gradient]         || (category == :text ? nil : theme_palette.gradient)
@@ -113,11 +119,24 @@ module DrawioDsl
       # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
       def as_xml(xml)
+        # log.error category
+        # log.error type
+        draw_element(xml) if category == :element
+        draw_line(xml)    if category == :line
+      end
+
+      def draw_element(xml)
         xml.mxCell(id: id, value: value, style: style, vertex: 1, parent: parent&.id) do
           xml.mxGeometry(x: x, y: y, width: w, height: h, as: 'geometry')
         end
       end
 
+      def draw_line(xml)
+        xml.mxCell(id: id, value: value, style: style, parent: parent&.id, source: source, target: target, edge: 1) do
+          xml.mxGeometry(relative: 1, as: 'geometry')
+        end
+      end
+
       def to_h
         result = {
           id: id,

data/lib/drawio_dsl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DrawioDsl
-  VERSION = '0.8.2'
+  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.2",
+  "version": "0.8.5",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "drawio_dsl",
-      "version": "0.8.2",
+      "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.2",
+  "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.2
+  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
@@ -88,6 +88,10 @@ files:
 - ".builders/generators/02-generate-app.rb"
 - ".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"
 - ".builders/generators/sample_diagrams/10-page-margin.rb"
@@ -111,6 +115,11 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- 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
@@ -265,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
@@ -297,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
@@ -329,6 +343,8 @@ files:
 - lib/drawio_dsl/schema/shapes/container3.rb
 - 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