drawio_dsl 0.3.0 → 0.4.0

data/lib/drawio_dsl/schema/node.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module DrawioDsl
+  module Schema
+    # Node is a base class for shapes, connections, positioners and layout rules
+    #
+    class Node
+      attr_accessor :id
+      attr_accessor :page
+      attr_accessor :classification
+
+      def initialize(page, **args)
+        @page = page
+        @id = args[:id]
+        @classification = args[:classification] || :unknown
+      end
+
+      def to_h
+        {
+          id: id,
+          classification: classification
+        }
+      end
+
+      #   def debug(format: :detail)
+      #     if format == :detail
+      #       debug_detail(to_h)
+      #     else
+      #       debug_row(classification, id)
+      #     end
+      #   end
+
+      #   def debug_detail(**key_values)
+      #     key_values.each do |key, value|
+      #       puts "#{key.to_s.ljust(15)}: #{value}"
+      #     end
+      #   end
+
+      #
+      #   def debug_row(classification, id, type = 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 << (x.nil? ? '' : x).to_s.rjust(5)
+      #     row << (y.nil? ? '' : y).to_s.rjust(5)
+      #     row << (width.nil? ? '' : width).to_s.rjust(5)
+      #     row << (height.nil? ? '' : height).to_s.rjust(5)
+      #     puts row.join(' | ')
+      #   end
+    end
+  end
+end

data/lib/drawio_dsl/schema/page.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module DrawioDsl
+  module Schema
+    # Page is a container for nodes
+    class Page
+      attr_accessor :diagram
+
+      # These transient attributes hold the current x, y location for the last element added to the page
+      attr_accessor :position_x
+      attr_accessor :position_y
+
+      attr_accessor :id
+      attr_reader :name
+      attr_reader :theme
+      attr_reader :style
+      attr_reader :palette
+      attr_reader :margin_left
+      attr_reader :margin_top
+      attr_reader :nodes
+
+      attr_reader :grid            # grid       = "0"
+      attr_reader :grid_size       # gridSize   = "10"
+      attr_reader :guides          # guides     = "1"
+      attr_reader :tooltips        # tooltips   = "1"
+      attr_reader :connect         # connect    = "1"
+      attr_reader :arrows          # arrows     = "1"
+      attr_reader :fold            # fold       = "1"
+      attr_reader :page_no         # page       = "1"
+      attr_reader :page_scale      # pageScale  = "1"
+      attr_reader :page_width      # pageWidth  = "583"
+      attr_reader :page_height     # pageHeight = "827"
+      attr_reader :background      # background = "#FFFACD"
+      attr_reader :page_shadow     # shadow     = "0"
+      attr_reader :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
+
+        # cursor positioning is used by the layout engine
+        @position_x   = 0
+        @position_y   = 0
+
+        # settings to support the layout engine
+        @margin_left  = args[:margin_left]  || 50
+        @margin_top   = args[:margin_top]   || 50
+
+        # settings that live on the drawio page object
+        @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
+
+        @nodes = args[:nodes] || []
+      end
+      # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
+
+      def shapes
+        @nodes.select { |node| node.is_a?(DrawioDsl::Schema::Shape) }
+      end
+
+      def to_h
+        {
+          id: id,
+          name: name,
+          position_x: position_x,
+          position_y: position_y,
+          theme: theme,
+          palette: palette.to_h,
+          style: style.to_h,
+          settings: settings,
+          nodes: nodes.map(&:to_h)
+        }
+      end
+
+      private
+
+      def settings
+        {
+          margin_left: margin_left,
+          margin_top: margin_top,
+          grid: grid,
+          grid_size: grid_size,
+          guides: guides,
+          tooltips: tooltips,
+          connect: connect,
+          arrows: arrows,
+          fold: fold,
+          page_no: page_no,
+          page_scale: page_scale,
+          page_width: page_width,
+          page_height: page_height,
+          background: background,
+          page_shadow: page_shadow,
+          math: math
+        }
+      end
+    end
+  end
+end

data/lib/drawio_dsl/schema/shapes/callout.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DrawioDsl
+  module Schema
+    class Callout < Shape
+      configure_shape(:callout)
+    end
+  end
+end

data/lib/drawio_dsl/schema/shapes/circle.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DrawioDsl
+  module Schema
+    class Circle < Shape
+      configure_shape(:circle)
+    end
+  end
+end

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

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

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

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

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

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

data/lib/drawio_dsl/schema/shapes/hexagon.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DrawioDsl
+  module Schema
+    class Hexagon < Shape
+      configure_shape(:hexagon)
+    end
+  end
+end

data/lib/drawio_dsl/schema/shapes/note.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DrawioDsl
+  module Schema
+    class Note < Shape
+      configure_shape(:note)
+    end
+  end
+end

data/lib/drawio_dsl/schema/shapes/process.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DrawioDsl
+  module Schema
+    class Process < Shape
+      configure_shape(:process)
+    end
+  end
+end

data/lib/drawio_dsl/schema/shapes/rectangle.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DrawioDsl
+  module Schema
+    class Rectangle < Shape
+      configure_shape(:rectangle)
+    end
+  end
+end

data/lib/drawio_dsl/schema/shapes/shape.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module DrawioDsl
+  module Schema
+    # Shape is a graphical element, it can be a shape, a text, or a group (todo)
+    class Shape < Node
+      class << self
+        def configure_shape(name)
+          raise "Shape #{name} not found in configuration" unless KConfig.configuration.drawio.shapes.members.include?(name)
+
+          config = KConfig.configuration.drawio.shapes[name]
+
+          @shape_defaults = config.clone
+        end
+
+        def shape_defaults
+          return @shape_defaults if defined? @shape_defaults
+
+          raise 'Shape defaults not configured'
+        end
+      end
+
+      configure_shape(:shape)
+
+      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 :type
+      attr_accessor :x
+      attr_accessor :y
+      attr_accessor :w
+      attr_accessor :h
+      attr_accessor :style_modifiers
+
+      def initialize(page, **args)
+        args[:classification] = :shape
+        super(page, **args)
+
+        apply_defaults(args)
+      end
+
+      def shape_defaults
+        @shape_defaults ||= self.class.shape_defaults.clone
+      end
+
+      # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      def apply_defaults(args)
+        @theme            = args[:theme] || page.theme # KConfig.configuration.drawio.themes.sample
+        theme_palette     = KConfig.configuration.drawio.palette(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]             || shape_defaults.type
+        @x                = args[:x]                || shape_defaults.x
+        @y                = args[:y]                || shape_defaults.y
+        @w                = args[:w]                || shape_defaults.w
+        @h                = args[:h]                || shape_defaults.h
+        @style_modifiers  = args[:style_modifiers]  || shape_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,
+          classification: classification,
+          type: type,
+          x: x,
+          y: y,
+          w: w,
+          h: h,
+          style: style
+        }
+      end
+
+      def debug(format: :detail)
+        if format == :detail
+          debug_detail({ id: id, classification: classification, type: type })
+        else
+          debug_row(classification, id, type, x, y, w, h)
+        end
+      end
+    end
+  end
+end

data/lib/drawio_dsl/schema/shapes/square.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DrawioDsl
+  module Schema
+    class Square < Shape
+      configure_shape(:square)
+    end
+  end
+end

data/lib/drawio_dsl/version.rb

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

data/lib/drawio_dsl.rb

@@ -9,7 +9,7 @@ require 'k_director'
 
 require_relative 'drawio_dsl/configuration'
 require_relative 'drawio_dsl/version'
-require_relative 'drawio_dsl/schema'
+require_relative 'drawio_dsl/schema/_'
 require_relative 'drawio_dsl/dom_builder'
 require_relative 'drawio_dsl/xml_builder'
 require_relative 'drawio_dsl/layout_engine'

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "drawio_dsl",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "drawio_dsl",
-      "version": "0.3.0",
+      "version": "0.4.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.3.0",
+  "version": "0.4.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.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - David Cruwys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-04 00:00:00.000000000 Z
+date: 2022-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: k_config
@@ -73,7 +73,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".builders/.templates/command.rb"
+- ".builders/.templates/schema_shape.rb"
 - ".builders/_.rb"
+- ".builders/blueprint/shapes.rb"
 - ".builders/boot.rb"
 - ".builders/generators/01-bootstrap.rb"
 - ".builders/generators/10-page-margin.rb"
@@ -99,7 +102,26 @@ files:
 - lib/drawio_dsl/dom_builder.rb
 - lib/drawio_dsl/drawio.rb
 - lib/drawio_dsl/layout_engine.rb
-- lib/drawio_dsl/schema.rb
+- lib/drawio_dsl/schema/_.rb
+- lib/drawio_dsl/schema/common_style.rb
+- lib/drawio_dsl/schema/default_palette.rb
+- lib/drawio_dsl/schema/diagram.rb
+- lib/drawio_dsl/schema/layouts/flex_layout.rb
+- lib/drawio_dsl/schema/layouts/grid_layout.rb
+- lib/drawio_dsl/schema/layouts/layout.rb
+- lib/drawio_dsl/schema/node.rb
+- lib/drawio_dsl/schema/page.rb
+- lib/drawio_dsl/schema/shapes/callout.rb
+- lib/drawio_dsl/schema/shapes/circle.rb
+- lib/drawio_dsl/schema/shapes/cloud.rb
+- lib/drawio_dsl/schema/shapes/diamond.rb
+- lib/drawio_dsl/schema/shapes/ellipse.rb
+- lib/drawio_dsl/schema/shapes/hexagon.rb
+- lib/drawio_dsl/schema/shapes/note.rb
+- lib/drawio_dsl/schema/shapes/process.rb
+- lib/drawio_dsl/schema/shapes/rectangle.rb
+- lib/drawio_dsl/schema/shapes/shape.rb
+- lib/drawio_dsl/schema/shapes/square.rb
 - lib/drawio_dsl/version.rb
 - lib/drawio_dsl/xml_builder.rb
 - package-lock.json