drawio_dsl 0.9.0 → 0.11.0

data/lib/drawio_dsl/configuration.rb

@@ -4,33 +4,18 @@
 module DrawioDsl
   # Configuration container for the DrawIO DSL
   class Configuration
-    include DrawioDsl::ConfigurationShapes
-    include DrawioDsl::ConfigurationThemes
+    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)
+    BaseStyle     = Struct.new(:white_space, :html, :rounded, :shadow, :sketch, :glass, 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)
-
-      add_shapes
-      add_themes
-    end
-
-    def palette(theme)
-      themes[theme]
-    end
-
-    def random_theme
-      themes.keys.sample
     end
 
     def stroke(type)
@@ -60,82 +45,153 @@ module DrawioDsl
       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(:type, :x, :y, :w, :h, :style_modifiers, keyword_init: true)
+      LineShapeConfig    = Struct.new(:type, :x, :y, :w, :h, :style_modifiers, keyword_init: true)
+      TextShapeConfig    = Struct.new(:type, :x, :y, :w, :h, :style_modifiers, keyword_init: true)
+
+      def initialize(source_config)
+        @source_config = source_config
+      end
+
+      # Elements
+
+      def element(type)
+        elements[type] || ElementShapeConfig.new(
+          type: :square,
+          x: 0,
+          y: 0,
+          w: 160,
+          h: 160,
+          style_modifiers: ''
         )
       end
 
-      @lines
-    end
+      def elements
+        return @elements if defined? @elements
+
+        @elements = {}
+        source_config['elements'].each do |element|
+          @elements[element['type'].to_sym] = ElementShapeConfig.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 text(type)
-      texts[type]
-    end
+        @elements
+      end
+
+      def element_types
+        elements.keys
+      end
+
+      def random_element_type
+        elements.values.sample.type
+      end
+
+      # Lines
 
-    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']
+      def line(type)
+        lines[type] || LineShapeConfig.new(
+          type: :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['type'].to_sym] = LineShapeConfig.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']
+          )
+        end
 
-    def connector
-      @connector ||= Connector.new(source_config['connector'])
-    end
+        @lines
+      end
 
-    def source_config
-      return @source_config if defined? @source_config
+      def line_types
+        lines.keys
+      end
 
-      @source_config = begin
-        file = File.join(DrawioDsl::ROOT_PATH, 'config/configuration.json')
-        JSON.parse(File.read(file))
+      def random_line_type
+        lines.values.sample.type
+      end
+
+      def text(type)
+        texts[type] || TextShapeConfig.new(
+          type: :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['type'].to_sym] = TextShapeConfig.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']
+          )
+        end
+
+        @texts
+      end
+
+      def text_types
+        texts.keys
+      end
+
+      def random_text_type
+        texts.values.sample.type
       end
     end
 
@@ -209,6 +265,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/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.element_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

@@ -16,7 +16,7 @@ module DrawioDsl
         @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.element_font_color
+        @font_color       = args[:font_color]       || theme_palette.font_color
       end
     end
   end

data/lib/drawio_dsl/schema/page.rb

@@ -14,6 +14,7 @@ module DrawioDsl
       attr_accessor :active
       attr_reader :name
       attr_reader :theme
+      attr_reader :bg_theme
       attr_reader :style
       attr_reader :palette
       attr_reader :margin_left
@@ -43,6 +44,7 @@ module DrawioDsl
         @active       = args[:active].nil? ? true : !args[:active].nil?
         @name         = args[:name]
         @theme        = args[:theme] || diagram.theme
+        @bg_theme     = args[:bg_theme] || diagram.bg_theme
 
         # cursor positioning is used by the layout engine
         @position_x   = 0
@@ -64,7 +66,7 @@ module DrawioDsl
         @page_scale   = args[:page_scale]   || 1
         @page_width   = args[:page_width]   || 1169 # A4
         @page_height  = args[:page_height]  || 827  # A4
-        @background   = args[:background]   || '#FFFACD'
+        @background   = args[:background]   || bg_theme_palette.bg_color
         @page_shadow  = args[:page_shadow]  || 0
         @math         = args[:math]         || 0
 
@@ -82,7 +84,7 @@ module DrawioDsl
           # Inherit from theme when specific palette options are not specified.
           @fill_color   ||= page.theme_palette.fill_color
           @stroke_color ||= page.theme_palette.stroke_color
-          @font_color   ||= page.theme_palette.element_font_color
+          @font_color   ||= page.theme_palette.font_color
           @gradient     ||= page.theme_palette.gradient
         end
 
@@ -100,7 +102,11 @@ module DrawioDsl
       end
 
       def theme_palette
-        @theme_palette ||= KConfig.configuration.drawio.palette(theme)
+        @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 as_xml(xml)

data/lib/drawio_dsl/schema/shape.rb

@@ -142,7 +142,12 @@ module DrawioDsl
       end
 
       def theme_palette
-        @theme_palette ||= KConfig.configuration.drawio.palette(theme)
+        @theme_palette ||= KConfig.configuration.drawio.theme.element(theme)
+      end
+
+      # TODO: test
+      def bg_theme_palette
+        @bg_theme_palette ||= KConfig.configuration.drawio.theme.background(bg_theme)
       end
 
       # :nocov:

data/lib/drawio_dsl/schema/text.rb

@@ -16,7 +16,7 @@ module DrawioDsl
         @fill_color       = args[:fill_color]
         @stroke_color     = args[:stroke_color]
         @gradient         = args[:gradient]
-        @font_color       = args[:font_color] || theme_palette.text_font_color
+        @font_color       = args[:font_color] || page.bg_theme_palette.font_color
       end
     end
   end

data/lib/drawio_dsl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DrawioDsl
-  VERSION = '0.9.0'
+  VERSION = '0.11.0'
 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,8 +15,6 @@ module DrawioDsl
 end
 
 require_relative 'drawio_dsl/configuration_extension'
-require_relative 'drawio_dsl/configuration_shapes'
-require_relative 'drawio_dsl/configuration_themes'
 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.9.0",
+  "version": "0.11.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "drawio_dsl",
-      "version": "0.9.0",
+      "version": "0.11.0",
       "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.9.0",
+  "version": "0.11.0",
   "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.9.0
+  version: 0.11.0
 platform: ruby
 authors:
 - David Cruwys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-23 00:00:00.000000000 Z
+date: 2022-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: k_config
@@ -255,7 +255,8 @@ files:
 - docs/printspeak-architecture-controllers-fat.svg
 - docs/printspeak-architecture-controllers-thin.svg
 - docs/printspeak-architecture-controllers.drawio
-- docs/printspeak-architecture-generator.drawio
+- docs/printspeak-architecture-generator-custom.drawio
+- docs/printspeak-architecture-generator-custom.png
 - docs/printspeak-architecture-generator.svg
 - docs/project-plan.md
 - docs/project-plan/project.drawio
@@ -281,8 +282,6 @@ files:
 - lib/drawio_dsl.rb
 - lib/drawio_dsl/configuration.rb
 - lib/drawio_dsl/configuration_extension.rb
-- lib/drawio_dsl/configuration_shapes.rb
-- lib/drawio_dsl/configuration_themes.rb
 - lib/drawio_dsl/dom_builder.rb
 - lib/drawio_dsl/dom_builder_shapes.rb
 - lib/drawio_dsl/drawio.rb