drawio_dsl 0.8.4 → 0.8.7

data/.builders/generators/parking_app.rb

@@ -0,0 +1,110 @@
+KManager.action :parking_app do
+  action do
+
+    DrawioDsl::Drawio
+      .init(k_builder, on_exist: :write, on_action: :execute)
+      .diagram(theme: :style_04)
+      .page('Domain Modal', margin_left: 0, margin_top: 0, rounded: 0, background: '#fafafa') do
+        grid_layout(wrap_at: 6)
+
+        # Two apps in the market for parking currently do the following:
+        # 
+        # Allow an officer to see if a car is parked legally or not
+        # Officer can book the car and if it is parked illegally
+        # Officer can print out the penalty infringement notice (PIN)
+        # The vehicle operator (driver) can use the app to buy a ticket for a parking space
+        #
+        # System is integrated with State Debt Recovery System
+        #
+        # Two actors involved:
+        # Officer will book illegal cars
+        #  - An officer can be a: Parking cop, Police officer, Ranger or parking station attendant.
+        #  - Examples of parking station attendants include, McDonald'se, Wilsons Car Park, etc. (limited GEO fence)
+        # The vehicle operator will pay the ticket for parking space
+        #
+        # What can be booked? Anything that is a registered vehicle.
+        #   - Truck, Bus, Car, Motorcycle, Trailer, etc.
+        #   - They all have a number plate.
+        # 
+        # Goal is to build a better app
+
+        # What is wrong with the current apps?
+        #
+        # When I book a car, I say it is outside of house #5,  Bondi road.
+
+        # What can be improved?
+        #
+        # AI can be used to detect the vehicle definition.
+
+        actor2(title: 'Officer', description: 'Officer can book illegal cars')
+        actor2(title: 'Vehicle operator', description: 'vehicle operator can buy a ticket for a parking space')
+
+        # square
+
+        # should there be vehicle, the definition.
+        # should there be vehicle, the instance of the definition.
+
+        klass do # table in the database
+          format
+            .header('Vehicle', description: 'Any vehicle with a registration number plate, Truck, Bus, Car, Motorcycle, Trailer')
+            .field(:make)
+            .field(:model)
+            .field(:type) # Bus, Sedan, Station Wagon, 4WD, Motorcycle, Trailer, Caravan, Car+Caravan, Van etc.
+            .field(:registration_number)
+            .field(:heavy_vehicle)
+        end
+
+        klass do
+          format
+            .header('Chalk', description: 'Noting that a vehicle is parked at a specific time and location')
+            .field(:date_time)          # 9am (from chalk)
+            .field(:vehicle)
+            .field(:location_geo_long)  # , value: '-33.8425248')
+            .field(:location_geo_lat)   # , value: '151.2054196')
+        end
+
+        klass do
+          format
+            .header('Pin', description: 'Penalty infringement notice (PIN)')
+            .field(:date_time)
+            .field(:vehicle)
+            .field(:location_address)                 # can AI be used auto suggest to populate this field, and then the officer can alter if needed.
+            .field(:location_geo_long)                #, value: '-33.8425248')
+            .field(:location_geo_lat)                 #, value: '151.2054196')
+            .field(:location_photo)
+            .field(:photos)
+            .field(:offense_chalk_time)               # 9am (from chalk)
+            .field(:offense_offence_limit_time)       # 2 hours - has to be after chalk time (and is based on signage)
+            .field(:offense_pin_time)                 # has to be after offense limit time
+        end
+
+        # square(title: 'Schema/virtual', theme: :style_01)
+        # diamond(title: 'anchor')
+
+        # klass do
+        #   format
+        #     .header('Container', description: 'A container acts a base data object for any data that requires tagging')
+        # end
+        # square(title: 'Documents', theme: :style_01)
+        # interface(theme: :style_02) do
+        #   format
+        #     .header('Block Processor', interface_type: 'MixIn', description: 'Provide data load events, dependency and import management')
+        #     .field(:block, type: :proc)
+        #     .field(:block_state, type: :symbol)
+        #     .method(:depend_on)
+        # end
+      end
+      .cd(:docs)
+      .save('parking_app.drawio')
+      .export_svg('parking_app', page: 1)
+  end
+end
+
+KManager.opts.app_name                    = 'domain_diagram'
+KManager.opts.sleep                       = 2
+KManager.opts.reboot_on_kill              = 0
+KManager.opts.reboot_sleep                = 4
+KManager.opts.exception_style             = :short
+KManager.opts.show.time_taken             = true
+KManager.opts.show.finished               = true
+KManager.opts.show.finished_message       = 'FINISHED :)'

data/.builders/generators/printspeak-architecture-generator.rb

@@ -1,4 +1,4 @@
-KManager.action :domain_diagram do
+KManager.action :printspeak_architecture_generator do
   action do
 
     DrawioDsl::Drawio
@@ -7,26 +7,31 @@ KManager.action :domain_diagram do
       .page('Style-Plain', margin_left: 0, margin_top: 0, rounded: 0, background: '#fafafa') do
         grid_layout(wrap_at: 6)
 
+        square(title: 'Data Documents', theme: :style_01)
+
         klass do
           format
-            .header('Container', description: 'A container acts a base data object for any data that requires tagging')
-        end
-        interface(theme: :style_02) do
-          format
-            .header('Block Processor', interface_type: 'MixIn', description: 'Provide data load events, dependency and import management')
+            .header('Container', description: '')
         end
-        square(title: 'Documents', theme: :style_01)
+
+        db_json(title: 'db_schema.json', description: 'A model of the database schema based on schema.rb')
+        db_json(title: 'domain_model.json', description: 'A model of domain based db_schema.json and annotated with model and controller code')
+        db_json(title: 'sql_count.json', description: 'Latest SQL counts from production, normalized into a JSON file across regions')
+        db_json(title: 'rubocop.json', description: 'Takes a rubo_cop.txt file parse it so that you can see what issues are in the ruby application')
+        db_json(title: 'data_context.json', description: 'A model of the data context based on domain_model.json and data_context.json')
+        db_json(title: 'routes.json', description: 'Run rails routes and build up a model of what we use')
+
         interface(theme: :style_02) do
           format
-            .header('Block Processor', interface_type: 'MixIn', description: 'Provide data load events, dependency and import management')
+            .header('Block Processor', interface_type: 'Subsystems', description: '')
             .field(:block, type: :proc)
             .field(:block_state, type: :symbol)
             .method(:depend_on)
         end
       end
       .cd(:docs)
-      .save('domain.drawio')
-      .export_svg('domain_model', page: 1)
+      .save('printspeak-architecture-generator.drawio')
+      .export_svg('printspeak-architecture-generator', page: 1)
   end
 end
 

data/.builders/generators/project-plan.rb

@@ -9,13 +9,14 @@ KManager.action :project_plan 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)
+        grid_layout(y: 90, direction: :horizontal, grid_h: 80, grid_w: 320, wrap_at: 3, grid: 0)
         
-        todo(title: 'build a domain (class) diagram')
+        todo(title: 'class html builder to support include/extend modules, class methods')
         todo(title: 'add new shapes related to line connectors')
         todo(title: 'line connector aliases gives a simple way to use predefined line configurations')
         todo(title: 'line connectors need to support autolinking using ids')
         todo(title: 'line connectors should not effect the grid positioning systems')
+        todo(title: 'export diagram json for use with a different DSL builder')
       end
       .page('To Do', theme: :style_02, margin_left: 0, margin_top: 0) do
 
@@ -27,10 +28,9 @@ KManager.action :project_plan do
         todo(title: 'add page background to theme, use it whenever the theme is set at a diagram/page level')
         todo(title: 'move DrawioDsl::Formatters::Factory::FORMATTERS to resource file')
         todo(title: 'move DrawioDsl::Formatters::StyleBuilder::MAPPINGS to resource file')
-        todo(title: 'need to setup new project plans')
         todo(title: 'settings style attributes need to de-duplicate, might be best to utilize the new StyleBuilder class')
         todo(title: 'write SVG directly into other projects')
-        todo(title: 'add :shape, :line and :text to random shape generator')
+        todo(title: 'add :shape, :line and :text to random shape generator, note: you can see the issue in the samples/20-styled-shapes.rb where the text is not rendered')
         todo(title: 'Nodes need to support child nodes')
         todo(title: 'Grid layout does not position itself in relation to the last element')
         todo(title: 'Dynamic sized shapes that expand to the size of their text')
@@ -46,6 +46,9 @@ KManager.action :project_plan do
 
         grid_layout(y:90, direction: :horizontal, grid_h: 80, grid_w: 320, wrap_at: 3, grid: 0)
 
+        todo(title: 'class html formatter to support regular html nodes such as p, h1.. ul, li that are found on the builder')
+        todo(title: 'group box, like a regular box but with a top aligned h1 style title')
+        todo(title: 'build a domain (class) diagram')
         todo(title: 'build configuration for line strokes %i[dashed dotted dashdot dashdotdot dotdotdot longdash)')
         todo(title: 'build configuration for line compass %i[n ne e se s sw w nw]')
         todo(title: 'build configuration for line shape %i[style1 style2 style3 style4]')

data/.builders/generators/sample_diagrams/20-styles.rb

@@ -1,4 +1,4 @@
-KManager.action :bootstrap do
+KManager.action :styled_shapes do
   action do
 
     DrawioDsl::Drawio
@@ -50,7 +50,7 @@ KManager.action :bootstrap do
         end
       end
       .cd(:spec)
-      .save('.samples/20-styles.drawio')
+      .osave('.samples/20-styled-shapes.drawio')
       .cd(:docs)
       .export_svg('samples/styles-plain', page: 1)
       .export_svg('samples/styles-shadow', page: 2)

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

@@ -8,20 +8,6 @@ KManager.action :html_shapes do
       .page('Style-Plain', margin_left: 0, margin_top: 0, rounded: 0, background: '#FFEADB') do
         grid_layout(wrap_at: 8)
 
-        # html = DrawioDsl::Formatters::KlassFormatter.new
-        #   .header('IPerson')
-        #   .field(:first_name, type: :string)
-        #   .field(:last_name, type: :string)
-        #   .field(:age, type: :integer)
-        #   .field(:birthday, type: :date)
-        #   .method(:full_name)
-        #   .method(:sean)
-        #   .as_html
-
-        # square(title: html,
-        #   style_modifiers: 'align=left;overflow=fill;fontSize=12;fontFamily=Helvetica'
-        # )
-
         interface(theme: :style_07) do
           format
             .header('IPerson')
@@ -39,6 +25,42 @@ KManager.action :html_shapes do
             .field(:birthday, type: :date)
             .method(:full_name, type: :string)
         end
+
+        klass(h: 280) do
+          format
+            .header('Custom HTML')
+            .p('David')
+            .b('Cruwys')
+            .hr
+            .h1('h1')
+            .h2('h2')
+            .h3('h3')
+            .h4('h4')
+            .h5('h5')
+            .h6('h6')
+            .ul_s
+            .li('li')
+            .li('li')
+            .ul_e
+        end
+
+        interface(theme: :style_07, h: 280) do
+          format
+            .header('ICustom HTML')
+            .p('David')
+            .b('Cruwys')
+            .hr
+            .h1('h1')
+            .h2('h2')
+            .h3('h3')
+            .h4('h4')
+            .h5('h5')
+            .h6('h6')
+            .ul_s
+            .li('li')
+            .li('li')
+            .ul_e
+        end
       end
       .cd(:spec)
       .osave('.samples/30-html-shapes.drawio')

data/.builders/generators/sample_diagrams/35-ids-and-arrows.rb

@@ -24,7 +24,5 @@ KManager.action :bootstrap do
       end
       .cd(:spec)
       .save('.samples/35-ids-and-arrows.drawio')
-      # .cd(:docs)
-      # .export_svg('samples/styles-plain', page: 1)
   end
 end

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+## [0.8.6](https://github.com/klueless-io/drawio_dsl/compare/v0.8.5...v0.8.6) (2022-03-20)
+
+
+### Bug Fixes
+
+* group box, like a regular box but with a top aligned h1 style title ([282c7e8](https://github.com/klueless-io/drawio_dsl/commit/282c7e8ab8c932082ba9d6914b34767163f1e5e3))
+
+## [0.8.5](https://github.com/klueless-io/drawio_dsl/compare/v0.8.4...v0.8.5) (2022-03-20)
+
+
+### Bug Fixes
+
+* build a domain (class) diagram ([673cbba](https://github.com/klueless-io/drawio_dsl/commit/673cbba2e84bac025f43b64f93547d1547dc6d63))
+
+## [0.8.4](https://github.com/klueless-io/drawio_dsl/compare/v0.8.3...v0.8.4) (2022-03-17)
+
+
+### Bug Fixes
+
+* add database shape ([abd80d8](https://github.com/klueless-io/drawio_dsl/commit/abd80d80e268484e6298c0e7a299cbbba3de4768))
+
 ## [0.8.3](https://github.com/klueless-io/drawio_dsl/compare/v0.8.2...v0.8.3) (2022-03-17)
 
 

data/README.md

@@ -40,11 +40,13 @@ See all [samples](./docs/samples/samples.md)
 
 ![](docs/samples/samples.svg)
 
-## Usage
+## Architecture
 
-See all [usage examples](./USAGE.md)
+### Domain 
 
-## Development
+Domain modal and class diagram can be found [here](docs/domain-modal.md)
+
+### Development
 
 Checkout the repo