drawio_dsl 0.6.0 → 0.7.0

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,53 @@
+# 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(value)
+        html.p('<i>Interface</i>', text_align: :center)
+        html.p("<b>#{value}</b>", text_align: :center)
+        html.hr
+
+        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,52 @@
+# 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(value)
+        html.p("<b>#{value}</b>", text_align: :center)
+        html.hr
+
+        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'

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,6 +4,8 @@ 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_defaults
 
@@ -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
@@ -101,7 +108,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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DrawioDsl
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 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.7.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "drawio_dsl",
-      "version": "0.6.0",
+      "version": "0.7.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.6.0",
+  "version": "0.7.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.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - David Cruwys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-13 00:00:00.000000000 Z
+date: 2022-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: k_config
@@ -96,6 +96,7 @@ files:
 - ".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/50-willoughby-council.rb"
 - ".releaserc.json"
 - ".rspec"
@@ -295,6 +296,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 +342,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