drawio_dsl 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 874e60205978452d6b06bd53855edff255b5b168fb7a80693ac109279381c880
-  data.tar.gz: f5073b3be534353987969a4c96c563a1ed5d9dedcb52c09355ef013db0c5a382
+  metadata.gz: 56780c6c8fa8c1ea29a29e07bf389cf257fd7a33faf52e955b3fe56133367063
+  data.tar.gz: f583d40a64cea1177d7d52ab627dcbfa954cb3091dada0903947f69f5792d3b5
 SHA512:
-  metadata.gz: 50178f5c6728de3571a1effb263d62b4676f9685e05a59b4b31fb88a1f3b1d3fc4583f13a976c8d67202c3dc4981470073855f10b2c69196051984ae70d06c8a
-  data.tar.gz: 5ad8beb7a169b7d3c0b44e887dfb71b6a966d63023986efe319007e0f4fcaf397edd688cfbd3c98f5dc8a6760d55af1eaea3d7b646ed8658fda765c2dd129d0d
+  metadata.gz: 92b5c4e8e2a8210c3e2213df96f1d35034689a3d2ff9132e17fc1fa30f68b89551cb395f725e0b1b5da3b506e62471e2e64def33683f8959f53a41a43e4f5805
+  data.tar.gz: 112eb4f963aa4c295559f8d1e8ed0eaf0121bb768282924ca54059c3de4924d16a33b5a3d33dd9044378315840aafda7db34d228aa2064606eccf5d29776da52

data/.builders/.templates/command.rb

@@ -0,0 +1,8 @@
+KManager.model :{{command.name}}, namespace: %i[blueprint command] do
+  # microapp = import(:handlebars_helpers, :microapp)
+
+  settings do
+    name                  :{{command.name}}
+    description           "{{command.description}}"
+  end
+end

data/.builders/.templates/schema_shape.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DrawioDsl
+  module Schema
+    class {{camle type}} < Shape
+      configure_shape(:{{snake type}})
+    end
+  end
+end

data/.builders/blueprint/shapes.rb

@@ -0,0 +1,19 @@
+KManager.model :shapes, namespace: %i[domain] do
+  # microapp = import(:handlebars_helpers, :microapp)
+
+  table :shapes do
+    fields :type, :x, :y, :w, :h, :style_modifiers
+
+    # row :shape      , x: 0, y: 0, w:  20, h:  20, style_modifiers: ''
+    row :square     , x: 0, y: 0, w: 160, h: 160, style_modifiers: ''
+    row :rectangle  , x: 0, y: 0, w: 200, h: 120, style_modifiers: ''
+    row :circle     , x: 0, y: 0, w: 160, h: 160, style_modifiers: 'double=1;ellipse'
+    row :process    , x: 0, y: 0, w: 200, h: 120, style_modifiers: 'double=1;shape=process'
+    row :ellipse    , x: 0, y: 0, w: 200, h: 120, style_modifiers: 'double=1;ellipse'
+    row :diamond    , x: 0, y: 0, w: 160, h: 160, style_modifiers: 'double=1;rhombus'
+    row :hexagon    , x: 0, y: 0, w: 200, h: 120, style_modifiers: 'double=1;shape=hexagon'
+    row :cloud      , x: 0, y: 0, w: 160, h: 160, style_modifiers: 'double=1;shape=cloud'
+    row :note       , x: 0, y: 0, w: 160, h: 160, style_modifiers: 'double=1;shape=note'
+    row :callout    , x: 0, y: 0, w: 160, h: 160, style_modifiers: 'double=1;shape=callout'
+  end
+end

data/.builders/boot.rb

@@ -60,6 +60,7 @@ resource_manager
   .fileset
   .glob('*.rb', exclude: ['boot.rb'])
   .glob('generators/**/*.rb')
+  .glob('blueprint/**/*.rb')
 resource_manager.add_resources
 
 KManager.boot

data/.builders/generators/25-themes.rb

@@ -8,6 +8,9 @@ KManager.action :bootstrap do
       .page('Style-Plain', margin_left: 0, margin_top: 0) do
         grid_layout(wrap_at: 5)
 
+        square(title: 'The quick brown fox jumps over the lazy dog')
+        circle(title: 'Mary had a little lamb')
+
         KConfig.configuration.drawio.themes.keys.each do |theme|
           random(title: theme.to_s, theme: theme)
         end

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [0.3.0](https://github.com/klueless-io/drawio_dsl/compare/v0.2.0...v0.3.0) (2022-03-04)
+
+
+### Features
+
+* add samples for direction, alignment, themes, styles and page margin ([2e9f735](https://github.com/klueless-io/drawio_dsl/commit/2e9f735ba50c9391d7dea64c565ca9c0fb61978a))
+
 # [0.2.0](https://github.com/klueless-io/drawio_dsl/compare/v0.1.0...v0.2.0) (2022-03-04)
 
 

data/lib/drawio_dsl/configuration.rb

@@ -16,42 +16,33 @@ module DrawioDsl
     include KLog::Logging
 
     BaseStyle = Struct.new(:white_space, :html, :rounded, :shadow, :sketch, :glass, keyword_init: true)
-
-    ShapeDefaults   = Struct.new(:type, :x, :y, :w, :h, :style_modifiers)
+    ShapeDefaults   = Struct.new(:type, :x, :y, :w, :h, :style_modifiers, keyword_init: true)
     ShapeThemeStyle = Struct.new(:fill_color, :stroke_color, :font_color, :gradient, keyword_init: true)
 
+    Shapes = Struct.new(
+      :shape,
+      :square,
+      :rectangle,
+      :circle,
+      :process,
+      :ellipse,
+      :diamond,
+      :hexagon,
+      :cloud,
+      :note,
+      :callout,
+      keyword_init: true
+    )
+
     attr_accessor :base_style
 
-    # Theme colors
     attr_accessor :themes
-
-    # Shape shapes
-    attr_accessor :shape
-    attr_accessor :square
-    attr_accessor :rectangle
-    attr_accessor :circle
-    attr_accessor :process
-    attr_accessor :ellipse
-    attr_accessor :diamond
-    attr_accessor :hexagon
-
-    # <mxCell id="6" value="" style="rhombus;whiteSpace=wrap;html=1;" vertex="1" parent="TqO-B">
-    #     <mxGeometry x="-496" y="115" width="80" height="80" as="geometry"/>
-    # </mxCell>
+    attr_accessor :shapes
 
     def initialize
       @base_style = BaseStyle.new(white_space: :wrap, html: 1, rounded: nil, shadow: nil, sketch: nil, glass: nil)
 
-      @shape      = ShapeDefaults.new(:shape   , 0, 0, 20, 20, '')
-      @square     = ShapeDefaults.new(:square    , 0, 0, 160, 160, '')
-      @rectangle  = ShapeDefaults.new(:rectangle , 0, 0, 200, 120, '')
-      @circle     = ShapeDefaults.new(:circle    , 0, 0, 160, 160, 'ellipse')
-      @process    = ShapeDefaults.new(:process   , 0, 0, 200, 120, 'shape=process')
-      @ellipse    = ShapeDefaults.new(:ellipse   , 0, 0, 200, 120, 'ellipse')
-      @diamond    = ShapeDefaults.new(:diamond  , 0, 0, 160, 160, 'rhombus')
-      @hexagon    = ShapeDefaults.new(:hexagon  , 0, 0, 200, 120, 'shape=hexagon')
-
-      @themes     = {}
+      add_shapes
       add_themes
     end
 
@@ -65,12 +56,30 @@ module DrawioDsl
 
     private
 
+    def add_shapes
+      @shapes = Shapes.new(
+        shape: ShapeDefaults.new(type: :shape , x: 0, y: 0, w: 20, h: 20, style_modifiers: ''),
+        square: ShapeDefaults.new(type: :square , x: 0, y: 0, w: 160, h: 160, style_modifiers: ''),
+        rectangle: ShapeDefaults.new(type: :rectangle , x: 0, y: 0, w: 200, h: 120, style_modifiers: ''),
+        circle: ShapeDefaults.new(type: :circle , x: 0, y: 0, w: 160, h: 160, style_modifiers: 'double=1;ellipse'),
+        process: ShapeDefaults.new(type: :process , x: 0, y: 0, w: 200, h: 120, style_modifiers: 'double=1;shape=process'),
+        ellipse: ShapeDefaults.new(type: :ellipse , x: 0, y: 0, w: 200, h: 120, style_modifiers: 'double=1;ellipse'),
+        diamond: ShapeDefaults.new(type: :diamond , x: 0, y: 0, w: 160, h: 160, style_modifiers: 'double=1;rhombus'),
+        hexagon: ShapeDefaults.new(type: :hexagon , x: 0, y: 0, w: 200, h: 120, style_modifiers: 'double=1;shape=hexagon'),
+        cloud: ShapeDefaults.new(type: :cloud , x: 0, y: 0, w: 160, h: 160, style_modifiers: 'double=1;shape=cloud'),
+        note: ShapeDefaults.new(type: :note , x: 0, y: 0, w: 160, h: 160, style_modifiers: 'double=1;shape=note'),
+        callout: ShapeDefaults.new(type: :callout , x: 0, y: 0, w: 160, h: 160, style_modifiers: 'double=1;shape=callout')
+      )
+    end
+
     def add_theme(name, **opts)
       @themes[name] = ShapeThemeStyle.new(**opts)
     end
 
     # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
     def add_themes
+      @themes = {}
+
       add_theme(:style_01         , fill_color: '#f5f5f5', stroke_color: '#666666', font_color: '#333333')
       add_theme(:style_02         , fill_color: '#dae8fc', stroke_color: '#6c8ebf', font_color: '#333333')
       add_theme(:style_03         , fill_color: '#d5e8d4', stroke_color: '#82b366', font_color: '#333333')

data/lib/drawio_dsl/dom_builder.rb

@@ -119,6 +119,21 @@ module DrawioDsl
       add_shape(add_hexagon)
     end
 
+    def add_cloud(**opts)
+      cloud = DrawioDsl::Schema::Cloud.new(current_page, **opts)
+      add_shape(cloud)
+    end
+
+    def add_note(**opts)
+      note = DrawioDsl::Schema::Note.new(current_page, **opts)
+      add_shape(note)
+    end
+
+    def add_callout(**opts)
+      callout = DrawioDsl::Schema::Callout.new(current_page, **opts)
+      add_shape(callout)
+    end
+
     def debug
       puts JSON.pretty_generate(actions)
       puts JSON.pretty_generate(diagram.to_h)

data/lib/drawio_dsl/drawio.rb

@@ -58,7 +58,7 @@ module DrawioDsl
 
     # rubocop:disable Metrics/CyclomaticComplexity
     def random(**opts)
-      case rand(7)
+      case rand(10)
       when 0
         square(**opts)
       when 1
@@ -73,6 +73,12 @@ module DrawioDsl
         diamond(**opts)
       when 6
         hexagon(**opts)
+      when 7
+        cloud(**opts)
+      when 8
+        note(**opts)
+      when 9
+        callout(**opts)
       end
     end
     # rubocop:enable Metrics/CyclomaticComplexity
@@ -105,6 +111,18 @@ module DrawioDsl
       builder.add_hexagon(**opts)
     end
 
+    def cloud(**opts)
+      builder.add_cloud(**opts)
+    end
+
+    def note(**opts)
+      builder.add_note(**opts)
+    end
+
+    def callout(**opts)
+      builder.add_callout(**opts)
+    end
+
     private
 
     def current_shape

data/lib/drawio_dsl/layout_engine.rb

@@ -34,7 +34,7 @@ module DrawioDsl
         when :layout_rule
           @current_layout = node
         when :shape
-          current_layout.position_shape(node)
+          current_layout&.position_shape(node)
         end
         # node.debug(format: :row)
       end

data/lib/drawio_dsl/schema/_.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative 'common_style'
+require_relative 'default_palette'
+require_relative 'diagram'
+require_relative 'node'
+require_relative 'page'
+
+require_relative 'layouts/layout'
+require_relative 'layouts/flex_layout'
+require_relative 'layouts/grid_layout'
+
+require_relative 'shapes/shape'
+require_relative 'shapes/callout'
+require_relative 'shapes/circle'
+require_relative 'shapes/cloud'
+require_relative 'shapes/diamond'
+require_relative 'shapes/ellipse'
+require_relative 'shapes/hexagon'
+require_relative 'shapes/note'
+require_relative 'shapes/process'
+require_relative 'shapes/rectangle'
+require_relative 'shapes/square'

data/lib/drawio_dsl/schema/common_style.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module DrawioDsl
+  module Schema
+    # Common Style is the reused on Diagram, Page and Shape
+    #
+    # When styles are not provided at each level, then they will inherit from
+    # the parent common style.
+    #
+    # Shapes will use the common style of their page
+    class CommonStyle
+      attr_accessor :white_space
+      attr_accessor :html
+      attr_accessor :rounded
+      attr_accessor :shadow
+      attr_accessor :glass
+      attr_accessor :sketch
+
+      def initialize(**args, &block)
+        @white_space      = args[:white_space]
+        @html             = args[:html]
+        @rounded          = args[:rounded]
+        @shadow           = args[:shadow]
+        @sketch           = args[:sketch]
+        @glass            = args[:glass]
+
+        instance_eval(&block) if block_given?
+      end
+
+      def to_h
+        {
+          white_space: white_space,
+          html: html,
+          rounded: rounded,
+          shadow: shadow,
+          sketch: sketch,
+          glass: glass
+        }
+      end
+    end
+  end
+end

data/lib/drawio_dsl/schema/default_palette.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module DrawioDsl
+  module Schema
+    # Default Palette contains palette information that can be inherited at each level
+    class DefaultPalette
+      attr_accessor :fill_color
+      attr_accessor :stroke_color
+      attr_accessor :font_color
+      attr_accessor :gradient
+
+      def initialize(owner, **args, &block)
+        @fill_color   = args[:fill_color]
+        @stroke_color = args[:stroke_color]
+        @font_color   = args[:font_color]
+        @gradient     = args[:gradient]
+
+        instance_exec(owner, &block) if block_given?
+      end
+
+      def to_h
+        {
+          fill_color: fill_color,
+          stroke_color: stroke_color,
+          font_color: font_color,
+          gradient: gradient
+        }
+      end
+    end
+  end
+end

data/lib/drawio_dsl/schema/diagram.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module DrawioDsl
+  module Schema
+    # Diagram is the root of the schema, it contains pages
+    class Diagram
+      attr_accessor :host
+      attr_accessor :theme
+      attr_accessor :style
+      attr_accessor :palette
+      attr_accessor :pages
+
+      # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      def initialize(**args)
+        @host = args[:host]   || SecureRandom.alphanumeric(3)
+
+        # Apply a random theme to the diagram if none is specified.
+        @theme = args[:theme] || KConfig.configuration.drawio.random_theme
+
+        @style = DrawioDsl::Schema::CommonStyle.new(**args) do
+          default_style = KConfig.configuration.drawio.base_style
+
+          # Inherit from configured style when specific style not specified.
+          @white_space  ||= default_style.white_space
+          @html         ||= default_style.html
+          @rounded      ||= default_style.rounded
+          @shadow       ||= default_style.shadow
+          @sketch       ||= default_style.sketch
+          @glass        ||= default_style.glass
+        end
+
+        @palette = DrawioDsl::Schema::DefaultPalette.new(self, **args) do |diagram|
+          theme_palette = KConfig.configuration.drawio.palette(diagram.theme)
+
+          # Inherit from theme when specific palette options are not specified.
+          @fill_color   ||= theme_palette.fill_color
+          @stroke_color ||= theme_palette.stroke_color
+          @font_color   ||= theme_palette.font_color
+          @gradient     ||= theme_palette.gradient
+        end
+
+        @pages = args[:pages] || []
+      end
+      # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+      def to_h
+        {
+          host: host,
+          theme: theme,
+          palette: palette.to_h,
+          style: style.to_h,
+          pages: pages.map(&:to_h)
+        }
+      end
+    end
+  end
+end

data/lib/drawio_dsl/schema/layouts/flex_layout.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module DrawioDsl
+  module Schema
+    # Provides flex style layouts
+    class FlexLayout < Layout
+      attr_accessor :direction
+      attr_accessor :wrap_at
+      attr_reader :gap
+      attr_reader :perpendicular_max
+
+      def initialize(page, **args)
+        @type = :flex_layout
+        @direction = args[:direction] || :horizontal
+        @wrap_at = args[:wrap_at] || (direction == :horizontal ? 1000 : 800)
+        @gap = args[:gap] || 20
+        @perpendicular_max = 0
+
+        super(page, **args)
+      end
+
+      def position_shape(shape)
+        fire_after_init
+
+        position_shape_horizontally(shape) if direction == :horizontal
+        position_shape_vertically(shape) if direction == :vertical
+      end
+
+      def to_h
+        fire_after_init
+
+        super.merge(
+          direction: direction,
+          wrap_at: wrap_at,
+          boundary: boundary,
+          perpendicular_max: perpendicular_max
+        )
+      end
+
+      private
+
+      # rubocop:disable Metrics/AbcSize
+      def position_shape_horizontally(shape)
+        boundary_violation = page.position_x + shape.w + gap > boundary
+
+        if boundary_violation
+          page.position_x = anchor_x
+          page.position_y += perpendicular_max
+        end
+
+        shape.x = page.position_x
+        shape.y = page.position_y
+
+        return if boundary_violation
+
+        page.position_x += shape.w + gap
+        @perpendicular_max = [perpendicular_max, shape.h].max
+      end
+      # rubocop:enable Metrics/AbcSize
+
+      # rubocop:disable Metrics/AbcSize
+      def position_shape_vertically(shape)
+        boundary_violation = page.position_y + shape.h + gap > boundary
+
+        if boundary_violation
+          page.position_y = anchor_y
+          page.position_x += perpendicular_max
+        end
+
+        shape.x = page.position_x
+        shape.y = page.position_y
+
+        return if boundary_violation
+
+        page.position_y += shape.h + gap
+        @perpendicular_max = [perpendicular_max, shape.w].max
+      end
+      # rubocop:enable Metrics/AbcSize
+
+      def boundary
+        return @boundary if defined? @boundary
+
+        @boundary = wrap_at + (direction == :horizontal ? anchor_x : anchor_y)
+      end
+    end
+  end
+end

data/lib/drawio_dsl/schema/layouts/grid_layout.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module DrawioDsl
+  module Schema
+    # Provides grid style layouts
+    class GridLayout < Layout
+      attr_accessor :direction
+      attr_accessor :wrap_at
+      attr_accessor :grid_size
+      attr_accessor :cell_no
+      attr_accessor :h_align
+      attr_accessor :v_align
+
+      def initialize(page, **args)
+        @type       = :grid_layout
+        @direction  = args[:direction]  || :horizontal
+        @wrap_at    = args[:wrap_at]    || 5
+        @grid_size  = args[:grid_size]  || 220
+        @h_align    = args[:h_align]    || :center
+        @v_align    = args[:v_align]    || :center
+        @cell_no    = 1
+
+        super(page, **args)
+      end
+
+      def position_shape(shape)
+        fire_after_init
+
+        shape.x = horizontal_shape_alignment(shape)
+        shape.y = vertical_shape_alignment(shape)
+
+        # puts '------------------'
+        # puts "cell: #{cell_no}"
+        # puts "wrap_at: #{wrap_at}"
+        # puts "shape-x: #{shape.x}"
+        # puts "shape-y: #{shape.y}"
+        # puts "page-x: #{page.position_x}"
+        # puts "page-y: #{page.position_y}"
+        # puts "anchor-x: #{anchor_x}"
+        # puts "anchor-y: #{anchor_y}"
+
+        move_cell_horizontally if direction == :horizontal
+        move_cell_vertically if direction == :vertical
+      end
+
+      def to_h
+        super.merge(
+          direction: direction,
+          wrap_at: wrap_at,
+          grid_size: grid_size,
+          cell_no: cell_no
+        )
+      end
+
+      private
+
+      # rubocop:disable Metrics/AbcSize
+      def horizontal_shape_alignment(shape)
+        return page.position_x + ((grid_size - shape.w) / 2)  if h_align == :center
+        return page.position_x + (grid_size - shape.w)        if h_align == :right
+
+        page.position_x
+      end
+      # rubocop:enable Metrics/AbcSize
+
+      # rubocop:disable Metrics/AbcSize
+      def vertical_shape_alignment(shape)
+        return page.position_y + ((grid_size - shape.h) / 2)  if v_align == :center || v_align == :middle
+        return page.position_y + (grid_size - shape.h)        if v_align == :bottom
+
+        page.position_y
+      end
+      # rubocop:enable Metrics/AbcSize
+
+      def move_cell_horizontally
+        if cell_no < wrap_at
+          page.position_x += grid_size
+          @cell_no += 1
+          return
+        end
+
+        # Flow down to the next row
+        page.position_x = anchor_x
+        page.position_y += grid_size
+        @cell_no = 1
+      end
+
+      def move_cell_vertically
+        if cell_no < wrap_at
+          page.position_y += grid_size
+          @cell_no += 1
+          return
+        end
+
+        # Flow right to the next column
+        page.position_y = anchor_y
+        page.position_x += grid_size
+        @cell_no = 1
+      end
+    end
+  end
+end

data/lib/drawio_dsl/schema/layouts/layout.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module DrawioDsl
+  module Schema
+    # Provides base configuration for automatic layouts
+    class Layout < Node
+      attr_accessor :type
+
+      # represents the x coordinate of the top left corner layout area
+      # this coordinate is based on the current location of the page
+      attr_accessor :anchor_x
+      attr_accessor :anchor_y
+
+      def initialize(page, **args)
+        @after_init_fired = false
+
+        super(page, **args.merge(classification: :layout_rule))
+      end
+
+      def fire_after_init
+        return if @after_init_fired
+
+        @after_init_fired = true
+        after_init
+      end
+
+      def after_init
+        @anchor_x ||= page.position_x
+        @anchor_y ||= page.position_y
+      end
+
+      def to_h
+        super.merge(
+          type: type,
+          anchor_x: anchor_x,
+          anchor_y: anchor_y
+        )
+      end
+    end
+  end
+end