drawio_dsl 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56780c6c8fa8c1ea29a29e07bf389cf257fd7a33faf52e955b3fe56133367063
-  data.tar.gz: f583d40a64cea1177d7d52ab627dcbfa954cb3091dada0903947f69f5792d3b5
+  metadata.gz: e5d0f74df30a578aa511a4d9a7ba497839667f25c33d30cb70ec97c42254ec57
+  data.tar.gz: bab21fd8a4c2e2db844e3bf1cba63b6e224778fbe94a029ddaba9fd6fad71539
 SHA512:
-  metadata.gz: 92b5c4e8e2a8210c3e2213df96f1d35034689a3d2ff9132e17fc1fa30f68b89551cb395f725e0b1b5da3b506e62471e2e64def33683f8959f53a41a43e4f5805
-  data.tar.gz: 112eb4f963aa4c295559f8d1e8ed0eaf0121bb768282924ca54059c3de4924d16a33b5a3d33dd9044378315840aafda7db34d228aa2064606eccf5d29776da52
+  metadata.gz: c1b8da217e0876c4720cf087080ed0d66a332eaecb469ab51548b52f95f923943ea57c1fb2405499456be030ce8144d74667f8ff120a7df7d674b4f138c11945
+  data.tar.gz: 1bf29a42082f521cf04f51cd882bb0f664589f076add43d956ccf636f1c24f57c260bf46721bb4f18b8bf87acb9ed487b0ac77d5fd35d482b9dbd71853f875af

data/.builders/.data/shapes.json

@@ -0,0 +1,242 @@
+[
+  {
+    "type": "actor",
+    "x": 0,
+    "y": 0,
+    "w": 40,
+    "h": 50,
+    "style_modifiers": "shape=actor"
+  },
+  {
+    "type": "actor2",
+    "x": 0,
+    "y": 0,
+    "w": 30,
+    "h": 50,
+    "style_modifiers": "shape=umlActor;verticalLabelPosition=bottom;outlineConnect=1"
+  },
+  {
+    "type": "callout",
+    "x": 0,
+    "y": 0,
+    "w": 160,
+    "h": 120,
+    "style_modifiers": "shape=callout"
+  },
+  {
+    "type": "callout2",
+    "x": 0,
+    "y": 0,
+    "w": 160,
+    "h": 160,
+    "style_modifiers": "shape=mxgraph.basic.oval_callout"
+  },
+  {
+    "type": "callout3",
+    "x": 0,
+    "y": 0,
+    "w": 160,
+    "h": 160,
+    "style_modifiers": "shape=mxgraph.basic.cloud_callout"
+  },
+  {
+    "type": "callout4",
+    "x": 0,
+    "y": 0,
+    "w": 160,
+    "h": 120,
+    "style_modifiers": "shape=mxgraph.basic.roundRectCallout;dx=30;dy=15;size=5;boundedLbl=1;"
+  },
+  {
+    "type": "circle",
+    "x": 0,
+    "y": 0,
+    "w": 160,
+    "h": 160,
+    "style_modifiers": "ellipse"
+  },
+  {
+    "type": "cloud",
+    "x": 0,
+    "y": 0,
+    "w": 160,
+    "h": 160,
+    "style_modifiers": "shape=cloud"
+  },
+  {
+    "type": "cross",
+    "x": 0,
+    "y": 0,
+    "w": 50,
+    "h": 50,
+    "style_modifiers": "verticalLabelPosition=bottom;verticalAlign=top;html=1;shape=mxgraph.basic.x"
+  },
+  {
+    "type": "envelop",
+    "x": 0,
+    "y": 0,
+    "w": 160,
+    "h": 100,
+    "style_modifiers": "shape=message"
+  },
+  {
+    "type": "diamond",
+    "x": 0,
+    "y": 0,
+    "w": 100,
+    "h": 100,
+    "style_modifiers": "rhombus"
+  },
+  {
+    "type": "document",
+    "x": 0,
+    "y": 0,
+    "w": 160,
+    "h": 160,
+    "style_modifiers": "shape=mxgraph.basic.document"
+  },
+  {
+    "type": "ellipse",
+    "x": 0,
+    "y": 0,
+    "w": 200,
+    "h": 120,
+    "style_modifiers": "ellipse"
+  },
+  {
+    "type": "hexagon",
+    "x": 0,
+    "y": 0,
+    "w": 200,
+    "h": 120,
+    "style_modifiers": "shape=hexagon"
+  },
+  {
+    "type": "container",
+    "x": 0,
+    "y": 0,
+    "w": 160,
+    "h": 160,
+    "style_modifiers": "swimlane"
+  },
+  {
+    "type": "container2",
+    "x": 0,
+    "y": 0,
+    "w": 160,
+    "h": 160,
+    "style_modifiers": "swimlane;horizontal=0"
+  },
+  {
+    "type": "container3",
+    "x": 0,
+    "y": 0,
+    "w": 160,
+    "h": 160,
+    "style_modifiers": "swimlane;startSize=50"
+  },
+  {
+    "type": "container4",
+    "x": 0,
+    "y": 0,
+    "w": 160,
+    "h": 160,
+    "style_modifiers": "swimlane;resizable=0"
+  },
+  {
+    "type": "note",
+    "x": 0,
+    "y": 0,
+    "w": 160,
+    "h": 160,
+    "style_modifiers": "shape=note"
+  },
+  {
+    "type": "process",
+    "x": 0,
+    "y": 0,
+    "w": 200,
+    "h": 120,
+    "style_modifiers": "shape=process"
+  },
+  {
+    "type": "rectangle",
+    "x": 0,
+    "y": 0,
+    "w": 200,
+    "h": 120,
+    "style_modifiers": ""
+  },
+  {
+    "type": "rectangle2",
+    "x": 0,
+    "y": 0,
+    "w": 200,
+    "h": 120,
+    "style_modifiers": "shape=mxgraph.basic.cloud_rect"
+  },
+  {
+    "type": "square",
+    "x": 0,
+    "y": 0,
+    "w": 160,
+    "h": 160,
+    "style_modifiers": ""
+  },
+  {
+    "type": "step",
+    "x": 0,
+    "y": 0,
+    "w": 120,
+    "h": 80,
+    "style_modifiers": "shape=step;perimeter=stepPerimeter;fixedSize=1"
+  },
+  {
+    "type": "tick",
+    "x": 0,
+    "y": 0,
+    "w": 50,
+    "h": 50,
+    "style_modifiers": "verticalLabelPosition=bottom;verticalAlign=top;shape=mxgraph.basic.tick"
+  },
+  {
+    "type": "face",
+    "x": 0,
+    "y": 0,
+    "w": 100,
+    "h": 100,
+    "style_modifiers": "verticalLabelPosition=bottom;verticalAlign=top;shape=mxgraph.basic.smiley"
+  },
+  {
+    "type": "triangle",
+    "x": 0,
+    "y": 0,
+    "w": 100,
+    "h": 100,
+    "style_modifiers": "triangle"
+  },
+  {
+    "type": "embed_row",
+    "x": 0,
+    "y": 0,
+    "w": 200,
+    "h": 40,
+    "style_modifiers": "shape=partialRectangle;collapsible=0;dropTarget=0;pointerEvents=0;top=0;left=0;bottom=1;right=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest"
+  },
+  {
+    "type": "embed_col50",
+    "x": 0,
+    "y": 0,
+    "w": 50,
+    "h": 40,
+    "style_modifiers": "shape=partialRectangle;connectable=0;top=0;left=0;bottom=0;right=0;fontStyle=1;overflow=hidden"
+  },
+  {
+    "type": "embed_col200",
+    "x": 0,
+    "y": 0,
+    "w": 150,
+    "h": 40,
+    "style_modifiers": "shape=partialRectangle;connectable=0;top=0;left=0;bottom=0;right=0;align=left;spacingLeft=6;overflow=hidden"
+  }
+]

data/.builders/.templates/basic/configuration_shapes.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Attach configuration to the DrawIO DSL module
+# :nocov:
+module DrawioDsl
+  # Used to attach configuration to KConfig module
+  module ConfigurationShapes
+    ShapeDefaults   = Struct.new(:type, :x, :y, :w, :h, :style_modifiers, keyword_init: true)
+    Shapes = Struct.new(
+      :shape,
+      {{#each shapes}}
+      :{{snake ./type}},
+      {{/each}}
+      keyword_init: true
+    )
+
+    def add_shapes
+      @shapes = Shapes.new(
+        shape: ShapeDefaults.new(type: :shape, x: 0, y: 0, w: 20, h: 20, style_modifiers: ''),
+        {{#each shapes}}
+        {{snake ./type}}: ShapeDefaults.new(type: :{{snake ./type}}, x: {{./x}}, y: {{./y}}, w: {{./w}}, h: {{./h}}, style_modifiers: '{{{./style_modifiers}}}'){{#if @last}}{{^}},{{/if}}
+        {{/each}}
+      )
+    end
+  end
+end
+# :nocov:

data/.builders/.templates/basic/dom_builder_shapes.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# :nocov:
+module DrawioDsl
+  # DrawioDsl is a DSL for draw-io diagrams.
+  module DomBuilderShapes
+    {{#each shapes}}
+
+    def add_{{snake ./type}}(**opts)
+      {{snake ./type}} = DrawioDsl::Schema::{{camel ./type}}.new(current_page, **opts)
+      add_shape({{snake ./type}})
+    end
+    {{/each}}
+  end
+end
+# :nocov:

data/.builders/.templates/basic/drawio_shapes.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module DrawioDsl
+  # DrawioDsl::Shapes is a list of DSL methods (one per shape)
+  # :nocov:
+  module DrawioShapes
+    def random(**opts)
+      case rand({{shape_length}})
+      {{#each shapes}}
+      when {{@index}}
+        {{snake ./type}}(**opts)
+      {{/each}}
+      end
+    end
+    {{#each shapes}}
+
+    def {{snake ./type}}(**opts)
+      builder.add_{{snake ./type}}(**opts)
+    end
+    {{/each}}
+  end
+  # :nocov:
+end

data/.builders/.templates/basic/schema_require.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative 'common_style'
+require_relative 'default_palette'
+require_relative 'diagram'
+require_relative 'node'
+require_relative 'page'
+
+require_relative 'layouts/layout'
+require_relative 'layouts/flex_layout'
+require_relative 'layouts/grid_layout'
+
+require_relative 'shapes/shape'
+{{#each shapes}}
+require_relative 'shapes/{{snake ./type}}'
+{{/each}}

data/.builders/.templates/basic/schema_shape.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DrawioDsl
+  module Schema
+    class {{camel shape.type}} < Shape
+      configure_shape(:{{snake shape.type}})
+    end
+  end
+end

data/.builders/.templates/basic/schema_shape_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+RSpec.describe DrawioDsl::Schema::{{camel shape.type}} do
+  include_context :node_dependencies
+
+  subject { instance }
+
+  let(:instance) { described_class.new(diagram, **args) }
+  let(:args) { { id: 1 } }
+  let(:default) { KConfig.configuration.drawio.shapes.{{snake shape.type}} }
+
+  it_behaves_like :basic_shape_attributes
+end

data/.builders/blueprint/shapes.rb

@@ -2,18 +2,53 @@ KManager.model :shapes, namespace: %i[domain] do
   # microapp = import(:handlebars_helpers, :microapp)
 
   table :shapes do
-    fields :type, :x, :y, :w, :h, :style_modifiers
+    fields [:type, :x, :y, :w, :h, :style_modifiers]
 
-    # row :shape      , x: 0, y: 0, w:  20, h:  20, style_modifiers: ''
-    row :square     , x: 0, y: 0, w: 160, h: 160, style_modifiers: ''
-    row :rectangle  , x: 0, y: 0, w: 200, h: 120, style_modifiers: ''
-    row :circle     , x: 0, y: 0, w: 160, h: 160, style_modifiers: 'double=1;ellipse'
-    row :process    , x: 0, y: 0, w: 200, h: 120, style_modifiers: 'double=1;shape=process'
-    row :ellipse    , x: 0, y: 0, w: 200, h: 120, style_modifiers: 'double=1;ellipse'
-    row :diamond    , x: 0, y: 0, w: 160, h: 160, style_modifiers: 'double=1;rhombus'
-    row :hexagon    , x: 0, y: 0, w: 200, h: 120, style_modifiers: 'double=1;shape=hexagon'
-    row :cloud      , x: 0, y: 0, w: 160, h: 160, style_modifiers: 'double=1;shape=cloud'
-    row :note       , x: 0, y: 0, w: 160, h: 160, style_modifiers: 'double=1;shape=note'
-    row :callout    , x: 0, y: 0, w: 160, h: 160, style_modifiers: 'double=1;shape=callout'
+    # shape is a custom object
+    # row :shape      , 0, 0,  20,  20, ''
+
+    # configuration for general purpose shapes
+    row :actor                , 0, 0,  40,  50, 'shape=actor'
+    row :actor2               , 0, 0,  30,  50, 'shape=umlActor;verticalLabelPosition=bottom;outlineConnect=1'
+    row :callout              , 0, 0, 160, 120, 'shape=callout'
+    row :callout2             , 0, 0, 160, 160, 'shape=mxgraph.basic.oval_callout'
+    row :callout3             , 0, 0, 160, 160, 'shape=mxgraph.basic.cloud_callout'
+    row :callout4             , 0, 0, 160, 120, 'shape=mxgraph.basic.roundRectCallout;dx=30;dy=15;size=5;boundedLbl=1;'
+    row :circle               , 0, 0, 160, 160, 'ellipse'
+    row :cloud                , 0, 0, 160, 160, 'shape=cloud'
+    row :cross                , 0, 0,  50,  50, 'verticalLabelPosition=bottom;verticalAlign=top;html=1;shape=mxgraph.basic.x'
+    row :envelop              , 0, 0, 160, 100, 'shape=message'
+    row :diamond              , 0, 0, 100, 100, 'rhombus'
+    row :document             , 0, 0, 160, 160, 'shape=mxgraph.basic.document'
+    row :ellipse              , 0, 0, 200, 120, 'ellipse'
+    row :hexagon              , 0, 0, 200, 120, 'shape=hexagon'
+    row :container            , 0, 0, 160, 160, 'swimlane'
+    row :container2           , 0, 0, 160, 160, 'swimlane;horizontal=0'
+    row :container3           , 0, 0, 160, 160, 'swimlane;startSize=50'
+    row :container4           , 0, 0, 160, 160, 'swimlane;resizable=0'
+    row :note                 , 0, 0, 160, 160, 'shape=note'
+    row :process              , 0, 0, 200, 120, 'shape=process'
+    row :rectangle            , 0, 0, 200, 120, ''
+    row :rectangle2           , 0, 0, 200, 120, 'shape=mxgraph.basic.cloud_rect'
+    row :square               , 0, 0, 160, 160, ''
+    row :step                 , 0, 0, 120,  80, 'shape=step;perimeter=stepPerimeter;fixedSize=1'
+    row :tick                 , 0, 0,  50,  50, 'verticalLabelPosition=bottom;verticalAlign=top;shape=mxgraph.basic.tick'
+    row :face                 , 0, 0, 100, 100, 'verticalLabelPosition=bottom;verticalAlign=top;shape=mxgraph.basic.smiley'
+    row :triangle             , 0, 0, 100, 100, 'triangle'
+
+    # configuration for embedded element shape
+    # note that the width / height probably should be driven of parent shape
+    row :embed_row            , 0, 0, 200,  40, 'shape=partialRectangle;collapsible=0;dropTarget=0;pointerEvents=0;top=0;left=0;bottom=1;right=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest'
+    row :embed_col50          , 0, 0,  50,  40, 'shape=partialRectangle;connectable=0;top=0;left=0;bottom=0;right=0;fontStyle=1;overflow=hidden'
+    row :embed_col200         , 0, 0, 150,  40, 'shape=partialRectangle;connectable=0;top=0;left=0;bottom=0;right=0;align=left;spacingLeft=6;overflow=hidden'
+  end
+
+  action do
+    data = self.raw_data
+    shapes = JSON.pretty_generate(data['shapes'])
+
+    k_builder
+      .cd(:data)
+      .add_file('shapes.json', content: shapes, on_exist: :write)
   end
 end

data/.builders/boot.rb

@@ -45,11 +45,16 @@ KConfig.configure(CONFIG_KEY) do |config|
   base_folder       = File.expand_path('../', builder_folder)
   global_template   = File.expand_path('~/dev/kgems/k_templates/templates')
 
+  # Templates
   config.template_folders.add(:global_template    , global_template)
   config.template_folders.add(:template           , File.expand_path('.templates', Dir.pwd))
 
+  # Target Folders
   config.target_folders.add(:app                  , base_folder)
+  config.target_folders.add(:lib                  , :app, 'lib', 'drawio_dsl')
+  config.target_folders.add(:spec                 , :app, 'spec', 'drawio_dsl')
   config.target_folders.add(:builder              , builder_folder)
+  config.target_folders.add(:data                 , :builder, '.data')
 end
 
 KConfig.configuration(CONFIG_KEY).debug

data/.builders/generators/02-generate-app.rb

@@ -0,0 +1,43 @@
+KManager.action :requires do
+
+  action do
+    shapes_file = k_builder.target_folders.get_filename(:data, 'shapes.json')
+    shapes = JSON.parse(File.read(shapes_file))
+
+    KDirector::Dsls::BasicDsl
+      .init(k_builder,
+        on_exist:                   :write,                      # %i[skip write compare]
+        on_action:                  :execute                    # %i[queue execute]
+      )
+      .blueprint(
+        active: true,
+        on_exist: :write) do
+
+        cd(:lib)
+
+        add('schema/_.rb', template_file: 'schema_require.rb', shapes: shapes)
+
+        shapes.each do |shape|
+          add("schema/shapes/#{shape['type']}.rb",
+            template_file: 'schema_shape.rb',
+            shape: shape)
+        end
+
+        add("drawio_shapes.rb"        , template_file: 'drawio_shapes.rb'       , shapes: shapes, shape_length: shapes.length)
+        add("dom_builder_shapes.rb"   , template_file: 'dom_builder_shapes.rb'  , shapes: shapes)
+        add("configuration_shapes.rb" , template_file: 'configuration_shapes.rb', shapes: shapes)
+
+        cd(:spec)
+
+        shapes.each do |shape|
+          add("schema/shapes/#{shape['type']}_spec.rb",
+            template_file: 'schema_shape_spec.rb',
+            shape: shape)
+        end
+
+        cd(:app)
+        run_command('rubocop -a')
+
+      end
+  end
+end

data/.builders/generators/{25-themes.rb → sample_diagrams/25-themes.rb}

@@ -5,8 +5,8 @@ KManager.action :bootstrap do
     director = DrawioDsl::Drawio
       .init(k_builder)
       .diagram(theme: :style_06)
-      .page('Style-Plain', margin_left: 0, margin_top: 0) do
-        grid_layout(wrap_at: 5)
+      .page('Style-Plain', margin_left: 0, margin_top: 0, rounded: 1, background: '#FFEADB') do
+        grid_layout(wrap_at: 8)
 
         square(title: 'The quick brown fox jumps over the lazy dog')
         circle(title: 'Mary had a little lamb')

data/.builders/generators/sample_diagrams/30-shapes.rb

@@ -0,0 +1,23 @@
+KManager.action :bootstrap do
+  action do
+
+    # :rounded, :shadow, :sketch, :glass
+    director = DrawioDsl::Drawio
+      .init(k_builder)
+      .diagram(theme: :style_06)
+      .page('Shapes', margin_left: 0, margin_top: 0) do
+        grid_layout(wrap_at: 5)
+
+        KConfig.configuration.drawio.shapes.members.each do |shape|
+          next if shape == :shape
+
+          send(shape, title: shape.to_s, shape: shape)
+        end
+      end
+
+    diagram = DrawioDsl::XmlBuilder.new(director.builder.diagram)
+
+    File.write('../spec/.samples/drawio/30-shapes.xml', diagram.build)
+    File.write('../spec/.samples/drawio/30-shapes.drawio', diagram.build)
+  end
+end

data/.rubocop.yml

@@ -11,6 +11,7 @@ AllCops:
     - ".builders/**/*"
     - "spec/samples/**/*"
 
+
 Metrics/BlockLength:
   Exclude:
     - "**/spec/**/*"
@@ -35,14 +36,13 @@ Metrics/BlockLength:
     - shared_examples_for
     - transaction
 
-Metrics/MethodLength:
-  Max: 25
-
 Layout/LineLength:
   Max: 200
   # Ignores annotate output
   IgnoredPatterns: ['\A# \*\*']
   IgnoreCopDirectives: true
+  Exclude:
+    - "lib/drawio_dsl/configuration_shapes.rb"
 
 Lint/UnusedMethodArgument:
   AllowUnusedKeywordArguments: true
@@ -58,6 +58,25 @@ Metrics/ClassLength:
 Metrics/ModuleLength:
   Exclude:
     - "**/spec/**/*"
+    - "lib/drawio_dsl/drawio_shapes.rb"
+    - "lib/drawio_dsl/schema/shapes/diagram.rb"
+    - "lib/drawio_dsl/dom_builder_shapes.rb"
+Metrics/AbcSize:
+  Exclude:
+    - "lib/drawio_dsl/drawio_shapes.rb"
+    - "lib/drawio_dsl/configuration_shapes.rb"
+    - "lib/drawio_dsl/configuration_themes.rb"
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - "lib/drawio_dsl/drawio_shapes.rb"
+Metrics/MethodLength:
+  Max: 25
+  Exclude:
+    - "lib/drawio_dsl/drawio_shapes.rb"
+    - "lib/drawio_dsl/schema/shapes/shape.rb"
+    - "lib/drawio_dsl/schema/shapes/page.rb"
+    - "lib/drawio_dsl/configuration_shapes.rb"
+    - "lib/drawio_dsl/configuration_themes.rb"
 Naming/MemoizedInstanceVariableName:
   Enabled: false
 Naming/AccessorMethodName:

data/CHANGELOG.md

@@ -1,3 +1,26 @@
+# [0.5.0](https://github.com/klueless-io/drawio_dsl/compare/v0.4.1...v0.5.0) (2022-03-07)
+
+
+### Features
+
+* add new and update older shapes ([64a0d83](https://github.com/klueless-io/drawio_dsl/commit/64a0d83dda6181183c0980914b7b2ee1520b84e6))
+* final code generation in place for shapes ([ac4ed3c](https://github.com/klueless-io/drawio_dsl/commit/ac4ed3cace4e1794d38306e14d3cee60529add4b))
+* final code generation in place for shapes ([4c2a6fb](https://github.com/klueless-io/drawio_dsl/commit/4c2a6fb376fe61cfd44a699677f7781c9e2b215c))
+
+## [0.4.1](https://github.com/klueless-io/drawio_dsl/compare/v0.4.0...v0.4.1) (2022-03-06)
+
+
+### Bug Fixes
+
+* add support for generated shapes ([b52f278](https://github.com/klueless-io/drawio_dsl/commit/b52f2786281acadc32d546f0ed9c7ac2c8fc1094))
+
+# [0.4.0](https://github.com/klueless-io/drawio_dsl/compare/v0.3.0...v0.4.0) (2022-03-05)
+
+
+### Features
+
+* big refactor, plus 98% test coverage ([0d1075c](https://github.com/klueless-io/drawio_dsl/commit/0d1075c177ff1441246950aaa7306ef774ba6df4))
+
 # [0.3.0](https://github.com/klueless-io/drawio_dsl/compare/v0.2.0...v0.3.0) (2022-03-04)
 
 

data/README.md

@@ -2,6 +2,10 @@
 
 > DrawIO DSL can build DrawIO diagrams using a Domain Specific Language
 
+## ToDo
+
+- Diagram needs to support background color and it needs to trickle down to pages
+
 ## Installation
 
 Add this line to your application's Gemfile: