classy-yaml 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 268a5b342320d4be502ad562a4740625645394eba3d927b97c3bf2919b611a5a
+  data.tar.gz: 4db1bc8ffbffed59fd5c60741614ac7e294be7e975a1b85fda472d0ab2319634
+SHA512:
+  metadata.gz: b54b1fdb7ecaaccf4d9da488111ef2b40d54bf536d683667a7af12ad30bb3c5e0d372823612f41b6737f311be0fd231642fdfbd71c1331572649b67ce8a5f54c
+  data.tar.gz: d715ccf782b6c54ee93eb7acb1cb804428ae9b2fbcb646088c4c9ee41a3ba0aa2663938d22867f6e33c2ffa556758f0715885601ceee7f91260291aef7984210

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,97 @@
+# Classy::Yaml
+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).
+
+The YAML structure should follow this format:
+
+```
+btn:
+  blue: "text-blue-200 bg-blue-500"
+  yellow: "text-yellow-200 bg-blue-500"
+```
+
+Then, you can add these classes to any element by calling `yass(btn: :blue)` or `yass(btn: :yellow)`.
+
+You may wonder though, what about shared classes you want all nested definitions to inherit? There is a special syntax for this type of inheritance:
+
+```
+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)` or `yass(btn: :yellow)` will ALSO pull in the classes from `btn: :base`.
+
+
+### 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`.
+
+So, it may look like this
+
+```
+# config/utility_classes.yml
+btn:
+  base: "px-3 py-2"
+  blue: "text-blue-200 bg-blue-500"
+  yellow: "text-yellow-200 bg-blue-500"
+  
+  
+# app/components/example_component/example_component.yml
+btn:
+  purple: "text-purple-200 bg-blue-500"
+  
+
+# app/components/example_component/example_component.html.erb
+
+<button class="<%=sass(btn: :purple)%>">Classy Button</button>
+
+# 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:
+```
+# config/utility_classes.yml
+btn:
+  base: "px-3 py-2"
+  blue: "text-blue-200 bg-blue-500"
+  yellow: "text-yellow-200 bg-blue-500"
+  
+  
+# app/components/example_component/example_component.yml
+btn:
+  blue: "text-blue-50"
+  
+
+# app/components/example_component/example_component.html.erb
+
+<button class="<%=sass(btn: :purple)%>">Classy Button</button>
+
+# will add the classes "px-3 py-2 text-blue-50"
+```
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'classy-yaml'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install classy-yaml
+```
+
+## 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
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/classy/yaml/component_helpers.rb

@@ -0,0 +1,13 @@
+module Classy
+  module Yaml
+    module ComponentHelpers
+      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"
+
+        helpers.yass(args, classy_files: [classy_file] )
+      end
+    end
+  end
+end

data/lib/classy/yaml/engine.rb

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

data/lib/classy/yaml/helpers.rb

@@ -0,0 +1,84 @@
+module Classy
+  module Yaml
+    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_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)
+              file = YAML.load_file(file)
+              classy_yamls << file if file
+            end
+          end
+        end
+
+        return if classy_yamls.blank?
+
+        keys, classes = flatten_args(values: args)
+        classes += fetch_classes(keys, classy_yamls: classy_yamls)
+
+        return classes.flatten.join(" ")
+      end
+
+      private
+
+      def flatten_args(root: [], values: [], keys: [], added_classes: [])
+        values.each do|value|
+          if value.is_a?(Hash)
+            if value.has_key? :add
+              added_classes << value[:add]
+              value.except! :add
+            end
+
+            value.keys.each do |key|
+              values << (root + [key.to_s])
+              flatten_args(root: root + [key.to_s], values: [value[key]], keys: keys, added_classes: added_classes)
+            end
+          else
+            if value.is_a?(Array)
+              flatten_args(root: root, values: value, keys: keys, added_classes: added_classes)
+            else
+              keys << (root + [value.to_s])
+            end
+          end
+        end
+
+        return keys, added_classes
+      end
+
+      def fetch_classes(keys, classy_yamls: [])
+        classes = []
+
+        keys.map do |key|
+          base_classes = nil
+          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?
+          end
+
+          classes << base_classes
+          classes << fetched_classes
+        end
+
+        classes.reject!(&:blank?)
+        return classes.flatten.uniq
+      end
+
+    end
+  end
+end

data/lib/classy/yaml/version.rb

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

data/lib/classy/yaml.rb

@@ -0,0 +1,9 @@
+require "classy/yaml/version"
+require "classy/yaml/engine"
+
+module Classy
+  module Yaml
+    autoload :Helpers, "classy/yaml/helpers"
+    autoload :ComponentHelpers, "classy/yaml/component_helpers"
+  end
+end

data/lib/tasks/classy/yaml_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :classy_yaml do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: classy-yaml
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Tonksthebear
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.4
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.4
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.4.1
+description: Rails helper to allow yaml configuration of utility css classes
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/classy/yaml.rb
+- lib/classy/yaml/component_helpers.rb
+- lib/classy/yaml/engine.rb
+- lib/classy/yaml/helpers.rb
+- lib/classy/yaml/version.rb
+- lib/tasks/classy/yaml_tasks.rake
+homepage: https://github.com/Tonksthebear/classy-yaml
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Rails helper to allow yaml configuration of utility css classes
+test_files: []