drawio_dsl 0.8.11 → 0.10.1

data/lib/drawio_dsl/configuration.rb

@@ -5,14 +5,13 @@ module DrawioDsl
   # Configuration container for the DrawIO DSL
   class Configuration
     include DrawioDsl::ConfigurationShapes
-    include DrawioDsl::ConfigurationThemes
 
     include KLog::Logging
 
-    BaseStyle = Struct.new(:white_space, :html, :rounded, :shadow, :sketch, :glass, keyword_init: true)
-    Element = Struct.new(:type, :x, :y, :w, :h, :style_modifiers, keyword_init: true)
-    Line = Struct.new(:type, :x, :y, :w, :h, :style_modifiers, keyword_init: true)
-    Text = Struct.new(:type, :x, :y, :w, :h, :style_modifiers, keyword_init: true)
+    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
 
@@ -21,16 +20,8 @@ module DrawioDsl
     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
-      add_themes
-    end
-
-    def palette(theme)
-      themes[theme]
-    end
-
-    def random_theme
-      themes.keys.sample
     end
 
     def stroke(type)
@@ -48,8 +39,20 @@ module DrawioDsl
       @strokes
     end
 
+    # need test
+    def get_item_by_category(type, category)
+      case category
+      when :text
+        text(type)
+      when :line
+        line(type)
+      else
+        element(type)
+      end
+    end
+
     def element(type)
-      elements[type] || ''
+      elements[type]
     end
 
     def elements
@@ -57,7 +60,7 @@ module DrawioDsl
 
       @elements = {}
       source_config['shapes'].select { |shape| shape['category'] == 'element' }.each do |element|
-        @elements[element['type'].to_sym] = Element.new(
+        @elements[element['type'].to_sym] = ElementConfig.new(
           type: element['type'].to_sym,
           x: element['x'].to_i,
           y: element['y'].to_i,
@@ -71,7 +74,7 @@ module DrawioDsl
     end
 
     def line(type)
-      lines[type] || ''
+      lines[type]
     end
 
     def lines
@@ -79,7 +82,7 @@ module DrawioDsl
 
       @lines = {}
       source_config['shapes'].select { |shape| shape['category'] == 'line' }.each do |line|
-        @lines[line['type'].to_sym] = Line.new(
+        @lines[line['type'].to_sym] = LineConfig.new(
           type: line['type'].to_sym,
           x: line['x'].to_i,
           y: line['y'].to_i,
@@ -93,7 +96,7 @@ module DrawioDsl
     end
 
     def text(type)
-      texts[type] || ''
+      texts[type]
     end
 
     def texts
@@ -101,7 +104,7 @@ module DrawioDsl
 
       @texts = {}
       source_config['shapes'].select { |shape| shape['category'] == 'text' }.each do |text|
-        @texts[text['type'].to_sym] = Text.new(
+        @texts[text['type'].to_sym] = TextConfig.new(
           type: text['type'].to_sym,
           x: text['x'].to_i,
           y: text['y'].to_i,
@@ -118,6 +121,10 @@ module DrawioDsl
       @connector ||= Connector.new(source_config['connector'])
     end
 
+    def theme
+      @theme ||= Theme.new(source_config['theme'])
+    end
+
     def source_config
       return @source_config if defined? @source_config
 
@@ -197,6 +204,89 @@ module DrawioDsl
         @designs
       end
     end
+
+    class Theme
+      attr_reader :source_config
+
+      BackgroundThemeConfig = Struct.new(:type, :bg_color, :font_color, :favourite, keyword_init: true)
+      ElementThemeConfig = Struct.new(:type, :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,
+          bg_color: '#000000',
+          font_color: '#FFFFFF',
+          favourite: false
+        )
+      end
+
+      def backgrounds
+        return @backgrounds if defined? @backgrounds
+
+        @backgrounds = {}
+        source_config['backgrounds'].each do |background|
+          @backgrounds[background['type'].to_sym] = BackgroundThemeConfig.new(
+            type: background['type'].to_sym,
+            bg_color: background['bg_color'],
+            font_color: background['font_color'],
+            favourite: background['favourite'] == 1
+          )
+        end
+
+        @backgrounds
+      end
+
+      def background_types
+        backgrounds.keys
+      end
+
+      def favourite_background_types
+        backgrounds.values.select(&:favourite).map(&:type)
+      end
+
+      def random_background_type
+        backgrounds.values.sample.type
+      end
+
+      def element(type)
+        elements[type] || ElementThemeConfig.new(
+          type: type,
+          fill_color: '#ffffff',
+          stroke_color: '#000000',
+          font_color: '#000000',
+          gradient: nil
+        )
+      end
+
+      def elements
+        return @elements if defined? @elements
+
+        @elements = {}
+        source_config['elements'].each do |element|
+          @elements[element['type'].to_sym] = ElementThemeConfig.new(
+            type: element['type'].to_sym,
+            fill_color: element['fill_color'],
+            stroke_color: element['stroke_color'],
+            font_color: element['font_color'],
+            gradient: element['gradient']
+          )
+        end
+
+        @elements
+      end
+
+      def element_types
+        elements.keys
+      end
+
+      def random_element_type
+        elements.values.sample.type
+      end
+    end
   end
 end
 

data/lib/drawio_dsl/configuration_shapes.rb

@@ -8,7 +8,7 @@ module DrawioDsl
     ShapeDefaults = Struct.new(:type, :category, :x, :y, :w, :h, :style_modifiers, keyword_init: true)
     Shapes = Struct.new(
       :shape,
-      :line,
+      :solid,
       :h1,
       :h2,
       :h3,
@@ -58,14 +58,14 @@ 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'),
-        h4: ShapeDefaults.new(type: :h4, x: 0, category: :text, y: 0, w: 100, h: 50, style_modifiers: 'text;fontSize=37;fontColor=#ffffff;fontStyle=1;fillColor=none'),
-        h5: ShapeDefaults.new(type: :h5, x: 0, category: :text, y: 0, w: 100, h: 50, style_modifiers: 'text;fontSize=28;fontColor=#ffffff;fontStyle=1;fillColor=none'),
-        h6: ShapeDefaults.new(type: :h6, x: 0, category: :text, y: 0, w: 100, h: 50, style_modifiers: 'text;fontSize=21;fontColor=#ffffff;fontStyle=1;fillColor=none'),
-        p: ShapeDefaults.new(type: :p, x: 0, category: :text, y: 0, w: 100, h: 50, style_modifiers: 'text;fontSize=16;fontColor=#ffffff;fontStyle=1;fillColor=none'),
+        solid: ShapeDefaults.new(type: :solid, 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;fontStyle=1;fillColor=none'),
+        h2: ShapeDefaults.new(type: :h2, x: 0, category: :text, y: 0, w: 100, h: 50, style_modifiers: 'text;fontSize=67;fontStyle=1;fillColor=none'),
+        h3: ShapeDefaults.new(type: :h3, x: 0, category: :text, y: 0, w: 100, h: 50, style_modifiers: 'text;fontSize=50;fontStyle=1;fillColor=none'),
+        h4: ShapeDefaults.new(type: :h4, x: 0, category: :text, y: 0, w: 100, h: 50, style_modifiers: 'text;fontSize=37;fontStyle=1;fillColor=none'),
+        h5: ShapeDefaults.new(type: :h5, x: 0, category: :text, y: 0, w: 100, h: 50, style_modifiers: 'text;fontSize=28;fontStyle=1;fillColor=none'),
+        h6: ShapeDefaults.new(type: :h6, x: 0, category: :text, y: 0, w: 100, h: 50, style_modifiers: 'text;fontSize=21;fontStyle=1;fillColor=none'),
+        p: ShapeDefaults.new(type: :p, x: 0, category: :text, y: 0, w: 100, h: 50, style_modifiers: 'text;fontSize=16;fontStyle=1;fillColor=none'),
         actor: ShapeDefaults.new(type: :actor, x: 0, category: :element, y: 0, w: 40, h: 50, style_modifiers: 'shape=actor'),
         actor2: ShapeDefaults.new(type: :actor2, x: 0, category: :element, y: 0, w: 30, h: 50, style_modifiers: 'shape=umlActor;verticalLabelPosition=bottom;outlineConnect=1'),
         callout: ShapeDefaults.new(type: :callout, x: 0, category: :element, y: 0, w: 160, h: 120, style_modifiers: 'shape=callout'),

data/lib/drawio_dsl/dom_builder_shapes.rb

@@ -4,10 +4,10 @@
 module DrawioDsl
   # DrawioDsl is a DSL for draw-io diagrams.
   module DomBuilderShapes
-    def add_line(id = nil, **opts, &block)
+    def add_solid(id = nil, **opts, &block)
       opts = { id: id }.merge(opts) if id
-      line = DrawioDsl::Schema::Line.new(current_page, **opts, &block)
-      add_shape(line)
+      solid = DrawioDsl::Schema::Solid.new(current_page, **opts, &block)
+      add_shape(solid)
     end
 
     def add_h1(id = nil, **opts, &block)

data/lib/drawio_dsl/drawio_shapes.rb

@@ -7,7 +7,7 @@ module DrawioDsl
     def random(**opts)
       case rand(44)
       when 0
-        line(**opts)
+        solid(**opts)
       when 1
         h1(**opts)
       when 2
@@ -97,8 +97,8 @@ module DrawioDsl
       end
     end
 
-    def line(id = nil, **opts, &block)
-      builder.add_line(id, **opts, &block)
+    def solid(id = nil, **opts, &block)
+      builder.add_solid(id, **opts, &block)
     end
 
     def h1(id = nil, **opts, &block)

data/lib/drawio_dsl/schema/_.rb

@@ -11,50 +11,60 @@ require_relative 'layouts/layout'
 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'
-require_relative 'shapes/h4'
-require_relative 'shapes/h5'
-require_relative 'shapes/h6'
-require_relative 'shapes/p'
-require_relative 'shapes/actor'
-require_relative 'shapes/actor2'
-require_relative 'shapes/callout'
-require_relative 'shapes/callout2'
-require_relative 'shapes/callout3'
-require_relative 'shapes/callout4'
-require_relative 'shapes/circle'
-require_relative 'shapes/cloud'
-require_relative 'shapes/container'
-require_relative 'shapes/container2'
-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'
-require_relative 'shapes/group'
-require_relative 'shapes/hexagon'
-require_relative 'shapes/interface'
-require_relative 'shapes/klass'
-require_relative 'shapes/note'
-require_relative 'shapes/process'
-require_relative 'shapes/rectangle'
-require_relative 'shapes/rectangle2'
-require_relative 'shapes/square'
-require_relative 'shapes/step'
-require_relative 'shapes/tick'
-require_relative 'shapes/todo'
-require_relative 'shapes/face'
-require_relative 'shapes/triangle'
-require_relative 'shapes/embed_row'
-require_relative 'shapes/embed_col50'
-require_relative 'shapes/embed_col200'
+require_relative 'shape'
+require_relative 'element'
+require_relative 'line'
+require_relative 'text'
 
+# Block elements such as actor, callout, square, circle, etc.
+require_relative 'elements/actor'
+require_relative 'elements/actor2'
+require_relative 'elements/callout'
+require_relative 'elements/callout2'
+require_relative 'elements/callout3'
+require_relative 'elements/callout4'
+require_relative 'elements/circle'
+require_relative 'elements/cloud'
+require_relative 'elements/container'
+require_relative 'elements/container2'
+require_relative 'elements/container3'
+require_relative 'elements/container4'
+require_relative 'elements/cross'
+require_relative 'elements/envelop'
+require_relative 'elements/database'
+require_relative 'elements/db_json'
+require_relative 'elements/diamond'
+require_relative 'elements/document'
+require_relative 'elements/ellipse'
+require_relative 'elements/group'
+require_relative 'elements/hexagon'
+require_relative 'elements/interface'
+require_relative 'elements/klass'
+require_relative 'elements/note'
+require_relative 'elements/process'
+require_relative 'elements/rectangle'
+require_relative 'elements/rectangle2'
+require_relative 'elements/square'
+require_relative 'elements/step'
+require_relative 'elements/tick'
+require_relative 'elements/todo'
+require_relative 'elements/face'
+require_relative 'elements/triangle'
+require_relative 'elements/embed_row'
+require_relative 'elements/embed_col50'
+require_relative 'elements/embed_col200'
+
+# Connector lines
+require_relative 'lines/solid'
+
+# Text elements such as h1, h2, p, etc.
+require_relative 'texts/h1'
+require_relative 'texts/h2'
+require_relative 'texts/h3'
+require_relative 'texts/h4'
+require_relative 'texts/h5'
+require_relative 'texts/h6'
+require_relative 'texts/p'
+
+# Virtual elements have internal uses
 require_relative 'virtual/anchor'

data/lib/drawio_dsl/schema/diagram.rb

@@ -6,16 +6,17 @@ module DrawioDsl
     class Diagram
       attr_accessor :host
       attr_accessor :theme
+      attr_accessor :bg_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
+        @host     = args[:host]     || SecureRandom.alphanumeric(3)
+        # TODO: assess and resolve this inconsistency
+        @theme    = args[:theme]    || KConfig.configuration.drawio.theme.random_background_type
+        @bg_theme = args[:bg_theme] || :not_set
 
         @style = DrawioDsl::Schema::CommonStyle.new(**args) do
           default_style = KConfig.configuration.drawio.base_style
@@ -30,19 +31,24 @@ module DrawioDsl
         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
+          @fill_color   ||= diagram.theme_palette.fill_color
+          @stroke_color ||= diagram.theme_palette.stroke_color
+          @font_color   ||= diagram.theme_palette.font_color
+          @gradient     ||= diagram.theme_palette.gradient
         end
 
         @pages = args[:pages] || []
       end
       # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
+      def theme_palette
+        @theme_palette ||= KConfig.configuration.drawio.theme.element(theme)
+      end
+
+      def bg_theme_palette
+        @bg_theme_palette ||= KConfig.configuration.drawio.theme.background(bg_theme)
+      end
+
       def to_h
         {
           host: host,

data/lib/drawio_dsl/schema/element.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module DrawioDsl
+  module Schema
+    # Elements represents some kind of shape such as a Square, Circle, Callout, Actor, etc.
+    class Element < Shape
+      class << self
+        def configure_as(key)
+          configure_shape(key, :element)
+        end
+      end
+
+      def apply_defaults(args)
+        super(args)
+
+        @fill_color       = args[:fill_color]       || theme_palette.fill_color
+        @stroke_color     = args[:stroke_color]     || theme_palette.stroke_color
+        @gradient         = args[:gradient]         || theme_palette.gradient
+        @font_color       = args[:font_color]       || theme_palette.font_color
+      end
+    end
+  end
+end

data/lib/drawio_dsl/schema/{shapes/face.rb → elements/actor.rb}

@@ -2,8 +2,8 @@
 
 module DrawioDsl
   module Schema
-    class Face < Shape
-      configure_shape(:face)
+    class Actor < Element
+      configure_as(:actor)
     end
   end
 end

data/lib/drawio_dsl/schema/{shapes/cross.rb → elements/actor2.rb}

@@ -2,8 +2,8 @@
 
 module DrawioDsl
   module Schema
-    class Cross < Shape
-      configure_shape(:cross)
+    class Actor2 < Element
+      configure_as(:actor2)
     end
   end
 end

data/lib/drawio_dsl/schema/{shapes/actor2.rb → elements/callout.rb}

@@ -2,8 +2,8 @@
 
 module DrawioDsl
   module Schema
-    class Actor2 < Shape
-      configure_shape(:actor2)
+    class Callout < Element
+      configure_as(:callout)
     end
   end
 end

data/lib/drawio_dsl/schema/{shapes/callout.rb → elements/callout2.rb}

@@ -2,8 +2,8 @@
 
 module DrawioDsl
   module Schema
-    class Callout < Shape
-      configure_shape(:callout)
+    class Callout2 < Element
+      configure_as(:callout2)
     end
   end
 end

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

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

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

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

data/lib/drawio_dsl/schema/{shapes/actor.rb → elements/circle.rb}

@@ -2,8 +2,8 @@
 
 module DrawioDsl
   module Schema
-    class Actor < Shape
-      configure_shape(:actor)
+    class Circle < Element
+      configure_as(:circle)
     end
   end
 end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

data/lib/drawio_dsl/schema/{shapes/circle.rb → elements/db_json.rb}

@@ -2,8 +2,8 @@
 
 module DrawioDsl
   module Schema
-    class Circle < Shape
-      configure_shape(:circle)
+    class DbJson < Element
+      configure_as(:db_json)
     end
   end
 end

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

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

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

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

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

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

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

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