clsx-rails 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f910e1aa08bd5f0ed39ae1e8b6472cc5c2c7872fbccdbb11ad8269cfb8ac5ff
-  data.tar.gz: fb198c1b483216c51529869c66ed7d30b6ea4263ad7c97e9a7d9c9a077c2d8a4
+  metadata.gz: 5ac79817d0d2f653dbc76e4f3d044c6d599f342acecc1c6d6c6639dbbdec1ecf
+  data.tar.gz: ce38f0509202614f8aeab6f16f0079eb93d686e6c5c42d48170af8d50ccd801b
 SHA512:
-  metadata.gz: 7cea9003c893fbc6cd5de38f42767a4b06156176fea6fbf2c5be67aa90452546d9a9c8f53f66db2ea77c69cc98abcdeddd2814311cf5daf834b11f0c11245bf0
-  data.tar.gz: 74be5e9a20bf2e34d1e295d71ba249a8dfadcb7a9b74704de908e4289a6fc28a31f838053d13be6f29336d69981888fc8bb27c505ca5985ee9a307ac8fd12b4e
+  metadata.gz: 0c8e9e1d7100c07f7336b9a8ac4fd699b4a1a90f78bd4c2fa51cdd931583948913d9622e901a17f3fa03104fbebca4f92ac07df50287a1f4209bb531cf4886fe
+  data.tar.gz: 155e24fb75550a7a12e050fc20089fc9677e0435d7b08f0412d65b19a727f7fbca2cb86cbb0d7cf6df44b037e4e515efa947c42d2da9f020805ac8c4461d7e58

data/CHANGELOG.md

@@ -1,5 +1,57 @@
-## [Unreleased]
+# Changelog
 
-## [1.0.0] - 2024-03-03
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) and to [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
+
+## Unreleased changes
+
+## v2.0.0 (2025-01-11)
+
+### Breaking Changes
+- Drop Rails 6.1 and 7.0 support, require Rails 7.1+
+
+### Features
+- Add Ruby 3.4 support
+- Add Rails 8.0, 8.1, and edge support
+
+### Performance Improvements
+- Rewrite algorithm for 2-5x performance improvement
+- Add fast-paths for single string, string array, and simple hash
+- Use Hash-based deduplication instead of Array + `uniq!`
+- Use `Symbol#name` instead of `to_s` for faster symbol conversion
+- Use direct class comparison for type checking
+- Remove unused `require 'set'`
+
+### Chore
+- Refactor benchmark infrastructure (data.rb, original.rb, quick.rb, run.rb)
+- Add CLAUDE.md for AI coding assistants
+
+## v1.0.1 (2024-03-04)
+
+### Performance Improvements
+- Speeds up the performance by 2x [`32236ed`](https://github.com/svyatov/clsx-rails/commit/32236ed)
+
+### Chore
+- Fixes CI action [`f1b948c`](https://github.com/svyatov/clsx-rails/commit/f1b948c)
+- Upload code coverage to CodeCov for the latest combination of Ruby and ActionView only [`4e5d768`](https://github.com/svyatov/clsx-rails/commit/4e5d768)
+
+### Documentation
+- Changelog update + version bump [`13b408d`](https://github.com/svyatov/clsx-rails/commit/13b408d)
+- Adds information about supported Ruby and Rails version [skip ci] [`2e6483f`](https://github.com/svyatov/clsx-rails/commit/2e6483f)
+- Adds link to the CodeCov badge, switch to Conventional Commits [`b48cc84`](https://github.com/svyatov/clsx-rails/commit/b48cc84)
+
+### Other
+- Updates CI badge [skip ci] [`a829613`](https://github.com/svyatov/clsx-rails/commit/a829613)
+- Adds code coverage tracking [`0c5d34c`](https://github.com/svyatov/clsx-rails/commit/0c5d34c)
+- Ignore ruby-head in the CI matrix [`f3ab4df`](https://github.com/svyatov/clsx-rails/commit/f3ab4df)
+- Better name for the GitHub Action job [`a28adb7`](https://github.com/svyatov/clsx-rails/commit/a28adb7)
+- Adds badges, fixes rubocop configuration for CI [`56fab44`](https://github.com/svyatov/clsx-rails/commit/56fab44)
+- Create dependabot.yml [`ed1e0eb`](https://github.com/svyatov/clsx-rails/commit/ed1e0eb)
+- Fixes GitHub Actions [`f58a4b2`](https://github.com/svyatov/clsx-rails/commit/f58a4b2)
+
+## v1.0.0 (2024-03-03)
+
+### Other
+- Initial commit [`f65b9b8`](https://github.com/svyatov/clsx-rails/commit/f65b9b8)
 
-- Initial release

data/CLAUDE.md

@@ -0,0 +1,54 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+clsx-rails is a Ruby gem that provides a Rails view helper (`clsx`/`cn`) for constructing CSS class strings conditionally. It's a Ruby port of the JavaScript [clsx](https://github.com/lukeed/clsx) package, adapted for Rails conventions.
+
+## Common Commands
+
+```bash
+# Run all tests and linting (default rake task)
+bundle exec rake
+
+# Run tests only
+bundle exec rake test
+
+# Run a single test file
+bundle exec ruby -Itest test/clsx/helper_test.rb
+
+# Run a specific test method
+bundle exec ruby -Itest test/clsx/helper_test.rb -n test_with_strings
+
+# Run linter
+bundle exec rake rubocop
+
+# Run benchmark
+bundle exec ruby benchmark/run.rb
+
+# Install dependencies
+bin/setup
+```
+
+## Architecture
+
+The gem has a minimal structure:
+
+- `lib/clsx-rails.rb` - Entry point that auto-includes the helper into ActionView via `ActiveSupport.on_load`
+- `lib/clsx/helper.rb` - Core implementation with `clsx` method and `cn` alias
+- `lib/clsx/version.rb` - Version constant
+
+The helper uses an optimized algorithm with fast-paths for common cases (single string, string array, simple hash) and Hash-based deduplication for complex inputs.
+
+## Key Behaviors
+
+- Returns `nil` (not empty string) when no classes apply - this prevents Rails from rendering empty `class=""` attributes
+- Eliminates duplicate classes automatically
+- Ruby falsy values are only `false` and `nil` (unlike JS, `0`, `''`, `[]`, `{}` are truthy)
+- Ignores `Proc`/lambda objects and boolean `true` values
+- Supports complex hash keys like `{ %w[foo bar] => true }` which resolve recursively
+
+## Commit Convention
+
+Uses [Conventional Commits](https://www.conventionalcommits.org/): `feat`, `fix`, `perf`, `chore`, `docs`, `refactor`

data/README.md

@@ -1,4 +1,4 @@
-# clsx-rails
+# clsx-rails [![Gem Version](https://img.shields.io/gem/v/clsx-rails)](https://rubygems.org/gems/clsx-rails) [![Codecov](https://img.shields.io/codecov/c/github/svyatov/clsx-rails)](https://app.codecov.io/gh/svyatov/clsx-rails) [![CI](https://github.com/svyatov/clsx-rails/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/svyatov/clsx-rails/actions?query=workflow%3ACI) [![GitHub License](https://img.shields.io/github/license/svyatov/clsx-rails)](LICENSE.txt)
 
 > A tiny Rails view helper for constructing CSS class strings conditionally.
 
@@ -6,21 +6,29 @@ This gem is essentially a clone if the [clsx](https://github.com/lukeed/clsx) np
 It provides a simple way to conditionally apply classes to HTML elements in Rails views.
 It is especially useful when you have a lot of conditional classes and you want to keep your views clean and readable.
 
+## Supported Ruby and Rails versions
+
+Ruby 3.1+ and Rails 7.1+ are supported.
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add clsx-rails
+```bash
+bundle add clsx-rails
+```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Or add it manually to the Gemfile:
 
-    $ gem install clsx-rails
+```ruby
+gem 'clsx-rails', '~> 1.0'
+```
 
 ## Usage
 
-The `clsx` method can be used in views to conditionally apply classes to HTML elements.
+The `clsx` helper method can be used in views to conditionally apply classes to HTML elements.
 You can also use a slightly more conise `cn` alias.
-It accepts a variety of arguments and returns a string of classes.
+It accepts a variety of arguments and returns a string of unique classes.
 
 ```ruby
 # Strings (variadic)
@@ -151,6 +159,18 @@ There is a simple benchmark script in the `benchmark` directory.
 You can run it with `bundle exec ruby benchmark/run.rb`.
 I've added it for easier performance testing when making changes to the gem.
 
+## Conventional Commits
+
+This project uses [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for commit messages.
+
+Types of commits are:
+- `feat`: a new feature
+- `fix`: a bug fix
+- `perf`: code that improves performance
+- `chore`: updating build tasks, configs, formatting etc; no code change
+- `docs`: changes to documentation
+- `refactor`: refactoring code
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/svyatov/clsx-rails.

data/lib/clsx/helper.rb

@@ -1,16 +1,14 @@
 # frozen_string_literal: true
 
-require 'set'
-require 'action_view'
-
 # :nodoc:
 module Clsx
   # :nodoc:
   module Helper
     # The clsx function can take any number of arguments,
-    # each of which can be an Hash, Array, Boolean, String, or Symbol.
+    # each of which can be Hash, Array, Boolean, String, or Symbol.
     #
-    # **Important**: Any falsy values are discarded! Standalone Boolean values are discarded as well.
+    # **Important**
+    # Any falsy values are discarded! Standalone Boolean values are discarded as well.
     #
     # @param [Mixed] args
     #
@@ -26,28 +24,97 @@ module Clsx
     #   <div class="<%= clsx('foo', 'bar') %>">
     #   <div class="<%= clsx('foo', active: @is_active, 'another-class' => @condition) %>">
     #   <%= tag.div class: clsx(%w[foo bar], hidden: @condition) do ... end %>
+    #
+    # @note Implementation prioritizes performance over readability.
+    #   Direct class comparisons and explicit conditionals are used
+    #   instead of more idiomatic Ruby patterns for speed.
+
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
     def clsx(*args)
-      clsx_args_processor(*args).join(' ').presence
+      return nil if args.empty?
+
+      # Fast path: single argument (most common cases)
+      if args.size == 1
+        arg = args[0]
+        klass = arg.class
+
+        if klass == String
+          return arg.empty? ? nil : arg
+        elsif klass == Symbol
+          return arg.name
+        elsif klass == Array && arg.all?(String)
+          seen = {}
+          arg.each { |s| seen[s] = true unless s.empty? || seen.key?(s) }
+          return seen.empty? ? nil : seen.keys.join(' ')
+        elsif klass == Hash
+          return clsx_simple_hash(arg)
+        end
+      end
+
+      seen = {}
+      clsx_process(args, seen)
+      seen.empty? ? nil : seen.keys.join(' ')
     end
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+
     alias cn clsx
 
     private
 
-    # @param [Mixed] args
-    #
-    # @return [Set]
-    def clsx_args_processor(*args) # rubocop:disable Metrics/CyclomaticComplexity
-      result = Set.new
-      args.flatten!
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+    def clsx_simple_hash(hash)
+      return nil if hash.empty?
+
+      seen = {}
+      hash.each do |key, value|
+        next unless value
+
+        klass = key.class
+
+        if klass == Symbol
+          seen[key.name] = true
+        elsif klass == String
+          seen[key] = true unless key.empty?
+        else
+          # Complex key - fall back to full processing
+          seen = {}
+          clsx_process([hash], seen)
+          return seen.empty? ? nil : seen.keys.join(' ')
+        end
+      end
+
+      seen.empty? ? nil : seen.keys.join(' ')
+    end
+
+    # rubocop:disable Style/MultipleComparison
+    def clsx_process(args, seen)
+      deferred = nil
 
       args.each do |arg|
-        next if arg.blank? || arg.is_a?(TrueClass) || arg.is_a?(Proc)
-        next result << arg.to_s unless arg.is_a?(Hash)
+        klass = arg.class
 
-        arg.each { |k, v| result += clsx_args_processor(k) if v }
+        if klass == String
+          seen[arg] = true unless arg.empty? || seen.key?(arg)
+        elsif klass == Symbol
+          str = arg.name
+          seen[str] = true unless seen.key?(str)
+        elsif klass == Array
+          clsx_process(arg, seen)
+        elsif klass == Hash
+          arg.each { |key, value| (deferred ||= []) << key if value }
+        elsif klass == Integer || klass == Float
+          str = arg.to_s
+          seen[str] = true unless seen.key?(str)
+        elsif klass == NilClass || klass == FalseClass || klass == TrueClass || klass == Proc
+          next
+        else
+          str = arg.to_s
+          seen[str] = true unless str.empty? || seen.key?(str)
+        end
       end
 
-      result
+      clsx_process(deferred, seen) if deferred
     end
+    # rubocop:enable Style/MultipleComparison, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
   end
 end

data/lib/clsx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Clsx
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 end

data/lib/clsx-rails.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'active_support'
+require 'action_view'
 
 require_relative 'clsx/version'
 require_relative 'clsx/helper'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: clsx-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Leonid Svyatov
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-03 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -16,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.1'
 description: A tiny Rails view helper for constructing CSS class strings conditionally
 email:
 - leonid@svyatov.com
@@ -32,6 +31,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
+- CLAUDE.md
 - LICENSE.txt
 - README.md
 - lib/clsx-rails.rb
@@ -45,7 +45,6 @@ metadata:
   source_code_uri: https://github.com/svyatov/clsx-rails
   changelog_uri: https://github.com/svyatov/clsx-rails/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -60,8 +59,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: clsx / classnames for Rails views
 test_files: []