Merge pull request avo-hq#20 from javierav/feature/deprecate-compound-variants

Deprecate compoundVariants in favor of compound_variants

Author: javierav

CHANGELOG.md

@@ -1,5 +1,6 @@
 ## Unreleased
 - Deprecate usage of positional arguments ([#12](https://github.com/avo-hq/class_variants/pull/12))
+- Deprecate compoundVariants in favor of compound_variants ([#20](https://github.com/avo-hq/class_variants/pull/20))
 
 ## 0.0.7 (2023-12-07)
 - Add support for compound variants ([#8](https://github.com/avo-hq/class_variants/pull/8))

lib/class_variants/instance.rb

@@ -1,17 +1,22 @@
 module ClassVariants
   class Instance
-    attr_reader :base, :variants, :compoundVariants, :defaults
+    attr_reader :base, :variants, :compound_variants, :defaults
 
     # rubocop:disable Naming/VariableName
-    def initialize(classes = nil, base: nil, variants: {}, compoundVariants: [], defaults: {})
+    def initialize(classes = nil, base: nil, variants: {}, compoundVariants: [], compound_variants: [], defaults: {})
       warn <<~MSG if classes
         (ClassVariants) DEPRECATION WARNING: Use of positional argument for default classes is deprecated
         and will be removed in the next version. Use the `base` keyword argument instead.
       MSG
 
+      warn <<~MSG unless compoundVariants.empty?
+        (ClassVariants) DEPRECATION WARNING: Use of `compoundVariants` keyword argument is deprecated
+        and will be removed in the next version. Use the `compound_variant` instead.
+      MSG
+
       @base = base || classes
       @variants = expand_boolean_variants(variants)
-      @compoundVariants = compoundVariants
+      @compound_variants = compound_variants.empty? ? compoundVariants : compound_variants
       @defaults = defaults
     end
     # rubocop:enable Naming/VariableName
@@ -28,7 +33,7 @@ def render(**overrides)
         result << @variants.dig(variant_type, variant)
       end
 
-      @compoundVariants.each do |compound_variant|
+      @compound_variants.each do |compound_variant|
         if (compound_variant.keys - [:class]).all? { |key| selected[key] == compound_variant[key] }
           result << compound_variant[:class]
         end

readme.md

@@ -35,7 +35,7 @@ We create an object from the class or helper where we define the configuration u
 
 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 `compoundVariants` keyword argument where we declare the compound variants with their conditions 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.
 
 ## Example
@@ -90,7 +90,7 @@ button_classes = ClassVariants.build(
     },
     border: "border"
   },
-  compoundVariants: [
+  compound_variants: [
     { color: :red,  border: true, class: "border-red-800"  },
     { color: :blue, border: true, class: "border-blue-800" }
   ]

test/class_variants_test.rb

@@ -17,7 +17,7 @@ def setup
         visible: "inline-block",
         "!visible": "hidden"
       },
-      compoundVariants: [
+      compound_variants: [
         {ring: true, color: :red, class: "focus:ring-red-600"},
         {ring: true, color: :green, class: "focus:ring-green-600"}
       ],