drawio_dsl 0.6.0 → 0.8.1

data/lib/drawio_dsl/formatters/base_formatter.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Work with HTML formatters to DrawIO shapes
+module DrawioDsl
+  # HTML formatters can be used on shapes to render HTML using a DSL
+  module Formatters
+    # Create an instance of a HTML formatter on the shape
+    class BaseFormatter
+      attr_reader :html
+
+      def initialize(element_style_defaults = {})
+        @html = DrawioDsl::Formatters::HtmlBuilder.new(element_style_defaults)
+      end
+
+      def empty?
+        html.empty?
+      end
+
+      def as_html(new_line: false)
+        html.as_html(new_line: new_line)
+      end
+    end
+  end
+end

data/lib/drawio_dsl/formatters/factory.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# Work with HTML formatters to DrawIO shapes
+module DrawioDsl
+  # HTML formatters can be used on shapes to render HTML using a DSL
+  module Formatters
+    # Create an instance of a HTML formatter on the shape
+    module Factory
+      include KLog::Logging
+
+      FORMATTERS = {
+        klass: DrawioDsl::Formatters::KlassFormatter,
+        class: DrawioDsl::Formatters::KlassFormatter, # alias for klass
+        interface: DrawioDsl::Formatters::InterfaceFormatter
+      }.freeze
+
+      def format_instance(type)
+        unless FORMATTERS.key?(type)
+          log.error "Unknown formatter type: #{type}"
+          @formatter = nil
+          return formatter
+        end
+
+        @formatter = FORMATTERS[type].new
+        formatter
+      end
+
+      def formatter
+        @formatter ||= DrawioDsl::Formatters::BaseFormatter.new
+      end
+    end
+  end
+end

data/lib/drawio_dsl/formatters/html_builder.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+# Work with HTML formatters to DrawIO shapes
+module DrawioDsl
+  # HTML formatters can be used on shapes to render HTML using a DSL
+  module Formatters
+    # Create an instance of a HTML formatter on the shape
+    class HtmlBuilder
+      attr_reader :element_style_defaults
+
+      def initialize(element_style_defaults = {})
+        @element_style_defaults = element_style_defaults
+      end
+
+      def default_for(tag)
+        element_style_defaults[tag] || {}
+      end
+
+      def style_for(tag, **opts)
+        defaults = default_for(tag)
+        DrawioDsl::Formatters::StyleBuilder.new(**defaults).customize(**opts).style_attribute
+      end
+
+      def empty?
+        build_lines.empty?
+      end
+
+      def exist?
+        !empty?
+      end
+
+      def as_html(new_line: false)
+        new_line ? build_lines.join("\n") : build_lines.join
+      end
+
+      def hr(size: 1)
+        add_line("<hr size=\"#{size}\"/>")
+      end
+
+      def b(content, **opts)
+        add_line("<b#{style_for(:b, **opts)}>#{content}</b>")
+      end
+
+      def p(content, **opts)
+        # style_parts = %w[margin:0px margin-top:4px]
+        # style_parts << "text-align:#{opts[:text_align]}" if opts[:text_align]
+        # style=\"#{style_parts.join(';')}\"
+        add_line("<p#{style_for(:p, **opts)}>#{content}</p>")
+      end
+
+      def add_line(line)
+        lines << line
+      end
+
+      def add_placeholder(group_key)
+        lines << group_key
+      end
+
+      def group(key)
+        groups[key] ||= DrawioDsl::Formatters::HtmlBuilder.new(element_style_defaults)
+      end
+
+      def build_lines
+        lines.flat_map do |line|
+          if line.is_a?(Symbol)
+            group(line).build_lines
+          else
+            line
+          end
+        end
+      end
+
+      private
+
+      def lines
+        @lines ||= []
+      end
+
+      def groups
+        @groups ||= {}
+      end
+    end
+  end
+end

data/lib/drawio_dsl/formatters/interface_formatter.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# Work with HTML formatters to DrawIO shapes
+module DrawioDsl
+  # HTML formatters can be used on shapes to render HTML using a DSL
+  module Formatters
+    # Create an instance of a HTML formatter on the shape
+    class InterfaceFormatter < BaseFormatter
+      def initialize
+        super({ p: { margin: '0px', margin_left: '4px', margin_top: '4px' } })
+      end
+
+      def header(name, description: nil, interface_type: 'Interface')
+        html.p("<i>&lt;&lt; #{interface_type} &gt;&gt;</i>", text_align: :center)
+        html.p("<b>#{name}</b>", text_align: :center)
+        html.hr
+
+        html.group(:description).p(description) if description
+
+        self
+      end
+
+      def field(name, type: nil)
+        value = if type
+                  "#{name}: #{type}"
+                else
+                  name
+                end
+        html.group(:fields).p(value)
+
+        self
+      end
+
+      def method(name, type: nil)
+        value = if type
+                  "#{name}() : #{type}"
+                else
+                  "#{name}()"
+                end
+        html.group(:methods).p(value)
+
+        self
+      end
+
+      def as_html(new_line: false)
+        html.add_placeholder(:fields)
+        html.add_placeholder(:methods)
+
+        html.group(:fields).hr if html.group(:fields).exist? && html.group(:methods).exist?
+
+        html.as_html(new_line: new_line)
+      end
+    end
+  end
+end

data/lib/drawio_dsl/formatters/klass_formatter.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# Work with HTML formatters to DrawIO shapes
+module DrawioDsl
+  # HTML formatters can be used on shapes to render HTML using a DSL
+  module Formatters
+    # Create an instance of a HTML formatter on the shape
+    class KlassFormatter < BaseFormatter
+      def initialize
+        super({ p: { margin: '0px', margin_left: '4px', margin_top: '4px' } })
+      end
+
+      def header(name, description: nil)
+        html.p("<b>#{name}</b>", text_align: :center)
+        html.hr
+
+        html.group(:description).p(description) if description
+
+        self
+      end
+
+      def field(name, type: nil)
+        value = if type
+                  "#{name}: #{type}"
+                else
+                  name
+                end
+        html.group(:fields).p(value)
+
+        self
+      end
+
+      def method(name, type: nil)
+        value = if type
+                  "#{name}() : #{type}"
+                else
+                  "#{name}()"
+                end
+        html.group(:methods).p(value)
+
+        self
+      end
+
+      def as_html(new_line: false)
+        html.add_placeholder(:fields)
+        html.add_placeholder(:methods)
+
+        html.group(:fields).hr if html.group(:fields).exist? && html.group(:methods).exist?
+
+        html.as_html(new_line: new_line)
+      end
+    end
+  end
+end

data/lib/drawio_dsl/formatters/style_builder.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+# Work with HTML formatters to DrawIO shapes
+module DrawioDsl
+  # HTML formatters can be used on shapes to render HTML using a DSL
+  module Formatters
+    # Create an instance of a HTML formatter on the shape
+    class StyleBuilder
+      MAPPINGS = {
+        margin: 'margin',
+        margin_top: 'margin-top',
+        margin_bottom: 'margin-bottom',
+        margin_left: 'margin-left',
+        margin_right: 'margin-right',
+        padding: 'padding',
+        padding_top: 'padding-top',
+        padding_bottom: 'padding-bottom',
+        padding_left: 'padding-left',
+        padding_right: 'padding-right',
+        text_align: 'text-align',
+        font_size: 'font-size',
+        font_weight: 'font-weight',
+        font_style: 'font-style',
+        font_family: 'font-family',
+        color: 'color'
+      }.freeze
+
+      attr_reader :defaults
+      attr_reader :custom
+
+      def initialize(**opts)
+        @style_parts = []
+        @defaults = opts
+        @custom = {}
+      end
+
+      def customize(**opts)
+        @custom = opts
+
+        self
+      end
+
+      def style
+        build
+        @style_parts.join(';')
+      end
+
+      def style_attribute
+        style_value = style
+        style_value.empty? ? nil : " style=\"#{style_value}\""
+      end
+
+      private
+
+      def build
+        defaults.merge(custom).each do |key, value|
+          style_key = MAPPINGS[key]
+          @style_parts << "#{style_key}:#{value}" if style_key
+        end
+      end
+    end
+  end
+end

data/lib/drawio_dsl/schema/_.rb

@@ -27,16 +27,18 @@ 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/diamond'
 require_relative 'shapes/document'
 require_relative 'shapes/ellipse'
 require_relative 'shapes/hexagon'
-require_relative 'shapes/container'
-require_relative 'shapes/container2'
-require_relative 'shapes/container3'
-require_relative 'shapes/container4'
+require_relative 'shapes/interface'
+require_relative 'shapes/klass'
 require_relative 'shapes/note'
 require_relative 'shapes/process'
 require_relative 'shapes/rectangle'
@@ -44,6 +46,7 @@ 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'

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

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

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

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

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

@@ -4,18 +4,20 @@ module DrawioDsl
   module Schema
     # Shape is a graphical element, it can be a shape, a text, or a group (todo)
     class Shape < Node
+      include DrawioDsl::Formatters::Factory
+
       class << self
+        attr_reader :shape_key
         attr_reader :shape_defaults
 
-        def configure_shape(name)
-          unless KConfig.configuration.drawio.shapes.members.include?(name)
-            puts "Shape #{name} not found in configuration"
+        def configure_shape(key)
+          unless KConfig.configuration.drawio.shapes.members.include?(key)
+            puts "Shape #{key} not found in configuration"
             return
           end
 
-          config = KConfig.configuration.drawio.shapes[name]
-
-          @shape_defaults = config.clone
+          @shape_key = key
+          @shape_defaults = KConfig.configuration.drawio.shapes[key].clone
         end
       end
 
@@ -23,6 +25,7 @@ module DrawioDsl
 
       attr_accessor :theme
       attr_accessor :title
+      attr_accessor :value
 
       # The style of the element, these will derive from the page style if not provided
       attr_accessor :white_space
@@ -44,11 +47,15 @@ module DrawioDsl
       attr_accessor :h
       attr_accessor :style_modifiers
 
-      def initialize(page, **args)
+      def initialize(page, **args, &block)
         args[:classification] = :shape
         super(page, **args)
 
         apply_defaults(args)
+
+        instance_eval(&block) if block_given?
+
+        @value = formatter.empty? ? title : formatter.as_html
       end
 
       def shape_defaults
@@ -82,6 +89,11 @@ module DrawioDsl
         @font_color       = args[:font_color]       || theme_palette.font_color
       end
 
+      def format(type = nil)
+        type ||= self.class.shape_key
+        format_instance(type)
+      end
+
       def style
         key_values = []
         key_values << "whiteSpace=#{white_space}"         if white_space
@@ -101,7 +113,7 @@ module DrawioDsl
       # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
       def as_xml(xml)
-        xml.mxCell(id: id, value: title, style: style, vertex: 1, parent: parent&.id) do
+        xml.mxCell(id: id, value: value, style: style, vertex: 1, parent: parent&.id) do
           xml.mxGeometry(x: x, y: y, width: w, height: h, as: 'geometry')
         end
       end

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

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

data/lib/drawio_dsl/version.rb

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

data/lib/drawio_dsl.rb

@@ -12,6 +12,7 @@ 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/_'
 require_relative 'drawio_dsl/schema/_'
 require_relative 'drawio_dsl/dom_builder_shapes'
 require_relative 'drawio_dsl/dom_builder'

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "drawio_dsl",
-  "version": "0.6.0",
+  "version": "0.8.1",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "drawio_dsl",
-      "version": "0.6.0",
+      "version": "0.8.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.6.0",
+  "version": "0.8.1",
   "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.6.0
+  version: 0.8.1
 platform: ruby
 authors:
 - David Cruwys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-13 00:00:00.000000000 Z
+date: 2022-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: k_config
@@ -88,14 +88,15 @@ files:
 - ".builders/generators/02-generate-app.rb"
 - ".builders/generators/10-transform-drawio-js.rb"
 - ".builders/generators/20-drawio-extensions.rb"
-- ".builders/generators/project_plans/drawio_dsl.rb"
-- ".builders/generators/project_plans/k_doc.rb"
+- ".builders/generators/project-plan.rb"
 - ".builders/generators/sample_diagrams/05-samples.rb"
 - ".builders/generators/sample_diagrams/10-page-margin.rb"
 - ".builders/generators/sample_diagrams/15-grid-direction.rb"
 - ".builders/generators/sample_diagrams/16-grid-alignment.rb"
 - ".builders/generators/sample_diagrams/20-styles.rb"
 - ".builders/generators/sample_diagrams/25-themes.rb"
+- ".builders/generators/sample_diagrams/30-html-shapes.rb"
+- ".builders/generators/sample_diagrams/35-ids-and-arrows.rb"
 - ".builders/generators/sample_diagrams/50-willoughby-council.rb"
 - ".releaserc.json"
 - ".rspec"
@@ -265,13 +266,15 @@ files:
 - docs/extensions/venn_plain.svg
 - docs/extensions/vessels.svg
 - docs/project-plan.md
-- docs/project_done.svg
-- docs/project_in_progress.svg
-- docs/project_todo.svg
+- docs/project-plan/project.drawio
+- docs/project-plan/project_done.svg
+- docs/project-plan/project_in_progress.svg
+- docs/project-plan/project_todo.svg
 - docs/samples/grid-alignment-center.svg
 - docs/samples/grid-alignment.svg
 - docs/samples/grid-direction-horizontal.svg
 - docs/samples/grid-direction-vertical.svg
+- docs/samples/html-shapes.svg
 - docs/samples/samples.md
 - docs/samples/samples.svg
 - docs/samples/styles-glass.svg
@@ -295,6 +298,13 @@ files:
 - lib/drawio_dsl/drawio_extensions.rb
 - lib/drawio_dsl/drawio_extensions_active.rb
 - lib/drawio_dsl/drawio_shapes.rb
+- lib/drawio_dsl/formatters/_.rb
+- lib/drawio_dsl/formatters/base_formatter.rb
+- lib/drawio_dsl/formatters/factory.rb
+- lib/drawio_dsl/formatters/html_builder.rb
+- lib/drawio_dsl/formatters/interface_formatter.rb
+- lib/drawio_dsl/formatters/klass_formatter.rb
+- lib/drawio_dsl/formatters/style_builder.rb
 - lib/drawio_dsl/layout_engine.rb
 - lib/drawio_dsl/schema/_.rb
 - lib/drawio_dsl/schema/common_style.rb
@@ -334,6 +344,8 @@ files:
 - lib/drawio_dsl/schema/shapes/h5.rb
 - lib/drawio_dsl/schema/shapes/h6.rb
 - lib/drawio_dsl/schema/shapes/hexagon.rb
+- lib/drawio_dsl/schema/shapes/interface.rb
+- lib/drawio_dsl/schema/shapes/klass.rb
 - lib/drawio_dsl/schema/shapes/note.rb
 - lib/drawio_dsl/schema/shapes/p.rb
 - lib/drawio_dsl/schema/shapes/process.rb
@@ -343,6 +355,7 @@ files:
 - lib/drawio_dsl/schema/shapes/square.rb
 - lib/drawio_dsl/schema/shapes/step.rb
 - lib/drawio_dsl/schema/shapes/tick.rb
+- lib/drawio_dsl/schema/shapes/todo.rb
 - lib/drawio_dsl/schema/shapes/triangle.rb
 - lib/drawio_dsl/schema/virtual/anchor.rb
 - lib/drawio_dsl/version.rb

data/.builders/generators/project_plans/drawio_dsl.rb

@@ -1,63 +0,0 @@
-KManager.action :todo_drawio_dsl do
-  action do
-
-    DrawioDsl::Drawio
-      .init(k_builder, on_exist: :write, on_action: :execute)
-      .diagram(rounded: 1, glass: 1)
-      .page('In progress', theme: :style_03, margin_left: 0, margin_top: 0) do
-
-        # h5(x: 300, y: 0, w: 400, h: 80, title: 'DrawIO DSL')
-        # p(x: 350, y: 40, w: 400, h: 80, title: 'Project plan - In progress')
-
-        grid_layout(y:90, direction: :horizontal, grid_h: 80, grid_w: 320, wrap_at: 3, grid: 0)
-
-        square(w: 300, h: 60, title: 'Add page background to theme, use it whenever the theme is set at a diagram/page level')
-      end
-      .page('To Do', theme: :style_02, margin_left: 0, margin_top: 0) do
-
-        # h5(x: 300, y: 0, w: 400, h: 80, title: 'DrawIO DSL')
-        # p(x: 350, y: 40, w: 400, h: 80, title: 'Project plan')
-
-        grid_layout(y:90, direction: :horizontal, grid_h: 80, grid_w: 320, wrap_at: 3, grid: 0)
-
-        square(w: 300, h: 60, title: 'write SVG directly into other projects')
-        square(w: 300, h: 60, title: 'add :shape and :text-only to random shape generator')
-        square(w: 300, h: 60, title: 'Nodes need to support child nodes')
-        square(w: 300, h: 60, title: 'Grid layout does no position itself in relation to the last element')
-        square(w: 300, h: 60, title: 'Dynamic sized shapes that expand to the size of their text')
-        square(w: 300, h: 60, title: 'Control of text padding left, right, top and bottom')
-        square(w: 300, h: 60, title: 'Improve the theme control over text-only shapes')
-        square(w: 300, h: 60, title: 'x,y settings do not work for shapes within a grid layout')
-        square(w: 300, h: 60, title: 'background color does not work from the diagram object')
-        square(w: 300, h: 60, title: 'settings style attributes need to de-duplicate')
-        square(w: 300, h: 60, title: 'need to setup new project plans')
-        square(w: 300, h: 60, title: 'write SVG directly into other projects')
-        square(w: 300, h: 60, title: 'page layout so that you drop elements on and they are positioned correctly, e.g centered, left, right, etc, maybe a grid layout with a wrap of 1 and a width of the page is sufficient')
-      end
-      .page('Done', theme: :style_06, margin_left: 0, margin_top: 0) do
-
-        # h5(x: 300, y: 0, w: 400, h: 80, title: 'DrawIO DSL')
-        # p(x: 350, y: 40, w: 400, h: 80, title: 'Done')
-
-        grid_layout(y:90, direction: :horizontal, grid_h: 80, grid_w: 320, wrap_at: 3, grid: 0)
-
-        square(w: 300, h: 60, title: 'generate extension based graphics based on drawio extensions.js')
-        square(w: 300, h: 60, title: 'active? flag on page defaulting to true. set to false to exclude page from diagram.')
-        square(w: 300, h: 60, title: 'first level child nodes need to hang of node 1')
-        square(w: 300, h: 60, title: 'node has child nodes and add_node will set a nodes parent')
-        square(w: 300, h: 60, title: 'nodes can belong to a parent node, the top level node responds with truthy to root?')
-        square(w: 300, h: 60, title: 'add sample diagram for the github readme file')
-        square(w: 300, h: 60, title: 'write samples into docs folder and display in readme')
-        square(w: 300, h: 60, title: 'add export as .PNG, needs to take a page number as the PNG will not support multiple pages')
-        square(w: 300, h: 60, title: 'add export as .SVG, needs to take a page number as the SVG will not support multiple pages')
-        square(w: 300, h: 60, title: 'add save as .drawio')
-
-      end
-      .cd(:spec)
-      .save('project-plans/drawio_dsl.drawio')
-      .cd(:docs)
-      .export_svg('project_in_progress', page: 1)
-      .export_svg('project_todo'       , page: 2)
-      .export_svg('project_done'       , page: 3)
-  end
-end

data/.builders/generators/project_plans/k_doc.rb

@@ -1,39 +0,0 @@
-KManager.action :todo_drawio_dsl do
-  action do
-
-    DrawioDsl::Drawio
-      .init(k_builder, on_exist: :write, on_action: :execute)
-      .diagram(rounded: 1, glass: 1)
-      .page('In progress', theme: :style_03, margin_left: 0, margin_top: 0) do
-
-        # h5(x: 300, y: 0, w: 400, h: 80, title: 'DrawIO DSL')
-        # p(x: 350, y: 40, w: 400, h: 80, title: 'Project plan - In progress')
-
-        grid_layout(y:90, direction: :horizontal, grid_h: 80, grid_w: 320, wrap_at: 3, grid: 0)
-
-        square(w: 300, h: 60, title: '')
-      end
-      .page('To Do', theme: :style_02, margin_left: 0, margin_top: 0) do
-
-        # h5(x: 300, y: 0, w: 400, h: 80, title: 'DrawIO DSL')
-        # p(x: 350, y: 40, w: 400, h: 80, title: 'Project plan')
-
-        grid_layout(y:90, direction: :horizontal, grid_h: 80, grid_w: 320, wrap_at: 3, grid: 0)
-
-      end
-      .page('Done', theme: :style_06, margin_left: 0, margin_top: 0) do
-
-        # h5(x: 300, y: 0, w: 400, h: 80, title: 'DrawIO DSL')
-        # p(x: 350, y: 40, w: 400, h: 80, title: 'Done')
-
-        grid_layout(y:90, direction: :horizontal, grid_h: 80, grid_w: 320, wrap_at: 3, grid: 0)
-
-      end
-      .cd(:spec)
-      .save('project-plans/k_doc.drawio')
-      # .cd(:k_doc_docs)
-      # .export_svg('project_in_progress', page: 1)
-      # .export_svg('project_todo'       , page: 2)
-      # .export_svg('project_done'       , page: 3)
-  end
-end