tail_merge 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df9120474172d53dc79d7592c20832032545e05572a437c63b7d342cfd2bb33a
-  data.tar.gz: 24e6b1bc37558804a3a4fa4afdd06b4a4d21e5ace5ed349def07a5d0b2768584
+  metadata.gz: 163e2f04ba6092bb1d8a0e268dab58a087c9f853edc52ba1ae091cc6b2c7ece4
+  data.tar.gz: e0aa6a361b8e4219a783b6a00b099ca8dfe6b8c82ae071b2cac8ea4f79d268ce
 SHA512:
-  metadata.gz: 904e825d0f09aace9c811225fa59c455eb473d958843b587be89e91dcf2d080ac373c73147699ed3f93ebfed28f9570e2e58025d95eb48ebce4c92e889c25e53
-  data.tar.gz: 83604251ac57755a2106dfab3544379d8f234fffe3440599ea03a2c217085aa1b9dff583ba3a6041df9e2bffc72713f89aaaf6273c4942d1c1838ee0e622464e
+  metadata.gz: f5071ee3b5bccf88d692a1863e2d7f4a1c37fd00f13786dd685127a557b5c23f064ece27f8e99f2719aae2e989b52ff09c1cc2395fc7977ceb2a8f7e1704193d
+  data.tar.gz: 8debb6513dc3035e7acab2ee0ebd58cb4ff265d523c28a17dc77d64fb7930faa02c91c8371875307525c6c63b50080d86f0c1ef20679be7a73077b2d6b76716d

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]]
@@ -106,6 +102,8 @@ TailMerge.merge "px-2 py-1 bg-red hover:bg-dark-red p-3 bg-[#B91C1C]"
 
 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]]
@@ -120,30 +118,34 @@ 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)](https://github.com/gjtorikian/tailwind_merge).
+This caching technique was inspired by [Tailwind Merge](https://github.com/dcastil/tailwind-merge).
 
 ## Benchmark
 
-So how fast/much faster is TailMerge?
+So how fast is TailMerge?
 
-I've benchmarked TailMerge with an instance (cached) and without an instance against Tailwind Merge with (cached) and without a merger instance, and these are the results:
+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.216178   0.001744   0.217922 (  0.219441)
-Rust: Cached TailMerge.merge (all samples):   0.005465   0.000092   0.005557 (  0.005581)
-Ruby: TailwindMerge each time (all samples): 50.391383   0.494058  50.885441 ( 52.272354)
-Ruby:Cached TailwindMerge (all samples):      0.011672   0.000140   0.011812 (  0.011813)
+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 using pure Ruby to merge classes.
+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 we will not deal with 1000 merges to be done per page and I suspect you'd be much closer to the non-cached runs.
+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 . Merging will be done at my own pace and discretion.
+
+## License
+
+This gem is available as open source under under the MIT License.

data/benchmark/benchmark.rb

@@ -56,9 +56,6 @@ cached_merger = TailwindMerge::Merger.new
 
 tail_merge_instance = TailMerge.new
 
-# Normalize all samples to strings
-normalized_samples = samples.map { |classes| classes.is_a?(Array) ? classes.join(' ') : classes }
-
 puts "Benchmarking class merging strategies (whole set)..."
 puts "-" * 50
 puts
@@ -66,7 +63,7 @@ puts
 Benchmark.bm(30) do |x|
   x.report("Rust: TailMerge.merge (all samples):") do
     1000.times do
-      normalized_samples.each do |classes|
+      samples.each do |classes|
         TailMerge.merge(classes)
       end
     end
@@ -74,7 +71,7 @@ Benchmark.bm(30) do |x|
 
   x.report("Rust: Cached TailMerge.merge (all samples):") do
     1000.times do
-      normalized_samples.each do |classes|
+      samples.each do |classes|
         tail_merge_instance.merge(classes)
       end
     end
@@ -82,7 +79,7 @@ Benchmark.bm(30) do |x|
 
   x.report("Ruby: TailwindMerge each time (all samples):") do
     1000.times do
-      normalized_samples.each do |classes|
+      samples.each do |classes|
         TailwindMerge::Merger.new.merge(classes)
       end
     end
@@ -90,7 +87,7 @@ Benchmark.bm(30) do |x|
 
   x.report("Ruby:Cached TailwindMerge (all samples):") do
     1000.times do
-      normalized_samples.each do |classes|
+      samples.each do |classes|
         cached_merger.merge(classes)
       end
     end

data/lib/tail_merge/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tail_merge
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Achilleas Buisman