clsx-ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b9a68c03880d32a04dc1c721e0ee3009ac8a276f906da830e4866e2afae6ce92
+  data.tar.gz: 24155294bbdca977a8358ef7f6296febfdc86c2ca61d4faaf5b7e49b7f6d0d2a
+SHA512:
+  metadata.gz: 34de1db1360cae0f43ac95c1c5e1cb65d53294a313d5ad232afd79fe2b785e9ffab14f5b6bec527058f0cacc13354a000db1ea3479f43f0f6e17e5240a245c90
+  data.tar.gz: 4236efda398f4977ebb215ef492fd3965eff434efe9a8bccb9da4fb06023bd0bf8f32c02fabc962129a0fce7cbae34950c7936e0b3334e5da48219ddb15dc7ea

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## v1.0.0
+
+- Initial release as standalone framework-agnostic gem
+- Extracted from clsx-rails v2.0.0
+- API: `Clsx['foo', bar: true]`, `Cn['foo', bar: true]`, `include Clsx::Helper`
+- No runtime dependencies

data/CLAUDE.md

@@ -0,0 +1,66 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+clsx-ruby is a Ruby gem that provides a utility (`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 Ruby conventions. Framework-agnostic — works with Rails, Sinatra, Hanami, or plain Ruby.
+
+## 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
+
+# Release a new version (update version.rb first)
+# Builds gem, creates git tag, pushes to rubygems.org
+# OTP is fetched automatically from 1Password
+bundle exec rake release
+```
+
+## Architecture
+
+The gem has a minimal structure:
+
+- `lib/clsx.rb` - Entry point; extends `Clsx` with `Helper`, defines `Clsx[]` and `Cn[]` shortcuts
+- `lib/clsx/helper.rb` - Core implementation with `clsx` method and `cn` alias
+- `lib/clsx/version.rb` - Version constant
+
+### API
+
+- **`Clsx['foo', bar: true]`** — primary bracket API via `self.[]`
+- **`Cn['foo', bar: true]`** — short alias (defined only if `Cn` constant is not taken)
+- **`Clsx.clsx(...)`** / **`Clsx.cn(...)`** — module methods
+- **`include Clsx::Helper`** — mixin giving `clsx()` and `cn()` instance methods
+
+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 — prevents 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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024-2026 Leonid Svyatov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,160 @@
+# clsx-ruby [![Gem Version](https://img.shields.io/gem/v/clsx-ruby)](https://rubygems.org/gems/clsx-ruby) [![CI](https://github.com/svyatov/clsx-ruby/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/svyatov/clsx-ruby/actions?query=workflow%3ACI) [![GitHub License](https://img.shields.io/github/license/svyatov/clsx-ruby)](LICENSE.txt)
+
+> A tiny, framework-agnostic utility for constructing CSS class strings conditionally.
+
+Ruby port of the JavaScript [clsx](https://github.com/lukeed/clsx) package. Works with Rails, Sinatra, Hanami, or plain Ruby.
+
+For automatic Rails view helper integration, see [clsx-rails](https://github.com/svyatov/clsx-rails).
+
+## Requirements
+
+Ruby 3.2+. No runtime dependencies.
+
+## Installation
+
+```bash
+bundle add clsx-ruby
+```
+
+Or add it manually to the Gemfile:
+
+```ruby
+gem 'clsx-ruby', '~> 1.0'
+```
+
+## Usage
+
+### Bracket API (recommended)
+
+```ruby
+require 'clsx'
+
+Clsx['foo', 'bar']
+# => 'foo bar'
+
+Clsx['foo', bar: true, baz: false]
+# => 'foo bar'
+
+Clsx['btn', 'btn-primary', active: is_active, disabled: is_disabled]
+# => 'btn btn-primary active' (when is_active is truthy, is_disabled is falsy)
+```
+
+### Short alias
+
+```ruby
+Cn['foo', bar: true]
+# => 'foo bar'
+```
+
+`Cn` is defined only if the constant is not already taken.
+
+### Mixin
+
+```ruby
+include Clsx::Helper
+
+clsx('foo', 'bar')
+# => 'foo bar'
+
+cn(hidden: @hidden, 'text-bold': @bold)
+# => 'hidden text-bold' (when both are truthy)
+```
+
+### Module methods
+
+```ruby
+Clsx.clsx('foo', 'bar')
+# => 'foo bar'
+
+Clsx.cn('foo', bar: true)
+# => 'foo bar'
+```
+
+### Input types
+
+```ruby
+# Strings (variadic)
+Clsx['foo', true && 'bar', 'baz']
+# => 'foo bar baz'
+
+# Hashes
+Clsx[foo: true, bar: false, baz: a_truthy_method]
+# => 'foo baz'
+
+# Hashes (variadic)
+Clsx[{ foo: true }, { bar: false }, nil, { '--foobar': 'hello' }]
+# => 'foo --foobar'
+
+# Arrays
+Clsx[['foo', nil, false, 'bar']]
+# => 'foo bar'
+
+# Arrays (variadic)
+Clsx[['foo'], ['', nil, false, 'bar'], [['baz', [['hello'], 'there']]]]
+# => 'foo bar baz hello there'
+
+# Kitchen sink (with nesting)
+Clsx['foo', ['bar', { baz: false, bat: nil }, ['hello', ['world']]], 'cya']
+# => 'foo bar hello world cya'
+```
+
+### Framework examples
+
+```erb
+<%# Rails %>
+<%= tag.div class: Clsx['foo', 'baz', 'is-active': @active] do %>
+  Hello, world!
+<% end %>
+```
+
+```ruby
+# Sinatra
+erb :"<div class='#{Clsx['nav', active: @active]}'>...</div>"
+```
+
+## Differences from JavaScript clsx
+
+1. **Falsy values** — In Ruby only `false` and `nil` are falsy, so `0`, `''`, `[]`, `{}` are all truthy:
+   ```ruby
+   Clsx['foo' => 0, bar: []] # => 'foo bar'
+   ```
+
+2. **Complex hash keys** — Any valid `clsx` input works as a hash key:
+   ```ruby
+   Clsx[[{ foo: true }, 'bar'] => true] # => 'foo bar'
+   ```
+
+3. **Ignored values** — Boolean `true` and `Proc`/lambda objects are silently ignored:
+   ```ruby
+   Clsx['', proc {}, -> {}, nil, false, true] # => nil
+   ```
+
+4. **Returns `nil`** when no classes apply (not an empty string). This prevents rendering empty `class=""` attributes in template engines that skip `nil`:
+   ```ruby
+   Clsx[nil, false] # => nil
+   ```
+
+5. **Deduplication** — Duplicate classes are automatically removed:
+   ```ruby
+   Clsx['foo', 'foo'] # => 'foo'
+   ```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt.
+
+There is a benchmark suite in the `benchmark` directory. Run it with `bundle exec ruby benchmark/run.rb`.
+
+## Conventional Commits
+
+This project uses [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for commit messages.
+
+Types: `feat`, `fix`, `perf`, `chore`, `docs`, `refactor`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/svyatov/clsx-ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/clsx/helper.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+# :nodoc:
+module Clsx
+  # :nodoc:
+  module Helper
+    # The clsx function can take any number of arguments,
+    # each of which can be Hash, Array, Boolean, String, or Symbol.
+    #
+    # **Important**
+    # Any falsy values are discarded! Standalone Boolean values are discarded as well.
+    #
+    # @param [Mixed] args
+    #
+    # @return [String] the joined class names
+    #
+    # @example
+    #   clsx('foo', 'bar') # => 'foo bar'
+    #   clsx(true, { bar: true }) # => 'bar'
+    #   clsx('foo', { bar: false }) # => 'foo'
+    #   clsx({ bar: true }, 'baz', { bat: false }) # => 'bar baz'
+    #
+    # @example within a view
+    #   <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)
+      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
+
+    # 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|
+        klass = arg.class
+
+        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
+
+      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

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

data/lib/clsx.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative 'clsx/version'
+require_relative 'clsx/helper'
+
+# :nodoc:
+module Clsx
+  extend Helper
+
+  def self.[](*)
+    clsx(*)
+  end
+end
+
+# Short alias — only defined if `Cn` is not already taken
+unless Object.const_defined?(:Cn)
+  # :nodoc:
+  module Cn
+    def self.[](*)
+      Clsx[*]
+    end
+  end
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: clsx-ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Leonid Svyatov
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: A tiny utility for constructing CSS class strings conditionally
+email:
+- leonid@svyatov.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CLAUDE.md
+- LICENSE.txt
+- README.md
+- lib/clsx.rb
+- lib/clsx/helper.rb
+- lib/clsx/version.rb
+homepage: https://github.com/svyatov/clsx-ruby
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/svyatov/clsx-ruby
+  changelog_uri: https://github.com/svyatov/clsx-ruby/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.4
+specification_version: 4
+summary: clsx / classnames for Ruby
+test_files: []