tail_merge 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09136ec0a7747e58715fc95aae08f3c81599247202a152bc3b21c85217b5dbad'
-  data.tar.gz: b4313ed6f949a48149d1e417e88c84bd026dd9791197f68f0137c2217e5798fb
+  metadata.gz: 163e2f04ba6092bb1d8a0e268dab58a087c9f853edc52ba1ae091cc6b2c7ece4
+  data.tar.gz: e0aa6a361b8e4219a783b6a00b099ca8dfe6b8c82ae071b2cac8ea4f79d268ce
 SHA512:
-  metadata.gz: 8a797eafd289cc37273f8ebf323241f6245f9a90337dc2c9b9841d279ec7eac957b492ed974b4a4c9bc824485dd057722fc2191ff04d9bddeff6ec3b50b85f43
-  data.tar.gz: 7e52a4c5a9b2d763228aab6930895742a2f2dddfbbb2581fb6d8b31dfd719bcb85b75d86a43976f45b65d22dadd6527187a771744a432d808fe24c241c11694a
+  metadata.gz: f5071ee3b5bccf88d692a1863e2d7f4a1c37fd00f13786dd685127a557b5c23f064ece27f8e99f2719aae2e989b52ff09c1cc2395fc7977ceb2a8f7e1704193d
+  data.tar.gz: 8debb6513dc3035e7acab2ee0ebd58cb4ff265d523c28a17dc77d64fb7930faa02c91c8371875307525c6c63b50080d86f0c1ef20679be7a73077b2d6b76716d

data/Cargo.lock

@@ -141,6 +141,14 @@ version = "2.7.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "78ca9ab1a0babb1e7d5695e3530886289c18cf2f87ec19a575a0abdce112e3a3"
 
+[[package]]
+name = "merger"
+version = "0.1.0"
+dependencies = [
+ "magnus",
+ "rustui_merge",
+]
+
 [[package]]
 name = "minimal-lexical"
 version = "0.2.1"
@@ -278,14 +286,6 @@ dependencies = [
  "unicode-ident",
 ]
 
-[[package]]
-name = "tail_merge"
-version = "0.1.0"
-dependencies = [
- "magnus",
- "rustui_merge",
-]
-
 [[package]]
 name = "unicode-ident"
 version = "1.0.18"

data/Cargo.toml

@@ -5,3 +5,4 @@
 [workspace]
 members = ["./ext/tail_merge"]
 resolver = "2"
+

data/README.md

@@ -1,19 +1,19 @@
 # TailMerge
 
-TailMerge is a super fast utility library to merge Tailwind CSS classes without conflicts.
+TailMerge is a super-fast utility library to merge Tailwind CSS classes without conflicts.
 
 ```ruby
 TailMerge.merge %w[px-2 py-1 bg-red hover:bg-dark-red p-3 bg-[#B91C1C]]
 => "hover:bg-dark-red p-3 bg-[#B91C1C]"
 ```
 
-Classes on the right will override classes on the left.
+Classes that appear later in the list override earlier ones.
 
-TailMerge wraps the Rust library [rustui_merge](https://docs.rs/rustui_merge/latest/rustui_merge/) so that it can be used in Ruby. This makes it a lot faster than combining classes in Ruby.
+By leveraging the Rust crate [rustui_merge](https://docs.rs/rustui_merge/latest/rustui_merge/), TailMerge merges classes significantly faster than pure Ruby alternatives.
 
 ## Purpose
 
-When you use Tailwindcss to style components, you will probably run into the situation where you want to adjust the styling of component in a specific situation.
+When you use Tailwind CSS to style components, you'll often want to adjust the styling of a component in certain situations.
 
 An example:
 
@@ -24,7 +24,7 @@ class Well < ApplicationComponent
   end
 
   def call
-    tag.div class: default_classes + @classes
+    tag.div class: default_classes + @classes do
       content
     end
   end
@@ -61,7 +61,7 @@ class Well < ApplicationComponent
   end
 
   def call
-    tag.div class: TailMerge.merge(default_classes + @classes)
+    tag.div class: TailMerge.merge(default_classes + @classes) do
       content
     end
   end
@@ -86,11 +86,7 @@ Run `bundle install` to install the gem.
 
 ## Usage
 
-You can pass a string or an array of strings to the `merge` method.
-
-Whatever you pass last will override whatever you pass first.
-
-A string is returned for easy use in ERB.
+You can pass either a string or an array of strings to the merge method. Values passed later override previous ones. The result is always a string, ready for use in ERB templates.
 
 ```ruby
 TailMerge.merge %w[px-2 py-1 bg-red hover:bg-dark-red p-3 bg-[#B91C1C]]
@@ -102,6 +98,54 @@ TailMerge.merge "px-2 py-1 bg-red hover:bg-dark-red p-3 bg-[#B91C1C]"
 => "hover:bg-dark-red p-3 bg-[#B91C1C]"
 ```
 
+## More speed?
+
+You can create an instance of TailMerge and call `merge` on it instead of on the `TailMerge` class. This will cache the results of the merge.
+
+This is useful in cases where you need to merge the same classes repeatedly, such as when rendering a list of the same component.
+
+```ruby
+tail_merge_instance = TailMerge.new
+tail_merge_instance.merge %w[px-2 py-1 bg-red hover:bg-dark-red p-3 bg-[#B91C1C]]
+=> "hover:bg-dark-red p-3 bg-[#B91C1C]" # Write to cache, still fast though
+
+# Second time, same key, read from cache
+tail_merge_instance.merge %w[px-2 py-1 bg-red hover:bg-dark-red p-3 bg-[#B91C1C]]
+=> "hover:bg-dark-red p-3 bg-[#B91C1C]" # Read from cache, much faster!
+
+# Third time, string key instead of array, read from same cache
+tail_merge_instance.merge "px-2 py-1 bg-red hover:bg-dark-red p-3 bg-[#B91C1C]"
+=> "hover:bg-dark-red p-3 bg-[#B91C1C]" # Read from cache, much faster!
+```
+
+This caching technique was inspired by [Tailwind Merge](https://github.com/dcastil/tailwind-merge).
+
+## Benchmark
+
+So how fast is TailMerge?
+
+I've benchmarked TailMerge with and without caching, and compared it to Tailwind Merge (also with and without caching). Here are the results:
+
+```
+                                                  user     system      total        real
+Rust: TailMerge.merge (all samples):          0.371744   0.019642   0.391386 (  0.391821)
+Rust: Cached TailMerge.merge (all samples):   0.012976   0.000580   0.013556 (  0.013560)
+Ruby: TailwindMerge each time (all samples): 51.488919   0.225130  51.714049 ( 51.883713)
+Ruby:Cached TailwindMerge (all samples):      0.019882   0.000166   0.020048 (  0.020051)
+```
+
+As you can see, TailMerge is much faster than using pure Ruby to merge classes.
+
+The benchmark loops through an array of strings and arrays and merges them 1000 times.
+
+The difference between the cached runs, obviously, is much smaller as we are basically benchmarking the cache lookup and not the actual merge.
+
+In reality, you will not need to perform 1000 merges per page, and I suspect you'll be much closer to the non-cached runs.
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/abuisman/tail_merge.
+Bug reports and pull requests are welcome on GitHub at https://github.com/abuisman/tail_merge . Merging will be done at my own pace and discretion.
+
+## License
+
+This gem is available as open source under under the MIT License.

data/Rakefile

@@ -15,7 +15,7 @@ task build: :compile
 
 GEMSPEC = Gem::Specification.load("tail_merge.gemspec")
 
-RbSys::ExtensionTask.new("tail_merge", GEMSPEC) do |ext|
+RbSys::ExtensionTask.new("merger", GEMSPEC) do |ext|
   ext.lib_dir = "lib/tail_merge"
 end
 

data/benchmark/benchmark.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require "benchmark"
+require "tailwind_merge"
+
+require "bundler/setup"
+require "tail_merge"
+
+samples = [
+  ["relative"],
+  ["self-center"],
+  ["self-start"],
+  ["shadow-inner", "size-4", "text-xs"],
+  ["shadow-inner", "size-7"],
+  ["size-10"],
+  ["static"],
+  ["upload-attachment", "flex-none", "rounded-3xl", "min-h-16", "group", "relative"],
+  ["w-full", "py-2", "px-2", "rounded-md", "w-44"],
+  "relative",
+  "self-center",
+  "self-start",
+  "shadow-inner size-4 text-xs",
+  "shadow-inner size-7",
+  "size-10",
+  "static",
+  "upload-attachment flex-none rounded-3xl min-h-16 group relative",
+  "w-full py-2 px-2 rounded-md w-44",
+  ["p-4", "px-2", "py-6", "m-3", "mx-8", "my-2", "bg-blue-500", "bg-red-600", "text-sm", "text-lg", "font-bold", "font-normal", "rounded-lg", "rounded-xl", "shadow-md", "shadow-lg", "hover:bg-blue-700", "hover:bg-red-800", "focus:ring-2", "focus:ring-4"],
+  ["grid", "flex", "inline-flex", "grid-cols-3", "grid-cols-4", "gap-2", "gap-4", "items-center", "items-start", "justify-between", "justify-center", "p-8", "p-4", "bg-gray-100", "bg-white", "border", "border-2", "rounded-full", "rounded-md"],
+  ["transform", "scale-100", "scale-110", "rotate-45", "rotate-90", "translate-x-2", "translate-x-4", "skew-y-3", "skew-y-6", "transition", "duration-200", "duration-500", "ease-in", "ease-out", "delay-150", "delay-300"],
+  ["w-full", "w-1/2", "w-3/4", "h-screen", "h-full", "h-32", "min-h-0", "min-h-full", "max-w-xs", "max-w-xl", "overflow-hidden", "overflow-scroll", "object-cover", "object-contain", "opacity-75", "opacity-100"],
+  ["text-left", "text-center", "text-right", "text-justify", "tracking-wide", "tracking-wider", "leading-tight", "leading-loose", "uppercase", "lowercase", "capitalize", "normal-case", "truncate", "line-clamp-2", "line-clamp-3"],
+  ["border-t", "border-b", "border-l", "border-r", "border-solid", "border-dashed", "border-red-500", "border-blue-600", "divide-y", "divide-x", "divide-gray-200", "divide-blue-300", "ring-2", "ring-4", "ring-offset-2"],
+  ["cursor-pointer", "cursor-wait", "select-none", "select-text", "resize", "resize-none", "z-10", "z-50", "float-left", "float-right", "clear-both", "clear-none", "box-border", "box-content"],
+  ["bg-opacity-50", "bg-opacity-75", "backdrop-blur-sm", "backdrop-blur-lg", "backdrop-filter", "filter", "brightness-90", "brightness-110", "contrast-75", "contrast-125", "saturate-50", "saturate-200"],
+  ["focus:outline-none", "focus:ring-2", "focus:ring-offset-2", "focus:border-blue-500", "hover:scale-105", "hover:rotate-3", "active:scale-95", "disabled:opacity-50", "disabled:cursor-not-allowed"],
+  ["sm:text-lg", "md:text-xl", "lg:text-2xl", "xl:text-3xl", "2xl:text-4xl", "sm:w-1/2", "md:w-2/3", "lg:w-3/4", "xl:w-full", "2xl:max-w-screen-xl", "sm:p-4", "md:p-6", "lg:p-8", "xl:p-10"],
+  ["dark:bg-gray-800", "dark:text-white", "dark:border-gray-600", "dark:hover:bg-gray-700", "dark:focus:ring-blue-800", "bg-white", "text-black", "border-gray-200", "hover:bg-gray-100"],
+  ["group-hover:scale-110", "group-hover:rotate-6", "group-focus:outline-none", "group-active:scale-95", "peer-checked:bg-blue-500", "peer-checked:text-white", "peer-disabled:opacity-50"],
+  ["animate-spin", "animate-pulse", "animate-bounce", "animate-ping", "motion-safe:animate-spin", "motion-reduce:animate-none", "transition-all", "duration-300", "ease-in-out", "delay-150"],
+  ["space-x-4", "space-x-reverse", "space-y-6", "space-y-reverse", "gap-x-4", "gap-y-6", "place-items-center", "place-content-center", "place-self-center", "content-center"],
+  ["from-blue-500", "to-purple-500", "via-pink-500", "bg-gradient-to-r", "bg-gradient-to-br", "text-transparent", "bg-clip-text", "bg-origin-border", "bg-no-repeat", "bg-cover"],
+  ["columns-2", "columns-3", "break-inside-avoid", "break-after-column", "aspect-square", "aspect-video", "object-right-top", "object-left-bottom", "isolation-auto", "mix-blend-multiply"],
+  ["first:pt-0", "last:pb-0", "odd:bg-gray-50", "even:bg-white", "first-letter:text-7xl", "first-line:uppercase", "selection:bg-yellow-200", "selection:text-black"],
+  ["[mask-type:luminance]", "[mask-type:alpha]", "[transform-style:preserve-3d]", "[clip-path:circle(50%)]", "[-webkit-text-stroke:2px]", "[text-align-last:justify]"],
+  ["will-change-scroll", "will-change-transform", "scroll-smooth", "scroll-mt-2", "scroll-pb-4", "overscroll-contain", "touch-pan-right", "touch-manipulation"],
+  ["hyphens-auto", "hyphens-manual", "text-underline-offset-2", "text-decoration-thickness-2", "indent-8", "indent-16", "vertical-align-sub", "vertical-align-super"]
+]
+
+require 'benchmark'
+require 'tail_merge'
+require 'tailwind_merge'
+
+# Pre-initialize cached mergers
+cached_merger = TailwindMerge::Merger.new
+
+tail_merge_instance = TailMerge.new
+
+puts "Benchmarking class merging strategies (whole set)..."
+puts "-" * 50
+puts
+
+Benchmark.bm(30) do |x|
+  x.report("Rust: TailMerge.merge (all samples):") do
+    1000.times do
+      samples.each do |classes|
+        TailMerge.merge(classes)
+      end
+    end
+  end
+
+  x.report("Rust: Cached TailMerge.merge (all samples):") do
+    1000.times do
+      samples.each do |classes|
+        tail_merge_instance.merge(classes)
+      end
+    end
+  end
+
+  x.report("Ruby: TailwindMerge each time (all samples):") do
+    1000.times do
+      samples.each do |classes|
+        TailwindMerge::Merger.new.merge(classes)
+      end
+    end
+  end
+
+  x.report("Ruby:Cached TailwindMerge (all samples):") do
+    1000.times do
+      samples.each do |classes|
+        cached_merger.merge(classes)
+      end
+    end
+  end
+end

data/ext/tail_merge/Cargo.toml

@@ -1,11 +1,12 @@
 [package]
-name = "tail_merge"
+name = "merger"
 version = "0.1.0"
 edition = "2021"
 authors = ["Achilleas Buisman <accounts@abuisman.nl>"]
 publish = false
 
 [lib]
+name = "merger"
 crate-type = ["cdylib"]
 
 [dependencies]

data/ext/tail_merge/extconf.rb

@@ -3,4 +3,4 @@
 require "mkmf"
 require "rb_sys/mkmf"
 
-create_rust_makefile("tail_merge/tail_merge")
+create_rust_makefile("tail_merge/merger")

data/ext/tail_merge/src/lib.rs

@@ -119,8 +119,10 @@ fn merge_tailwind_classes(args: &[Value]) -> Result<RString, Error> {
 
 #[magnus::init]
 fn init() -> Result<(), Error> {
-    let module = define_module("TailMerge")?;
-    // -1 = variable arity (positional + kw-hash)
-    module.define_singleton_method("merge", function!(merge_tailwind_classes, -1))?;
+    let ruby = Ruby::get().unwrap();
+    let tail_merge_class: magnus::RClass = ruby.class_object().const_get("TailMerge")?;
+    let merger_module = tail_merge_class.define_module("Merger")?;
+    // Assuming merge_tailwind_classes is your target function
+    merger_module.define_singleton_method("perform", function!(merge_tailwind_classes, -1))?;
     Ok(())
 }

data/lib/tail_merge/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module TailMerge
-  VERSION = "0.3.0"
+class TailMerge
+  VERSION = "0.4.1"
 end

data/lib/tail_merge.rb

@@ -1,9 +1,27 @@
 # frozen_string_literal: true
 
 require_relative "tail_merge/version"
-require_relative "tail_merge/tail_merge"
+require_relative "tail_merge/merger"
 
-module TailMerge
+# Main class for merging tailwind classes.
+class TailMerge
   class Error < StandardError; end
-  # Your code goes here...
+
+  def self.merge(classes, options = {})
+    Merger.perform(classes, options)
+  end
+
+  attr_reader :options
+
+  def initialize(options = {})
+    @options = options
+    @class_hash = {}
+  end
+
+  def merge(classes)
+    return "" if classes.empty?
+
+    classes = classes.join(" ") if classes.is_a?(Array)
+    @class_hash[classes] ||= Merger.perform(classes, options)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tail_merge
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Achilleas Buisman
@@ -36,6 +36,7 @@ files:
 - Cargo.toml
 - README.md
 - Rakefile
+- benchmark/benchmark.rb
 - ext/tail_merge/Cargo.toml
 - ext/tail_merge/extconf.rb
 - ext/tail_merge/src/lib.rs