classy-yaml 0.8.5 → 1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a317b7d0d4d98ba75bede21873cab424ae0238336fbd61a3425240d9972824a
-  data.tar.gz: e42bba9cb118a3805da435e1737bad5000ca1b181104eb5ddfabc194f7472ebd
+  metadata.gz: 18499d16c6513652c6424bf8ff1cf2ec887b26a50a28f1d1a16b317f74a63ce4
+  data.tar.gz: ee602d76c693f54041c07548c5634760c9ccba8c74746177d7d22207148a590f
 SHA512:
-  metadata.gz: 3dce1e8ae1e7174381890149634d25b820f46d786451cc128437a8b5e960bc6f5729d9b38de6ad7ceb712494dee3237d04d3b5658b27730c9110de0608dbea26
-  data.tar.gz: 15740e73a3143adc07ef903f7dfebf31e3bb20ef89b621776f207b1e9afa5874b314be84dc8df1ebf90f48fb9a7603ac956cf8c02f0327ee399711e73557c45a
+  metadata.gz: 16aa91f99106e901e9561f5e1d41a454999dfaefdeac7557becbc6d1ecf32cec6a6d306c2904b8981b2efbb75e7ca2bfd74af4b96521a37a3ae5ae9b0ece8fbb
+  data.tar.gz: 8696d46b02167e605ecaa5d74117f51dae9563595f9b87c94cf5f856b39bb979df19d5414e9e36924b99ba45bb4579d51741d02d9fab159fdd5595c6e2852236

data/README.md

@@ -25,6 +25,19 @@ btn:
 
 Now, calling `yass(btn: :blue)` or `yass(btn: :yellow)` will ALSO pull in the classes from `btn: :base`.
 
+### Optionally Skipping Base
+
+You can optionally skip including the base on a `yass` call by including the key/value `skip_base: true`. So, using the example above,
+we can perform:
+```
+btn:
+  base: "px-3 py-2"
+  blue: "text-blue-200 bg-blue-500"
+  yellow: "text-yellow-200 bg-blue-500"
+```
+
+Now, calling `yass(btn: :blue, skip_base: true)` and this will skip pulling in the classes from `btn: :base`. This is helpful
+when defining animation classes and you only want to include the different classes, such as `active` and `inactive` for instance.
 
 ### ViewComponent
 There is a special helper built for ViewComponent and sidecar assets. In your `example_component.rb`, add the line `include Classy::Yaml::ComponentHelpers`. This helper will tell `yass` to check if there is a `example_component.yml` file, and first use that for definitions. If the definitions aren't found in the `example_component.yml`, then it will fallback to `config/utility_classes.yml`.
@@ -72,6 +85,20 @@ btn:
 
 # will add the classes "px-3 py-2 text-blue-50"
 ```
+## Configuration
+You can configure the gem by creating an initializer in your Rails app. The following options are available:
+
+```ruby
+Classy::Yaml.setup do |config|
+  # The default path for the utility classes YAML file 
+  config.default_path = "config/utility_classes.yml"
+  
+  # Any extra files you want to load in addition to the default file. The last file loaded will overwrite any previous definitions
+  config.extra_files = [
+    "app/yamls/extra_styles.yml"
+  ]
+end
+```
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -98,7 +125,7 @@ purge: [
 ]
 ```
 ## Contributing
-This is my first attempt at an actual gem usable for all. Any and all suggestions are absolutely welcome. I'm not the cleanest programmer, so code quality suggestions are welcome too 👍 I extracted this logic from my private work and I felt it was useful enought to be worth publishing.
+This is my first attempt at an actual gem usable for all. Any and all suggestions are absolutely welcome. I'm not the cleanest programmer, so code quality suggestions are welcome too 👍 I extracted this logic from my private work and I felt it was useful enough to be worth publishing.
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/classy/yaml/component_helpers.rb

@@ -6,12 +6,12 @@ module Classy
         calling_file = self.class.source_location.split("/").last.split(".").first
         component_name = self.class.name.underscore.split("/").last.split(".").first
 
-        classy_file = if Dir.exist?("#{calling_path}/#{calling_file}")
-                        "#{calling_path}/#{calling_file}/#{component_name}.yml"
-                      else
-                        "#{calling_path}/#{component_name}.yml"
-                      end
-        helpers.yass(args, classy_files: [classy_file] )
+        classy_files = ["#{calling_path}/#{component_name}.yml",
+                       "#{calling_path}/#{calling_file}/#{calling_file}.yml",
+                       "#{calling_path}/#{calling_file}/#{component_name}.yml"
+        ]
+
+        helpers.yass(args, classy_files: classy_files.uniq)
       end
     end
   end

data/lib/classy/yaml/helpers.rb

@@ -3,22 +3,22 @@ module Classy
     module Helpers
       def yass(*args)
         classy_yamls = []
-        classy_yamls << YAML.load_file(Rails.root.join("config/utility_classes.yml")) if File.exist?(Rails.root.join("config/utility_classes.yml"))
-
-        classy_files_hash = args.find { |arg| arg.is_a?(Hash) && arg.keys.include?(:classy_files) }
-        if classy_files_hash.present?
-          classy_files_hash[:classy_files].each do |file|
-            if File.exist?(file) && YAML.load_file(file)
-              file = YAML.load_file(file)
-              classy_yamls << file if file
-            end
+        classy_yamls << YAML.load_file(Rails.root.join(Classy::Yaml.default_file)) if File.exist?(Rails.root.join(Classy::Yaml.default_file))
+
+        classy_files_hash = args.find { |arg| arg.is_a?(Hash) && arg.keys.include?(:classy_files) } || { classy_files: [] }
+
+        (classy_files_hash[:classy_files] + Classy::Yaml.extra_files).each do |file|
+          if File.exist?(file) && YAML.load_file(file)
+            file = YAML.load_file(file)
+            classy_yamls << file if file
           end
         end
 
         return if classy_yamls.blank?
 
+        skip_base_hash = args.find { |arg| arg.is_a?(Hash) && arg.keys.include?(:skip_base) } || {}
         keys, classes = flatten_args(values: args)
-        classes += fetch_classes(keys, classy_yamls: classy_yamls)
+        classes += fetch_classes(keys, classy_yamls: classy_yamls, skip_base: skip_base_hash[:skip_base])
 
         return classes.flatten.join(" ")
       end
@@ -26,7 +26,7 @@ module Classy
       private
 
       def flatten_args(root: [], values: [], keys: [], added_classes: [])
-        values.each do|value|
+        values.each do |value|
           if value.is_a?(Hash)
             if value.has_key? :add
               added_classes << value[:add]
@@ -49,7 +49,7 @@ module Classy
         return keys, added_classes
       end
 
-      def fetch_classes(keys, classy_yamls: [])
+      def fetch_classes(keys, classy_yamls: [], skip_base: false)
         classes = []
 
         keys.map do |key|
@@ -57,14 +57,16 @@ module Classy
           fetched_classes = nil
 
           classy_yamls.reverse_each do |classy_yaml|
-            begin
-              base_classes ||= if classy_yaml.send(:dig, *key).is_a?(Hash)
-                                 classy_yaml.send(:dig, *(key + ['base'])).try(:split, " ")
-                               else
-                                 classy_yaml.send(:dig, *(key[0...-1] + ['base'])).try(:split, " ")
-                               end
-            rescue
-              raise Classy::Yaml::InvalidKeyError.new(data: key)
+            unless skip_base == true
+              begin
+                base_classes ||= if classy_yaml.send(:dig, *key).is_a?(Hash)
+                                   classy_yaml.send(:dig, *(key + ['base'])).try(:split, " ")
+                                 else
+                                   classy_yaml.send(:dig, *(key[0...-1] + ['base'])).try(:split, " ")
+                                 end
+              rescue
+                Rails.logger.warn(Classy::Yaml::InvalidKeyError.new(data: key))
+              end
             end
 
             begin
@@ -75,12 +77,12 @@ module Classy
               base_classes = nil if base_classes.blank?
               fetched_classes = nil if fetched_classes.blank?
             rescue
-              raise Classy::Yaml::InvalidKeyError.new(data: key)
+              Rails.logger.warn(Classy::Yaml::InvalidKeyError.new(data: key))
             end
           end
 
-          classes << base_classes
-          classes << fetched_classes
+          classes << base_classes unless base_classes.blank?
+          classes << fetched_classes unless fetched_classes.blank?
         end
 
         classes.reject!(&:blank?)

data/lib/classy/yaml/version.rb

@@ -1,5 +1,5 @@
 module Classy
   module Yaml
-    VERSION = '0.8.5'
+    VERSION = '1.2'
   end
 end

data/lib/classy/yaml.rb

@@ -3,8 +3,22 @@ require "classy/yaml/engine"
 
 module Classy
   module Yaml
+    mattr_accessor :default_file
+    @@default_file = "config/utility_classes.yml"
+
+    mattr_accessor :extra_files
+    @@extra_files = []
+
     autoload :Helpers, "classy/yaml/helpers"
     autoload :ComponentHelpers, "classy/yaml/component_helpers"
     autoload :InvalidKeyError, "classy/yaml/invalid_key_error"
+
+    def self.extra_files=(value)
+      @@extra_files = Array.wrap(value).reject(&:blank?).map { |file| Rails.root.join(file) }
+    end
+
+    def self.setup
+      yield self
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: classy-yaml
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: '1.2'
 platform: ruby
 authors:
 - Tonksthebear
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-29 00:00:00.000000000 Z
+date: 2024-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -105,7 +105,7 @@ metadata:
   homepage_uri: https://github.com/Tonksthebear/classy-yaml
   source_code_uri: https://github.com/Tonksthebear/classy-yaml
   changelog_uri: https://github.com/Tonksthebear/classy-yaml/releases
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -120,8 +120,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.26
-signing_key: 
+rubygems_version: 3.4.1
+signing_key:
 specification_version: 4
 summary: Rails helper to allow yaml configuration of utility css classes
 test_files: []