tailwind_dsl 0.0.13 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86fb67e259cee179a6eee1454ec670b68d5c88f03e67b8074fab845116913dc2
-  data.tar.gz: dfbb4c75a44d45bb92715642d27b94f3de509914e1d7701c16414390157a6e48
+  metadata.gz: e6646b23144a973701ff3a0357cdf6eb27fcc34e26690d2fdbcd77abf1b4767b
+  data.tar.gz: 1930985fae4778a5d7576ba843f2f727c634c14802fa3c572d0513df5e2eb3f3
 SHA512:
-  metadata.gz: f5ac166f49be7f7f61ccb0b1481e55f678a7a37b721d63449efbdb187e9a45000c553169664df2d8d3343c3c9a62f29f9867ff3a439eecb0309e5a18d1481ddf
-  data.tar.gz: 4841cdcf0af2012c18c356399ab94f2e6e2703dc12ec9af365282b5f07c95b137c2411db82d4e7ab326212cb0786e3ce962fb7094ca5c54005a9d801f551477e
+  metadata.gz: a6ccea6907b5a4a1ff3cdc20fa20d0ce6dc814890d1cc4524e2fba9b124b85d599c5ae1046de94ddf10b20bde5292ddf79cdd7f0d0c38d6fa117a0bf7bb73ee1
+  data.tar.gz: 8feb59692ddaf59ffe373c1492e08e45dfe546ab63bfc09554afe47322975ad0fb8de5ec91046bb506b0ad303543157a1c0e86c0c5098db85098d12d059ebfc5

data/.builders/boot.rb

@@ -31,6 +31,7 @@ KConfig.configure(CONFIG_KEY) do |config|
   config.target_folders.add(:builder              , builder_folder)
   config.target_folders.add(:data                 , base_folder, '.data')
   config.target_folders.add(:components           , base_folder, '.components')
+  config.target_folders.add(:component_models     , base_folder, '.component_models')
 
   config.target_folders.add(:template_merakiui    , global_template, 'tailwind', 'merakiui')
   config.target_folders.add(:template_devdojo     , global_template, 'tailwind', 'devdojo')

data/.builders/generators/utilities.rb

@@ -11,21 +11,31 @@ KManager.action :utilities do
         cd(:data)
 
         # Raw components are source HTML/Tailwind files that have embedded information such as tailwind.config.js and usage instructions
-        raw_component_path = File.expand_path('~/dev/kgems/k_templates/templates/tailwind')
+        source_component_path = File.expand_path('~/dev/kgems/k_templates/templates/tailwind')
 
         # Target components are the processed components that are ready to be consumed by the TailwindDSL
-        component_folder = k_builder.target_folders.get(:components)
+        target_component_path = k_builder.target_folders.get(:components)
+        
+        # The component data shapes are reflected model based on the data inside of a HTML templates
+        target_component_model_path = k_builder.target_folders.get(:component_models)
 
-        uikit = helpers.build_design_systems(raw_component_path)
-        json = JSON.pretty_generate(uikit.to_h)
+        # Builds the design_system.json by reading all the HTML templates for every UIKit found the source_component_path
+        uikit = helpers.build_design_systems(source_component_path)
 
-        add('design_system.json', content: json)
+        add('design_system.json', content: JSON.pretty_generate(uikit.to_h))
 
-        helpers.generate_components(uikit, raw_component_path, component_folder, reset_root_path: false)
+        # Separate clean and raw components, tailwind configuration, settings into their own folders
+        component_generator = helpers.generate_components(uikit, source_component_path, target_component_path, reset_root_path: false)
+        components = component_generator.components
+
+        # Use GPT3 to extract component models in supervised fashion
+        helpers.extract_next_component_model(components, target_component_model_path, batch_size: 1, use_prompt: true, filter_design_system: 'tui')
+        # puts target_component_path
+        # /Users/davidcruwys/dev/kgems/tailwind_dsl/.components
 
         # Goals
         #   - Generate a Tailwind component complete design system so that I can see both the component plus the original source code
-        #     There should be a deep hierarchy of folders and files in a menu structure
+        #     [✔️] There should be a deep hierarchy of folders and files in a menu structure
         #     When you click on a menu item, there should be a preview of the component
         #     The menus should be collapsible
         #     The menus should be searchable
@@ -39,21 +49,32 @@ KManager.action :utilities do
 
   end
 
-  def build_design_systems(raw_component_path)
+  def build_design_systems(source_component_path)
     director = TailwindDsl::Etl::RawComponents::Director.new
 
-    director.add_design_system(File.join(raw_component_path, 'tui'))
-    # director.add_design_system(File.join(raw_component_path, 'codepen'))
-    # director.add_design_system(File.join(raw_component_path, 'devdojo'))
-    # director.add_design_system(File.join(raw_component_path, 'merakiui'))
-    # director.add_design_system(File.join(raw_component_path, 'noq'))
-    # director.add_design_system(File.join(raw_component_path, 'starter-kit'))
+    director.add_design_system(File.join(source_component_path, 'tui'))
+    # director.add_design_system(File.join(source_component_path, 'codepen'))
+    # director.add_design_system(File.join(source_component_path, 'devdojo'))
+    # director.add_design_system(File.join(source_component_path, 'merakiui'))
+    # director.add_design_system(File.join(source_component_path, 'noq'))
+    # director.add_design_system(File.join(source_component_path, 'starter-kit'))
     director.uikit
   end
 
-  def generate_components(uikit, raw_component_path, target_folder, reset_root_path: false)
-    generator = TailwindDsl::Etl::ComponentStructures::Generator.new(uikit, raw_component_path, target_folder, reset_root_path: reset_root_path)
+  def generate_components(uikit, source_component_path, target_folder, reset_root_path: false)
+    generator = TailwindDsl::Etl::ComponentStructures::Generator.new(uikit, source_component_path, target_folder, reset_root_path: reset_root_path)
     generator.generate
+    generator
+  end
+
+  # Extracts the next component model using GPT3
+  #
+  # This needs to be supervised and verified, so it will only do a few models at a time
+  def extract_next_component_model(components, target_folder, batch_size: 1, use_prompt: false, filter_design_system: nil)
+    puts target_folder
+    extractor = TailwindDsl::Etl::ComponentModels::Extractor.new(components, target_folder, batch_size: batch_size, use_prompt: use_prompt, filter_design_system: filter_design_system)
+    extractor.extract
   end
 end
+
 KManager.opts.sleep = 2

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## [0.0.14](https://github.com/klueless-io/tailwind_dsl/compare/v0.0.13...v0.0.14) (2022-10-18)
+
+
+### Bug Fixes
+
+* refactor sample data directories ([23e4efb](https://github.com/klueless-io/tailwind_dsl/commit/23e4efb2863643cfbc8744e656a873900a421572))
+* refactor sample data directories ([4017917](https://github.com/klueless-io/tailwind_dsl/commit/401791784e51fbe771c841294a4ad837f99c8ec9))
+* start working on component model extractor ([929292d](https://github.com/klueless-io/tailwind_dsl/commit/929292dcdae8d79ccd12e2eae30d3e6710bac3f2))
+
+## [0.0.13](https://github.com/klueless-io/tailwind_dsl/compare/v0.0.12...v0.0.13) (2022-10-18)
+
+
+### Bug Fixes
+
+* refactor tests ([91b730d](https://github.com/klueless-io/tailwind_dsl/commit/91b730d91f99cf06810581d2d1684bb836eae860))
+
 ## [0.0.12](https://github.com/klueless-io/tailwind_dsl/compare/v0.0.11...v0.0.12) (2022-10-14)
 
 

data/lib/tailwind_dsl/etl/component_models/extractor.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module TailwindDsl
+  module Etl
+    module ComponentModels
+      # Extract component models by reading the cleansed component HTML and then using GPT3 to infer both the data/model structure.
+      class Extractor
+        attr_reader :components
+        attr_reader :target_root_path
+        attr_reader :batch_size
+        attr_reader :use_prompt
+
+        def initialize(components, target_root_path, batch_size: 1, use_prompt: false, filter_design_system: nil)
+          @components = components
+          @target_root_path = target_root_path
+          @batch_size = batch_size
+          @batch_left = batch_size
+          @use_prompt = use_prompt
+        end
+
+        # Goal:       Extract the next (batch_size) component models using GPT3 and save them to target_root_path
+        #             Create a data file at: design_system.name -> group-hierarchy -> component-name.data.json
+        #             Create a model file at: design_system.name -> group-hierarchy -> component-name.model.rb
+
+        # Process:    Collect all components and optionally filter them by design system name.
+        #             Look for the next component to be processed, if it does not exist in the target folder then process it.
+        #             decrement the batch_left counter and continue until batch_left is 0.
+        #             if :use_prompt is true then display the input/output files and ask if you wish to process the component or skip.
+        #             process the component by calling the GPT3 API and save the results to the target folder.
+
+        def extract; end
+
+        # def components
+        #   @components ||= components.design_systems.map do |design_system|
+        #     design_system.components.map do |component|
+        #       Component.new(design_system, component, source_root_path, target_root_path)
+        #     end
+        #   end.flatten
+        # end
+      end
+    end
+  end
+end

data/lib/tailwind_dsl/etl/component_structures/generator.rb

@@ -21,7 +21,9 @@ module TailwindDsl
         # .gsub(/(\n\s*\n)+/, "\n")
         attr_reader :uikit
         attr_reader :components
+        # Location for raw components
         attr_reader :source_root_path
+        # Location for component structures
         attr_reader :target_root_path
         attr_reader :reset_root_path
 
@@ -54,8 +56,8 @@ module TailwindDsl
 
         def query_components
           RawComponentQuery.query(uikit,
-                                  raw_component_root_path: source_root_path,
-                                  component_structure_root_path: target_root_path).records
+                                  source_root_path: source_root_path,
+                                  target_root_path: target_root_path).records
         end
 
         def process_components

data/lib/tailwind_dsl/etl/component_structures/raw_component_query.rb

@@ -8,8 +8,6 @@ module TailwindDsl
       # This is a two pass process:
       #  1. Query the raw component folder for all files that match the pattern and build up a graph with required information
       #  2. Flatten the graph into a list of rows
-      #
-      # If you need to debug, then pass in the debug flag and it will output the graph to the console
       class RawComponentQuery
         DesignSystem = Struct.new(
           :name,
@@ -64,22 +62,22 @@ module TailwindDsl
         end
 
         attr_reader :uikit
-        attr_reader :raw_component_root_path
-        attr_reader :component_structure_root_path
+        # Location for raw components
+        attr_reader :source_root_path
+        # Location for component structures
+        attr_reader :target_root_path
         attr_reader :current_design_system
-        attr_reader :debug
         attr_reader :records
 
         def initialize(uikit, **args)
           @uikit = uikit
-          @raw_component_root_path = args[:raw_component_root_path] || raise(ArgumentError, 'Missing raw_component_root_path')
-          @component_structure_root_path = args[:component_structure_root_path] || raise(ArgumentError, 'Missing component_structure_root_path')
-          @debug = args[:debug] || false
+          @source_root_path = args[:source_root_path] || raise(ArgumentError, 'Missing source_root_path')
+          @target_root_path = args[:target_root_path] || raise(ArgumentError, 'Missing target_root_path')
         end
 
         class << self
-          def query(uikit, raw_component_root_path:, component_structure_root_path:, debug: false)
-            instance = new(uikit, raw_component_root_path: raw_component_root_path, component_structure_root_path: component_structure_root_path, debug: debug)
+          def query(uikit, source_root_path:, target_root_path:)
+            instance = new(uikit, source_root_path: source_root_path, target_root_path: target_root_path)
             instance.call
           end
         end
@@ -119,11 +117,11 @@ module TailwindDsl
         end
 
         def source_path
-          File.join(raw_component_root_path, design_system_name)
+          File.join(source_root_path, design_system_name)
         end
 
         def target_path
-          File.join(component_structure_root_path, design_system_name)
+          File.join(target_root_path, design_system_name)
         end
 
         def map_design_system

data/lib/tailwind_dsl/etl/raw_components/director.rb

@@ -3,6 +3,8 @@
 module TailwindDsl
   module Etl
     module RawComponents
+      # NOTE: Director is badly named.
+
       # Use the Director to build the UiKit which will store the JSON representations of each Design System plus components.
       #
       # This is a raw representation of the source.

data/lib/tailwind_dsl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TailwindDsl
-  VERSION = '0.0.13'
+  VERSION = '0.0.15'
 end

data/lib/tailwind_dsl.rb

@@ -17,6 +17,8 @@ require_relative 'tailwind_dsl/etl/raw_components/schema/uikit'
 
 require_relative 'tailwind_dsl/etl/component_structures/raw_component_query'
 require_relative 'tailwind_dsl/etl/component_structures/generator'
+
+require_relative 'tailwind_dsl/etl/component_models/extractor'
 # require_relative 'tailwind_dsl/astro_demo/generate_astro_page_data'
 
 module TailwindDsl

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "tailwind_dsl",
-  "version": "0.0.13",
+  "version": "0.0.15",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "tailwind_dsl",
-      "version": "0.0.13",
+      "version": "0.0.15",
       "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": "tailwind_dsl",
-  "version": "0.0.13",
+  "version": "0.0.15",
   "description": "Tailwind DSL will build tailwind websites useing Domain Specific Language conventions",
   "scripts": {
     "release": "semantic-release"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tailwind_dsl
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.15
 platform: ruby
 authors:
 - David Cruwys
@@ -2151,6 +2151,7 @@ files:
 - lib/_.rb
 - lib/tailwind_dsl.rb
 - lib/tailwind_dsl/astro_demo/generate_astro_page_data.rb
+- lib/tailwind_dsl/etl/component_models/extractor.rb
 - lib/tailwind_dsl/etl/component_structures/generator.rb
 - lib/tailwind_dsl/etl/component_structures/raw_component_query.rb
 - lib/tailwind_dsl/etl/element.rb