drawio_dsl 0.8.5 → 0.8.8

data/lib/drawio_dsl/configuration_shapes.rb

@@ -3,7 +3,7 @@
 # Attach configuration to the DrawIO DSL module
 # :nocov:
 module DrawioDsl
-  # Attach predefined shapes DrawIO KConfig module
+  # Used to attach configuration to KConfig module
   module ConfigurationShapes
     ShapeDefaults = Struct.new(:type, :category, :x, :y, :w, :h, :style_modifiers, keyword_init: true)
     Shapes = Struct.new(
@@ -35,6 +35,7 @@ module DrawioDsl
       :diamond,
       :document,
       :ellipse,
+      :group,
       :hexagon,
       :interface,
       :klass,
@@ -84,6 +85,7 @@ module DrawioDsl
         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'),
+        group: ShapeDefaults.new(type: :group, x: 0, category: :element, y: 0, w: 210, h: 210, style_modifiers: 'fontSize=20;verticalAlign=top'),
         hexagon: ShapeDefaults.new(type: :hexagon, x: 0, category: :element, y: 0, w: 200, h: 120, style_modifiers: 'shape=hexagon'),
         interface: ShapeDefaults.new(type: :interface, x: 0, category: :element, y: 0, w: 160, h: 160, style_modifiers: 'align=left;overflow=fill;fontSize=12;fontFamily=Helvetica'),
         klass: ShapeDefaults.new(type: :klass, x: 0, category: :element, y: 0, w: 160, h: 160, style_modifiers: 'align=left;overflow=fill;fontSize=12;fontFamily=Helvetica'),

data/lib/drawio_dsl/dom_builder_shapes.rb

@@ -2,7 +2,7 @@
 
 # :nocov:
 module DrawioDsl
-  # Builder methods for each shape, line and text element to attach to DomBuilder.
+  # DrawioDsl is a DSL for draw-io diagrams.
   module DomBuilderShapes
     def add_line(id = nil, **opts, &block)
       opts = { id: id }.merge(opts) if id
@@ -166,6 +166,12 @@ module DrawioDsl
       add_shape(ellipse)
     end
 
+    def add_group(id = nil, **opts, &block)
+      opts = { id: id }.merge(opts) if id
+      group = DrawioDsl::Schema::Group.new(current_page, **opts, &block)
+      add_shape(group)
+    end
+
     def add_hexagon(id = nil, **opts, &block)
       opts = { id: id }.merge(opts) if id
       hexagon = DrawioDsl::Schema::Hexagon.new(current_page, **opts, &block)

data/lib/drawio_dsl/drawio.rb

@@ -19,6 +19,7 @@ module DrawioDsl
 
       layout = DrawioDsl::LayoutEngine.new(builder.current_page)
       layout.call
+
       self
     end
 
@@ -37,6 +38,21 @@ module DrawioDsl
       save(file_name, **{ open: :write }.merge(opts))
     end
 
+    def save_json(file_name, **opts)
+      return unless last_save_file_name
+      return unless File.exist?(last_save_file_name)
+
+      file_name = "#{file_name}.json" unless file_name.end_with?('.json')
+
+      add(file_name, content: JSON.pretty_generate(builder.dom), **opts)
+
+      self
+    end
+
+    def osave_json(file_name, **opts)
+      save_json(file_name, **{ open: :write }.merge(opts))
+    end
+
     def export_svg(output_file_name, page: 1)
       return unless last_save_file_name
       return unless File.exist?(last_save_file_name)

data/lib/drawio_dsl/drawio_shapes.rb

@@ -5,7 +5,7 @@ module DrawioDsl
   # :nocov:
   module DrawioShapes
     def random(**opts)
-      case rand(43)
+      case rand(44)
       when 0
         line(**opts)
       when 1
@@ -61,36 +61,38 @@ module DrawioDsl
       when 26
         ellipse(**opts)
       when 27
-        hexagon(**opts)
+        group(**opts)
       when 28
-        interface(**opts)
+        hexagon(**opts)
       when 29
-        klass(**opts)
+        interface(**opts)
       when 30
-        note(**opts)
+        klass(**opts)
       when 31
-        process(**opts)
+        note(**opts)
       when 32
-        rectangle(**opts)
+        process(**opts)
       when 33
-        rectangle2(**opts)
+        rectangle(**opts)
       when 34
-        square(**opts)
+        rectangle2(**opts)
       when 35
-        step(**opts)
+        square(**opts)
       when 36
-        tick(**opts)
+        step(**opts)
       when 37
-        todo(**opts)
+        tick(**opts)
       when 38
-        face(**opts)
+        todo(**opts)
       when 39
-        triangle(**opts)
+        face(**opts)
       when 40
-        embed_row(**opts)
+        triangle(**opts)
       when 41
-        embed_col50(**opts)
+        embed_row(**opts)
       when 42
+        embed_col50(**opts)
+      when 43
         embed_col200(**opts)
       end
     end
@@ -203,6 +205,10 @@ module DrawioDsl
       builder.add_ellipse(id, **opts, &block)
     end
 
+    def group(id = nil, **opts, &block)
+      builder.add_group(id, **opts, &block)
+    end
+
     def hexagon(id = nil, **opts, &block)
       builder.add_hexagon(id, **opts, &block)
     end

data/lib/drawio_dsl/formatters/base_formatter.rb

@@ -12,6 +12,78 @@ module DrawioDsl
         @html = DrawioDsl::Formatters::HtmlBuilder.new(element_style_defaults)
       end
 
+      def hr(size: 1)
+        html.hr(size: size)
+
+        self
+      end
+
+      def b(content, **opts)
+        html.b(content, **opts)
+
+        self
+      end
+
+      def p(content, **opts)
+        html.p(content, **opts)
+
+        self
+      end
+
+      def h1(content, **opts)
+        html.h1(content, **opts)
+
+        self
+      end
+
+      def h2(content, **opts)
+        html.h2(content, **opts)
+
+        self
+      end
+
+      def h3(content, **opts)
+        html.h3(content, **opts)
+
+        self
+      end
+
+      def h4(content, **opts)
+        html.h4(content, **opts)
+
+        self
+      end
+
+      def h5(content, **opts)
+        html.h5(content, **opts)
+
+        self
+      end
+
+      def h6(content, **opts)
+        html.h6(content, **opts)
+
+        self
+      end
+
+      def ul_s(**opts)
+        html.ul_s(**opts)
+
+        self
+      end
+
+      def ul_e(**opts)
+        html.ul_e(**opts)
+
+        self
+      end
+
+      def li(content, **opts)
+        html.li(content, **opts)
+
+        self
+      end
+
       def empty?
         html.empty?
       end
@@ -19,6 +91,54 @@ module DrawioDsl
       def as_html(new_line: false)
         html.as_html(new_line: new_line)
       end
+
+      private
+
+      # useful defaults
+
+      def ratio
+        @ratio ||= 1.2
+      end
+
+      def base_margin_bottom
+        @base_margin_bottom ||= 4
+      end
+
+      def p_margin_bottom
+        @p_margin_bottom ||= base_margin_bottom
+      end
+
+      def b_margin_bottom
+        @b_margin_bottom ||= base_margin_bottom
+      end
+
+      def li_margin_bottom
+        @li_margin_bottom ||= base_margin_bottom
+      end
+
+      def h6_margin_bottom
+        @h6_margin_bottom ||= base_margin_bottom
+      end
+
+      def h5_margin_bottom
+        @h5_margin_bottom ||= h6_margin_bottom * ratio
+      end
+
+      def h4_margin_bottom
+        @h4_margin_bottom ||= h5_margin_bottom * ratio
+      end
+
+      def h3_margin_bottom
+        @h3_margin_bottom ||= h4_margin_bottom * ratio
+      end
+
+      def h2_margin_bottom
+        @h2_margin_bottom ||= h3_margin_bottom * ratio
+      end
+
+      def h1_margin_bottom
+        @h1_margin_bottom ||= h2_margin_bottom * ratio
+      end
     end
   end
 end

data/lib/drawio_dsl/formatters/html_builder.rb

@@ -12,6 +12,9 @@ module DrawioDsl
         @element_style_defaults = element_style_defaults
       end
 
+      # Access the default styles for a HTML element
+      #
+      # Formatters can define the defaults styles for HTML elements such as <p>, <h1>, etc.
       def default_for(tag)
         element_style_defaults[tag] || {}
       end
@@ -48,6 +51,42 @@ module DrawioDsl
         add_line("<p#{style_for(:p, **opts)}>#{content}</p>")
       end
 
+      def h1(content, **opts)
+        add_line("<h1#{style_for(:h1, **opts)}>#{content}</h1>")
+      end
+
+      def h2(content, **opts)
+        add_line("<h2#{style_for(:h2, **opts)}>#{content}</h2>")
+      end
+
+      def h3(content, **opts)
+        add_line("<h3#{style_for(:h3, **opts)}>#{content}</h3>")
+      end
+
+      def h4(content, **opts)
+        add_line("<h4#{style_for(:h4, **opts)}>#{content}</h4>")
+      end
+
+      def h5(content, **opts)
+        add_line("<h5#{style_for(:h5, **opts)}>#{content}</h5>")
+      end
+
+      def h6(content, **opts)
+        add_line("<h6#{style_for(:h6, **opts)}>#{content}</h6>")
+      end
+
+      def li(content, **opts)
+        add_line("<li#{style_for(:li, **opts)}>#{content}</li>")
+      end
+
+      def ul_s(**opts)
+        add_line("<ul#{style_for(:ul, **opts)}>")
+      end
+
+      def ul_e(**_opts)
+        add_line('</ul>')
+      end
+
       def add_line(line)
         lines << line
       end

data/lib/drawio_dsl/formatters/interface_formatter.rb

@@ -7,7 +7,19 @@ module DrawioDsl
     # 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' } })
+        super(
+          {
+            p: { margin: '0px', margin_left: '4px', margin_bottom: "#{p_margin_bottom}px" },
+            b: { margin: '0px', margin_left: '4px', margin_bottom: "#{b_margin_bottom}px" },
+            h1: { margin: '0px', margin_left: '4px', margin_bottom: "#{h1_margin_bottom}px" },
+            h2: { margin: '0px', margin_left: '4px', margin_bottom: "#{h2_margin_bottom}px" },
+            h3: { margin: '0px', margin_left: '4px', margin_bottom: "#{h3_margin_bottom}px" },
+            h4: { margin: '0px', margin_left: '4px', margin_bottom: "#{h4_margin_bottom}px" },
+            h5: { margin: '0px', margin_left: '4px', margin_bottom: "#{h5_margin_bottom}px" },
+            h6: { margin: '0px', margin_left: '4px', margin_bottom: "#{h6_margin_bottom}px" },
+            li: { margin: '0px', margin_left: '4px', margin_bottom: "#{li_margin_bottom}px" }
+          }
+        )
       end
 
       def header(name, description: nil, interface_type: 'Interface')

data/lib/drawio_dsl/formatters/klass_formatter.rb

@@ -7,7 +7,19 @@ module DrawioDsl
     # 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' } })
+        super(
+          {
+            p: { margin: '0px', margin_left: '4px', margin_bottom: "#{p_margin_bottom}px" },
+            b: { margin: '0px', margin_left: '4px', margin_bottom: "#{b_margin_bottom}px" },
+            h1: { margin: '0px', margin_left: '4px', margin_bottom: "#{h1_margin_bottom}px" },
+            h2: { margin: '0px', margin_left: '4px', margin_bottom: "#{h2_margin_bottom}px" },
+            h3: { margin: '0px', margin_left: '4px', margin_bottom: "#{h3_margin_bottom}px" },
+            h4: { margin: '0px', margin_left: '4px', margin_bottom: "#{h4_margin_bottom}px" },
+            h5: { margin: '0px', margin_left: '4px', margin_bottom: "#{h5_margin_bottom}px" },
+            h6: { margin: '0px', margin_left: '4px', margin_bottom: "#{h6_margin_bottom}px" },
+            li: { margin: '0px', margin_left: '4px', margin_bottom: "#{li_margin_bottom}px" }
+          }
+        )
       end
 
       def header(name, description: nil)

data/lib/drawio_dsl/schema/_.rb

@@ -39,6 +39,7 @@ require_relative 'shapes/db_json'
 require_relative 'shapes/diamond'
 require_relative 'shapes/document'
 require_relative 'shapes/ellipse'
+require_relative 'shapes/group'
 require_relative 'shapes/hexagon'
 require_relative 'shapes/interface'
 require_relative 'shapes/klass'

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

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

data/lib/drawio_dsl/version.rb

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

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "drawio_dsl",
-  "version": "0.8.5",
+  "version": "0.8.8",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "drawio_dsl",
-      "version": "0.8.5",
+      "version": "0.8.8",
       "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.5",
+  "version": "0.8.8",
   "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.5
+  version: 0.8.8
 platform: ruby
 authors:
 - David Cruwys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-20 00:00:00.000000000 Z
+date: 2022-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: k_config
@@ -119,7 +119,10 @@ files:
 - 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/domain-modal/domain_model_custom.svg
+- docs/domain_model.drawio
+- docs/domain_model.json
+- docs/domain_model.svg
 - docs/extensions.md
 - docs/extensions/analyti_cs.svg
 - docs/extensions/android_inputs.svg
@@ -353,6 +356,7 @@ files:
 - lib/drawio_dsl/schema/shapes/embed_row.rb
 - lib/drawio_dsl/schema/shapes/envelop.rb
 - lib/drawio_dsl/schema/shapes/face.rb
+- lib/drawio_dsl/schema/shapes/group.rb
 - lib/drawio_dsl/schema/shapes/h1.rb
 - lib/drawio_dsl/schema/shapes/h2.rb
 - lib/drawio_dsl/schema/shapes/h3.rb