clsx-rails 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f910e1aa08bd5f0ed39ae1e8b6472cc5c2c7872fbccdbb11ad8269cfb8ac5ff
-  data.tar.gz: fb198c1b483216c51529869c66ed7d30b6ea4263ad7c97e9a7d9c9a077c2d8a4
+  metadata.gz: 458496856224ba13decce2fcc1c4a15efd2eb8a44f86639c7eba9ecd5a06027a
+  data.tar.gz: 10dffbb660e3888a3d1379642d9895cc2cb63acde24e15cce06ae00428517722
 SHA512:
-  metadata.gz: 7cea9003c893fbc6cd5de38f42767a4b06156176fea6fbf2c5be67aa90452546d9a9c8f53f66db2ea77c69cc98abcdeddd2814311cf5daf834b11f0c11245bf0
-  data.tar.gz: 74be5e9a20bf2e34d1e295d71ba249a8dfadcb7a9b74704de908e4289a6fc28a31f838053d13be6f29336d69981888fc8bb27c505ca5985ee9a307ac8fd12b4e
+  metadata.gz: 72edd36ee323a3a8900d949142676f0539e44e1daa965fd2a02c87d7e8ec182bb2caa69f7494468d3bc500e8ad600d320839e70e4d0f3fac41589e3a541981ff
+  data.tar.gz: b65cf587a989e8ceac0b2b71c1e6ef518e2bd0761143fba3db407e9598d7c3e69de58fe92445e69eb70deb6df77e57c1e25c1f8c61c5601bbedeab4ab417657d

data/CHANGELOG.md

@@ -1,5 +1,35 @@
-## [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
+
+## v1.0.1 (2024-03-04)
+
+### Performance Improvements
+- Speeds up the performance by 2x [`32236ed`](git@github.com:svyatov/clsx-rails/commit/32236ed)
+
+### Chore
+- Fixes CI action [`f1b948c`](git@github.com:svyatov/clsx-rails/commit/f1b948c)
+- Upload code coverage to CodeCov for the latest combination of Ruby and ActionView only [`4e5d768`](git@github.com:svyatov/clsx-rails/commit/4e5d768)
+
+### Documentation
+- Adds information about supported Ruby and Rails version [skip ci] [`2e6483f`](git@github.com:svyatov/clsx-rails/commit/2e6483f)
+- Adds link to the CodeCov badge, switch to Conventional Commits [`b48cc84`](git@github.com:svyatov/clsx-rails/commit/b48cc84)
+
+### Other
+- Updates CI badge [skip ci] [`a829613`](git@github.com:svyatov/clsx-rails/commit/a829613)
+- Adds code coverage tracking [`0c5d34c`](git@github.com:svyatov/clsx-rails/commit/0c5d34c)
+- Ignore ruby-head in the CI matrix [`f3ab4df`](git@github.com:svyatov/clsx-rails/commit/f3ab4df)
+- Better name for the GitHub Action job [`a28adb7`](git@github.com:svyatov/clsx-rails/commit/a28adb7)
+- Adds badges, fixes rubocop configuration for CI [`56fab44`](git@github.com:svyatov/clsx-rails/commit/56fab44)
+- Create dependabot.yml [`ed1e0eb`](git@github.com:svyatov/clsx-rails/commit/ed1e0eb)
+- Fixes GitHub Actions [`f58a4b2`](git@github.com:svyatov/clsx-rails/commit/f58a4b2)
+
+## v1.0.0 (2024-03-03)
+
+### Other
+- Initial commit [`f65b9b8`](git@github.com:svyatov/clsx-rails/commit/f65b9b8)
 
-- Initial release

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.0+ 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,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'set'
-require 'action_view'
 
 # :nodoc:
 module Clsx
@@ -27,7 +26,9 @@ module Clsx
     #   <div class="<%= clsx('foo', active: @is_active, 'another-class' => @condition) %>">
     #   <%= tag.div class: clsx(%w[foo bar], hidden: @condition) do ... end %>
     def clsx(*args)
-      clsx_args_processor(*args).join(' ').presence
+      result = clsx_args_processor(*args)
+      result.uniq!
+      result.join(' ').presence
     end
     alias cn clsx
 
@@ -35,19 +36,22 @@ module Clsx
 
     # @param [Mixed] args
     #
-    # @return [Set]
-    def clsx_args_processor(*args) # rubocop:disable Metrics/CyclomaticComplexity
-      result = Set.new
-      args.flatten!
+    # @return [Array]
+    def clsx_args_processor(*args) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      result = []
+      complex_keys = []
 
+      args.flatten!
       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)
 
-        arg.each { |k, v| result += clsx_args_processor(k) if v }
+        arg.each { |key, value| complex_keys << key if value }
       end
 
-      result
+      return result if complex_keys.empty?
+
+      result + clsx_args_processor(*complex_keys)
     end
   end
 end

data/lib/clsx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Clsx
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 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,14 @@
 --- !ruby/object:Gem::Specification
 name: clsx-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Leonid Svyatov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-03 00:00:00.000000000 Z
+date: 2024-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview