class_variants 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c8fd556b85ee91d2d2709e66af72e1d4017c5a20ba5884c49eed0c755f1a593
-  data.tar.gz: c6f77333c70953510eb23ab94846c2b2f9d1ae1a8b185c289ee3530060546651
+  metadata.gz: b8ecbdedc158b731b446bf166b1dcc6d99b4569cc90f484e95ff6c5466cc3db9
+  data.tar.gz: 80de309d4e820f9a3b5667f8c8b4958172906971e923beb3fd169a915cb20811
 SHA512:
-  metadata.gz: c9f77343da5f6e521cd8a895cef3683a5fc65823b8df3f1f84d03adf38099fb6f51cfc191e24111d35f7ac95ef697e6a61b6dc37a547c50b4732e0863e78631f
-  data.tar.gz: 5a0db3c1db7f88ccc689fbaadc514aa04d73ef405e1ae05755a55918d16d1f1179ff9c736b11402da99e57917c393fd830801f6d78b87c07964d9dc951ac3f98
+  metadata.gz: 3fda53be42ac74e51fb85209a24d3bbfed78101052c4bcf016f307f5c0e852adfaf1062102f5e7a80d5563c101c1e418b836eb274557fee1655679084dafe9b8
+  data.tar.gz: c20bcba0b71ea4b7c151e2e9a07ca6eac7508f4d938cf8c4b0923baea4dd934651582f4ba7a9eaf0fdacaa606ad71db1faff4ac31705237ca7b5fe5bd31bf26d

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Adrian Marin
+Copyright (c) 2025 Adrian Marin
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/lib/class_variants/action_view/helpers.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module ClassVariants
   module ActionView
     module Helpers
-      def class_variants(classes, **args)
-        ClassVariants::Instance.new classes, **args
+      def class_variants(...)
+        ClassVariants::Instance.new(...)
       end
     end
   end

data/lib/class_variants/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ClassVariants
   class Configuration
     def process_classes_with(&block)

data/lib/class_variants/helper.rb

@@ -1,23 +1,28 @@
+# frozen_string_literal: true
+
 module ClassVariants
   module Helper
     module ClassMethods
       def class_variants(...)
-        @_class_variants_instance = ClassVariants.build(...)
-      end
-
-      def _class_variants_instance
-        @_class_variants_instance
+        singleton_class.instance_variable_get(:@_class_variants_instance).merge(...)
       end
     end
 
     def self.included(base)
       base.extend(ClassMethods)
+      base.singleton_class.instance_variable_set(:@_class_variants_instance, ClassVariants::Instance.new)
+
+      def base.inherited(subclass)
+        super if defined?(super)
+
+        subclass.singleton_class.instance_variable_set(
+          :@_class_variants_instance, singleton_class.instance_variable_get(:@_class_variants_instance).dup
+        )
+      end
     end
 
     def class_variants(...)
-      raise "You must configure class_variants in class definition" unless self.class._class_variants_instance
-
-      self.class._class_variants_instance.render(...)
+      self.class.singleton_class.instance_variable_get(:@_class_variants_instance).render(...)
     end
   end
 end

data/lib/class_variants/instance.rb

@@ -1,20 +1,47 @@
+# frozen_string_literal: true
+
 module ClassVariants
   class Instance
-    def initialize(**options, &block)
-      raise ArgumentError, "Use of hash config and code block is not supported" if !options.empty? && block_given?
+    def initialize(...)
+      @bases = []
+      @variants = []
+      @defaults = {}
+      @slots = nil
 
-      @base = options.empty? ? {} : {default: options.fetch(:base, nil)}
-      @variants = expand_variants(options.fetch(:variants, {})) + expand_compound_variants(options.fetch(:compound_variants, []))
-      @defaults = options.fetch(:defaults, {})
+      merge(...)
+    end
 
-      instance_eval(&block) if block_given?
+    def dup
+      self.class.new.tap do |copy|
+        copy.instance_variable_set(:@bases, @bases.dup)
+        copy.instance_variable_set(:@variants, @variants.dup)
+        copy.instance_variable_set(:@defaults, @defaults.dup)
+      end
+    end
+
+    def merge(**options, &block)
+      raise ArgumentError, "Use of hash config and code block is not supported" if !options.empty? && block
+
+      (base = options.fetch(:base, nil)) && @bases << {class: base, slot: :default}
+      @variants += [
+        expand_variants(options.fetch(:variants, {})),
+        expand_compound_variants(options.fetch(:compound_variants, []))
+      ].inject(:+)
+      @defaults.merge!(options.fetch(:defaults, {}))
+
+      instance_eval(&block) if block
+
+      self
     end
 
     def render(slot = :default, **overrides)
       classes = overrides.delete(:class)
+      result = []
 
       # Start with our default classes
-      result = [@base[slot]]
+      @bases.each do |base|
+        result << base[:class] if base[:slot] == slot
+      end
 
       # Then merge the passed in overrides on top of the defaults
       criteria = @defaults.merge(overrides)
@@ -22,9 +49,15 @@ module ClassVariants
       @variants.each do |candidate|
         next unless candidate[:slot] == slot
 
-        if (candidate.keys - [:class, :slot]).all? { |key| criteria[key] == candidate[key] }
-          result << candidate[:class]
+        match = false
+
+        candidate.each_key do |key|
+          next if key == :class || key == :slot
+          match = criteria[key] == candidate[key]
+          break unless match
         end
+
+        result << candidate[:class] if match
       end
 
       # add the passed in classes to the result
@@ -40,21 +73,21 @@ module ClassVariants
     private
 
     def base(klass = nil, &block)
-      raise ArgumentError, "Use of positional argument and code block is not supported" if klass && block_given?
+      raise ArgumentError, "Use of positional argument and code block is not supported" if klass && block
 
-      if block_given?
+      if block
         with_slots(&block).each do |slot|
-          @base[slot[:slot]] = slot[:class]
+          @bases << slot
         end
       else
-        @base[:default] = klass
+        @bases << {slot: :default, class: klass}
       end
     end
 
     def variant(**options, &block)
-      raise ArgumentError, "Use of class option and code block is not supported" if options.key?(:class) && block_given?
+      raise ArgumentError, "Use of class option and code block is not supported" if options.key?(:class) && block
 
-      if block_given?
+      if block
         with_slots(&block).each do |slot|
           @variants << options.merge(slot)
         end
@@ -74,9 +107,10 @@ module ClassVariants
     end
 
     def with_slots
-      @slots = []
+      new_slots = []
+      @slots = new_slots
       yield
-      @slots
+      new_slots
     end
 
     def expand_variants(variants)

data/lib/class_variants/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rails/railtie"
 
 module ClassVariants

data/lib/class_variants/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ClassVariants
-  VERSION = "1.0.0".freeze
+  VERSION = "1.1.1"
 end

data/lib/class_variants.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "class_variants/version"
 require "class_variants/action_view/helpers"
 require "class_variants/configuration"

data/lib/generators/class_variants/install/install_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ClassVariants
   module Generators
     class InstallGenerator < Rails::Generators::Base

data/readme.md

@@ -2,13 +2,14 @@
 
 We ❤️ Tailwind CSS but sometimes it's difficult to manage the state of some elements using conditionals. `class_variants` is a tiny helper that should enable you to create, configure, and apply different variants of elements as classes.
 
+![](./logo.png)
+
 Inspired by [variant-classnames](https://github.com/mattvalleycodes/variant-classnames) ✌️
 
 ## Quicklinks
 
 * [DRY up your tailwind CSS using this awesome gem](https://www.youtube.com/watch?v=cFcwNH6x77g)
 
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -34,9 +35,9 @@ $ gem install class_variants
 We create an object from the class or helper where we define the configuration using four arguments:
 
 1. The `base` keyword argument with default classes that should be applied to each variant.
-1. The `variants` keyword argument where we declare the variants with their option and classes.
-1. The `compound_variants` keyword argument where we declare the compound variants with their conditions and classes
-1. The `defaults` keyword argument (optional) where we declare the default value for each variant.
+2. The `variants` keyword argument where we declare the variants with their option and classes.
+3. The `compound_variants` keyword argument where we declare the compound variants with their conditions and classes
+4. The `defaults` keyword argument (optional) where we declare the default value for each variant.
 
 Below we'll implement the [button component](https://tailwindui.com/components/application-ui/elements/buttons) from Tailwind UI.
 
@@ -99,7 +100,7 @@ button_classes = ClassVariants.build(
 )
 
 button_classes.render(color: :red) # => "inline-flex items-center rounded bg-red-600"
-button_classes.render(color: :red, border: true) # => "inline-flex items-center rounded bg-red-600 border border-red-600"
+button_classes.render(color: :red, border: true) # => "inline-flex items-center rounded bg-red-600 border border-red-800"
 ```
 
 ## Override classes with `render`
@@ -185,6 +186,14 @@ end
 </div>
 ```
 
+## Merge definitions
+
+```ruby
+alert_classes = ClassVariants.build(base: "bg-white")
+alert_classes.merge(base: "text-black")
+alert_classes.render # => "bg-white text-black"
+```
+
 ## Full API
 
 ```ruby
@@ -272,7 +281,7 @@ alert_classes.render(:body, class: "...")
 
 ```ruby
 # Somewhere in your helpers
-def button_classes(classes, **args)
+def button_classes
   class_variants(
     base: "inline-flex items-center rounded border border-transparent font-medium text-white hover:text-white shadow-sm focus:outline-none focus:ring-2 focus:ring-offset-2",
     variants: {
@@ -303,6 +312,10 @@ end
 <%= link_to :Avo, "https://avohq.io", class: button_classes.render(color: :red, size: :xl) %>
 ```
 
+### Output
+
+### ![](sample.jpg)
+
 ## Helper module
 
 If you're developing something more complex you might want to use composition more. You might want to use the helper module for that.
@@ -311,54 +324,81 @@ If you're developing something more complex you might want to use composition mo
 class MyClass
   include ClassVariants::Helper
 
-  class_variants {
-    base: {},
-    variants: {}
-  }
+  class_variants(
+    base: "bg-white",
+    variants: {
+      color: {
+        red: "text-red",
+        blue: "text-blue"
+      }
+    }
+  )
+end
+
+MyClass.new.class_variants(color: :red, class: "shadow") # => "bg-white text-red shadow"
+```
+
+This helper supports class inheritance, so that the subclass receives a copy of the class_variants config that the parent class had at the time of inheritance. From that point on, the settings are kept separate for both. Successive calls to class_variants helper method, will cause the configuration to be merged.
+
+```ruby
+class A
+  include ClassVariants::Helper
+
+  class_variants(base: "bg-red")
+end
+
+class B < A
+  class_variants(base: "text-black")
 end
 
-MyClass.new.class_variants(:container, color: :red, class: "shadow")
+A.class_variants(base: "text-white")
+
+A.new.class_variants # => "bg-red text-white"
+B.new.class_variants # => "bg-red text-black"
 ```
 
 ## `tailwind_merge`
 
 By default, the classes are merged using `concat`, but you can use the awesome [TailwindMerge](https://github.com/gjtorikian/tailwind_merge) gem.
-Install the gem using `bundle add tailwind_merge` and use this configuration to enable it.
+Install the gem using `bundle add tailwind_merge` and use this configuration to enable it. If you're using Rails, you can put this in an initializer.
 
 ```ruby
 ClassVariants.configure do |config|
+  merger = TailwindMerge::Merger.new
   config.process_classes_with do |classes|
-    TailwindMerge::Merger.new.merge(classes)
+    merger.merge(classes)
   end
 end
 ```
 
-### Output
-
-![](sample.jpg)
-
 ## Other packages
 
- - [`active_storage-blurhash`](https://github.com/avo-hq/active_storage-blurhash) - A plug-n-play [blurhash](https://blurha.sh/) integration for images stored in ActiveStorage
- - [`avo`](https://github.com/avo-hq/avo) - Build Content management systems with Ruby on Rails
- - [`prop_initializer`](https://github.com/avo-hq/prop_initializer) - A flexible tool for defining properties on Ruby classes.
- - [`stimulus-confetti`](https://github.com/avo-hq/stimulus-confetti) - The easiest way to add confetti to your StimulusJS app
+- [`active_storage-blurhash`](https://github.com/avo-hq/active_storage-blurhash) - A plug-n-play [blurhash](https://blurha.sh/) integration for images stored in ActiveStorage
+- [`avo`](https://github.com/avo-hq/avo) - Build internal tools, admin panels, and dashboards with Ruby on Rails
+- [`marksmith`](https://github.com/avo-hq/marksmith) - GitHub-style markdown editor for Ruby and Rails
+- [`prop_initializer`](https://github.com/avo-hq/prop_initializer) - A flexible tool for defining properties on Ruby classes.
+- [`stimulus-confetti`](https://github.com/avo-hq/stimulus-confetti) - The easiest way to add confetti to your StimulusJS app
 
 ## Try Avo ⭐️
 
 If you enjoyed this gem try out [Avo](https://github.com/avo-hq/avo). It helps developers build Internal Tools, Admin Panels, CMSes, CRMs, and any other type of Business Apps 10x faster on top of Ruby on Rails.
 
-[![](./logo-on-white.png)](https://github.com/avo-hq/avo)
+[![](./avo-logo.png)](https://github.com/avo-hq/avo)
+
+## Articles
+
+[TIL: How to use `class_variants` with Phlex](https://henrikbjorn.medium.com/til-how-to-use-class-variants-with-phlex-8042bd4407f1)
 
 ## Contributing
 
 1. Fork it `git clone https://github.com/avo-hq/class_variants`
-1. Create your feature branch `git checkout -b my-new-feature`
-1. Commit your changes `git commit -am 'Add some feature'`
-1. Push to the branch `git push origin my-new-feature`
-1. Create new Pull Request
+2. Create your feature branch `git checkout -b my-new-feature`
+3. Commit your changes `git commit -am 'Add some feature'`
+4. Push to the branch `git push origin my-new-feature`
+5. Create new Pull Request
 
 ## License
+
 This package is available as open source under the terms of the MIT License.
 
 ## Cutting a release

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: class_variants
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Adrian Marin
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-13 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: Easily configure styles and apply them as classes.
 email: adrian@adrianthedev.com
@@ -36,7 +35,6 @@ metadata:
   source_code_uri: https://github.com/avo-hq/class_variants
   bug_tracker_uri: https://github.com/avo-hq/class_variants/issues
   changelog_uri: https://github.com/avo-hq/class_variants/releases
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -51,8 +49,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Easily configure styles and apply them as classes.
 test_files: []