clsx 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33af2843149edd1b19b3aa92deba184a299fed74da1700732f9efe88489ba95a
-  data.tar.gz: 96747f817c0e25dafbd079923278a7a6551ba68c8ab23f509498d8993d85f4ae
+  metadata.gz: 16b3171bd57263e7a62fc9303c180032f9ae66a6aeb203e965ed669d1299fafa
+  data.tar.gz: 06f2dde23148ba2c6a1b4994404635f41b664bdeed52ef7db36fdcd81d7aa63a
 SHA512:
-  metadata.gz: 4a81c07a59b55d498fc8e1d7b3f705da0e33aa24b319f5aadbace08f8deaa510a8724009fabe5a450f4d43d02534f084738dcb5f27855804f35a9c9a99e96450
-  data.tar.gz: 51ddc05377658fcfd59c49daf86d69e21589666bf20ce21c7f1578fe83de7e9fcde87e2201bdab9c11c2040c1f860971f88d551886a2d628f491463f59342065
+  metadata.gz: 28f8655c985f735272854fd03ff64d484f06f5c0f63960ce832f9ecfed4f0ebcff0db3f3b100ffe24d8dd33b82c06e2564d0d1fe52e222c98fa62f38d5c0cbcb
+  data.tar.gz: 101ddbc96d910cf315ad4010a9656d4c0a0492298cd588b4e2d7bbf1782c59bdf262659d89ba967b2e33f18dac6743bff69fd5dd172ec1ce1bf20c93c7554598

data/.overcommit.yml

@@ -0,0 +1,6 @@
+PreCommit:
+  StandardRB:
+    enabled: true
+    required: true
+    command: ['bundle', 'exec', 'standardrb']
+    flags: ['--fix']

data/CHANGELOG.md

@@ -1,5 +1,51 @@
 ## [Unreleased]
+## [0.1.2] - 2024-03-02
+PUBLIC RELEASE
 
-## [0.1.0] - 2022-11-01
+## [0.1.1] - 2024-03-03
+### Changed
+- Changed `clsx` to `CLSX`
+
+
+## [0.1.0] - 2024-03-02
 
 - Initial release
+
+These examples should be working
+
+Strings (variadic)
+```ruby
+  clsx("foo", true && "bar", "baz")
+  #=> "foo bar baz"
+```
+
+Objects
+```ruby
+  clsx({ foo:true, bar:false, baz:is_true? })
+  #=> "foo baz"
+```
+
+Objects (variadic)
+```ruby
+  clsx({ foo:true }, { bar:false }, null, { "--foobar":"hello" })
+  #=> "foo --foobar"
+```
+
+Arrays
+```ruby
+  clsx(["foo", 0, false, "bar"])
+  #=> "foo bar"
+```
+
+Arrays (variadic)
+```ruby
+  clsx(["foo"], ["", 0, false, "bar"], [["baz", [["hello"], "there"]]])
+  #=> "foo bar baz hello there"
+```
+
+Kitchen sink (with nesting)
+```ruby
+  clsx("foo", [1 && "bar", { baz:false, bat:null }, ["hello", ["world"]]], "cya")
+  #=> "foo bar hello world cya"
+```
+

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 Marco Roth
+Copyright (c) 2024 Seth Horsley
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,18 +1,58 @@
-# CLSX
+# Clsx
+## A gem for constructing HTML class strings conditionally
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/clsx`. To experiment with that code, run `bin/console` for an interactive prompt.
+Ruby utility for constructing HTML class strings conditionally with the provided syntax, you can define a module named Clsx that includes a method to handle each case: strings, objects (hashes), arrays, and a combination of these with nested structures. This method will recursively process each argument, filter out falsy values, and concatenate the truthy values into a single string.
 
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add clsx
+    $ bundle add "clsx"
 
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install clsx
 
 ## Usage
+Strings (variadic)
+```ruby
+  clsx("foo", true && "bar", "baz")
+  #=> "foo bar baz"
+```
+
+Objects
+```ruby
+  clsx({ foo:true, bar:false, baz:is_true? })
+  #=> "foo baz"
+```
+
+Objects (variadic)
+```ruby
+  clsx({ foo:true }, { bar:false }, null, { "--foobar":"hello" })
+  #=> "foo --foobar"
+```
+
+Arrays
+```ruby
+  clsx(["foo", 0, false, "bar"])
+  #=> "foo bar"
+```
+
+Arrays (variadic)
+```ruby
+  clsx(["foo"], ["", 0, false, "bar"], [["baz", [["hello"], "there"]]])
+  #=> "foo bar baz hello there"
+```
+
+Kitchen sink (with nesting)
+```ruby
+  clsx("foo", [1 && "bar", { baz:false, bat:null }, ["hello", ["world"]]], "cya")
+  #=> "foo bar hello world cya"
+```
+
+You can also use clsx in rails views like this:
+```ruby
+  <div class="<%= clsx({ 'border': true, "border-t": false, "border-b":true }) %>">
+    <!-- ... -->
+  </div>
+```
 
 
 ## Development
@@ -23,7 +63,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/marcoroth/clsx. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/marcoroth/clsx/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome. Just fork this repo make the changes you want and submit a pull request back to this repo :)
 
 ## License
 
@@ -31,4 +71,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Clsx project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/marcoroth/clsx/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Clsx project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/clsx/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,16 +1,8 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-require "rake/testtask"
+require "minitest/test_task"
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
-end
+Minitest::TestTask.create
 
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: %i[test rubocop]
+task default: :test

data/lib/clsx/railtie.rb

@@ -0,0 +1,18 @@
+require "clsx"
+require "rails"
+
+module Clsx
+  class Railtie < Rails::Railtie
+    initializer "clsx.action_view" do
+      ActiveSupport.on_load :action_view do
+        ActionView::Base.send :include, Helper
+      end
+    end
+  end
+
+  module Helper
+    def clsx(*)
+      CLSX.clsx(*)
+    end
+  end
+end

data/lib/clsx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CLSX
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/clsx.rb

@@ -1,6 +1,23 @@
 # frozen_string_literal: true
 
 require_relative "clsx/version"
+require "clsx/railtie" if defined?(Rails)
 
 module CLSX
+  class Error < StandardError; end
+
+  def self.clsx(*args)
+    args.flat_map { |arg| parse(arg) }.compact.join(" ")
+  end
+
+  def self.parse(arg)
+    case arg
+    when String
+      arg unless arg.empty?
+    when Hash
+      arg.map { |k, v| k if v }.compact
+    when Array
+      arg.flat_map { |a| parse(a) }
+    end
+  end
 end

data/sig/clsx.rbs

@@ -1,3 +1,4 @@
 module CLSX
   VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
 end

metadata

@@ -1,41 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: clsx
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
-- Marco Roth
+- Seth Horsley
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-01 00:00:00.000000000 Z
+date: 2024-03-03 00:00:00.000000000 Z
 dependencies: []
-description: A tiny utility for constructing CSS class strings conditionally.
+description: 'Ruby utility for constructing HTML class strings conditionally with
+  the provided syntax, you can define a module named Clsx that includes a method to
+  handle each case: strings, objects (hashes), arrays, and a combination of these
+  with nested structures. This method will recursively process each argument, filter
+  out falsy values, and concatenate the truthy values into a single string.'
 email:
-- marco.roth@hey.com
+- isethi@me.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rubocop.yml"
+- ".overcommit.yml"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/clsx.rb
+- lib/clsx/railtie.rb
 - lib/clsx/version.rb
 - sig/clsx.rbs
-homepage: https://github.com/marcoroth/clsx
+homepage: https://github.com/iseth/ruby-clsx
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/marcoroth/clsx
-  source_code_uri: https://github.com/marcoroth/clsx
-  changelog_uri: https://github.com/marcoroth/clsx/blob/main/CHANGELOG.md
-  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/iseth/ruby-clsx
+  source_code_uri: https://github.com/iseth/ruby-clsx
+  changelog_uri: https://github.com/iseth/ruby-clsx/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -44,15 +45,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
-summary: A tiny utility for constructing CSS class strings conditionally.
+summary: A gem for constructing HTML class strings conditionally
 test_files: []

data/.rubocop.yml

@@ -1,18 +0,0 @@
-AllCops:
-  NewCops: enable
-  TargetRubyVersion: 2.7
-  SuggestExtensions: false
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/Documentation:
-  Enabled: false
-
-Layout/LineLength:
-  Max: 120

data/CODE_OF_CONDUCT.md

@@ -1,84 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at marco.roth@intergga.ch. All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-gemspec
-
-gem "minitest", "~> 5.0"
-gem "rake", "~> 13.0"
-gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -1,45 +0,0 @@
-PATH
-  remote: .
-  specs:
-    clsx (0.1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    json (2.6.2)
-    minitest (5.16.3)
-    parallel (1.22.1)
-    parser (3.1.2.1)
-      ast (~> 2.4.1)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.6.0)
-    rexml (3.2.5)
-    rubocop (1.37.1)
-      json (~> 2.3)
-      parallel (~> 1.10)
-      parser (>= 3.1.2.1)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.23.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.23.0)
-      parser (>= 3.1.1.0)
-    ruby-progressbar (1.11.0)
-    unicode-display_width (2.3.0)
-
-PLATFORMS
-  x86_64-darwin-19
-  x86_64-linux
-
-DEPENDENCIES
-  clsx!
-  minitest (~> 5.0)
-  rake (~> 13.0)
-  rubocop (~> 1.21)
-
-BUNDLED WITH
-   2.3.22