tailwind_merge 0.16.0 → 1.0.0

data/lib/tailwind_merge/parse_class_name.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module TailwindMerge
+  class TailwindClass < Struct.new(:is_external, :modifiers, :has_important_modifier, :base_class_name, :maybe_postfix_modifier_position)
+  end
+
+  module ParseClassName
+    IMPORTANT_MODIFIER = "!"
+    MODIFIER_SEPARATOR = ":"
+    MODIFIER_SEPARATOR_LENGTH = MODIFIER_SEPARATOR.length
+
+    ##
+    # Parse class name into parts.
+    #
+    # Inspired by `splitAtTopLevelOnly` used in Tailwind CSS
+    # @see https://github.com/tailwindlabs/tailwindcss/blob/v3.2.2/src/util/splitAtTopLevelOnly.js
+    def parse_class_name(class_name, prefix: nil)
+      unless prefix.nil?
+        full_prefix = "#{prefix}#{MODIFIER_SEPARATOR}"
+        if class_name.start_with?(full_prefix)
+          return parse_class_name(class_name[full_prefix.length..])
+        else
+          return TailwindClass.new(
+            is_external: true,
+            modifiers: [],
+            has_important_modifier: false,
+            base_class_name: class_name,
+            maybe_postfix_modifier_position: nil,
+          )
+        end
+      end
+
+      modifiers = []
+
+      bracket_depth = 0
+      paren_depth = 0
+      modifier_start = 0
+      postfix_modifier_position = nil
+
+      class_name.each_char.with_index do |char, index|
+        if bracket_depth.zero? && paren_depth.zero?
+          if char == MODIFIER_SEPARATOR
+            modifiers << class_name[modifier_start...index]
+            modifier_start = index + MODIFIER_SEPARATOR_LENGTH
+            next
+          elsif char == "/"
+            postfix_modifier_position = index
+            next
+          end
+        end
+
+        bracket_depth += 1 if char == "["
+        bracket_depth -= 1 if char == "]"
+        paren_depth += 1 if char == "("
+        paren_depth -= 1 if char == ")"
+      end
+
+      base_class_name_with_important_modifier = modifiers.empty? ? class_name : class_name[modifier_start..]
+
+      base_class_name, has_important_modifier = strip_important_modifier(base_class_name_with_important_modifier)
+
+      maybe_postfix_modifier_position = if postfix_modifier_position && postfix_modifier_position > modifier_start
+        postfix_modifier_position - modifier_start
+      end
+
+      TailwindClass.new(
+        is_external: false,
+        modifiers:,
+        has_important_modifier:,
+        base_class_name: base_class_name,
+        maybe_postfix_modifier_position:,
+      )
+    end
+
+    def strip_important_modifier(base_class_name)
+      if base_class_name.end_with?(IMPORTANT_MODIFIER)
+        return [base_class_name[0...-IMPORTANT_MODIFIER.length], true]
+      end
+
+      # In Tailwind CSS v3 the important modifier was at the start of the base class name. This is still supported for legacy reasons.
+      # @see https://github.com/dcastil/tailwind-merge/issues/513#issuecomment-2614029864
+      if base_class_name.start_with?(IMPORTANT_MODIFIER)
+        return [base_class_name[1..], true]
+      end
+
+      [base_class_name, false]
+    end
+  end
+end

data/lib/tailwind_merge/sort_modifiers.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module TailwindMerge
+  module SortModifiers
+    # Sorts modifiers according to following schema:
+    # - Predefined modifiers are sorted alphabetically
+    # - When an arbitrary variant appears, it must be preserved which modifiers are before and after it
+    def sort_modifiers(modifiers, order_sensitive_modifiers)
+      return modifiers if modifiers.size <= 1
+
+      sorted_modifiers = []
+      unsorted_modifiers = []
+
+      modifiers.each do |modifier|
+        is_position_sensitive = modifier.start_with?("[") || order_sensitive_modifiers.include?(modifier)
+
+        if is_position_sensitive
+          sorted_modifiers.concat(unsorted_modifiers.sort)
+          sorted_modifiers << modifier
+          unsorted_modifiers.clear
+        else
+          unsorted_modifiers << modifier
+        end
+      end
+
+      sorted_modifiers.concat(unsorted_modifiers.sort)
+
+      sorted_modifiers
+    end
+  end
+end

data/lib/tailwind_merge/validators.rb

@@ -5,13 +5,22 @@ require "set"
 module TailwindMerge
   module Validators
     class << self
-      def arbitrary_value?(class_part, label, test_value)
+      def arbitrary_value?(class_part, test_label, test_value)
         match = ARBITRARY_VALUE_REGEX.match(class_part)
         return false unless match
-        return test_value.call(match[2]) if match[1].nil?
-        return label == match[1] if label.is_a?(String)
 
-        label.include?(match[1])
+        return test_label.call(match[1]) unless match[1].nil?
+
+        test_value.call(match[2])
+      end
+
+      def arbitrary_variable?(class_part, test_label, should_match_no_label: false)
+        match = ARBITRARY_VARIABLE_REGEX.match(class_part)
+        return false unless match
+
+        return test_label.call(match[1]) unless match[1].nil?
+
+        should_match_no_label
       end
 
       def numeric?(x)
@@ -23,95 +32,150 @@ module TailwindMerge
       end
     end
 
-    STRING_LENGTHS = Set.new(["px", "full", "screen"]).freeze
-
-    ARBITRARY_VALUE_REGEX = /^\[(?:([a-z-]+):)?(.+)\]$/i
+    ARBITRARY_VALUE_REGEX = /^\[(?:(\w[\w-]*):)?(.+)\]$/i
+    ARBITRARY_VARIABLE_REGEX = /^\((?:(\w[\w-]*):)?(.+)\)$/i
     FRACTION_REGEX = %r{^\d+/\d+$}
-    LENGTH_UNIT_REGEX = /\d+(%|px|r?em|[sdl]?v([hwib]|min|max)|pt|pc|in|cm|mm|cap|ch|ex|r?lh|cq(w|h|i|b|min|max))|\b(calc|min|max|clamp)\(.+\)|^0$/
     TSHIRT_UNIT_REGEX = /^(\d+(\.\d+)?)?(xs|sm|md|lg|xl)$/
+    LENGTH_UNIT_REGEX = /\d+(%|px|r?em|[sdl]?v([hwib]|min|max)|pt|pc|in|cm|mm|cap|ch|ex|r?lh|cq(w|h|i|b|min|max))|\b(calc|min|max|clamp)\(.+\)|^0$/
     COLOR_FUNCTION_REGEX = /^(rgba?|hsla?|hwb|(ok)?(lab|lch))\(.+\)$/
+
     # Shadow always begins with x and y offset separated by underscore optionally prepended by inset
     SHADOW_REGEX = /^(inset_)?-?((\d+)?\.?(\d+)[a-z]+|0)_-?((\d+)?\.?(\d+)[a-z]+|0)/
     IMAGE_REGEX = /^(url|image|image-set|cross-fade|element|(repeating-)?(linear|radial|conic)-gradient)\(.+\)$/
 
-    SIZE_LABELS = Set.new(["length", "size", "percentage"]).freeze
-    IMAGE_LABELS = Set.new(["image", "url"]).freeze
+    IS_FRACTION = ->(value) {
+      FRACTION_REGEX.match?(value)
+    }
+
+    IS_NUMBER = ->(value) {
+      numeric?(value)
+    }
+
+    IS_INTEGER = ->(value) {
+      integer?(value)
+    }
+
+    IS_PERCENT = ->(value) {
+      value.end_with?("%") && IS_NUMBER.call(value[0..-2])
+    }
+
+    IS_TSHIRT_SIZE = ->(value) {
+      TSHIRT_UNIT_REGEX.match?(value)
+    }
+
+    IS_ANY = ->(_ = nil) { true }
 
-    is_length_only = ->(value) {
+    IS_LENGTH_ONLY = ->(value) {
       # `colorFunctionRegex` check is necessary because color functions can have percentages in them which which would be incorrectly classified as lengths.
       # For example, `hsl(0 0% 0%)` would be classified as a length without this check.
       # I could also use lookbehind assertion in `lengthUnitRegex` but that isn't supported widely enough.
       LENGTH_UNIT_REGEX.match?(value) && !COLOR_FUNCTION_REGEX.match?(value)
     }
 
-    is_never = ->(_) { false }
+    IS_NEVER = ->(_) { false }
 
-    is_number = ->(value) {
-      numeric?(value)
+    IS_SHADOW = ->(value) {
+      SHADOW_REGEX.match?(value)
     }
 
-    is_integer_only = ->(value) {
-      integer?(value)
+    IS_IMAGE = ->(value) {
+      IMAGE_REGEX.match?(value)
     }
 
-    is_shadow = ->(value) {
-      SHADOW_REGEX.match?(value)
+    IS_ANY_NON_ARBITRARY = ->(value) {
+      !IS_ARBITRARY_VALUE.call(value) && !IS_ARBITRARY_VARIABLE.call(value)
     }
 
-    is_image = ->(value) {
-      IMAGE_REGEX.match?(value)
+    IS_ARBITRARY_SIZE = ->(value) {
+      arbitrary_value?(value, IS_LABEL_SIZE, IS_NEVER)
     }
 
-    IS_LENGTH = ->(value) {
-      numeric?(value) ||
-        STRING_LENGTHS.include?(value) ||
-        FRACTION_REGEX.match?(value)
+    IS_ARBITRARY_VALUE = ->(value) {
+      ARBITRARY_VALUE_REGEX.match(value)
     }
 
     IS_ARBITRARY_LENGTH = ->(value) {
-      arbitrary_value?(value, "length", is_length_only)
+      arbitrary_value?(value, IS_LABEL_LENGTH, IS_LENGTH_ONLY)
     }
 
     IS_ARBITRARY_NUMBER = ->(value) {
-      arbitrary_value?(value, "number", is_number)
+      arbitrary_value?(value, IS_LABEL_NUMBER, IS_NUMBER)
     }
 
-    IS_NUMBER = ->(value) {
-      is_number.call(value)
+    IS_ARBITRARY_POSITION = ->(value) {
+      arbitrary_value?(value, IS_LABEL_POSITION, IS_NEVER)
     }
 
-    IS_INTEGER = ->(value) {
-      is_integer_only.call(value)
+    IS_ARBITRARY_IMAGE = ->(value) {
+      arbitrary_value?(value, IS_LABEL_IMAGE, IS_IMAGE)
     }
 
-    IS_PERCENT = ->(value) {
-      value.end_with?("%") && is_number.call(value[0..-2])
+    IS_ARBITRARY_SHADOW = ->(value) {
+      arbitrary_value?(value, IS_NEVER, IS_SHADOW)
     }
 
-    IS_ARBITRARY_VALUE = ->(value) {
-      ARBITRARY_VALUE_REGEX.match(value)
+    IS_ARBITRARY_VARIABLE = ->(value) {
+      ARBITRARY_VARIABLE_REGEX.match(value)
     }
 
-    IS_TSHIRT_SIZE = ->(value) {
-      TSHIRT_UNIT_REGEX.match?(value)
+    IS_ARBITRARY_VARIABLE_LENGTH = ->(value) {
+      arbitrary_variable?(value, IS_LABEL_LENGTH)
     }
 
-    IS_ARBITRARY_SIZE = ->(value) {
-      arbitrary_value?(value, SIZE_LABELS, is_never)
+    IS_ARBITRARY_VARIABLE_FAMILY_NAME = ->(value) {
+      arbitrary_variable?(value, IS_LABEL_FAMILY_NAME)
     }
 
-    IS_ARBITRARY_POSITION = ->(value) {
-      arbitrary_value?(value, "position", is_never)
+    IS_ARBITRARY_VARIABLE_POSITION = ->(value) {
+      arbitrary_variable?(value, IS_LABEL_POSITION)
     }
 
-    IS_ARBITRARY_IMAGE = ->(value) {
-      arbitrary_value?(value, IMAGE_LABELS, is_image)
+    IS_ARBITRARY_VARIABLE_SIZE = ->(value) {
+      arbitrary_variable?(value, IS_LABEL_SIZE)
     }
 
-    IS_ARBITRARY_SHADOW = ->(value) {
-      arbitrary_value?(value, "", is_shadow)
+    IS_ARBITRARY_VARIABLE_IMAGE = ->(value) {
+      arbitrary_variable?(value, IS_LABEL_IMAGE)
+    }
+
+    IS_ARBITRARY_VARIABLE_SHADOW = ->(value) {
+      arbitrary_variable?(value, IS_LABEL_SHADOW, should_match_no_label: true)
     }
 
-    IS_ANY = ->(_) { true }
+    ############
+    # Labels
+    ############
+
+    IS_LABEL_POSITION = ->(value) {
+      value == "position"
+    }
+
+    IMAGE_LABELS = Set.new(["image", "url"]).freeze
+
+    IS_LABEL_IMAGE = ->(value) {
+      IMAGE_LABELS.include?(value)
+    }
+
+    SIZE_LABELS = Set.new(["length", "size", "percentage"]).freeze
+
+    IS_LABEL_SIZE = ->(value) {
+      SIZE_LABELS.include?(value)
+    }
+
+    IS_LABEL_LENGTH = ->(value) {
+      value == "length"
+    }
+
+    IS_LABEL_NUMBER = ->(value) {
+      value == "number"
+    }
+
+    IS_LABEL_FAMILY_NAME = ->(value) {
+      value == "family-name"
+    }
+
+    IS_LABEL_SHADOW = ->(value) {
+      value == "shadow"
+    }
   end
 end

data/lib/tailwind_merge/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TailwindMerge
-  VERSION = "0.16.0"
+  VERSION = "1.0.0"
 end

data/lib/tailwind_merge.rb

@@ -5,8 +5,9 @@ require "lru_redux"
 require_relative "tailwind_merge/version"
 require_relative "tailwind_merge/validators"
 require_relative "tailwind_merge/config"
-require_relative "tailwind_merge/class_utils"
-require_relative "tailwind_merge/modifier_utils"
+require_relative "tailwind_merge/class_group_utils"
+require_relative "tailwind_merge/sort_modifiers"
+require_relative "tailwind_merge/parse_class_name"
 
 require "strscan"
 require "set"
@@ -14,18 +15,15 @@ require "set"
 module TailwindMerge
   class Merger
     include Config
-    include ModifierUtils
+    include ParseClassName
+    include SortModifiers
 
     SPLIT_CLASSES_REGEX = /\s+/
 
     def initialize(config: {})
-      @config = if config.key?(:theme)
-        merge_configs(config)
-      else
-        TailwindMerge::Config::DEFAULTS.merge(config)
-      end
-
-      @class_utils = TailwindMerge::ClassUtils.new(@config)
+      @config = merge_config(config)
+      @config[:important_modifier] = @config[:important_modifier].to_s
+      @class_utils = TailwindMerge::ClassGroupUtils.new(@config)
       @cache = LruRedux::Cache.new(@config[:cache_size], @config[:ignore_empty_cache])
     end
 
@@ -51,16 +49,20 @@ module TailwindMerge
       merged_classes = []
 
       trimmed.split(SPLIT_CLASSES_REGEX).reverse_each do |original_class_name|
-        modifiers, has_important_modifier, base_class_name, maybe_postfix_modifier_position =
-          split_modifiers(original_class_name, separator: @config[:separator])
-
-        actual_base_class_name = if maybe_postfix_modifier_position
-          base_class_name[0...maybe_postfix_modifier_position]
-        else
-          base_class_name
+        result = parse_class_name(original_class_name, prefix: @config[:prefix])
+        is_external = result.is_external
+        modifiers = result.modifiers
+        has_important_modifier = result.has_important_modifier
+        base_class_name = result.base_class_name
+        maybe_postfix_modifier_position = result.maybe_postfix_modifier_position
+
+        if is_external
+          merged_classes.push(original_class_name)
+          next
         end
 
         has_postfix_modifier = maybe_postfix_modifier_position ? true : false
+        actual_base_class_name = has_postfix_modifier ? base_class_name[0...maybe_postfix_modifier_position] : base_class_name
         class_group_id = @class_utils.class_group_id(actual_base_class_name)
 
         unless class_group_id
@@ -81,7 +83,7 @@ module TailwindMerge
           has_postfix_modifier = false
         end
 
-        variant_modifier = sort_modifiers(modifiers).join(":")
+        variant_modifier = sort_modifiers(modifiers, @config[:order_sensitive_modifiers]).join(":")
 
         modifier_id = has_important_modifier ? "#{variant_modifier}#{IMPORTANT_MODIFIER}" : variant_modifier
         class_id = "#{modifier_id}#{class_group_id}"

data/script/test

@@ -0,0 +1,43 @@
+#!/bin/bash
+#/ Usage: script/test <filename:test_line>
+#/ 1. `script/test FILE` runs all tests in the file.
+#/ 1. `script/test FILE:LINE` runs test in specific line of the file.
+#/ 1. `script/test 'GLOB'` runs all tests for matching glob.
+#/     * make sure to wrap the `GLOB` in single quotes `''`.
+
+if ! [ $# -eq 0 ]; then
+  export TEST=$(echo "$1" | cut -d ":" -f 1)
+
+  if [[ "$1" == *":"* ]]; then
+    LINE=$(echo "$1" | cut -d ":" -f 2)
+    LINE=$(head -n $LINE $TEST | tail -1)
+    NAME=$(echo "$LINE" | sed "s/.*def //")
+
+    if ! [[ "$NAME" == "test_"* ]] && ! [[ "$NAME" == "bench_"* ]]; then
+      echo
+      echo "ERROR: Line provided does not define a test case"
+      exit 1
+    fi
+
+    export TESTOPTS="--name=$NAME"
+  fi
+fi
+
+# Check for and parse flags
+for arg in "$@"
+do
+    case $arg in
+        --debug)
+            export DEBUG=true
+        ;;
+        *)
+            # Unknown arguments can be ignored or handled here
+        ;;
+    esac
+done
+
+if  [[ "$TEST" == "test/system"* ]] ; then
+  bundle exec rake test:system
+else
+  bundle exec rake test
+fi

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tailwind_merge
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Garen J. Torikian
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-25 00:00:00.000000000 Z
+date: 2025-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sin_lru_redux
@@ -68,21 +68,23 @@ files:
 - README.md
 - Rakefile
 - lib/tailwind_merge.rb
-- lib/tailwind_merge/class_utils.rb
+- lib/tailwind_merge/class_group_utils.rb
 - lib/tailwind_merge/config.rb
-- lib/tailwind_merge/modifier_utils.rb
+- lib/tailwind_merge/parse_class_name.rb
+- lib/tailwind_merge/sort_modifiers.rb
 - lib/tailwind_merge/validators.rb
 - lib/tailwind_merge/version.rb
+- script/test
 - tailwind_merge.gemspec
-homepage: https://github.com/gjtorikian/tailwind_merge/tree/v0.16.0
+homepage: https://github.com/gjtorikian/tailwind_merge/tree/v1.0.0
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/gjtorikian/tailwind_merge/tree/v0.16.0
-  source_code_uri: https://github.com/gjtorikian/tailwind_merge/tree/v0.16.0
-  changelog_uri: https://github.com/gjtorikian/tailwind_merge/blob/v0.16.0/CHANGELOG.md
+  homepage_uri: https://github.com/gjtorikian/tailwind_merge/tree/v1.0.0
+  source_code_uri: https://github.com/gjtorikian/tailwind_merge/tree/v1.0.0
+  changelog_uri: https://github.com/gjtorikian/tailwind_merge/blob/v1.0.0/CHANGELOG.md
   bug_tracker_uri: https://github.com/gjtorikian/tailwind_merge/issues
-  documentation_uri: https://rubydoc.info/gems/tailwind_merge/0.16.0
+  documentation_uri: https://rubydoc.info/gems/tailwind_merge/1.0.0
   funding_uri: https://github.com/sponsors/gjtorikian
   rubygems_mfa_required: 'true'
 post_install_message:

data/lib/tailwind_merge/modifier_utils.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-module TailwindMerge
-  module ModifierUtils
-    IMPORTANT_MODIFIER = "!"
-
-    def split_modifiers(class_name, separator: ":")
-      separator_length = separator.length
-      separator_is_single_char = (separator_length == 1)
-      first_separator_char = separator[0]
-
-      modifiers = []
-      bracket_depth = 0
-      modifier_start = 0
-      postfix_modifier_position = nil
-
-      class_name.each_char.with_index do |char, index|
-        if bracket_depth.zero?
-          if char == first_separator_char && (separator_is_single_char || class_name[index, separator_length] == separator)
-            modifiers << class_name[modifier_start...index]
-            modifier_start = index + separator_length
-            next
-          elsif char == "/"
-            postfix_modifier_position = index
-            next
-          end
-        end
-
-        bracket_depth += 1 if char == "["
-        bracket_depth -= 1 if char == "]"
-      end
-
-      base_class_name_with_important_modifier = modifiers.empty? ? class_name : class_name[modifier_start..]
-      has_important_modifier = base_class_name_with_important_modifier.start_with?(IMPORTANT_MODIFIER)
-      base_class_name = has_important_modifier ? base_class_name_with_important_modifier[1..] : base_class_name_with_important_modifier
-
-      maybe_postfix_modifier_position = if postfix_modifier_position && postfix_modifier_position > modifier_start
-        postfix_modifier_position - modifier_start
-      end
-
-      [modifiers, has_important_modifier, base_class_name, maybe_postfix_modifier_position]
-    end
-
-    # Sorts modifiers according to following schema:
-    # - Predefined modifiers are sorted alphabetically
-    # - When an arbitrary variant appears, it must be preserved which modifiers are before and after it
-    def sort_modifiers(modifiers)
-      return modifiers if modifiers.size <= 1
-
-      sorted_modifiers = []
-      unsorted_modifiers = []
-
-      modifiers.each do |modifier|
-        if modifier.start_with?("[")
-          sorted_modifiers.concat(unsorted_modifiers.sort)
-          sorted_modifiers << modifier
-          unsorted_modifiers.clear
-        else
-          unsorted_modifiers << modifier
-        end
-      end
-
-      sorted_modifiers.concat(unsorted_modifiers.sort)
-
-      sorted_modifiers
-    end
-  end
-end