drawio_dsl 0.1.0

data/lib/drawio_dsl/layout_container.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module DrawioDsl
+  # The layout engine is responsible for laying out the elements on the page.
+  #
+  # The layout engine can automatically place elements on the page.
+  #
+  # It will keep track of layout boundaries, current position and flow direction.
+  # Elements are positioned on the page in the order they are added.
+  # Row/column flow objects will hold information about horizontal and vertical element padding
+  class LayoutContainer
+    DEFAULT_DIRECTION       = :vertical
+    DEFAULT_PADDING         = 20
+    DEFAULT_BOUNDARY_HEIGHT = 800
+    DEFAULT_BOUNDARY_WIDTH  = 1000
+
+    attr_reader :engine
+    attr_accessor :direction
+    attr_accessor :padding
+
+    def initialize(engine, **opts)
+      @engine     = engine
+      @direction  = opts[:direction] || DEFAULT_DIRECTION
+      @padding    = opts[:padding]   || DEFAULT_PADDING
+      @boundary   = opts[:boundary]
+    end
+
+    def vertical?
+      @direction == :vertical
+    end
+
+    def horizontal?
+      @direction == :horizontal
+    end
+
+    attr_writer :boundary
+
+    def boundary
+      @boundary ||= (vertical? ? DEFAULT_BOUNDARY_HEIGHT : DEFAULT_BOUNDARY_WIDTH)
+    end
+
+    # Place the incoming element by altering it's x, y coordinates based on the rules engine
+    def place_element(element)
+      place_vertical(element) if vertical?
+    end
+
+    def place_vertical(element)
+      element.x = engine.x
+      element.y = engine.y
+
+      engine.y += (element.h + padding)
+    end
+  end
+end

data/lib/drawio_dsl/layout_engine.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module DrawioDsl
+  # The layout engine is responsible for laying out the elements on the page.
+  #
+  # The layout engine can automatically place elements on the page.
+  #
+  # It will keep track of layout boundaries, current position and flow direction.
+  # Elements will be placed on the page in the order they are added.
+  # Row/column flow objects will hold information about horizontal and vertical element padding
+  class LayoutEngine
+    attr_accessor :margin_left
+    attr_accessor :margin_top
+    attr_accessor :x
+    attr_accessor :y
+
+    def initialize(**opts)
+      @margin_left = opts[:margin_left] || 20
+      @margin_top  = opts[:margin_top]  || 20
+      @x           = opts[:x]           || @margin_left
+      @y           = opts[:y]           || @margin_top
+    end
+
+    def container
+      @container ||= LayoutContainer.new(self)
+    end
+
+    def go_vertical(**opts)
+      @container = LayoutContainer.new(self, direction: :vertical, **opts)
+    end
+
+    def go_horizontal(**opts)
+      @container = LayoutContainer.new(self, direction: :horizontal, **opts)
+    end
+
+    # # Position the incoming element by altering it's x, y coordinates based on the rules engine
+    # def position_element(element)
+    #   container.horizontal?
+    # end
+
+    # private
+
+    # def position_horizontally(element)
+
+    # end
+  end
+end

data/lib/drawio_dsl/schema.rb

@@ -0,0 +1,346 @@
+# frozen_string_literal: true
+
+module DrawioDsl
+  module Schema
+    # Common Style is the reused on Diagram, Page and Element
+    #
+    # When styles are not provided at each level, then they will inherit from
+    # the parent common style.
+    #
+    # Elements will use the common style of their page
+    class CommonStyle
+      attr_accessor :theme
+      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
+
+    # 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
+
+    # 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
+
+    # Page is a container for elements
+    class Page
+      attr_accessor :diagram
+
+      attr_accessor :id
+      attr_accessor :name
+      attr_accessor :theme
+      attr_accessor :style
+      attr_accessor :palette
+      attr_accessor :elements
+
+      # attr_accessor :dx              # dx         = "2636"
+      # attr_accessor :dy              # dy         = "2332"
+      attr_accessor :grid            # grid       = "0"
+      attr_accessor :grid_size       # gridSize   = "10"
+      attr_accessor :guides          # guides     = "1"
+      attr_accessor :tooltips        # tooltips   = "1"
+      attr_accessor :connect         # connect    = "1"
+      attr_accessor :arrows          # arrows     = "1"
+      attr_accessor :fold            # fold       = "1"
+      attr_accessor :page_no         # page       = "1"
+      attr_accessor :page_scale      # pageScale  = "1"
+      attr_accessor :page_width      # pageWidth  = "583"
+      attr_accessor :page_height     # pageHeight = "827"
+      attr_accessor :background      # background = "#FFFACD"
+      attr_accessor :page_shadow     # shadow     = "0"
+      attr_accessor :math            # math       = "0"
+
+      # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
+      def initialize(diagram, **args)
+        @diagram = diagram
+
+        @id           = args[:id]
+        @name         = args[:name]
+        @theme        = args[:theme]        || diagram.theme
+
+        @grid         = args[:grid]         || 0
+        @grid_size    = args[:grid_size]    || 10
+        @guides       = args[:guides]       || 1
+        @tooltips     = args[:tooltips]     || 1
+        @connect      = args[:connect]      || 1
+        @arrows       = args[:arrows]       || 1
+        @fold         = args[:fold]         || 1
+        @page_no      = args[:page_no]      || 1
+        @page_scale   = args[:page_scale]   || 1
+        @page_width   = args[:page_width]   || 1169 # A4
+        @page_height  = args[:page_height]  || 827  # A4
+        @background   = args[:background]   || '#FFFACD'
+        @page_shadow  = args[:page_shadow]  || 0
+        @math         = args[:math]         || 0
+
+        @style = DrawioDsl::Schema::CommonStyle.new(**args) do
+          # Inherit from the diagram style when specific style not specified.
+          @white_space ||= diagram.style.white_space
+          @html ||= diagram.style.html
+          @rounded ||= diagram.style.rounded
+          @shadow ||= diagram.style.shadow
+          @sketch ||= diagram.style.sketch
+          @glass ||= diagram.style.glass
+        end
+
+        @palette = DrawioDsl::Schema::DefaultPalette.new(self, **args) do |page|
+          theme_palette = KConfig.configuration.drawio.palette(page.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
+
+        @elements = args[:elements] || []
+      end
+      # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
+
+      def to_h
+        {
+          id: id,
+          name: name,
+          theme: theme,
+          palette: palette.to_h,
+          style: style.to_h,
+          elements: elements.map(&:to_h)
+        }
+      end
+    end
+
+    # Element is a graphical element, it can be a shape, a text, or a group (todo)
+    class Element
+      attr_accessor :page
+
+      attr_accessor :theme
+      attr_accessor :title
+
+      # The style of the element, these will derive from the page style if not provided
+      attr_accessor :white_space
+      attr_accessor :html
+      attr_accessor :rounded
+      attr_accessor :shadow
+      attr_accessor :glass
+      attr_accessor :sketch
+
+      attr_accessor :fill_color
+      attr_accessor :stroke_color
+      attr_accessor :font_color
+      attr_accessor :gradient
+
+      attr_accessor :id
+      attr_accessor :type
+      attr_accessor :x
+      attr_accessor :y
+      attr_accessor :w
+      attr_accessor :h
+      attr_accessor :style_modifiers
+
+      def initialize(page, **args)
+        @page = page
+        @id = args[:id]
+
+        apply_defaults(args, KConfig.configuration.drawio.element)
+      end
+
+      # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      def apply_defaults(args, element_defaults)
+        @theme            = args[:theme] || page.theme # KConfig.configuration.drawio.themes.sample
+        theme_palette     = KConfig.configuration.drawio.palette(page.theme)
+        @title            = args[:title]            || ''
+
+        @white_space      = args[:white_space]      || page.style.white_space # wrap or nil
+        @html             = args[:html]             || page.style.html
+        @rounded          = args[:rounded]          || page.style.rounded
+        @shadow           = args[:shadow]           || page.style.shadow
+        @sketch           = args[:sketch]           || page.style.sketch
+        @glass            = args[:glass]            || page.style.glass
+
+        @type             = args[:type]             || element_defaults.type
+        @x                = args[:x]                || element_defaults.x
+        @y                = args[:y]                || element_defaults.y
+        @w                = args[:w]                || element_defaults.w
+        @h                = args[:h]                || element_defaults.h
+        @style_modifiers  = args[:style_modifiers]  || element_defaults.style_modifiers
+
+        @fill_color       = args[:fill_color]       || theme_palette.fill_color
+        @stroke_color     = args[:stroke_color]     || theme_palette.stroke_color
+        @font_color       = args[:font_color]       || theme_palette.font_color
+        @gradient         = args[:gradient]         || theme_palette.gradient
+      end
+
+      def style
+        key_values = []
+        key_values << style_modifiers unless style_modifiers.empty?
+        key_values << "whiteSpace=#{white_space}"         if white_space
+        key_values << "html=#{html}"                      if html
+        key_values << "rounded=#{rounded}"                if rounded
+        key_values << "shadow=#{shadow}"                  if shadow
+        key_values << "sketch=#{sketch}"                  if sketch
+        key_values << "glass=#{glass}"                    if glass
+        key_values << "fillColor=#{fill_color}"           if fill_color
+        key_values << "strokeColor=#{stroke_color}"       if stroke_color
+        key_values << "fontColor=#{font_color}"           if font_color
+        key_values << "gradient=#{gradient}"              if gradient
+
+        key_values.join(';')
+      end
+      # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+      def to_h
+        {
+          id: id,
+          type: type,
+          x: x,
+          y: y,
+          w: w,
+          h: h,
+          style: style
+        }
+      end
+    end
+
+    # Graphical element in the shape of a square
+    class Square < Element
+      def initialize(page, **args)
+        super(page, **args)
+
+        apply_defaults(args, KConfig.configuration.drawio.square)
+      end
+    end
+
+    # Graphical element in the shape of a rectangle
+    class Rectangle < Element
+      def initialize(page, **args)
+        super(page, **args)
+
+        apply_defaults(args, KConfig.configuration.drawio.rectangle)
+      end
+    end
+
+    # Graphical element in the shape of a circle
+    class Circle < Element
+      def initialize(page, **args)
+        super(page, **args)
+
+        apply_defaults(args, KConfig.configuration.drawio.circle)
+      end
+    end
+
+    # Graphical element in the shape of an rectangle with to vertical lines
+    class Process < Element
+      def initialize(page, **args)
+        super(page, **args)
+
+        apply_defaults(args, KConfig.configuration.drawio.process)
+      end
+    end
+
+    # Graphical element in the shape of an ellipse
+    class Ellipse < Element
+      def initialize(page, **args)
+        super(page, **args)
+
+        apply_defaults(args, KConfig.configuration.drawio.ellipse)
+      end
+    end
+  end
+end
+# dx="800" dy="583" background="#FFFACD" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="0" pageScale="1" pageWidth="1169" pageHeight="827" math="0" shadow="0"

data/lib/drawio_dsl/version.rb

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

data/lib/drawio_dsl/xml_builder.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module DrawioDsl
+  # DrawioDsl is a DSL for draw-io diagrams.
+  class XmlBuilder
+    include KLog::Logging
+
+    attr_reader :diagram
+
+    def initialize(diagram)
+      @diagram = diagram
+    end
+
+    def build
+      xml_builder = Nokogiri::XML::Builder.new do |xml|
+        build_diagram(xml)
+      end
+      xml_builder.to_xml.sub('<?xml version="1.0"?>', '').strip
+    end
+
+    private
+
+    def build_diagram(xml)
+      xml.mxfile(host: diagram.host) do
+        diagram.pages.each do |page|
+          build_page(xml, page)
+        end
+      end
+    end
+
+    # rubocop:disable  Metrics/MethodLength, Metrics/AbcSize, Metrics/BlockLength
+    def build_page(xml, page)
+      xml.diagram(id: page.id, name: page.name) do
+        xml.mxGraphModel(
+          dx: 0,
+          dy: 0,
+          background: page.background,
+          grid: page.grid,
+          gridSize: page.grid_size,
+          guides: page.guides,
+          tooltips: page.tooltips,
+          connect: page.connect,
+          arrows: page.arrows,
+          fold: page.fold,
+          page: page.page_no,
+          pageScale: page.page_scale,
+          pageWidth: page.page_width,
+          pageHeight: page.page_height,
+          math: page.math,
+          shadow: page.page_shadow
+        ) do
+          xml.root do
+            xml.mxCell(id: "#{page.id}-A")
+            xml.mxCell(id: "#{page.id}-B", parent: "#{page.id}-A")
+            page.elements.each do |element|
+              build_element(xml, element)
+            end
+          end
+        end
+      end
+    end
+    # rubocop:enable  Metrics/MethodLength, Metrics/AbcSize, Metrics/BlockLength
+
+    def build_element(xml, element)
+      # puts "opts: #{opts}"
+      puts element.x
+      puts element.y
+
+      xml.mxCell(id: element.id, value: element.title, style: element.style, vertex: 1, parent: "#{element.page.id}-B") do
+        xml.mxGeometry(x: element.x, y: element.y, width: element.w, height: element.h, as: 'geometry')
+      end
+    end
+  end
+end

data/lib/drawio_dsl.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+require 'nokogiri'
+
+require 'k_config'
+require 'k_log'
+require 'k_director'
+
+require_relative 'drawio_dsl/configuration'
+require_relative 'drawio_dsl/version'
+require_relative 'drawio_dsl/schema'
+require_relative 'drawio_dsl/dom_builder'
+require_relative 'drawio_dsl/xml_builder'
+require_relative 'drawio_dsl/layout_container'
+require_relative 'drawio_dsl/layout_engine'
+require_relative 'drawio_dsl/drawio'
+
+module DrawioDsl
+  # raise DrawioDsl::Error, 'Sample message'
+  Error = Class.new(StandardError)
+
+  # Your code goes here...
+end
+
+if ENV['KLUE_DEBUG']&.to_s&.downcase == 'true'
+  namespace = 'DrawioDsl::Version'
+  file_path = $LOADED_FEATURES.find { |f| f.include?('drawio_dsl/version') }
+  version   = DrawioDsl::VERSION.ljust(9)
+  puts "#{namespace.ljust(35)} : #{version.ljust(9)} : #{file_path}"
+end