tailwind_dsl 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68a690ad2b3e6e2052376543026bd62cd78c42e1d1c1b66fdbb8c4aee6b714ee
-  data.tar.gz: 42774c4d3629197a4352150e7f7843c5338488bcc6387495fec7ce4b419efbbf
+  metadata.gz: 707385386be771dc2457c12377c7522b367fd3dc4fe806136d49f0ee0b3df12a
+  data.tar.gz: 1e79a6487b05453ae75d7b6c5bc68d43371e4068c4b8a2e18182a2353f587989
 SHA512:
-  metadata.gz: 3de3cc5f53383542f91b779de83fe6b6eb7737d559243230357345485c385344a31fae4d85ec30b660c8d255256a0b8de87b31983dd589704558411cc379c55c
-  data.tar.gz: 775e8d304ad2c414cb6ba31072e44459e5929233a6878a1c579d9fc8a5365895281d0fe04f13bc7fc0f48f197bac11221584a9aaa69ab4387a2dd6c35d76d8ec
+  metadata.gz: 3295d19615b011bb2b44ef7bb983d3e921723224992c72e07e8cb702086cade1d5b6fe9e4eeb67e30c987b523a2a82a1772d8bbb9bd9f1145685a6059a0eca07
+  data.tar.gz: 233c7879ba2613c8ebf6530793ee4a326e53731c4c3dd3f50061407b3e19b4bae35441c4124837343aed1b20acb1bb872e4e8f06d3b45be144842e44fabbc75d

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [0.0.11](https://github.com/klueless-io/tailwind_dsl/compare/v0.0.10...v0.0.11) (2022-10-14)
+
+
+### Bug Fixes
+
+* add raw component query object for use by component structures ([16cc578](https://github.com/klueless-io/tailwind_dsl/commit/16cc5785ee118b31d90c62e38b88a7ddae9c342f))
+
 ## [0.0.10](https://github.com/klueless-io/tailwind_dsl/compare/v0.0.9...v0.0.10) (2022-10-13)
 
 

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

@@ -20,73 +20,71 @@ module TailwindDsl
 
         # .gsub(/(\n\s*\n)+/, "\n")
         attr_reader :uikit
-        attr_reader :root_raw_component_path
-        attr_reader :root_target_path
+        attr_reader :source_root_path
+        attr_reader :target_root_path
         attr_reader :reset_root_path
 
-        def initialize(uikit, root_raw_component_path, root_target_path, reset_root_path: false)
+        def initialize(uikit, source_root_path, target_root_path, reset_root_path: false)
           @uikit = uikit
-          @root_raw_component_path = root_raw_component_path
-          @root_target_path = root_target_path
+          @source_root_path = source_root_path
+          @target_root_path = target_root_path
           @reset_root_path = reset_root_path
         end
 
         def generate
-          assert_root_target_path_exists
+          assert_target_root_path_exists
 
           delete_target_root_path if reset_root_path
 
-          uikit.design_systems.each do |design_system|
-            process_design_system(design_system)
-          end
+          @components = query_components
+
+          process_components
         end
 
         private
 
-        def assert_root_target_path_exists
-          raise 'Target path does not exist' unless Dir.exist?(root_target_path)
+        def assert_target_root_path_exists
+          raise 'Target path does not exist' unless Dir.exist?(target_root_path)
         end
 
         def delete_target_root_path
-          FileUtils.rm_rf(Dir.glob("#{root_target_path}/*"))
+          FileUtils.rm_rf(Dir.glob("#{target_root_path}/*"))
         end
 
-        def process_design_system(design_system)
-          design_system_name = design_system.name
-          design_system.groups.each do |group|
-            process_group(design_system_name, group)
-          end
+        def query_components
+          RawComponentQuery.query(uikit,
+                                  raw_component_root_path: source_root_path,
+                                  component_structure_root_path: target_root_path).records
         end
 
-        def process_group(design_system_name, group)
-          group.files.each do |file|
-            # puts "DSN: #{design_system_name}, GRP: #{group.type}, FILE: #{file.file}"
-            data = Data.new(design_system_name, group, file, root_raw_component_path)
-
-            unless data.source.exist?
-              puts "Source file does not exist: #{data.source.file}"
+        def process_components
+          @components.each do |component|
+            unless File.exist?(component.absolute_path.source_file)
+              puts "Source file does not exist: #{component.absolute_path.source_file}"
               next
             end
 
-            process_component(data)
+            # puts "DSN: #{component.design_system.name}, GRP: #{component.group.type}, FILE: #{component.relative_path.source_file}"
+
+            process_component(component)
           end
         end
 
-        def process_component(data)
+        def process_component(component)
           # Create a folder for the component
-          make_target_folder(data)
+          make_target_folder(component)
 
-          # Create a HTML file for each component
-          create_html_file(data)
+          # # Create a HTML file for each component
+          create_html_file(component)
 
-          # Create a clean HTML file for each component (comments removed)
-          create_clean_html_file(data)
+          # # Create a clean HTML file for each component (comments removed)
+          create_clean_html_file(component)
 
-          # Create a tailwind config file (if one exists) - look in first comment for the ``` ```
-          create_tailwind_config_file(data)
+          # # Create a tailwind config file (if one exists) - look in first comment for the ``` ```
+          create_tailwind_config_file(component)
 
-          # Create a settings file after extracting information from the HTML file
-          create_settings_file(data)
+          # # Create a settings file after extracting information from the HTML file
+          create_settings_file(component)
 
           # Build a menu of sources
           # see: https://tailwindui.com/components/application-ui/data-display/description-lists
@@ -104,42 +102,38 @@ module TailwindDsl
         #   Note that the data file is meant to represent the data in the raw component
         # Write an Astro file
 
-        def target_path(data)
-          File.join(root_target_path, data.design_system_name, data.target.folder)
-        end
-
-        def target_file(data, file)
-          File.join(root_target_path, data.design_system_name, file)
+        def target_path(component)
+          File.join(target_root_path, component.design_system.name, component.group.folder)
         end
 
-        def make_target_folder(data)
-          FileUtils.mkdir_p(target_path(data))
+        def make_target_folder(component)
+          FileUtils.mkdir_p(target_path(component))
         end
 
-        def create_html_file(data)
+        def create_html_file(component)
           # rules:
           # if the html file exists, then read the settings file, if the settings has html overwrite, then overwrite the html file
           # overwrite = true
-          FileUtils.cp_r(data.source.file, target_file(data, data.target.html_file), remove_destination: true) # if overwrite
+          FileUtils.cp_r(component.absolute_path.source_file, component.absolute_path.target_html_file, remove_destination: true) # if overwrite
         end
 
-        def create_clean_html_file(data)
-          html = data.source.content || ''
-          data.captured_comment_list = html.scan(COMMENT_REGEX)
-          data.captured_comment_text = data.captured_comment_list.join("\n")
+        def create_clean_html_file(component)
+          html = File.read(component.absolute_path.source_file) || ''
+          component.captured_comment_list = html.scan(COMMENT_REGEX)
+          component.captured_comment_text = component.captured_comment_list.join("\n")
 
           html = html.gsub(COMMENT_REGEX, '').gsub(BLANK_LINE_REGEX, "\n").lstrip
 
-          File.write(target_file(data, data.target.clean_html_file), html)
+          File.write(component.absolute_path.target_clean_html_file, html)
         end
 
-        def create_tailwind_config_file(data)
-          data.captured_tailwind_config = extract_tailwind_config(data)
+        def create_tailwind_config_file(component)
+          component.captured_tailwind_config = extract_tailwind_config(component)
 
-          File.write(target_file(data, data.target.tailwind_config_file), data.captured_tailwind_config) if data.captured_tailwind_config
+          File.write(component.absolute_path.target_tailwind_config_file, component.captured_tailwind_config) if component.captured_tailwind_config
         end
 
-        def create_settings_file(data)
+        def create_settings_file(component)
           # CUSTOM
           # templates/tailwind/tui/ecommerce/page/product-pages/02.html
           # templates/tailwind/tui/ecommerce/components/product-overviews/04.html
@@ -164,31 +158,31 @@ module TailwindDsl
           # templates/tailwind/tui/application-ui/page/home-screens/02.html
           # templates/tailwind/tui/application-ui/component/list/feed/03.html
           settings = {
-            source: extract_source(data),
+            source: extract_source(component),
             custom_html: {
-              html: data.captured_comment_text.match(/<html.*>/),
-              body: data.captured_comment_text.match(/<body.*>/)
+              html: component.captured_comment_text.match(/<html.*>/),
+              body: component.captured_comment_text.match(/<body.*>/)
             },
-            tailwind_config: tailwind_config_settings(data.captured_tailwind_config)
+            tailwind_config: tailwind_config_settings(component.captured_tailwind_config)
           }
 
-          File.write(target_file(data, data.target.settings_file), JSON.pretty_generate(settings))
+          File.write(component.absolute_path.target_settings_file, JSON.pretty_generate(settings))
         end
 
-        def extract_tailwind_config(data)
-          return nil if data.captured_comment_list.length.zero? || !data.captured_comment_list.first.include?('// tailwind.config.js')
+        def extract_tailwind_config(component)
+          return nil if component.captured_comment_list.length.zero? || !component.captured_comment_list.first.include?('// tailwind.config.js')
 
-          data.captured_comment_list.first.match(TAILWIND_CONFIG_REGEX)[:tailwind]
+          component.captured_comment_list.first.match(TAILWIND_CONFIG_REGEX)[:tailwind]
         end
 
-        def extract_source(data)
+        def extract_source(component)
           # In future I may be able to store the source in a comment in the HTML file
           # but at the moment all components are generally from TailwindUI and the source
           # URL can be inferred from the sub keys.
 
-          return "https://tailwindui.com/components/#{data.group.sub_keys.join('/')}" if data.design_system_name == 'tui'
+          return "https://tailwindui.com/components/#{component.group.sub_keys.join('/')}" if component.design_system.name == 'tui'
 
-          "##{data.design_system_name}/#{data.group.sub_keys.join('/')}"
+          "##{component.design_system.name}/#{component.group.sub_keys.join('/')}"
         end
 
         def tailwind_config_settings(raw_tailwind_config)

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

@@ -18,14 +18,14 @@ module TailwindDsl
           keyword_init: true
         )
 
-        ComponentGroup = Struct.new(
+        Group = Struct.new(
           :key,
           :type,
           :sub_keys,
           :folder,
           keyword_init: true
         )
-        ComponentInfo = Struct.new(
+        FilePath = Struct.new(
           :source_file,
           :target_html_file,
           :target_clean_html_file,
@@ -37,23 +37,28 @@ module TailwindDsl
 
         class Record
           attr_reader :design_system
-          attr_reader :component_group
-          attr_reader :absolute_component
-          attr_reader :relative_component
+          attr_reader :group
+          attr_reader :absolute_path
+          attr_reader :relative_path
 
-          def initialize(design_system:, component_group:, absolute_component:, relative_component:)
+          # Storage buckets for data that is extracted from the source file
+          attr_accessor :captured_comment_text
+          attr_accessor :captured_comment_list
+          attr_accessor :captured_tailwind_config
+
+          def initialize(design_system:, group:, absolute_path:, relative_path:)
             @design_system = design_system
-            @component_group = component_group
-            @absolute_component = absolute_component
-            @relative_component = relative_component
+            @group = group
+            @absolute_path = absolute_path
+            @relative_path = relative_path
           end
 
           def to_h
             {
               design_system: design_system.to_h,
-              component_group: component_group.to_h,
-              absolute_component: absolute_component.to_h,
-              relative_component: relative_component.to_h
+              group: group.to_h,
+              absolute_path: absolute_path.to_h,
+              relative_path: relative_path.to_h
             }
           end
         end
@@ -63,6 +68,7 @@ module TailwindDsl
         attr_reader :component_structure_root_path
         attr_reader :current_design_system
         attr_reader :debug
+        attr_reader :records
 
         def initialize(uikit, **args)
           @uikit = uikit
@@ -79,53 +85,52 @@ module TailwindDsl
         end
 
         def call
-          run_query
-          # puts JSON.pretty_generate(graph) if debug
-          # {
-          #   list: list.map(&:to_h)
-          # }
+          @records = build_records
+
           self
         end
 
         # Flattened list of records in hash format
         # @return [Array<Hash>] list
         def to_h
-          @list.map(&:to_h)
+          records.map(&:to_h)
         end
 
-        # Flattened list of records
-        #
-        # @return [Array<Record>] list
-        def records
-          @list
-        end
+        private
 
-        # Graph hierarchy is kept in deep nested format
-        #
-        # @return [Array<Hash>] graph
-        def graph
-          return @graph if defined? @graph
+        def build_records
+          uikit.design_systems.flat_map do |design_system|
+            @current_design_system = design_system
+            design_system.groups.flat_map do |group|
+              group.files.map do |file|
+                Record.new(
+                  design_system: DesignSystem.new(**map_design_system),
+                  group: Group.new(**map_group(group)),
+                  absolute_path: FilePath.new(**map_absolute_file(file)),
+                  relative_path: FilePath.new(**map_relative_file(file))
+                )
+              end
+            end
+          end
+        end
 
-          @graph = build_graph
+        def design_system_name
+          current_design_system.name
         end
 
-        private
+        def source_path
+          File.join(raw_component_root_path, design_system_name)
+        end
 
-        def build_graph
-          uikit.design_systems.map do |design_system|
-            @current_design_system = design_system
-            map_design_system
-          end
+        def target_path
+          File.join(component_structure_root_path, design_system_name)
         end
 
         def map_design_system
           {
-            name: current_design_system.name,
+            name: design_system_name,
             source_path: source_path,
-            target_path: target_path,
-            groups: current_design_system.groups.map do |group|
-              map_group(group)
-            end
+            target_path: target_path
           }
         end
 
@@ -134,63 +139,35 @@ module TailwindDsl
             key: group.key,
             type: group.type,
             sub_keys: group.sub_keys,
-            files: group.files.map do |file|
-              map_file(file)
-            end
+            folder: group.folder
           }
         end
 
-        # rubocop:disable Metrics/AbcSize
-        def map_file(file)
+        def map_relative_file(file)
           {
-            relative: {
-              source_file: file.file,
-              target_html_file: file.target.html_file,
-              target_clean_html_file: file.target.clean_html_file,
-              target_tailwind_config_file: file.target.tailwind_config_file,
-              target_settings_file: file.target.settings_file,
-              target_data_file: file.target.data_file,
-              target_astro_file: file.target.astro_file
-            },
-            absolute: {
-              source_file: File.join(source_path, file.file),
-              target_html_file: File.join(target_path, file.target.html_file),
-              target_clean_html_file: File.join(target_path, file.target.clean_html_file),
-              target_tailwind_config_file: File.join(target_path, file.target.tailwind_config_file),
-              target_settings_file: File.join(target_path, file.target.settings_file),
-              target_data_file: File.join(target_path, file.target.data_file),
-              target_astro_file: File.join(target_path, file.target.astro_file)
-            }
+            source_file: file.file,
+            target_html_file: file.target.html_file,
+            target_clean_html_file: file.target.clean_html_file,
+            target_tailwind_config_file: file.target.tailwind_config_file,
+            target_settings_file: file.target.settings_file,
+            target_data_file: file.target.data_file,
+            target_astro_file: file.target.astro_file
           }
         end
-        # rubocop:enable Metrics/AbcSize
-
-        def design_system_name
-          current_design_system.name
-        end
 
-        def source_path
-          File.join(raw_component_root_path, current_design_system.name)
-        end
-
-        def target_path
-          File.join(component_structure_root_path, current_design_system.name)
-        end
-
-        def run_query
-          @list = graph.flat_map do |design_system|
-            design_system[:groups].flat_map do |group|
-              group[:files].map do |file|
-                Record.new(
-                  design_system: DesignSystem.new(**design_system.slice(:name, :source_path, :target_path)),
-                  component_group: ComponentGroup.new(**group.slice(:key, :type, :sub_keys)),
-                  absolute_component: ComponentInfo.new(**file[:absolute]),
-                  relative_component: ComponentInfo.new(**file[:relative])
-                )
-              end
-            end
-          end
+        # rubocop:disable Metrics/AbcSize
+        def map_absolute_file(file)
+          {
+            source_file: File.join(source_path, file.file),
+            target_html_file: File.join(target_path, file.target.html_file),
+            target_clean_html_file: File.join(target_path, file.target.clean_html_file),
+            target_tailwind_config_file: File.join(target_path, file.target.tailwind_config_file),
+            target_settings_file: File.join(target_path, file.target.settings_file),
+            target_data_file: File.join(target_path, file.target.data_file),
+            target_astro_file: File.join(target_path, file.target.astro_file)
+          }
         end
+        # rubocop:enable Metrics/AbcSize
       end
     end
   end

data/lib/tailwind_dsl/version.rb

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

data/lib/tailwind_dsl.rb

@@ -15,7 +15,6 @@ require_relative 'tailwind_dsl/etl/raw_components/schema/group'
 require_relative 'tailwind_dsl/etl/raw_components/schema/design_system'
 require_relative 'tailwind_dsl/etl/raw_components/schema/uikit'
 
-require_relative 'tailwind_dsl/etl/component_structures/data'
 require_relative 'tailwind_dsl/etl/component_structures/raw_component_query'
 require_relative 'tailwind_dsl/etl/component_structures/generator'
 # require_relative 'tailwind_dsl/astro_demo/generate_astro_page_data'

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "tailwind_dsl",
-  "version": "0.0.11",
+  "version": "0.0.12",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "tailwind_dsl",
-      "version": "0.0.11",
+      "version": "0.0.12",
       "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.11",
+  "version": "0.0.12",
   "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.11
+  version: 0.0.12
 platform: ruby
 authors:
 - David Cruwys
@@ -2151,7 +2151,6 @@ files:
 - lib/_.rb
 - lib/tailwind_dsl.rb
 - lib/tailwind_dsl/astro_demo/generate_astro_page_data.rb
-- lib/tailwind_dsl/etl/component_structures/data.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

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

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-module TailwindDsl
-  module Etl
-    module ComponentStructures
-      # -----------------------------------------------------------------------------------------------
-      # Internal Data Structure
-      class Data
-        attr_reader :design_system_name
-        attr_reader :group                    # Component group information
-        attr_reader :source                   # Source file information for the component
-        attr_reader :target                   # Multiple target file information
-
-        # Storage buckets for data that is extracted from the source file
-        attr_accessor :captured_comment_text
-        attr_accessor :captured_comment_list
-        attr_accessor :captured_tailwind_config
-
-        # rubocop:disable Metrics/AbcSize
-        def initialize(design_system_name, group, file, root_raw_component_path)
-          @design_system_name = design_system_name
-
-          @captured_comment_text = ''
-          @captured_comment_list = []
-          @captured_tailwind_config = ''
-
-          @group = Group.new(key: group.key, type: group.type, sub_keys: group.sub_keys)
-          @source = Source.new(file: File.join(root_raw_component_path, design_system_name, file.file))
-          @target = Target.new(
-            folder: group.folder,
-            html_file: file.target.html_file,
-            clean_html_file: file.target.clean_html_file,
-            tailwind_config_file: file.target.tailwind_config_file,
-            settings_file: file.target.settings_file,
-            data_file: file.target.data_file,
-            astro_file: file.target.astro_file
-          )
-        end
-        # rubocop:enable Metrics/AbcSize
-
-        Group = Struct.new(:key, :type, :sub_keys, keyword_init: true)
-        Source = Struct.new(:file, keyword_init: true) do
-          def exist?
-            File.exist?(file)
-          end
-
-          def content
-            @content ||= File.exist?(file) ? File.read(file) : ''
-          end
-        end
-        Target = Struct.new(:folder, :html_file, :clean_html_file, :tailwind_config_file, :settings_file, :data_file, :astro_file, keyword_init: true)
-      end
-    end
-  end
-end