classy-yaml 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 268a5b342320d4be502ad562a4740625645394eba3d927b97c3bf2919b611a5a
-  data.tar.gz: 4db1bc8ffbffed59fd5c60741614ac7e294be7e975a1b85fda472d0ab2319634
+  metadata.gz: e550c3f72e3974d27db9f90ce7ff91b76e717373fd3965e2e3621442b7cbbd16
+  data.tar.gz: 4bb718adfce915e86a357e91c8497de69a08e7e79ad6b14169d8f81ad0bcea4e
 SHA512:
-  metadata.gz: b54b1fdb7ecaaccf4d9da488111ef2b40d54bf536d683667a7af12ad30bb3c5e0d372823612f41b6737f311be0fd231642fdfbd71c1331572649b67ce8a5f54c
-  data.tar.gz: d715ccf782b6c54ee93eb7acb1cb804428ae9b2fbcb646088c4c9ee41a3ba0aa2663938d22867f6e33c2ffa556758f0715885601ceee7f91260291aef7984210
+  metadata.gz: ae98344136a170b10ffc6c507518832d60583d0e7555cf536333998270ad04e6be83b82d3b555969271787bfebb71eb21988fe2b5a48c6924bd80725fd7f8167
+  data.tar.gz: 9277260199b1d3b84b13739f72b28ae1f4d93bb2c45b7e3fe330ed4fcffe15fac9ca9f6b338b4953ac259b464735e7f13e18b0a929b5a0668ab83714448ca57a

data/README.md

@@ -2,7 +2,7 @@
 This was created to provide convenient utility class grouping for environments without a bundler (or any situation where you might not want to add custom css classes). YAML files are a perfect structure for these situations.
 
 ## Usage
-After installing the gem, the helper method `yass` will be available from anywhere. It look for the definitions in the yaml file `config/utility_classes.yml` (note: you must add this yourself).
+After installing the gem, the helper method `yass` will be available from anywhere. It looks for the definitions in the YAML file `config/utility_classes.yml` (note: you must add this yourself).
 
 The YAML structure should follow this format:
 
@@ -51,7 +51,8 @@ btn:
 # will add the classes "px-3 py-2 text-purple-200 bg-blue-500"
 ```
 
-As you can see, this will merge definitions found in the ExampleComponent's sidecar asset with the main application's definitions. Not only will it merge, but it will overwrite them as well, allowing for true customization on a per-component basis:
+As you can see, this will merge definitions found in the `ExampleComponent`'s sidecar asset with the main application's definitions. Not only will it merge, but it will overwrite them as well, allowing for true customization on a per-component basis:
+
 ```
 # config/utility_classes.yml
 btn:
@@ -72,7 +73,6 @@ btn:
 # will add the classes "px-3 py-2 text-blue-50"
 ```
 
-
 ## Installation
 Add this line to your application's Gemfile:
 
@@ -90,8 +90,15 @@ Or install it yourself as:
 $ gem install classy-yaml
 ```
 
+If using purging for styles, be sure to add the YAML files to the purge directories. For example, below is a tailwind.config.js:
+```
+purge: [
+   "./config/utility_classes.yml",
+   "./app/components/**/*.yml" // If using view component sidecar assets
+]
+```
 ## 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 enought 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

@@ -4,8 +4,11 @@ module Classy
       def yass(*args)
         component_name = caller.first.split("/").last.split(".").first
         calling_path = caller.first.split("/")[0...-1].join("/")
-        classy_file = calling_path + "/" + component_name + ".yml"
-
+        classy_file = if Dir.exist?("#{calling_path}/#{component_name}")
+                        "#{calling_path}/#{component_name}/#{component_name}.yml"
+                      else
+                        "#{calling_path}/#{component_name}.yml"
+                      end
         helpers.yass(args, classy_files: [classy_file] )
       end
     end

data/lib/classy/yaml/engine.rb

@@ -1,7 +1,8 @@
+require "rails"
+
 module Classy
   module Yaml
-    class Engine < ::Rails::Engine
-      paths["lib/classy/yaml"]
+    class Engine < Rails::Railtie
       config.to_prepare do
         ApplicationController.helper(Classy::Yaml::Helpers)
       end

data/lib/classy/yaml/helpers.rb

@@ -3,12 +3,12 @@ module Classy
     module Helpers
       def yass(*args)
         classy_yamls = []
-        classy_yamls << YAML.load_file(Rails.root.join("config/utility_classes.yml")) if File.exists?(Rails.root.join("config/utility_classes.yml"))
+        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.exists?(file) && YAML.load_file(file)
+            if File.exist?(file) && YAML.load_file(file)
               file = YAML.load_file(file)
               classy_yamls << file if file
             end
@@ -57,18 +57,26 @@ module Classy
           fetched_classes = nil
 
           classy_yamls.reverse_each do |classy_yaml|
-            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
-
-            fetched_classes ||= unless classy_yaml.send(:dig, *key).is_a?(Hash)
-                                  classy_yaml.send(:dig, *key).try(:split, " ")
-                                end
-
-            base_classes = nil if base_classes.blank?
-            fetched_classes = nil if fetched_classes.blank?
+            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)
+            end
+
+            begin
+              fetched_classes ||= unless classy_yaml.send(:dig, *key).is_a?(Hash)
+                                    classy_yaml.send(:dig, *key).try(:split, " ")
+                                  end
+
+              base_classes = nil if base_classes.blank?
+              fetched_classes = nil if fetched_classes.blank?
+            rescue
+              raise Classy::Yaml::InvalidKeyError.new(data: key)
+            end
           end
 
           classes << base_classes

data/lib/classy/yaml/invalid_key_error.rb

@@ -0,0 +1,13 @@
+module Classy
+  module Yaml
+    class InvalidKeyError < StandardError
+      def initialize(data)
+        @data = data
+      end
+
+      def message
+        "yass called with invalid keys: #{@data}. This error can be raised when calling nested keys on an un-nested root."
+      end
+    end
+  end
+end

data/lib/classy/yaml/version.rb

@@ -1,5 +1,5 @@
 module Classy
   module Yaml
-    VERSION = '0.5.0'
+    VERSION = '0.7.0'
   end
 end

data/lib/classy/yaml.rb

@@ -5,5 +5,6 @@ module Classy
   module Yaml
     autoload :Helpers, "classy/yaml/helpers"
     autoload :ComponentHelpers, "classy/yaml/component_helpers"
+    autoload :InvalidKeyError, "classy/yaml/invalid_key_error"
   end
 end

metadata

@@ -1,35 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: classy-yaml
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Tonksthebear
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-11 00:00:00.000000000 Z
+date: 2021-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.4
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.4.1
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: view_component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.4
+        version: '3.36'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.4.1
+        version: '3.36'
 description: Rails helper to allow yaml configuration of utility css classes
 email:
 - ''
@@ -44,6 +94,7 @@ files:
 - lib/classy/yaml/component_helpers.rb
 - lib/classy/yaml/engine.rb
 - lib/classy/yaml/helpers.rb
+- lib/classy/yaml/invalid_key_error.rb
 - lib/classy/yaml/version.rb
 - lib/tasks/classy/yaml_tasks.rake
 homepage: https://github.com/Tonksthebear/classy-yaml