clsx-ruby 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 043652e6d2bc00c77d0409b45cb15f361cd1fb417af14db62892be42ed2a1815
-  data.tar.gz: dbacda2ec82ed045800345914fec73339d1dfee64df87e33305a5a8b5cf7c118
+  metadata.gz: 3f20a56982120e4142d5932688887cc7f4b38a3596e01ce8aacf1f7b5b15f8d4
+  data.tar.gz: ebbd199c2d2ad139c2dda52680953778092b21708e01aef7b09d4619d932333a
 SHA512:
-  metadata.gz: 26c9443192380c6b8415923df85df04d78add5cead6a676d78739410261cbeb277f8e6c4856b15761355dd61becfc09ad6aec7870d530f78bb5d3fcfbd358893
-  data.tar.gz: 919462b5126de045d8a2b1d63ef5e3da4fb04156ef62c9c3e4985922d05dd041997fcbc473f1aab7495d61914e87b09cdf88b2f1448f0fb80b8c3c3006115763
+  metadata.gz: 5ed8a104aac715ac054d3399f6cf0c6e15a1b5a2df6307218c5f31172ebe7c1aca261d24b8b7ed23e3a06974002c2c1b9af7f857b4a4ebf4e90eea3694e75050
+  data.tar.gz: 83a0ea7711cab8e01b9eb8f71376af34e51d21bbbbd7da6091e1abe323d4145228c6e8ed44ec13f6421670ad1685a7857c531e198c100e553f77771d4183db45

data/CHANGELOG.md

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## v1.1.2
+
+### Changed
+
+- Improved gemspec description and README marketing copy
+- Switched gemspec to whitelist approach for included files
+
 ## v1.1.1
 
 ### Added

data/README.md

@@ -1,8 +1,9 @@
 # clsx-ruby [![Gem Version](https://img.shields.io/gem/v/clsx-ruby)](https://rubygems.org/gems/clsx-ruby) [![Codecov](https://img.shields.io/codecov/c/github/svyatov/clsx-ruby)](https://app.codecov.io/gh/svyatov/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)
 
-> The fastest Ruby utility for constructing CSS class strings conditionally. Perfect for Tailwind CSS utility classes. Zero dependencies.
+> The fastest, framework-agnostic conditional CSS class builder for Ruby.  
+> Perfect for ViewComponent, Phlex, Tailwind CSS or just standalone.
 
-Ruby port of the JavaScript [clsx](https://github.com/lukeed/clsx) package — a faster, smarter alternative to Rails `class_names`. Works with Rails, Sinatra, Hanami, or plain Ruby.
+Inspired by the JavaScript [clsx](https://github.com/lukeed/clsx) package. Works with any Ruby codebase.
 
 ## Quick Start
 
@@ -25,11 +26,15 @@ Clsx['btn', 'btn-primary', active: is_active, disabled: is_disabled]
 # => "btn btn-primary active" (when is_active is truthy, is_disabled is falsy)
 ```
 
+## Rails Integration
+
+For Rails integration (adds `clsx` and `cn` helpers to all views), see [clsx-rails](https://github.com/svyatov/clsx-rails).
+
 ## Why clsx-ruby?
 
 ### Blazing fast
 
-**3–8x faster** than Rails `class_names` across every scenario:
+**3-8x faster** than Rails `class_names` across every scenario:
 
 | Scenario | clsx-ruby | Rails `class_names` | Speedup |
 |---|---|---|---|
@@ -243,10 +248,6 @@ end
    Clsx['', proc {}, -> {}, nil, false, true] # => nil
    ```
 
-## Rails Integration
-
-For automatic Rails view helper integration (adds `clsx` and `cn` helpers to all views), see [clsx-rails](https://github.com/svyatov/clsx-rails).
-
 ## Development
 
 ```bash

data/lib/clsx/version.rb

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

metadata

@@ -1,15 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: clsx-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Leonid Svyatov
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
-description: A tiny utility for constructing CSS class strings conditionally
+description: Build CSS class strings from conditional expressions, hashes, arrays,
+  or nested structures. Framework-agnostic. Perfect for ViewComponent, Phlex, and
+  Tailwind CSS. Works with any Ruby codebase.
 email:
 - leonid@svyatov.com
 executables: []
@@ -17,7 +19,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
-- CLAUDE.md
 - LICENSE.txt
 - README.md
 - lib/clsx.rb
@@ -46,5 +47,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.6
 specification_version: 4
-summary: clsx / classnames for Ruby
+summary: The fastest conditional CSS class builder for Ruby
 test_files: []

data/CLAUDE.md

@@ -1,138 +0,0 @@
-# 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
-
-## Benchmarking
-
-`benchmark/original.rb` contains the **previous version** of the algorithm for comparison. It must always reflect the last committed version from the main branch — not some ancient baseline.
-
-**Rule:** Before making any algorithm or performance change to `lib/clsx/helper.rb`, copy the current main-branch implementation into `benchmark/original.rb` (wrapping in `module ClsxOriginal` — method names stay the same, no renaming needed). This ensures `bundle exec ruby benchmark/run.rb` compares the new code against its immediate predecessor, giving meaningful before/after numbers.
-
-## Commit Convention
-
-This project follows [Conventional Commits v1.0.0](https://www.conventionalcommits.org/en/v1.0.0/).
-
-Format: `<type>[optional scope]: <description>`
-
-### Types
-
-| Type | Description | Version bump |
-|------|-------------|--------------|
-| `feat` | New feature | MINOR |
-| `fix` | Bug fix | PATCH |
-| `docs` | Documentation only | — |
-| `style` | Formatting, whitespace | — |
-| `refactor` | Code change (no feature/fix) | — |
-| `perf` | Performance improvement | — |
-| `test` | Adding/fixing tests | — |
-| `build` | Build system or dependencies | — |
-| `ci` | CI configuration | — |
-| `chore` | Maintenance tasks | — |
-
-### Breaking Changes
-
-Use `!` after type or add `BREAKING CHANGE:` footer. Breaking changes trigger a MAJOR version bump.
-
-## Changelog Format
-
-This project follows [Keep a Changelog v1.1.0](https://keepachangelog.com/en/1.1.0/).
-
-Allowed categories in **required order**:
-
-1. **Added** — new features
-2. **Changed** — changes to existing functionality
-3. **Deprecated** — soon-to-be removed features
-4. **Removed** — removed features
-5. **Fixed** — bug fixes
-6. **Security** — vulnerability fixes
-
-Rules:
-- Categories must appear in the order listed above within each release section
-- Each category must appear **at most once** per release section — always append to an existing category rather than creating a duplicate
-- Do NOT use non-standard categories like "Updated", "Internal", or "Breaking changes"
-- Breaking changes should be prefixed with **BREAKING:** within the relevant category (typically Changed or Removed)
-
-`CHANGELOG.md` must stay current on every feature branch. After each commit, ensure the `## Unreleased` section at the top accurately reflects all user-facing changes on the branch. Add the section if it doesn't exist. Keep entries concise — one bullet per logical change. On release, the `## Unreleased` heading gets replaced with the version number.
-
-The unreleased section describes the **net result** compared to the last release, not a history of intermediate steps. When a later change supersedes an earlier one, update or remove the stale bullet — don't accumulate entries that no longer reflect reality.
-
-## Documentation Style
-
-All classes and methods must have YARD documentation. Follow these conventions:
-
-- Always leave a **blank line** between the main description and `@` attributes (params, return, etc.)
-- Document all public methods with description, params, and return types
-- Document all private methods with params and return types, add description for complex logic
-- Include `@example` blocks for non-obvious usage patterns
-- **Omit descriptions that just repeat the code** — if the method name and signature make it obvious, only include `@param`, `@return` tags without a description
-
-## Releasing a New Version
-
-This project follows [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html):
-- **MAJOR** — breaking changes (incompatible API changes)
-- **MINOR** — new features (backwards-compatible)
-- **PATCH** — bug fixes (backwards-compatible)
-
-1. Update `lib/clsx/version.rb` with the new version number
-2. Update `CHANGELOG.md`: change `## Unreleased` to `## vX.Y.Z` and add new empty `## Unreleased` section
-3. Commit changes: `chore: bump version to X.Y.Z`
-4. Release: `bundle exec rake release`