utility_classes 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebf11e0859fc84f7928583f086575ea80626453438a19ef1740e6fcbb36c8a53
-  data.tar.gz: 544c439e27d9f85b30e2e9228ec3764035f7bed0e7029aa06e4240b8e1f05135
+  metadata.gz: 9a6e5099e722349306f58dae45a7e1d694eb964a4328d2c9f58b59c1c92144c9
+  data.tar.gz: 04f373b712af10ce1b282941b89b7eca1206056a6a9dd7049e3440cb2dacd8ae
 SHA512:
-  metadata.gz: 78c0d296405a00af4cdb1624bf24ca972e7e384a156a9fa275e31213b68ed6f4647b3c87d1057a63f84eb84cca9ff42556a14f697915a32e07f40ef98e625311
-  data.tar.gz: 966fcf3ea287899bd494ae167b613dd0d222daedef433aae17747e3983ee5e567f95d40bd97c225b0ed988874b707c1587ad9bb8960d6a717d393022da8806a7
+  metadata.gz: 1e6904b5733c4350794a9200385548af755477a72acc274c71c92cb7a1ffa0ebab08de9f152a5b52859ad43c331d05446bb7cabe4fe8bc4f2b0ab9f5297fa09a
+  data.tar.gz: e8d37d19dda559a73e38736f6333e0b041af3c6a6913d25f591eb2a592d34add03dc5881987dbf85279c3006d298b95426cdff3fc99a232f8e5918885f8c3740

data/README.md

@@ -8,8 +8,9 @@ This project was inspired by the [classy-yaml](https://github.com/Tonksthebear/c
 
 You can easily define a base class list for a given type:
 
-`config/utility_classes.yml`
 ```yaml
+# config/utility_classes.yml
+
 heading:
   base: 'text-lg font-semibold text-center'
 ```
@@ -18,22 +19,27 @@ And then retrieve the class list in your code:
 
 ```ruby
 UtilityClasses.for(:heading)
+# "text-lg font-semibold text-center"
 ```
 
 You can optionally define variants for each type:
 
-`config/utility_classes.yml`
 ```yaml
+# config/utility_classes.yml
+
 heading:
-  base: 'text-lg font-semibold text-center'
+  base: 'font-semibold text-center'
   variants:
-    grande: 'text-4xl'
+    normal: 'text-lg'
+    large: 'text-2xl'
+    xlarge: 'text-4xl'
 ```
 
 And then retrieve the class list by passing the variant key:
 
 ```ruby
-UtilityClasses.for(:heading, variant: :grande)
+UtilityClasses.for(:heading, variant: :large)
+# "font-semibold text-center text-2xl"
 ```
 
 The returned string will contain the base classes with the variant classes appended.
@@ -68,6 +74,35 @@ $ bin/rails generate utility_classes:install
 
 Add your classes to the generated config file following the structure of the examples.
 
+If you are using TailwindCSS, ensure that your configuration lists the  `utility_classes.yml` file.
+
+`webpacker` approach:
+
+```javascript
+// tailwind.config.js
+
+module.exports = {
+  purge: [
+    './app/**/**.html.erb',
+    './config/utility_classes.yml' // add this line
+  ],
+  theme: {},
+  variants: {},
+  plugins: [],
+}
+```
+
+`tailwindcss-rails` approach:
+
+```ruby
+# add to your `config/environments/production.rb` file
+
+config.assets.css_compressor = :purger
+config.assets.css_compressor = Tailwindcss::Compressor.new(
+  files_with_class_names: Rails.root.glob('app/views/**/*.*') + Rails.root.glob('config/utility_classes.yml')
+)
+```
+
 ## Contributing
 
 Contributions are welcome. Feel free to open a PR.

data/Rakefile

@@ -1,11 +1,13 @@
-require "bundler/setup"
+# frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rake/testtask"
+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.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
   t.verbose = false
 end
 

data/lib/tasks/utility_classes_tasks.rake

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

data/lib/utility_classes/railtie.rb

@@ -1,4 +1,8 @@
+# frozen_string_literal: true
+
 module UtilityClasses
+  ##
+  # Railtie for UtilityClasses
   class Railtie < ::Rails::Railtie
   end
 end

data/lib/utility_classes/utility_class_reader.rb

@@ -15,15 +15,10 @@ module UtilityClasses
     end
 
     def for(type, variant: nil)
-      reload_config! if config_changed?
+      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
+      classes = retrieve_classes_for_type(type)
+      variant_classes = retrieve_classes_for_variant(type, variant) if variant
 
       variant_classes ? "#{classes} #{variant_classes}" : classes
     end
@@ -40,7 +35,7 @@ module UtilityClasses
       Rails.root.join('config/utility_classes.yml')
     end
 
-    def reload_config!
+    def reload_config
       @styles = data_from_config
       @last_updated = File.ctime(config_file)
     end
@@ -50,5 +45,19 @@ module UtilityClasses
 
       last_updated != File.ctime(config_file)
     end
+
+    def retrieve_classes_for_type(type)
+      classes = styles.dig(type, :base)
+      raise UtilityClasses::Exceptions::TypeKeyNotFound.new(type_key: type) unless classes
+
+      classes
+    end
+
+    def retrieve_classes_for_variant(type, variant)
+      classes = styles.dig(type, :variants, variant)
+      raise UtilityClasses::Exceptions::VariantKeyNotFound.new(variant_key: variant) unless classes
+
+      classes
+    end
   end
 end

data/lib/utility_classes/version.rb

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

data/lib/utility_classes.rb

@@ -4,6 +4,9 @@ require 'rails'
 require 'active_support/dependencies'
 require 'utility_classes/version'
 require 'utility_classes/railtie'
+require 'utility_classes/utility_class_reader'
+require 'utility_classes/exceptions/type_key_not_found'
+require 'utility_classes/exceptions/variant_key_not_found'
 
 ##
 # Namespace for UtilityClasses gem
@@ -12,7 +15,6 @@ module UtilityClasses
   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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: utility_classes
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Dick Davis
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-05 00:00:00.000000000 Z
+date: 2021-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -47,9 +47,10 @@ homepage: https://github.com/d3d1rty/utility_classes
 licenses:
 - MIT
 metadata:
+  rubygems_mfa_required: 'true'
   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
+  changelog_uri: https://github.com/d3d1rty/utility_classes/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -58,14 +59,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: Rails gem that facilitates the use of utility CSS frameworks.