drawio_dsl 0.5.6 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35811da8138e65733de38529db78e785306a329c7a4f8b0cfb6c0317e647150c
-  data.tar.gz: 7604913a71121114897631cd5ee74666a9443a379119248e8e724d4c1edd4284
+  metadata.gz: 0ca0ef8325e3ca9e3eeb032142a12c57bc12b5bf0f0e564fe162d2da70a06136
+  data.tar.gz: 17d39e80687f5fa5778a9e48011b4073fea363082b3ce490dff3f90d06747c94
 SHA512:
-  metadata.gz: 23b027e1219e74a55ebb2ce56973d7b32c389f712e0f15d60571020bf7d182d2e360c54e043213e5dc360fcbb244b18b314da2f0df5109212b42a3b69f147c29
-  data.tar.gz: 4add99537c8e7e7a93fae23bb3d55634f0b8471c59a201f49cdc577e64a98e738763e98d1efbb82e601009d9847b77d7d9bc990b835317b130e7399e06d4222e
+  metadata.gz: c938d044a019af58cd694619dc5de2e78760f13a3626e06deb9470e0cb3066c2d4841066fb69bed1e921c2955a5849ae350e916e07c3eae31440779907057403
+  data.tar.gz: c37d85e61f581533d6803541fbbe3e6ed1aedc58cdafd48ef20834ac4c9361f81e96890f8514bc68c21b8bd0e58a415a5960e901774968f802f16bbe50b5965f

data/.builders/.data/shapes.json

@@ -134,6 +134,42 @@
     "h": 160,
     "style_modifiers": "shape=cloud"
   },
+  {
+    "type": "container",
+    "text_only": false,
+    "x": 0,
+    "y": 0,
+    "w": 160,
+    "h": 160,
+    "style_modifiers": "swimlane"
+  },
+  {
+    "type": "container2",
+    "text_only": false,
+    "x": 0,
+    "y": 0,
+    "w": 160,
+    "h": 160,
+    "style_modifiers": "swimlane;horizontal=0"
+  },
+  {
+    "type": "container3",
+    "text_only": false,
+    "x": 0,
+    "y": 0,
+    "w": 160,
+    "h": 160,
+    "style_modifiers": "swimlane;startSize=50"
+  },
+  {
+    "type": "container4",
+    "text_only": false,
+    "x": 0,
+    "y": 0,
+    "w": 160,
+    "h": 160,
+    "style_modifiers": "swimlane;resizable=0"
+  },
   {
     "type": "cross",
     "text_only": false,
@@ -189,40 +225,22 @@
     "style_modifiers": "shape=hexagon"
   },
   {
-    "type": "container",
+    "type": "interface",
     "text_only": false,
     "x": 0,
     "y": 0,
-    "w": 160,
-    "h": 160,
-    "style_modifiers": "swimlane"
-  },
-  {
-    "type": "container2",
-    "text_only": false,
-    "x": 0,
-    "y": 0,
-    "w": 160,
-    "h": 160,
-    "style_modifiers": "swimlane;horizontal=0"
-  },
-  {
-    "type": "container3",
-    "text_only": false,
-    "x": 0,
-    "y": 0,
-    "w": 160,
-    "h": 160,
-    "style_modifiers": "swimlane;startSize=50"
+    "w": 200,
+    "h": 120,
+    "style_modifiers": "align=left;overflow=fill;fontSize=12;fontFamily=Helvetica"
   },
   {
-    "type": "container4",
+    "type": "klass",
     "text_only": false,
     "x": 0,
     "y": 0,
-    "w": 160,
-    "h": 160,
-    "style_modifiers": "swimlane;resizable=0"
+    "w": 200,
+    "h": 120,
+    "style_modifiers": "align=left;overflow=fill;fontSize=12;fontFamily=Helvetica"
   },
   {
     "type": "note",

data/.builders/.templates/basic/dom_builder_shapes.rb

@@ -6,8 +6,8 @@ module DrawioDsl
   module DomBuilderShapes
     {{#each shapes}}
 
-    def add_{{snake ./type}}(**opts)
-      {{snake ./type}} = DrawioDsl::Schema::{{camel ./type}}.new(current_page, **opts)
+    def add_{{snake ./type}}(**opts, &block)
+      {{snake ./type}} = DrawioDsl::Schema::{{camel ./type}}.new(current_page, **opts, &block)
       add_shape({{snake ./type}})
     end
     {{/each}}

data/.builders/.templates/basic/drawio_extensions.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module DrawioDsl
+  # :nocov:
+  class DrawIoExtensions
+
+    attr_reader :sections
+    attr_reader :current_section
+
+    def initialize
+      @sections = []
+    end
+
+    def section(name)
+      @current_section = {
+        name: name,
+        shapes: []
+      }
+      @sections << current_section
+      
+      yield if block_given?
+    end
+
+    def shape(name, style, original_name)
+      shape = {
+        name: name,
+        style: style,
+        original_name: original_name
+      }
+      current_section[:shapes] << shape
+      shape
+    end
+
+    def to_h
+      {
+        sections: @sections.map(&:to_h)
+      }
+    end
+
+    # This methods was generated using Extensions.js
+    # This generation can be improved over time and the code to do the generation
+    # can be found in the .builders/generators/10-transform-drawio-js.rb.
+    # original source: ~/dev/tools/drawio-desktop/drawio/src/main/webapp/js/diagramly/Extensions.js
+    def build_extensions
+      # Constants
+{{{constants}}}
+      {{#each sections}}
+      section :{{snake ./name}} do
+        {{#each ./shapes}}
+        shape :{{padr (snake ./name) 60}}, "{{{./style}}}", "{{./name}}"
+        {{/each}}
+      end
+      {{/each}}
+    end
+  end
+  # :nocov:
+end

data/.builders/.templates/basic/drawio_shapes.rb

@@ -14,8 +14,8 @@ module DrawioDsl
     end
     {{#each shapes}}
 
-    def {{snake ./type}}(**opts)
-      builder.add_{{snake ./type}}(**opts)
+    def {{snake ./type}}(**opts, &block)
+      builder.add_{{snake ./type}}(**opts, &block)
     end
     {{/each}}
   end

data/.builders/.templates/basic/schema_require.rb

@@ -14,4 +14,6 @@ require_relative 'layouts/grid_layout'
 require_relative 'shapes/shape'
 {{#each shapes}}
 require_relative 'shapes/{{snake ./type}}'
-{{/each}}
+{{/each}}
+
+require_relative 'virtual/anchor'

data/.builders/blueprint/shapes.rb

@@ -1,4 +1,4 @@
-KManager.model :shapes, namespace: %i[domain] do
+m = KManager.model :shapes, namespace: %i[domain] do
   # microapp = import(:handlebars_helpers, :microapp)
 
   table :shapes do
@@ -24,16 +24,18 @@ KManager.model :shapes, namespace: %i[domain] do
     row :callout4             , false, 0, 0, 160, 120, 'shape=mxgraph.basic.roundRectCallout;dx=30;dy=15;size=5;boundedLbl=1;'
     row :circle               , false, 0, 0, 160, 160, 'ellipse'
     row :cloud                , false, 0, 0, 160, 160, 'shape=cloud'
+    row :container            , false, 0, 0, 160, 160, 'swimlane'
+    row :container2           , false, 0, 0, 160, 160, 'swimlane;horizontal=0'
+    row :container3           , false, 0, 0, 160, 160, 'swimlane;startSize=50'
+    row :container4           , false, 0, 0, 160, 160, 'swimlane;resizable=0'
     row :cross                , false, 0, 0,  50,  50, 'verticalLabelPosition=bottom;verticalAlign=top;html=1;shape=mxgraph.basic.x'
     row :envelop              , false, 0, 0, 160, 100, 'shape=message'
     row :diamond              , false, 0, 0, 100, 100, 'rhombus'
     row :document             , false, 0, 0, 160, 160, 'shape=mxgraph.basic.document'
     row :ellipse              , false, 0, 0, 200, 120, 'ellipse'
     row :hexagon              , false, 0, 0, 200, 120, 'shape=hexagon'
-    row :container            , false, 0, 0, 160, 160, 'swimlane'
-    row :container2           , false, 0, 0, 160, 160, 'swimlane;horizontal=0'
-    row :container3           , false, 0, 0, 160, 160, 'swimlane;startSize=50'
-    row :container4           , false, 0, 0, 160, 160, 'swimlane;resizable=0'
+    row :interface            , false, 0, 0, 200, 120, 'align=left;overflow=fill;fontSize=12;fontFamily=Helvetica'
+    row :klass                , false, 0, 0, 200, 120, 'align=left;overflow=fill;fontSize=12;fontFamily=Helvetica'
     row :note                 , false, 0, 0, 160, 160, 'shape=note'
     row :process              , false, 0, 0, 200, 120, 'shape=process'
     row :rectangle            , false, 0, 0, 200, 120, ''
@@ -60,3 +62,5 @@ KManager.model :shapes, namespace: %i[domain] do
       .add_file('shapes.json', content: shapes, on_exist: :write)
   end
 end
+
+

data/.builders/generators/10-transform-drawio-js.rb

@@ -0,0 +1,195 @@
+KManager.action :transform_drawio_js do
+
+  action do
+    director = KDirector::Dsls::BasicDsl
+      .init(k_builder,
+        on_exist:                   :write,                      # %i[skip write compare]
+        on_action:                  :execute                    # %i[queue execute]
+      )
+      .blueprint do
+        cd(:data)
+
+        source_file = '/Users/davidcruwys/dev/tools/drawio-desktop/drawio/src/main/webapp/js/diagramly/Extensions.js'
+        target_file = k_builder.target_folders.get_filename(:data, 'extensions.js')
+
+        clean = CleanExtensionsJs.new(source_file, target_file)
+
+        cd(:lib)
+
+        clean.parse
+
+        add_file('drawio_extensions.json', content: clean.build_json)
+        add('drawio_extensions.rb', constants: clean.constants, sections: clean.sections)
+      end
+  end
+end
+
+class CleanExtensionsJs
+  def initialize(source_file, target_file)
+    @source_file = source_file
+    @target_file = target_file
+    @source = File.read(@source_file)
+    @constants = []
+    @builder = ExtensionJsBuilder.new
+  end
+
+  def parse
+    split_source
+  end
+
+  def build_json
+    @builder.build_json
+  end
+
+  def build_ruby
+    @builder.build_ruby
+  end
+
+  def constants
+    @builder.constants.join("\n")
+  end
+
+  def sections
+    @builder.sections.select { |s| s[:shapes].length > 0 }
+  end
+
+  private
+
+  def split_source
+    source_lines = @source.split("\n")
+    section = :unknown
+
+    source_lines.each do |line|
+      if line.include?('// Global import transformation')
+        section = :constants
+        next
+      elsif line.include?('var styleMap = {') && !line.include?('var styleMap = {};')
+        puts '-----------------------------------'
+        section = :style_map
+        next
+      elsif line.include?('};') ||
+            line.include?('//Instead of doing a massive code refactoring, thees ugly global variables are used')
+        section = :unknown
+      end
+
+      if section == :constants
+        @builder.process_constant(line)
+      end
+
+      if section == :style_map
+        @builder.process_style_map(line)
+      end
+    end
+  end
+
+  def process_style_map(line)
+    line
+  end
+end
+
+class ExtensionJsBuilder
+  attr_accessor :constants
+  attr_accessor :shapes
+  attr_accessor :sections
+  attr_accessor :current_section
+
+  def initialize
+    @constants = []
+    @shapes = []
+    @sections = []
+    @current_section = nil
+  end
+
+  def process_constant(line)
+    line = line.gsub('	', '').gsub('var ', '').gsub(/;$/, '')
+    @constants << "      #{line}"
+  end
+
+  def process_style_map(line)
+    line = clean_line(line)
+    
+    return if kill_line(line)
+
+    if line.start_with?('#')
+      set_section(line)
+      return
+    end
+
+    return unless current_section
+
+    parts = process_line(line)
+
+    if parts.length == 2
+      name = parts[0]
+      style = parts[1]
+      current_section[:shapes] << { name: name, style: style }
+      shapes << line
+    else
+      puts 'length not 2'
+      puts line
+    end
+  end
+
+  def process_line(line)
+    line.split(':').map { |s| s.strip.gsub('"', '') }
+  end
+
+  def clean_line(line)
+    line
+      .strip
+      .gsub('  ', ' ')
+      .gsub('	', ' ')
+      .gsub(' :', ':')
+      .gsub("don't", 'do not')
+      .gsub('//TODO', '')
+      .gsub(/(\/\/)([^ ])/) do |_|
+        match = Regexp.last_match
+        "// #{match[2]}"
+      end
+      .gsub("'", '"')
+      .gsub('not all variants covered', '')
+      .gsub('Timeline shape', '')
+      .gsub('# not all variants covered', '')
+      .gsub('not all versions supported', '')
+      .gsub('ss + "', '"#{ss}')
+      .gsub('s + "', '"#{s}')
+      .gsub('cs,', '#{cs}')
+      .gsub(/cs$/, '#{cs}')
+      .gsub('" + containerStyle', '#{containerStyle}"')
+      .gsub('kupIcon + "', '"#{kupIcon}')
+      .gsub('gcpIcon + "', '"#{gcpIcon}')
+      .gsub('azur19 + "', '"#{azur19}')
+      .gsub('ssAzure + "', '"#{ssAzure}')
+      .gsub('" + arcSize + "', '#{arcSize}')
+      .gsub('//', '#')
+      .gsub('  ', ' ')
+      .gsub(', #', '')
+      .strip
+      .gsub(/,$/, '')
+      .strip
+  end
+
+  def kill_line(line)
+    line.end_with?('NA') ||
+    line.end_with?('not working properly, needs specific code)') ||
+    line.start_with?('Timeline shapes are postponed, this code is a work-in-progress') ||
+    line.start_with?('# *******') ||
+    line.start_with?('# 2019 mapping') ||
+    line.include?('#  "') ||
+    line.include?('# "') ||
+    line.empty?
+  end
+
+  def set_section(line)
+    section = line.gsub('#', '').strip
+    @current_section = {
+      name: section,
+      shapes: []
+    }
+    @sections << current_section
+  end
+
+  def build_json
+    JSON.pretty_generate(@sections)
+  end
+end

data/.builders/generators/20-drawio-extensions.rb

@@ -0,0 +1,41 @@
+KManager.action :transform_drawio_js do
+
+  action do
+    director = DrawioDsl::Drawio
+      .init(k_builder, on_exist: :write, on_action: :execute)
+      .diagram(theme: :style_10)
+
+      ext = DrawioDsl::DrawIoExtensions.new
+      ext.build_extensions
+      puts ext.sections.length
+
+      ext.sections.select { |s| s[:active] }.each do |section|
+        director.page(section[:name]) do
+          grid_layout(wrap_at: 5)
+          puts section[:name]
+          puts section[:shapes]
+          section[:shapes].select { |s| s[:active] }.each do |shape|
+            square(title: shape[:name], style_modifiers: shape[:style])
+            log.kv(:title, shape[:name])
+            log.kv(:style, shape[:style])
+          end
+        end
+      end
+      director
+        .cd(:spec)
+        .save('.samples/20-extensions.drawio')
+        .cd(:docs)
+
+      markdown = "# Extensions\n\n"
+
+      director.builder.diagram.pages.each_with_index do |page, index|
+        page_no = index+1
+        puts "Page #{page_no}, #{page.name}"
+        # director.export_svg("extensions/#{page.name}", page: page_no)
+        markdown += "## #{page.name}\n\n![](./extensions/#{page.name}.svg)\n\n"
+      end
+
+      director
+        .add('extensions.md', content: markdown)
+  end
+end

data/.builders/generators/project_plans/drawio_dsl.rb

@@ -11,8 +11,9 @@ KManager.action :todo_drawio_dsl do
 
         grid_layout(y:90, direction: :horizontal, grid_h: 80, grid_w: 320, wrap_at: 3, grid: 0)
 
-        square(w: 300, h: 60, title: 'add :shape and :text-only to random shape generator')
-        square(w: 300, h: 60, title: 'write SVG directly into other projects')
+        square(w: 300, h: 60, title: 'formatter DSL that can render HTML directly into the title property')
+        square(w: 300, h: 60, title: 'formatter DSL for class and interface generation')
+        square(w: 300, h: 60, title: 'Add page background to theme, use it whenever the theme is set at a diagram/page level')
       end
       .page('To Do', theme: :style_02, margin_left: 0, margin_top: 0) do
 
@@ -21,10 +22,10 @@ KManager.action :todo_drawio_dsl do
 
         grid_layout(y:90, direction: :horizontal, grid_h: 80, grid_w: 320, wrap_at: 3, grid: 0)
 
-        square(w: 300, h: 60, title: 'First level child nodes need to hang of node 1')
-        square(w: 300, h: 60, title: 'Add page background to theme, use it whenever the theme is set at a diagram/page level')
+        square(w: 300, h: 60, title: 'write SVG directly into other projects')
+        square(w: 300, h: 60, title: 'add :shape and :text-only to random shape generator')
         square(w: 300, h: 60, title: 'Nodes need to support child nodes')
-        square(w: 300, h: 60, title: 'Grid layout does no position itself in relation to the last element')
+        square(w: 300, h: 60, title: 'Grid layout does not position itself in relation to the last element')
         square(w: 300, h: 60, title: 'Dynamic sized shapes that expand to the size of their text')
         square(w: 300, h: 60, title: 'Control of text padding left, right, top and bottom')
         square(w: 300, h: 60, title: 'Improve the theme control over text-only shapes')
@@ -42,6 +43,11 @@ KManager.action :todo_drawio_dsl do
 
         grid_layout(y:90, direction: :horizontal, grid_h: 80, grid_w: 320, wrap_at: 3, grid: 0)
 
+        square(w: 300, h: 60, title: 'generate extension based graphics based on drawio extensions.js')
+        square(w: 300, h: 60, title: 'active? flag on page defaulting to true. set to false to exclude page from diagram.')
+        square(w: 300, h: 60, title: 'first level child nodes need to hang of node 1')
+        square(w: 300, h: 60, title: 'node has child nodes and add_node will set a nodes parent')
+        square(w: 300, h: 60, title: 'nodes can belong to a parent node, the top level node responds with truthy to root?')
         square(w: 300, h: 60, title: 'add sample diagram for the github readme file')
         square(w: 300, h: 60, title: 'write samples into docs folder and display in readme')
         square(w: 300, h: 60, title: 'add export as .PNG, needs to take a page number as the PNG will not support multiple pages')

data/.builders/generators/project_plans/k_doc.rb

@@ -0,0 +1,39 @@
+KManager.action :todo_drawio_dsl do
+  action do
+
+    DrawioDsl::Drawio
+      .init(k_builder, on_exist: :write, on_action: :execute)
+      .diagram(rounded: 1, glass: 1)
+      .page('In progress', theme: :style_03, margin_left: 0, margin_top: 0) do
+
+        # h5(x: 300, y: 0, w: 400, h: 80, title: 'DrawIO DSL')
+        # p(x: 350, y: 40, w: 400, h: 80, title: 'Project plan - In progress')
+
+        grid_layout(y:90, direction: :horizontal, grid_h: 80, grid_w: 320, wrap_at: 3, grid: 0)
+
+        square(w: 300, h: 60, title: '')
+      end
+      .page('To Do', theme: :style_02, margin_left: 0, margin_top: 0) do
+
+        # h5(x: 300, y: 0, w: 400, h: 80, title: 'DrawIO DSL')
+        # p(x: 350, y: 40, w: 400, h: 80, title: 'Project plan')
+
+        grid_layout(y:90, direction: :horizontal, grid_h: 80, grid_w: 320, wrap_at: 3, grid: 0)
+
+      end
+      .page('Done', theme: :style_06, margin_left: 0, margin_top: 0) do
+
+        # h5(x: 300, y: 0, w: 400, h: 80, title: 'DrawIO DSL')
+        # p(x: 350, y: 40, w: 400, h: 80, title: 'Done')
+
+        grid_layout(y:90, direction: :horizontal, grid_h: 80, grid_w: 320, wrap_at: 3, grid: 0)
+
+      end
+      .cd(:spec)
+      .save('project-plans/k_doc.drawio')
+      # .cd(:k_doc_docs)
+      # .export_svg('project_in_progress', page: 1)
+      # .export_svg('project_todo'       , page: 2)
+      # .export_svg('project_done'       , page: 3)
+  end
+end

data/.builders/generators/sample_diagrams/15-grid-direction.rb

@@ -1,13 +1,5 @@
 KManager.action :bootstrap do
   action do
-
-    # KConfig.configuration.drawio.square.w = KConfig.configuration.drawio.square.w / 4
-    # KConfig.configuration.drawio.square.h = KConfig.configuration.drawio.square.h / 4
-    # KConfig.configuration.drawio.circle.w = KConfig.configuration.drawio.circle.w / 4
-    # KConfig.configuration.drawio.circle.h = KConfig.configuration.drawio.circle.h / 4
-    # KConfig.configuration.drawio.rectangle.w = KConfig.configuration.drawio.rectangle.w / 4
-    # KConfig.configuration.drawio.rectangle.h = KConfig.configuration.drawio.rectangle.h / 4
-
     DrawioDsl::Drawio
       .init(k_builder, on_exist: :write, on_action: :execute)
       .diagram(theme: :style_01)

data/.builders/generators/sample_diagrams/20-styles.rb

@@ -1,8 +1,7 @@
 KManager.action :bootstrap do
   action do
 
-    # :rounded, :shadow, :sketch, :glass
-    director = DrawioDsl::Drawio
+    DrawioDsl::Drawio
       .init(k_builder, on_exist: :write, on_action: :execute)
       .diagram(theme: :style_06)
       .page('Style-Plain', margin_left: 0, margin_top: 0) do

data/.builders/generators/sample_diagrams/30-html-shapes.rb

@@ -0,0 +1,68 @@
+KManager.action :html_shapes do
+  action do
+
+    # :rounded, :shadow, :sketch, :glass
+    DrawioDsl::Drawio
+      .init(k_builder, on_exist: :write, on_action: :execute)
+      .diagram(theme: :style_11)
+      .page('Style-Plain', margin_left: 0, margin_top: 0, rounded: 0, background: '#FFEADB') do
+        grid_layout(wrap_at: 8)
+
+        html = DrawioDsl::Formatters::InterfaceFormatter.new
+          .header('IPerson')
+          .field(:first_name, type: :string)
+          .field(:last_name, type: :string)
+          .field(:age, type: :integer)
+          .field(:birthday, type: :date)
+          .method(:full_name)
+          .as_html
+
+        square(
+          title: html,
+          style_modifiers: 'align=left;overflow=fill;fontSize=12;fontFamily=Helvetica'
+        )
+
+        square(title: 'xxx', style_modifiers: 'align=left;overflow=fill;fontSize=12;fontFamily=Helvetica') do
+          format(:interface)
+            .header('IPerson')
+            .field(:field1, type: :string)
+            .field(:field2, type: :string)
+            .method(:full_name, type: :string)
+        end
+
+        html = DrawioDsl::Formatters::KlassFormatter.new
+          .header('Person')
+          .field(:first_name, type: :string)
+          .field(:last_name, type: :string)
+          .field(:age, type: :integer)
+          .method(:full_name)
+          .as_html
+
+        square(
+          title: html,
+          style_modifiers: 'align=left;overflow=fill;fontSize=12;fontFamily=Helvetica'
+        )
+
+        # square do
+        #   formatter(:class)
+        #     .name('Person')
+        #     .field(:field1, type: :string)
+        #     .field(:field2, type: :string)
+        #     .method(:full_name, type: :string)
+        # end
+
+        # dg_interface('IContract') do
+        #   field('first_name', type: 'String')
+        #   field('last_name', type: 'String')
+        #   field('age', type: 'int')
+        #   method('full_name', type: 'String', params: 'String first_name, String last_name')
+        # end
+
+      end
+      .cd(:spec)
+      .save('.samples/30-html-shapes.drawio')
+      # .cd(:docs)
+      # .export_svg('samples/themes-square', page: 1)
+
+  end
+end

data/.rubocop.yml

@@ -10,7 +10,7 @@ AllCops:
   Exclude:
     - ".builders/**/*"
     - "spec/samples/**/*"
-
+    - "lib/drawio_dsl/drawio_extensions.rb"
 
 Metrics/BlockLength:
   Exclude:
@@ -52,6 +52,9 @@ Style/BlockComments:
   Include:
     - "**/spec/*"
 
+Style/RegexpLiteral:
+  Enabled: false
+
 # My Preferences - Start
 Metrics/ClassLength:
   Enabled: false