clsx-rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8f910e1aa08bd5f0ed39ae1e8b6472cc5c2c7872fbccdbb11ad8269cfb8ac5ff
+  data.tar.gz: fb198c1b483216c51529869c66ed7d30b6ea4263ad7c97e9a7d9c9a077c2d8a4
+SHA512:
+  metadata.gz: 7cea9003c893fbc6cd5de38f42767a4b06156176fea6fbf2c5be67aa90452546d9a9c8f53f66db2ea77c69cc98abcdeddd2814311cf5daf834b11f0c11245bf0
+  data.tar.gz: 74be5e9a20bf2e34d1e295d71ba249a8dfadcb7a9b74704de908e4289a6fc28a31f838053d13be6f29336d69981888fc8bb27c505ca5985ee9a307ac8fd12b4e

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [1.0.0] - 2024-03-03
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 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-rails
+
+> A tiny Rails view helper for constructing CSS class strings conditionally.
+
+This gem is essentially a clone if the [clsx](https://github.com/lukeed/clsx) npm package.
+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.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add clsx-rails
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install clsx-rails
+
+## Usage
+
+The `clsx` 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.
+
+```ruby
+# Strings (variadic)
+clsx('foo', true && 'bar', 'baz')
+# => 'foo bar baz'
+
+# Hashes
+cn({ foo: true, bar: false, baz: a_method_that_returns_true })
+# => 'foo baz'
+
+# Hashes (variadic)
+clsx({ foo: true }, { bar: false }, nil, { '--foobar': 'hello' })
+# => 'foo --foobar'
+
+# Arrays
+cn(['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)
+cn('foo', ['bar', { baz: false, bat: nil }, ['hello', ['world']]], 'cya');
+# => 'foo bar hello world cya'
+```
+
+```erb
+<%= tag.div class: clsx('foo', 'baz', 'is-active' => @active) do %>
+  Hello, world!
+<% end %>
+
+<div class="<%= clsx('foo', 'baz', 'is-active' => @active) %>">
+  Hello, world!
+</div>
+```
+
+```haml
+%div{class: clsx('foo', 'baz', 'is-active' => @active)}
+  Hello, world!
+```
+
+```slim
+div class=clsx('foo', 'baz', 'is-active' => @active)
+  | Hello, world!
+```
+
+So the basic idea is to get rid of constructions like this in your views:
+
+```erb
+<% classes = ['foo', 'baz'] %>
+<% classes << 'is-active' if @active %>
+
+<div class="<%= classes.join(' ') %>">
+  Hello, world!
+</div>
+```
+
+or like this:
+
+```erb
+<div class="<%= ['foo', 'baz', @active ? 'is-active' : nil].compact.join(' ') %>">
+  Hello, world!
+</div>
+```
+
+or like this:
+
+```erb
+<div class="foo bar <%= 'is-active' if @active %>">
+  Hello, world!
+</div>
+```
+
+## Differences from the original `clsx` package
+
+This gem reproduces the functionality of the original `clsx` package, but with nuances of Ruby and Rails in mind.
+
+The main differences are:
+
+1. falsy values in Ruby are only `false` and `nil`, so the `clsx` method will not accept `0`, `''`, `[]`, `{}`, etc. as falsy values.
+   ```ruby
+    clsx('foo' => 0, bar: []) # => 'foo bar'
+   ``` 
+ 
+2. `clsx-rails` supports complex hash keys, like `{ %[foo bar] => true }`, which will be converted to `foo bar` in the resulting string.
+   Meaning, if it's a valid input for the `clsx-rails`, it's a valid hash key.
+   ```ruby
+    clsx([{ foo: true }, 'bar'] => true) # => 'foo bar'
+   ``` 
+ 
+3. `clsx-rails` will ignore objects that are `blank?`, boolean (`true` or `false`), or an instance of `Proc` (so, procs and lambdas).
+    ```ruby
+     clsx('', [], {}, proc {}, -> {}, nil, false, true) # => nil
+    ```
+ 
+4. `clsx-rails` returns `nil` if there are no classes to apply, instead of an empty string.
+   The reason for that is not to pollute the HTML with empty `class` attributes when using Rails tag helpers: Rails will not render the `class` attribute if it's `nil`.
+   ```ruby
+     clsx(nil, false) # => nil
+   ```
+   Although, it won't help if you're using it directly in erb:
+   ```erb
+    <div class="<%= clsx(nil, false) %>">
+      Hello, world!
+    </div>
+   ```
+   This code will render `<div class="">Hello, world!</div>` anyway.
+ 
+5. `clsx-rails` eliminates duplicate classes:
+   ```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 that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and the created tag, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+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.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/svyatov/clsx-rails.
+
+## 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,53 @@
+# 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.
+    #
+    # **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 %>
+    def clsx(*args)
+      clsx_args_processor(*args).join(' ').presence
+    end
+    alias cn clsx
+
+    private
+
+    # @param [Mixed] args
+    #
+    # @return [Set]
+    def clsx_args_processor(*args) # rubocop:disable Metrics/CyclomaticComplexity
+      result = Set.new
+      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 }
+      end
+
+      result
+    end
+  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-rails.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'active_support'
+
+require_relative 'clsx/version'
+require_relative 'clsx/helper'
+
+# :nodoc:
+module Clsx
+  ActiveSupport.on_load(:action_view) { include Helper }
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: clsx-rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Leonid Svyatov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+description: A tiny Rails view helper for constructing CSS class strings conditionally
+email:
+- leonid@svyatov.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/clsx-rails.rb
+- lib/clsx/helper.rb
+- lib/clsx/version.rb
+homepage: https://github.com/svyatov/clsx-rails
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/svyatov/clsx-rails
+  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
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.6
+signing_key:
+specification_version: 4
+summary: clsx / classnames for Rails views
+test_files: []