tailwind_dsl 0.0.5 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9745acb28cff41075148e24922fe169e2f8c9ef67a6603db4059f3e0d5c34b1a
-  data.tar.gz: b2a85dacf9b08fd73250ffb54abcb103f5f7f79a1b92eabb357b11f60ce7ee8f
+  metadata.gz: 12b4cb1ead96f5fff7c3314de7a9c1cbf0acc4543749a16bd11ad1044f54c3bb
+  data.tar.gz: afc589fd9df719bf67b6ab61088dd65345d39b617af6a5924f0a07a027991661
 SHA512:
-  metadata.gz: 00e447a6f21e5115f68a23d534fc2ee83749cb331638b3c223f8908a1a3c5225c4c3c67caed92a71e24660dbc24a0c9696638364f3aeb2f10397503c742b4ef3
-  data.tar.gz: bc37080b72bd940dc5406ff4fa2f22421488c456e8d4c84a81d038e051227492862fa485c3b0681d297d041b21a3168f514f2295b05a8a8b0a0c55a8b500d76a
+  metadata.gz: a88b93f3410119b8af4521b75fea20af52dfa84bae7b617ca163cfd3a600eeb36ff534ae470b2a99db4307313815657f05426618b3fbf32c08ba2b3d21658761
+  data.tar.gz: b4bf2cc19b04b6ff284cfeba11c152921c869c989f53cb1efcca20aa2a3e71de84d08a544c7709512dd5bcd44a9d72c2e2470900d5e940c988dd58676654e403

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [0.0.6](https://github.com/klueless-io/tailwind_dsl/compare/v0.0.5...v0.0.6) (2022-10-12)
+
+
+### Bug Fixes
+
+* add tests for generating component structures ([1299d63](https://github.com/klueless-io/tailwind_dsl/commit/1299d6341c680a21c9fd2dbbcfd7422e5ceab443))
+
+## [0.0.5](https://github.com/klueless-io/tailwind_dsl/compare/v0.0.4...v0.0.5) (2022-10-12)
+
+
+### Bug Fixes
+
+* add support for generating component structures ([555f188](https://github.com/klueless-io/tailwind_dsl/commit/555f1880b104897e26d89518e1ac7263ff7be978))
+
 ## [0.0.4](https://github.com/klueless-io/tailwind_dsl/compare/v0.0.3...v0.0.4) (2022-10-12)
 
 

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

@@ -17,7 +17,7 @@ module TailwindDsl
         attr_accessor :captured_tailwind_config
 
         # rubocop:disable Metrics/AbcSize
-        def initialize(design_system_name, group, file)
+        def initialize(design_system_name, group, file, root_raw_component_path)
           @design_system_name = design_system_name
 
           @captured_comment_text = ''
@@ -25,7 +25,7 @@ module TailwindDsl
           @captured_tailwind_config = ''
 
           @group = Group.new(key: group.key, type: group.type, sub_keys: group.sub_keys)
-          @source = Source.new(file: file.absolute_file)
+          @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,

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

@@ -20,11 +20,13 @@ module TailwindDsl
 
         # .gsub(/(\n\s*\n)+/, "\n")
         attr_reader :uikit
+        attr_reader :root_raw_component_path
         attr_reader :root_target_path
         attr_reader :reset_root_path
 
-        def initialize(uikit, root_target_path, reset_root_path: false)
+        def initialize(uikit, root_raw_component_path, root_target_path, reset_root_path: false)
           @uikit = uikit
+          @root_raw_component_path = root_raw_component_path
           @root_target_path = root_target_path
           @reset_root_path = reset_root_path
         end
@@ -59,7 +61,7 @@ module TailwindDsl
         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)
+            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}"

data/lib/tailwind_dsl/etl/element.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module TailwindDsl
+  module Etl
+    # Base class for all ETL data objects that load/persist JSON data
+    class Element
+      # Get the value of an argument from a hash
+      #
+      # @param args [Hash] The hash of arguments
+      # @param key [String, Symbol] The key to look up
+      # @param guard [String] The error message to raise if the key is not found. Guards are optional.
+      # @param default [Object] The default value to return if the key is not found. Also optional, defaults to nil.
+      def grab_arg(args, key, guard: nil, default: nil)
+        value = args[key.to_sym] || args[key.to_s]
+
+        raise guard if value.nil? && guard
+
+        value || default
+      end
+    end
+  end
+end

data/lib/tailwind_dsl/etl/raw_components/schema/design_system.rb

@@ -6,19 +6,15 @@ module TailwindDsl
       # Design System
       #
       # DesignSystem represents a collection of Tailwind CSS components that follow a specific design system
-      class DesignSystem
+      class DesignSystem < TailwindDsl::Etl::Element
         attr_accessor :name
-        attr_accessor :path
         attr_accessor :stats
         attr_accessor :groups
 
-        def initialize(name:, path:, stats: {}, groups: [])
-          @name = name
-          @path = path
-          @stats = stats
-
-          @groups = []
-          groups.each { |group| add_group(group) }
+        def initialize(**args)
+          @name = grab_arg(args, :name, guard: 'Missing name')
+          @stats = grab_arg(args, :stats, default: {})
+          @groups = grab_arg(args, :groups, default: []).map { |group| convert_group(group) }.compact
         end
 
         def add_group(group)
@@ -34,7 +30,6 @@ module TailwindDsl
         def to_h
           {
             name: name,
-            path: path,
             stats: stats,
             groups: groups.map(&:to_h)
           }
@@ -46,7 +41,7 @@ module TailwindDsl
           return nil if group.nil?
 
           return group if group.is_a?(Group)
-          return Group.new(group) if group.is_a?(Hash)
+          return Group.new(**group) if group.is_a?(Hash)
 
           puts "Unknown group type: #{group.class}"
           nil

data/lib/tailwind_dsl/etl/raw_components/schema/group.rb

@@ -6,21 +6,20 @@ module TailwindDsl
       # Group
       #
       # Group represents a collection of Tailwind CSS components withing a named group or category
-      class Group
+      class Group < TailwindDsl::Etl::Element
         attr_accessor :key
         attr_accessor :type
         attr_accessor :folder
         attr_accessor :sub_keys
         attr_accessor :files
 
-        def initialize(key:, type:, folder:, sub_keys:, files: [])
-          @key = key
-          @type = type
-          @folder = folder
-          @sub_keys = sub_keys
+        def initialize(**args)
+          @key  = grab_arg(args, :key, guard: 'Missing key')
+          @type = grab_arg(args, :type, guard: 'Missing type')
+          @folder = grab_arg(args, :folder, guard: 'Missing folder')
+          @sub_keys = grab_arg(args, :sub_keys, guard: 'Missing sub_keys')
 
-          @files = []
-          files.each { |file| add_file(file) }
+          @files = grab_arg(args, :files, default: []).map { |file| convert_file(file) }.compact
         end
 
         def add_file(file)
@@ -49,7 +48,7 @@ module TailwindDsl
           return nil if file.nil?
 
           return file if file.is_a?(SourceFile)
-          return SourceFile.new(file) if file.is_a?(Hash)
+          return SourceFile.new(**file) if file.is_a?(Hash)
 
           puts "Unknown file type: #{file.class}"
           nil

data/lib/tailwind_dsl/etl/raw_components/schema/source_file.rb

@@ -6,31 +6,26 @@ module TailwindDsl
       # Source File
       #
       # SourceFile represents a list of source files that contain raw Tailwind CSS components
-      class SourceFile
+      class SourceFile < TailwindDsl::Etl::Element
         attr_accessor :name
         attr_accessor :file_name
         attr_accessor :file_name_only
-        attr_accessor :absolute_file
         attr_accessor :file
         attr_accessor :target
 
-        # rubocop:disable Metrics/ParameterLists
-        def initialize(name:, file_name:, file_name_only:, absolute_file:, file:, target: nil)
-          @name = name
-          @file_name = file_name
-          @file_name_only = file_name_only
-          @absolute_file = absolute_file
-          @file = file
-          @target = convert_target(target)
+        def initialize(**args)
+          @name = grab_arg(args, :name, guard: 'Missing name')
+          @file_name = grab_arg(args, :file_name, guard: 'Missing file_name')
+          @file_name_only = grab_arg(args, :file_name_only, guard: 'Missing file_name_only')
+          @file = grab_arg(args, :file, guard: 'Missing file')
+          @target = convert_target(grab_arg(args, :target))
         end
-        # rubocop:enable Metrics/ParameterLists
 
         def to_h
           result = {
             name: name,
             file_name: file_name,
             file_name_only: file_name_only,
-            absolute_file: absolute_file,
             file: file
           }
           result[:target] = target.to_h if target
@@ -46,7 +41,7 @@ module TailwindDsl
           when TargetFile
             target
           when Hash
-            TargetFile.new(target)
+            TargetFile.new(**target)
           else
             raise "Unknown target type: #{target.class}"
           end

data/lib/tailwind_dsl/etl/raw_components/schema/target_file.rb

@@ -6,7 +6,7 @@ module TailwindDsl
       # Target File
       #
       # TargetFile represents each sub_file that can be built from a source file, such as HTML Component, Tailwind Config, Settings and Data Structure
-      class TargetFile
+      class TargetFile < TailwindDsl::Etl::Element
         attr_accessor :html_file
         attr_accessor :clean_html_file
         attr_accessor :tailwind_config_file
@@ -14,16 +14,14 @@ module TailwindDsl
         attr_accessor :data_file
         attr_accessor :astro_file
 
-        # rubocop:disable Metrics/ParameterLists
-        def initialize(html_file:, clean_html_file:, tailwind_config_file:, settings_file:, data_file:, astro_file:)
-          @html_file = html_file
-          @clean_html_file = clean_html_file
-          @tailwind_config_file = tailwind_config_file
-          @settings_file = settings_file
-          @data_file = data_file
-          @astro_file = astro_file
+        def initialize(**args)
+          @html_file = grab_arg(args, :html_file, guard: 'Missing html_file')
+          @clean_html_file = grab_arg(args, :clean_html_file, guard: 'Missing clean_html_file')
+          @tailwind_config_file = grab_arg(args, :tailwind_config_file, guard: 'Missing tailwind_config_file')
+          @settings_file = grab_arg(args, :settings_file, guard: 'Missing settings_file')
+          @data_file = grab_arg(args, :data_file, guard: 'Missing data_file')
+          @astro_file = grab_arg(args, :astro_file, guard: 'Missing astro_file')
         end
-        # rubocop:enable Metrics/ParameterLists
 
         def to_h
           {

data/lib/tailwind_dsl/etl/raw_components/schema/uikit.rb

@@ -54,7 +54,7 @@ module TailwindDsl
           return nil if design_system.nil?
 
           return design_system if design_system.is_a?(DesignSystem)
-          return DesignSystem.new(design_system) if design_system.is_a?(Hash)
+          return DesignSystem.new(**design_system) if design_system.is_a?(Hash)
 
           puts "Unknown design_system type: #{design_system.class}"
           nil

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

@@ -5,6 +5,7 @@ module TailwindDsl
     module RawComponents
       # The component reader will read the raw component files for each UI Kit.
       class Transformer
+        attr_reader :path
         attr_reader :design_system
 
         attr_reader :group_lookup
@@ -12,10 +13,10 @@ module TailwindDsl
 
         def call(name, path)
           @design_system = ::TailwindDsl::Etl::RawComponents::DesignSystem.new(
-            name: name,
-            path: path
+            name: name
           )
 
+          @path = path
           @group_lookup = {}
 
           process_files
@@ -30,7 +31,7 @@ module TailwindDsl
         private
 
         def process_files
-          glob = File.join(design_system.path, '**', '*')
+          glob = File.join(path, '**', '*')
 
           Dir.glob(glob) do |entry|
             next if reject?(entry)
@@ -44,7 +45,7 @@ module TailwindDsl
         # rubocop:disable Metrics/AbcSize
         def assign_group(entry)
           target_path = File.directory?(entry) ? entry : File.dirname(entry)
-          relative_folder = Pathname.new(target_path).relative_path_from(Pathname.new(design_system.path)).to_s
+          relative_folder = Pathname.new(target_path).relative_path_from(Pathname.new(path)).to_s
 
           group_key = relative_folder == '.' ? '@' :  relative_folder.split('/').map { |part| snake.call(part) }.join('.')
 
@@ -90,11 +91,11 @@ module TailwindDsl
         end
 
         def source_file(entry, folder, target)
+          # absolute_file: entry,
           ::TailwindDsl::Etl::RawComponents::SourceFile.new(
             name: File.basename(entry),
             file_name: File.basename(entry),
             file_name_only: File.basename(entry, File.extname(entry)),
-            absolute_file: entry,
             file: File.join(folder, File.basename(entry)),
             target: target
           )

data/lib/tailwind_dsl/version.rb

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

data/lib/tailwind_dsl.rb

@@ -7,6 +7,8 @@ require_relative 'tailwind_dsl/version'
 
 require_relative 'tailwind_dsl/etl/raw_components/director'
 require_relative 'tailwind_dsl/etl/raw_components/transformer'
+
+require_relative 'tailwind_dsl/etl/element'
 require_relative 'tailwind_dsl/etl/raw_components/schema/target_file'
 require_relative 'tailwind_dsl/etl/raw_components/schema/source_file'
 require_relative 'tailwind_dsl/etl/raw_components/schema/group'

data/package-lock.json

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tailwind_dsl
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.7
 platform: ruby
 authors:
 - David Cruwys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-12 00:00:00.000000000 Z
+date: 2022-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cmdlet
@@ -2201,6 +2201,7 @@ files:
 - 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/element.rb
 - lib/tailwind_dsl/etl/raw_components/director.rb
 - lib/tailwind_dsl/etl/raw_components/schema/design_system.rb
 - lib/tailwind_dsl/etl/raw_components/schema/group.rb