tailwind_merge 0.1.0

data/lib/tailwind_merge/validators.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require "set"
+
+module TailwindMerge
+  module Validators
+    class << self
+      def numeric?(x)
+        Float(x, exception: false).is_a?(Numeric)
+      end
+
+      def integer?(x)
+        Integer(x, exception: false).is_a?(Integer)
+      end
+    end
+
+    STRING_LENGTHS = Set.new(["px", "full", "screen"]).freeze
+
+    ARBITRARY_VALUE_REGEX = /^\[(.+)\]$/
+    FRACTION_REGEX = %r{^\d+/\d+$}
+    LENGTH_UNIT_REGEX = /\d+(%|px|em|rem|vh|vw|pt|pc|in|cm|mm|cap|ch|ex|lh|rlh|vi|vb|vmin|vmax)/
+    TSHIRT_UNIT_REGEX = /^(\d+)?(xs|sm|md|lg|xl)$/
+    # Shadow always begins with x and y offset separated by underscore
+    SHADOW_REGEX = /^-?((\d+)?\.?(\d+)[a-z]+|0)_-?((\d+)?\.?(\d+)[a-z]+|0)/
+
+    IS_ANY = ->(_) { return true }
+
+    IS_LENGTH = ->(class_part) {
+      numeric?(class_part) || \
+        STRING_LENGTHS.include?(class_part) || \
+        FRACTION_REGEX.match?(class_part) || \
+        IS_ARBITRARY_LENGTH.call(class_part)
+    }
+
+    IS_ARBITRARY_LENGTH = ->(class_part) {
+      if (match = ARBITRARY_VALUE_REGEX.match(class_part))
+        return match[1].start_with?("length:") || LENGTH_UNIT_REGEX.match?(class_part)
+      end
+
+      false
+    }
+
+    IS_ARBITRARY_SIZE = ->(class_part) {
+      if (match = ARBITRARY_VALUE_REGEX.match(class_part))
+        return match[1].start_with?("size:")
+      end
+
+      false
+    }
+
+    IS_ARBITRARY_POSITION = ->(class_part) {
+      if (match = ARBITRARY_VALUE_REGEX.match(class_part))
+        return match[1].start_with?("position:")
+      end
+
+      false
+    }
+
+    IS_ARBITRARY_VALUE = ->(class_part) {
+      ARBITRARY_VALUE_REGEX.match(class_part)
+    }
+
+    IS_ARBITRARY_URL = ->(class_part) {
+      if (match = ARBITRARY_VALUE_REGEX.match(class_part))
+        return match[1].start_with?("url(", "url:")
+      end
+
+      false
+    }
+
+    IS_ARBITRARY_WEIGHT = ->(class_part) {
+      if (match = ARBITRARY_VALUE_REGEX.match(class_part))
+        return match[1].start_with?("number:") || numeric?(match[1])
+      end
+
+      false
+    }
+
+    IS_TSHIRT_SIZE = ->(class_part) {
+      TSHIRT_UNIT_REGEX.match?(class_part)
+    }
+
+    IS_INTEGER = ->(class_part) {
+      if (match = ARBITRARY_VALUE_REGEX.match(class_part))
+        return integer?(match[1])
+      end
+
+      integer?(class_part)
+    }
+
+    IS_ARBITRARY_SHADOW = ->(class_part) {
+      if (match = ARBITRARY_VALUE_REGEX.match(class_part))
+        return SHADOW_REGEX.match?(match[1])
+      end
+
+      return false
+    }
+  end
+end

data/lib/tailwind_merge/version.rb

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

data/lib/tailwind_merge.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+if ENV.fetch("DEBUG", false)
+  require "amazing_print"
+  require "debug"
+end
+
+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 "strscan"
+require "set"
+
+module TailwindMerge
+  class Merger
+    include Config
+
+    SPLIT_CLASSES_REGEX = /\s+/
+    IMPORTANT_MODIFIER = "!"
+
+    def initialize(config: {})
+      @config = if config.fetch(:theme, nil)
+        merge_configs(config)
+      else
+        TailwindMerge::Config::DEFAULTS.merge(config)
+      end
+
+      @class_utils = TailwindMerge::ClassUtils.new(@config)
+      @cache = LruRedux::Cache.new(@config[:cache_size])
+    end
+
+    def merge(classes)
+      return merge_class_list(classes) unless has_cache?
+
+      @cache.getset(classes) do
+        merge_class_list(classes)
+      end
+    end
+
+    def has_cache?
+      @cache.nil?
+    end
+
+    private def merge_class_list(classes)
+      # Set of class_group_ids in following format:
+      # `{importantModifier}{variantModifiers}{classGroupId}`
+      # @example 'float'
+      # @example 'hover:focus:bg-color'
+      # @example 'md:!pr'
+      class_groups_in_conflict = Set.new
+
+      classes.strip.split(SPLIT_CLASSES_REGEX).map do |original_class_name|
+        modifiers, has_important_modifier, base_class_name = split_modifiers(original_class_name)
+
+        class_group_id = @class_utils.class_group_id(base_class_name)
+
+        unless class_group_id
+          next {
+            is_tailwind_class: false,
+            original_class_name: original_class_name,
+          }
+        end
+
+        variant_modifier = sort_modifiers(modifiers).join("")
+
+        modifier_id = has_important_modifier ? "#{variant_modifier}#{IMPORTANT_MODIFIER}" : variant_modifier
+
+        {
+          is_tailwind_class: true,
+          modifier_id: modifier_id,
+          class_group_id: class_group_id,
+          original_class_name: original_class_name,
+        }
+      end.reverse # Last class in conflict wins, so filter conflicting classes in reverse order.
+        .select do |parsed|
+        next(true) unless parsed[:is_tailwind_class]
+
+        modifier_id = parsed[:modifier_id]
+        class_group_id = parsed[:class_group_id]
+
+        class_id = "#{modifier_id}#{class_group_id}"
+
+        next if class_groups_in_conflict.include?(class_id)
+
+        class_groups_in_conflict.add(class_id)
+
+        @class_utils.get_conflicting_class_group_ids(class_group_id).each do |group|
+          class_groups_in_conflict.add("#{modifier_id}#{group}")
+        end
+
+        true
+      end.reverse.map { |parsed| parsed[:original_class_name] }.join(" ")
+    end
+
+    private def split_modifiers(class_name)
+      modifiers = []
+
+      bracket_depth = 0
+      modifier_start = 0
+
+      ss = StringScanner.new(class_name)
+
+      until ss.eos?
+        portion = ss.scan_until(/[:\[\]]/)
+
+        if portion.nil?
+          ss.terminate
+          next
+        end
+        pos = ss.pos - 1
+        if class_name[pos] == ":" && bracket_depth.zero?
+          next_modifier_start = pos
+          modifiers << class_name[modifier_start..next_modifier_start]
+          modifier_start = next_modifier_start + 1
+        elsif class_name[pos] == "["
+          bracket_depth += 1
+        elsif class_name[pos] == "]"
+          bracket_depth -= 1
+        end
+      end
+
+      base_class_name_with_important_modifier = modifiers.empty? ? class_name : class_name[modifier_start..-1]
+      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..-1] : base_class_name_with_important_modifier
+
+      [modifiers, has_important_modifier, base_class_name]
+    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
+    private def sort_modifiers(modifiers)
+      if modifiers.length <= 1
+        return modifiers
+      end
+
+      sorted_modifiers = []
+      unsorted_modifiers = []
+
+      modifiers.each do |modifier|
+        is_arbitrary_variant = modifier[0] == "["
+
+        if is_arbitrary_variant
+          sorted_modifiers.push(unsorted_modifiers.sort, modifier)
+          unsorted_modifiers = []
+        else
+          unsorted_modifiers.push(modifier)
+        end
+      end
+
+      sorted_modifiers.push(...unsorted_modifiers.sort)
+
+      sorted_modifiers
+    end
+  end
+end

data/script/changelog_generator

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+CHANGELOG_GITHUB_TOKEN="$GH_TOKEN" github_changelog_generator -u gjtorikian -p tailwind_merge

data/tailwind_merge.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "lib/tailwind_merge/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "tailwind_merge"
+  spec.version = TailwindMerge::VERSION
+  spec.authors = ["Garen J. Torikian"]
+  spec.email = ["gjtorikian@gmail.com"]
+
+  spec.summary = "Utility function to efficiently merge Tailwind CSS classes without style conflicts."
+  spec.homepage = "https://www.github.com/gjtorikian/tailwind_merge"
+  spec.license = "MIT"
+
+  spec.required_ruby_version = [">= 3.0", "< 4.0"]
+
+  spec.metadata = {
+    "funding_uri" => "https://github.com/sponsors/gjtorikian/",
+    "rubygems_mfa_required" => "true",
+  }
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    %x(git ls-files -z).split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency("lru_redux", "~> 1.1")
+
+  spec.add_development_dependency("amazing_print")
+  spec.add_development_dependency("debug") if "#{RbConfig::CONFIG["MAJOR"]}.#{RbConfig::CONFIG["MINOR"]}".to_f >= 3.1
+  spec.add_development_dependency("minitest", "~> 5.6")
+  spec.add_development_dependency("minitest-focus", "~> 1.1")
+  spec.add_development_dependency("rake")
+  spec.add_development_dependency("redcarpet")
+  spec.add_development_dependency("rubocop-standard")
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: tailwind_merge
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Garen J. Torikian
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lru_redux
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: amazing_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.6'
+- !ruby/object:Gem::Dependency
+  name: minitest-focus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- gjtorikian@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tailwind_merge.rb
+- lib/tailwind_merge/class_utils.rb
+- lib/tailwind_merge/config.rb
+- lib/tailwind_merge/validators.rb
+- lib/tailwind_merge/version.rb
+- script/changelog_generator
+- tailwind_merge.gemspec
+homepage: https://www.github.com/gjtorikian/tailwind_merge
+licenses:
+- MIT
+metadata:
+  funding_uri: https://github.com/sponsors/gjtorikian/
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://www.github.com/gjtorikian/tailwind_merge
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Utility function to efficiently merge Tailwind CSS classes without style
+  conflicts.
+test_files: []