drawio_dsl 0.10.0 → 0.11.1

data/lib/drawio_dsl/configuration.rb

@@ -4,28 +4,22 @@
 module DrawioDsl
   # Configuration container for the DrawIO DSL
   class Configuration
-    include DrawioDsl::ConfigurationShapes
+    extend Forwardable
 
     include KLog::Logging
 
     BaseStyle     = Struct.new(:white_space, :html, :rounded, :shadow, :sketch, :glass, keyword_init: true)
-    ElementConfig = Struct.new(:type, :x, :y, :w, :h, :style_modifiers, keyword_init: true)
-    LineConfig    = Struct.new(:type, :x, :y, :w, :h, :style_modifiers, keyword_init: true)
-    TextConfig    = Struct.new(:type, :x, :y, :w, :h, :style_modifiers, keyword_init: true)
 
     attr_accessor :base_style
 
-    attr_accessor :shapes
+    def_delegators :shape, :element, :line, :text
 
     def initialize
       @base_style = BaseStyle.new(white_space: :wrap, html: 1, rounded: nil, shadow: nil, sketch: nil, glass: nil)
-
-      # TODO: these need to be removed
-      add_shapes
     end
 
-    def stroke(type)
-      strokes[type] || ''
+    def stroke(key)
+      strokes[key] || ''
     end
 
     def strokes
@@ -33,104 +27,171 @@ module DrawioDsl
 
       @strokes = {}
       source_config['strokes'].each do |stroke|
-        @strokes[stroke['type'].to_sym] = stroke['style']
+        @strokes[stroke['key'].to_sym] = stroke['style']
       end
 
       @strokes
     end
 
     # need test
-    def get_item_by_category(type, category)
+    def get_item_by_category(key, category)
       case category
       when :text
-        text(type)
+        text(key)
       when :line
-        line(type)
+        line(key)
       else
-        element(type)
+        element(key)
       end
     end
 
-    def element(type)
-      elements[type]
+    def shape
+      @shape ||= Shape.new(source_config['shape'])
     end
 
-    def elements
-      return @elements if defined? @elements
-
-      @elements = {}
-      source_config['shapes'].select { |shape| shape['category'] == 'element' }.each do |element|
-        @elements[element['type'].to_sym] = ElementConfig.new(
-          type: element['type'].to_sym,
-          x: element['x'].to_i,
-          y: element['y'].to_i,
-          w: element['w'].to_i,
-          h: element['h'].to_i,
-          style_modifiers: element['style_modifiers']
-        )
-      end
+    def connector
+      @connector ||= Connector.new(source_config['connector'])
+    end
 
-      @elements
+    def theme
+      @theme ||= Theme.new(source_config['theme'])
     end
 
-    def line(type)
-      lines[type]
+    def source_config
+      return @source_config if defined? @source_config
+
+      @source_config = begin
+        file = File.join(DrawioDsl::ROOT_PATH, 'config/configuration.json')
+        JSON.parse(File.read(file))
+      end
     end
 
-    def lines
-      return @lines if defined? @lines
-
-      @lines = {}
-      source_config['shapes'].select { |shape| shape['category'] == 'line' }.each do |line|
-        @lines[line['type'].to_sym] = LineConfig.new(
-          type: line['type'].to_sym,
-          x: line['x'].to_i,
-          y: line['y'].to_i,
-          w: line['w'].to_i,
-          h: line['h'].to_i,
-          style_modifiers: line['style_modifiers']
+    class Shape
+      attr_reader :source_config
+
+      ElementShapeConfig = Struct.new(:key, :x, :y, :w, :h, :style_modifiers, keyword_init: true)
+      LineShapeConfig    = Struct.new(:key, :x, :y, :w, :h, :style_modifiers, keyword_init: true)
+      TextShapeConfig    = Struct.new(:key, :x, :y, :w, :h, :style_modifiers, keyword_init: true)
+
+      def initialize(source_config)
+        @source_config = source_config
+      end
+
+      # Elements
+
+      def element(key)
+        elements[key] || ElementShapeConfig.new(
+          key: :square,
+          x: 0,
+          y: 0,
+          w: 160,
+          h: 160,
+          style_modifiers: ''
         )
       end
 
-      @lines
-    end
+      def elements
+        return @elements if defined? @elements
 
-    def text(type)
-      texts[type]
-    end
+        @elements = {}
+        source_config['elements'].each do |element|
+          @elements[element['key'].to_sym] = ElementShapeConfig.new(
+            key: element['key'].to_sym,
+            x: element['x'].to_i,
+            y: element['y'].to_i,
+            w: element['w'].to_i,
+            h: element['h'].to_i,
+            style_modifiers: element['style_modifiers']
+          )
+        end
 
-    def texts
-      return @texts if defined? @texts
-
-      @texts = {}
-      source_config['shapes'].select { |shape| shape['category'] == 'text' }.each do |text|
-        @texts[text['type'].to_sym] = TextConfig.new(
-          type: text['type'].to_sym,
-          x: text['x'].to_i,
-          y: text['y'].to_i,
-          w: text['w'].to_i,
-          h: text['h'].to_i,
-          style_modifiers: text['style_modifiers']
+        @elements
+      end
+
+      def element_keys
+        elements.keys
+      end
+
+      def random_element_key
+        elements.values.sample.key
+      end
+
+      # Lines
+
+      def line(key)
+        lines[key] || LineShapeConfig.new(
+          key: :solid,
+          x: 0,
+          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'
         )
       end
 
-      @texts
-    end
+      def lines
+        return @lines if defined? @lines
+
+        @lines = {}
+        source_config['lines'].each do |line|
+          @lines[line['key'].to_sym] = LineShapeConfig.new(
+            key: line['key'].to_sym,
+            x: line['x'].to_i,
+            y: line['y'].to_i,
+            w: line['w'].to_i,
+            h: line['h'].to_i,
+            style_modifiers: line['style_modifiers']
+          )
+        end
 
-    def connector
-      @connector ||= Connector.new(source_config['connector'])
-    end
+        @lines
+      end
 
-    def theme
-      @theme ||= Theme.new(source_config['theme'])
-    end
+      def line_keys
+        lines.keys
+      end
 
-    def source_config
-      return @source_config if defined? @source_config
+      def random_line_key
+        lines.values.sample.key
+      end
 
-      @source_config = begin
-        file = File.join(DrawioDsl::ROOT_PATH, 'config/configuration.json')
-        JSON.parse(File.read(file))
+      def text(key)
+        texts[key] || TextShapeConfig.new(
+          key: :p,
+          x: 0,
+          y: 0,
+          w: 100,
+          h: 50,
+          style_modifiers: 'text;fontSize=16;fontStyle=1;fillColor=none'
+        )
+      end
+
+      # Texts
+
+      def texts
+        return @texts if defined? @texts
+
+        @texts = {}
+        source_config['texts'].each do |text|
+          @texts[text['key'].to_sym] = TextShapeConfig.new(
+            key: text['key'].to_sym,
+            x: text['x'].to_i,
+            y: text['y'].to_i,
+            w: text['w'].to_i,
+            h: text['h'].to_i,
+            style_modifiers: text['style_modifiers']
+          )
+        end
+
+        @texts
+      end
+
+      def text_keys
+        texts.keys
+      end
+
+      def random_text_key
+        texts.values.sample.key
       end
     end
 
@@ -144,8 +205,8 @@ module DrawioDsl
         @source_config = source_config
       end
 
-      def compass_point(type)
-        compass_points[type] || XyConfig.new(x: 0, y: 0)
+      def compass_point(key)
+        compass_points[key] || XyConfig.new(x: 0, y: 0)
       end
 
       def compass_points
@@ -153,14 +214,14 @@ module DrawioDsl
 
         @compass_points = {}
         source_config['compass_points'].each do |compass_point|
-          @compass_points[compass_point['type'].to_sym] = XyConfig.new(x: compass_point['x'], y: compass_point['y'])
+          @compass_points[compass_point['key'].to_sym] = XyConfig.new(x: compass_point['x'], y: compass_point['y'])
         end
 
         @compass_points
       end
 
-      def waypoint(type)
-        waypoints[type] || ''
+      def waypoint(key)
+        waypoints[key] || ''
       end
 
       def waypoints
@@ -168,14 +229,14 @@ module DrawioDsl
 
         @waypoints = {}
         source_config['waypoints'].each do |waypoint|
-          @waypoints[waypoint['type'].to_sym] = waypoint['style']
+          @waypoints[waypoint['key'].to_sym] = waypoint['style']
         end
 
         @waypoints
       end
 
-      def arrow(type)
-        arrows[type] || 'open'
+      def arrow(key)
+        arrows[key] || 'open'
       end
 
       def arrows
@@ -183,14 +244,14 @@ module DrawioDsl
 
         @arrows = {}
         source_config['arrows'].each do |arrow|
-          @arrows[arrow['type'].to_sym] = arrow['style']
+          @arrows[arrow['key'].to_sym] = arrow['style']
         end
 
         @arrows
       end
 
-      def design(type)
-        designs[type] || ''
+      def design(key)
+        designs[key] || ''
       end
 
       def designs
@@ -198,7 +259,7 @@ module DrawioDsl
 
         @designs = {}
         source_config['designs'].each do |design|
-          @designs[design['type'].to_sym] = design['style']
+          @designs[design['key'].to_sym] = design['style']
         end
 
         @designs
@@ -208,18 +269,19 @@ module DrawioDsl
     class Theme
       attr_reader :source_config
 
-      BackgroundThemeConfig = Struct.new(:type, :bg_color, :font_color, keyword_init: true)
-      ElementThemeConfig = Struct.new(:type, :fill_color, :stroke_color, :font_color, :gradient, keyword_init: true)
+      BackgroundThemeConfig = Struct.new(:key, :bg_color, :font_color, :favourite, keyword_init: true)
+      ElementThemeConfig = Struct.new(:key, :fill_color, :stroke_color, :font_color, :gradient, keyword_init: true)
 
       def initialize(source_config)
         @source_config = source_config
       end
 
-      def background(type)
-        backgrounds[type] || BackgroundThemeConfig.new(
-          type: type,
+      def background(key)
+        backgrounds[key] || BackgroundThemeConfig.new(
+          key: key,
           bg_color: '#000000',
-          font_color: '#ffffff'
+          font_color: '#FFFFFF',
+          favourite: false
         )
       end
 
@@ -228,27 +290,32 @@ module DrawioDsl
 
         @backgrounds = {}
         source_config['backgrounds'].each do |background|
-          @backgrounds[background['type'].to_sym] = BackgroundThemeConfig.new(
-            type: background['type'].to_sym,
+          @backgrounds[background['key'].to_sym] = BackgroundThemeConfig.new(
+            key: background['key'].to_sym,
             bg_color: background['bg_color'],
-            font_color: background['font_color']
+            font_color: background['font_color'],
+            favourite: background['favourite'] == 1
           )
         end
 
         @backgrounds
       end
 
-      def background_types
+      def background_keys
         backgrounds.keys
       end
 
-      def random_background_type
-        backgrounds.values.sample.type
+      def favourite_background_keys
+        backgrounds.values.select(&:favourite).map(&:key)
+      end
+
+      def random_background_key
+        backgrounds.values.sample.key
       end
 
-      def element(type)
-        elements[type] || ElementThemeConfig.new(
-          type: type,
+      def element(key)
+        elements[key] || ElementThemeConfig.new(
+          key: key,
           fill_color: '#ffffff',
           stroke_color: '#000000',
           font_color: '#000000',
@@ -261,8 +328,8 @@ module DrawioDsl
 
         @elements = {}
         source_config['elements'].each do |element|
-          @elements[element['type'].to_sym] = ElementThemeConfig.new(
-            type: element['type'].to_sym,
+          @elements[element['key'].to_sym] = ElementThemeConfig.new(
+            key: element['key'].to_sym,
             fill_color: element['fill_color'],
             stroke_color: element['stroke_color'],
             font_color: element['font_color'],
@@ -273,12 +340,12 @@ module DrawioDsl
         @elements
       end
 
-      def element_types
+      def element_keys
         elements.keys
       end
 
-      def random_element_type
-        elements.values.sample.type
+      def random_element_key
+        elements.values.sample.key
       end
     end
   end

data/lib/drawio_dsl/dom_builder.rb

@@ -47,8 +47,8 @@ module DrawioDsl
       current_page.id = SecureRandom.alphanumeric(3) unless current_page.id
 
       # add anchor nodes
-      page_anchor = DrawioDsl::Schema::Anchor.new(self, id: "page_root_#{current_page.id}", type: :page_root)
-      node_anchor = DrawioDsl::Schema::Anchor.new(self, id: "node_root_#{current_page.id}", type: :node_root)
+      page_anchor = DrawioDsl::Schema::Anchor.new(self, id: "page_root_#{current_page.id}", key: :page_root)
+      node_anchor = DrawioDsl::Schema::Anchor.new(self, id: "node_root_#{current_page.id}", key: :node_root)
       page_anchor.add_node(node_anchor)
 
       @focus_node = node_anchor

data/lib/drawio_dsl/schema/diagram.rb

@@ -15,7 +15,7 @@ module DrawioDsl
       def initialize(**args)
         @host     = args[:host]     || SecureRandom.alphanumeric(3)
         # TODO: assess and resolve this inconsistency
-        @theme    = args[:theme]    || KConfig.configuration.drawio.theme.random_background_type
+        @theme    = args[:theme]    || KConfig.configuration.drawio.theme.random_background_key
         @bg_theme = args[:bg_theme] || :not_set
 
         @style = DrawioDsl::Schema::CommonStyle.new(**args) do

data/lib/drawio_dsl/schema/elements/.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DrawioDsl
+  module Schema
+    class EmbedCol200 < Element
+      configure_as(:embed_col200)
+    end
+  end
+end

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

@@ -15,7 +15,7 @@ module DrawioDsl
         @gap = args[:gap] || 20
         @perpendicular_max = 0
 
-        super(page, **args.merge(type: :flex_layout))
+        super(page, **args.merge(key: :flex_layout))
       end
 
       def position_shape(shape)

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

@@ -24,7 +24,7 @@ module DrawioDsl
         @v_align    = args[:v_align]    || :center
         @cell_no    = 1
 
-        super(page, **args.merge(type: :grid_layout))
+        super(page, **args.merge(key: :grid_layout))
       end
       # rubocop:enable Metrics/CyclomaticComplexity
 

data/lib/drawio_dsl/schema/lines/.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DrawioDsl
+  module Schema
+    class Solid < Line
+      configure_as(:solid)
+    end
+  end
+end

data/lib/drawio_dsl/schema/node.rb

@@ -9,7 +9,7 @@ module DrawioDsl
       attr_accessor :page
       attr_accessor :parent
       attr_accessor :classification
-      attr_accessor :type
+      attr_accessor :key
       attr_accessor :nodes
 
       def initialize(page, **args)
@@ -17,7 +17,7 @@ module DrawioDsl
         @id = args[:id]
         @parent = args[:parent]
         @classification = args[:classification] || :unknown
-        @type = args[:type] || :unknown
+        @key = args[:key] || :unknown
         @nodes = NodeList.new
       end
 
@@ -26,7 +26,7 @@ module DrawioDsl
           id: id,
           parent_id: parent&.id,
           classification: classification,
-          type: type
+          key: key
         }
         result[:nodes] = nodes.to_h if nodes.any?
         result
@@ -58,11 +58,11 @@ module DrawioDsl
       end
 
       # rubocop:disable Metrics/ParameterLists
-      def debug_row(classification, id, type = nil, x = nil, y = nil, width = nil, height = nil)
+      def debug_row(classification, id, key = nil, x = nil, y = nil, width = nil, height = nil)
         row = []
         row << classification.to_s.ljust(11)
         row << id.to_s.ljust(6)
-        row << (type.nil? ? '' : type).to_s.ljust(15)
+        row << (key.nil? ? '' : key).to_s.ljust(15)
         row << (x.nil? ? '' : x).to_s.rjust(5)
         row << (y.nil? ? '' : y).to_s.rjust(5)
         row << (width.nil? ? '' : width).to_s.rjust(5)

data/lib/drawio_dsl/schema/page.rb

@@ -46,7 +46,6 @@ module DrawioDsl
         @theme        = args[:theme] || diagram.theme
         @bg_theme     = args[:bg_theme] || diagram.bg_theme
 
-        puts "Page has theme: #{theme}"
         # cursor positioning is used by the layout engine
         @position_x   = 0
         @position_y   = 0

data/lib/drawio_dsl/schema/shape.rb

@@ -75,7 +75,7 @@ module DrawioDsl
         @sketch           = args[:sketch]           || page.style.sketch
         @glass            = args[:glass]            || page.style.glass
 
-        @type             = args[:type]             || shape_defaults.type
+        @key              = args[:key]              || shape_defaults.key
         @x                = args[:x]                || shape_defaults.x
         @y                = args[:y]                || shape_defaults.y
         @w                = args[:w]                || shape_defaults.w
@@ -83,9 +83,9 @@ module DrawioDsl
         @style_modifiers  = args[:style_modifiers]  || shape_defaults.style_modifiers
       end
 
-      def format(type = nil)
-        type ||= self.class.shape_key
-        format_instance(type)
+      def format(key = nil)
+        key ||= self.class.shape_key
+        format_instance(key)
       end
 
       def style
@@ -108,7 +108,7 @@ module DrawioDsl
 
       def as_xml(xml)
         # log.error category
-        # log.error type
+        # log.error key
         draw_element(xml) if is_a?(Element) || is_a?(Text)
         draw_line(xml)    if is_a?(Line)
       end
@@ -130,7 +130,7 @@ module DrawioDsl
           id: id,
           parent_id: parent&.id,
           classification: classification,
-          type: type,
+          key: key,
           x: x,
           y: y,
           w: w,
@@ -153,9 +153,9 @@ module DrawioDsl
       # :nocov:
       def debug(format: :detail)
         if format == :detail
-          debug_detail({ id: id, classification: classification, type: type })
+          debug_detail({ id: id, classification: classification, key: key })
         else
-          debug_row(classification, id, type, x, y, w, h)
+          debug_row(classification, id, key, x, y, w, h)
         end
       end
       # :nocov:

data/lib/drawio_dsl/schema/texts/.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DrawioDsl
+  module Schema
+    class P < Text
+      configure_as(:p)
+    end
+  end
+end

data/lib/drawio_dsl/version.rb

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

data/lib/drawio_dsl.rb

@@ -2,7 +2,7 @@
 
 require 'securerandom'
 require 'nokogiri'
-
+require 'forwardable'
 require 'k_config'
 require 'k_log'
 require 'k_director'
@@ -15,7 +15,6 @@ module DrawioDsl
 end
 
 require_relative 'drawio_dsl/configuration_extension'
-require_relative 'drawio_dsl/configuration_shapes'
 require_relative 'drawio_dsl/configuration'
 require_relative 'drawio_dsl/version'
 require_relative 'drawio_dsl/formatters/_'

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "drawio_dsl",
-  "version": "0.10.0",
+  "version": "0.11.1",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "drawio_dsl",
-      "version": "0.10.0",
+      "version": "0.11.1",
       "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.10.0",
+  "version": "0.11.1",
   "description": "DrawIO DSL can build DrawIO diagrams using a Domain Specific Language",
   "scripts": {
     "release": "semantic-release"