utility_classes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fc3a27fdd8eb9c65a9c7aaa296f0aba4b3ddb93a2333a12fcd063b61d896a546
+  data.tar.gz: 3c19c85e940ae919c5c939c5b92ca5bcb2c64801b1cf62dd9c643b9a5f5aff41
+SHA512:
+  metadata.gz: 4db6adf30d9895e3fc28170aa760a891dc7515d7ffa6f519df2ca557df87d763bbccbaef8ec77838998bfd49f150cde016e2d3aeb1a2c8a5109a05960dd6e3da
+  data.tar.gz: f0efac2fac26eae4bdfefe097f32f0cbf25a4f8d4215df9e5e888bc5b56f5b4fc5b2faa2e2b6e1a4574663251fd46fc380e6fc17291f0ac019d8c853e0008558

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Dick Davis
+
+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,77 @@
+# UtilityClasses
+
+Rails gem that facilitates the use of utility CSS frameworks.
+
+This project was inspired by the [classy-yaml](https://github.com/Tonksthebear/classy-yaml) project.
+
+## Usage
+
+You can easily define a base class list for a given type:
+
+`config/utility_classes.yml`
+```yaml
+heading:
+  base: 'text-lg font-semibold text-center'
+```
+
+And then retrieve the class list in your code:
+
+```ruby
+UtilityClasses.for(:heading)
+```
+
+You can optionally define variants for each type:
+
+`config/utility_classes.yml`
+```yaml
+heading:
+  base: 'text-lg font-semibold text-center'
+  variants:
+    grande: 'text-4xl'
+```
+
+And then retrieve the class list by passing the variant key:
+
+```ruby
+UtilityClasses.for(:heading, variant: :grande)
+```
+
+The returned string will contain the base classes with the variant classes appended.
+
+The `config/utility_classes.yml` file will be loaded into memory the first time it is called and only be reloaded if changes are made to the file.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'utility_classes'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install utility_classes
+```
+
+Run the install generator to create a config file (`config/utility_classes.yml`):
+
+```bash
+$ bin/rails generate utility_classes:install
+```
+
+Add your classes to the generated config file following the structure of the examples.
+
+## Contributing
+
+Contributions are welcome. Feel free to open a PR.
+
+## 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,12 @@
+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/generators/utility_classes/install_generator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module UtilityClasses
+  module Generators
+    ##
+    # Creates basic installation files for UtilityClasses
+    class InstallGenerator < Rails::Generators::Base
+      desc 'Create basic installation files for UtilityClasses'
+      source_root File.expand_path('templates', __dir__)
+
+      def copy_config_file
+        copy_file 'utility_classes.yml', 'config/utility_classes.yml'
+      end
+    end
+  end
+end

data/lib/generators/utility_classes/templates/utility_classes.yml

@@ -0,0 +1,20 @@
+# The structure of the config file for utility_classes should follow the following pattern:
+#
+# ELEMENT:
+#   base: BASE STYLES HERE
+#   variants:
+#     NAMED VARIANTS HERE
+#
+# For example:
+#
+# btn:
+#   base: 'appearance-none cursor-pointer inline-block text-lg font-semibold text-center align-middle no-underline select-none transition-colors border-2 border-solid rounded-md px-4 py-3 focus:outline-none disabled:cursor-not-allowed disabled:opacity-50'
+#   variants:
+#     solid_blue: 'bg-blue-500 text-white border-blue-500 hover:bg-blue-700'
+#     outline_blue: 'bg-transparent text-blue-500 border-blue-500 hover:bg-blue-500 hover:text-white'
+#
+# You do not need to add variants if the element does not require it. For example, this is valid:
+#
+# btn:
+#   base: 'appearance-none cursor-pointer inline-block text-lg font-semibold text-center align-middle no-underline select-none transition-colors border-2 border-solid rounded-md px-4 py-3 focus:outline-none disabled:cursor-not-allowed disabled:opacity-50'
+#

data/lib/tasks/utility_classes_tasks.rake

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

data/lib/utility_classes/exceptions/type_key_not_found.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module UtilityClasses
+  module Exceptions
+    ##
+    # Exception thrown when type key is not found in config.
+    class TypeKeyNotFound < StandardError
+      attr_reader :type_key
+
+      def initialize(type_key:)
+        @type_key = type_key
+        super("Type key #{type_key} not found in config")
+      end
+    end
+  end
+end

data/lib/utility_classes/exceptions/variant_key_not_found.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module UtilityClasses
+  module Exceptions
+    ##
+    # Exception thrown when variant key is not found in config.
+    class VariantKeyNotFound < StandardError
+      attr_reader :variant_key
+
+      def initialize(variant_key:)
+        @variant_key = variant_key
+        super("Variant key #{variant_key} not found in config")
+      end
+    end
+  end
+end

data/lib/utility_classes/railtie.rb

@@ -0,0 +1,4 @@
+module UtilityClasses
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/utility_classes/utility_class_reader.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+require_relative 'exceptions/type_key_not_found'
+require_relative 'exceptions/variant_key_not_found'
+
+module UtilityClasses
+  ##
+  # Provides access to utility classes stored in config
+  class UtilityClassReader
+    def initialize
+      @styles = data_from_config
+      @last_updated = File.ctime(config_file)
+    end
+
+    def for(type, variant: nil)
+      reload_config! if config_changed?
+
+      classes = styles.dig(type, :base)
+      raise UtilityClasses::Exceptions::TypeKeyNotFound.new(type_key: type) unless classes
+
+      if variant
+        variant_classes = styles.dig(type, :variants, variant)
+        raise UtilityClasses::Exceptions::VariantKeyNotFound.new(variant_key: variant) unless variant_classes
+      end
+
+      variant_classes ? "#{classes} #{variant_classes}" : classes
+    end
+
+    private
+
+    attr_reader :styles, :last_updated
+
+    def data_from_config
+      YAML.safe_load(File.read(config_file)).deep_symbolize_keys
+    end
+
+    def config_file
+      Rails.root.join('config/utility_classes.yml')
+    end
+
+    def reload_config!
+      @styles = data_from_config
+      @last_updated = File.ctime(config_file)
+    end
+
+    def config_changed?
+      return false unless Rails.env.development?
+
+      last_updated != File.ctime(config_file)
+    end
+  end
+end

data/lib/utility_classes/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module UtilityClasses
+  VERSION = '0.1.0'
+end

data/lib/utility_classes.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'rails'
+require 'active_support/dependencies'
+require 'utility_classes/version'
+require 'utility_classes/railtie'
+
+##
+# Namespace for UtilityClasses gem
+module UtilityClasses
+  autoload :UtilityClassReader, 'utility_classes/utility_class_reader'
+  autoload :TypeKeyNotFound, 'utility_classes/exceptions/type_key_not_found'
+  autoload :VariantKeyNotFound, 'utility_classes/exceptions/variant_key_not_found'
+
+  mattr_accessor :reader
+  def self.reader
+    @reader ||= UtilityClassReader.new
+  end
+
+  def self.for(type, variant: nil)
+    reader.for(type, variant: variant)
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: utility_classes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dick Davis
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-12-05 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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+description: Rails gem that facilitates the use of utility CSS frameworks.
+email:
+- dick@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/generators/utility_classes/install_generator.rb
+- lib/generators/utility_classes/templates/utility_classes.yml
+- lib/tasks/utility_classes_tasks.rake
+- lib/utility_classes.rb
+- lib/utility_classes/exceptions/type_key_not_found.rb
+- lib/utility_classes/exceptions/variant_key_not_found.rb
+- lib/utility_classes/railtie.rb
+- lib/utility_classes/utility_class_reader.rb
+- lib/utility_classes/version.rb
+homepage: https://github.com/d3d1rty/utility_classes
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/d3d1rty/utility_classes
+  source_code_uri: https://github.com/d3d1rty/utility_classes
+  changelog_uri: https://github.com/d3d1rty/utility_classes
+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.2.15
+signing_key:
+specification_version: 4
+summary: Rails gem that facilitates the use of utility CSS frameworks.
+test_files: []