class_variants 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 765533378fe25d4d376f7b79d3071f056438f7c94ddddcdd45043d54669c1859
-  data.tar.gz: d05e57bd9f860e806687b52ee20faeffb59b2774904ec6fb84f3403bdff7d692
+  metadata.gz: 35b8ff14e7d3dfe7319d4fb4f09b78aec128422de09402e3504809ef5a0adacf
+  data.tar.gz: f4b9bd0eec1427ba964d6affd2d3ec0e84126070faadd60cb7b6e51e7979a2ba
 SHA512:
-  metadata.gz: e7517aed893faec0040d34907290f335135631fd12268359687dbcf411b4cbe1cc206ed9a1bffd34ad667bd3e43166300efa9fae7f81ae44c5bf129d6587805e
-  data.tar.gz: c1bb443cc535bd4eec83ebcc6880a851ab8c3bd89342406f904c83136006a082f60092111a20d05273b014639342ca8fb3faa9e67cb6a326e351411e18e57522
+  metadata.gz: 75f8bb22dafa4d3e67bcc198b804ce85a76705696d0f46f7d9a22fe7c2c97e7af9174304778c808cf00e502cac9f403d8b25d3c9be825b3e963bb042e24d593c
+  data.tar.gz: 201be369574e67efe1557b2e396fb2aa1e09faad3415d0b88efe9467d6a9137ede50c7b072d3859c09e5ed63eb1df6369748a1fb247146fca451a1a823878948

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Adrian Marin
+
+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/lib/class_variants/action_view/helpers.rb

@@ -6,4 +6,4 @@ module ClassVariants
       end
     end
   end
-end
+end

data/lib/class_variants/instance.rb

@@ -1,53 +1,67 @@
-class ClassVariants::Instance
-  attr_reader :classes
-  attr_reader :variants
-  attr_reader :defaults
-
-  def initialize(classes = "", variants: {}, compoundVariants: [], defaults: {})
-    @classes = classes
-    @variants = expand_boolean_variants(variants)
-    @compoundVariants = compoundVariants
-    @defaults = defaults
-  end
+module ClassVariants
+  class Instance
+    attr_reader :base, :variants, :compound_variants, :defaults
 
-  def render(**overrides)
-    # Start with our default classes
-    result = [@classes]
+    # rubocop:disable Naming/VariableName
+    def initialize(classes = nil, base: nil, variants: {}, compoundVariants: [], compound_variants: [], defaults: {})
+      warn <<~MSG if classes
+        (ClassVariants) DEPRECATION WARNING: Use of positional argument for default classes is deprecated
+        and will be removed in the next version. Use the `base` keyword argument instead.
+      MSG
 
-    # Then merge the passed in overrides on top of the defaults
-    selected = @defaults.merge(overrides)
+      warn <<~MSG unless compoundVariants.empty?
+        (ClassVariants) DEPRECATION WARNING: Use of `compoundVariants` keyword argument is deprecated
+        and will be removed in the next version. Use the `compound_variant` instead.
+      MSG
 
-    selected.each do |variant_type, variant|
-      # dig the classes out and add them to the result
-      result << @variants.dig(variant_type, variant)
+      @base = base || classes
+      @variants = expand_boolean_variants(variants)
+      @compound_variants = compound_variants.empty? ? compoundVariants : compound_variants
+      @defaults = defaults
     end
+    # rubocop:enable Naming/VariableName
+
+    def render(**overrides)
+      # Start with our default classes
+      result = [@base]
+
+      # Then merge the passed in overrides on top of the defaults
+      selected = @defaults.merge(overrides)
 
-    @compoundVariants.each do |compound_variant|
-      if (compound_variant.keys - [:class]).all? { |key| selected[key] == compound_variant[key] }
-        result << compound_variant[:class]
+      selected.each do |variant_type, variant|
+        # dig the classes out and add them to the result
+        result << @variants.dig(variant_type, variant)
+      end
+
+      @compound_variants.each do |compound_variant|
+        if (compound_variant.keys - [:class]).all? { |key| selected[key] == compound_variant[key] }
+          result << compound_variant[:class]
+        end
       end
-    end
 
-    # Compact out any nil values we may have dug up
-    result.compact!
+      # Compact out any nil values we may have dug up
+      result.compact!
 
-    # Return the final token list
-    result.join " "
-  end
+      # Return the final token list
+      result.join " "
+    end
 
-  private
+    private
+
+    def expand_boolean_variants(variants)
+      expanded = variants.map do |key, value|
+        case value
+        when String
+          s_key = key.to_s
+          {s_key.delete_prefix("!").to_sym => {!s_key.start_with?("!") => value}}
+        else
+          {key => value}
+        end
+      end
 
-  def expand_boolean_variants(variants)
-    variants.each.map { |key, value|
-      case value
-      when String
-        s_key = key.to_s
-        { s_key.delete_prefix("!").to_sym => { !s_key.start_with?("!") => value } }
-      else
-        { key => value }
+      expanded.reduce do |output, next_variant|
+        output.merge!(next_variant) { |_key, v1, v2| v1.merge!(v2) }
       end
-    }.reduce do |variants, more_variants|
-      variants.merge!(more_variants) { |_key, v1, v2| v1.merge!(v2) }
     end
   end
 end

data/lib/class_variants/railtie.rb

@@ -1,12 +1,12 @@
-require 'rails/railtie'
+require "rails/railtie"
 
 module ClassVariants
   class Railtie < ::Rails::Railtie
-    initializer "class_variants.action_view" do |app|
+    initializer "class_variants.action_view" do
       ActiveSupport.on_load :action_view do
         require "class_variants/action_view/helpers"
         include ClassVariants::ActionView::Helpers
       end
     end
   end
-end
+end

data/lib/class_variants/version.rb

@@ -1,3 +1,3 @@
 module ClassVariants
-  VERSION = "0.0.7" unless const_defined?(:VERSION)
+  VERSION = "0.0.8".freeze
 end

data/lib/class_variants.rb

@@ -5,8 +5,8 @@ require "class_variants/railtie" if defined?(Rails)
 
 module ClassVariants
   class << self
-    def build(classes, **args)
-      Instance.new classes, **args
+    def build(...)
+      Instance.new(...)
     end
   end
-end
+end

data/readme.md

@@ -0,0 +1,178 @@
+# Class variants
+
+We ❤️ Tailwind CSS but sometimes it's difficult to manage the state of some elements using conditionals. `class_variants` is a tiny helper that should enable you to create, configure, and apply different variants of elements as classes.
+
+Inspired by [variant-classnames](https://github.com/mattvalleycodes/variant-classnames) ✌️
+
+## Quicklinks
+
+* [DRY up your tailwind CSS using this awesome gem](https://www.youtube.com/watch?v=cFcwNH6x77g)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'class_variants'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install class_variants
+```
+
+## Usage
+
+We create an object from the class or helper where we define the configuration using four arguments:
+
+1. The `base` keyword argument with default classes that should be applied to each variant.
+1. The `variants` keyword argument where we declare the variants with their option and classes.
+1. The `compound_variants` keyword argument where we declare the compound variants with their conditions and classes
+1. The `defaults` keyword argument (optional) where we declare the default value for each variant.
+
+## Example
+
+Below we implement the [button component](https://tailwindui.com/components/application-ui/elements/buttons) from Tailwind UI.
+
+```ruby
+# Define the variants and defaults
+button_classes = ClassVariants.build(
+  base: "inline-flex items-center rounded border border-transparent font-medium text-white hover:text-white shadow-sm focus:outline-none focus:ring-2 focus:ring-offset-2",
+  variants: {
+    size: {
+      sm: "px-2.5 py-1.5 text-xs",
+      md: "px-3 py-2 text-sm",
+      lg: "px-4 py-2 text-sm",
+      xl: "px-4 py-2 text-base",
+    },
+    color: {
+      indigo: "bg-indigo-600 hover:bg-indigo-700 focus:ring-indigo-500",
+      red: "bg-red-600 hover:bg-red-700 focus:ring-red-500",
+      blue: "bg-blue-600 hover:bg-blue-700 focus:ring-blue-500",
+    },
+    # A variant whose value is a string will be expanded into a hash that looks
+    # like  { true => "classes" }
+    block: "w-full justify-center",
+    # Unless the key starts with !, in which case it will expand into
+    # { false => "classes" }
+    "!block": "w-auto",
+  },
+  defaults: {
+    size: :md,
+    color: :indigo,
+    icon: false
+  }
+)
+
+# Call it with our desired variants
+button_classes.render(color: :blue, size: :sm)
+button_classes.render
+button_classes.render(color: :red, size: :xl, icon: true)
+```
+
+### Compound Variants
+
+```ruby
+button_classes = ClassVariants.build(
+  base: "inline-flex items-center rounded",
+  variants: {
+    color: {
+      red:  "bg-red-600",
+      blue: "bg-blue-600",
+    },
+    border: "border"
+  },
+  compound_variants: [
+    { color: :red,  border: true, class: "border-red-800"  },
+    { color: :blue, border: true, class: "border-blue-800" }
+  ]
+)
+
+button_classes.render(color: :red) # => "inline-flex items-center rounded bg-red-600"
+button_classes.render(color: :red, border: true) # => "inline-flex items-center rounded bg-red-600 border border-red-600"
+```
+
+## Use with Rails
+
+```ruby
+# Somewhere in your helpers
+def button_classes(classes, **args)
+  class_variants(
+    base: "inline-flex items-center rounded border border-transparent font-medium text-white hover:text-white shadow-sm focus:outline-none focus:ring-2 focus:ring-offset-2",
+    variants: {
+      size: {
+        sm: "px-2.5 py-1.5 text-xs",
+        md: "px-3 py-2 text-sm",
+        lg: "px-4 py-2 text-sm",
+        xl: "px-4 py-2 text-base",
+      },
+      color: {
+        indigo: "bg-indigo-600 hover:bg-indigo-700 focus:ring-indigo-500",
+        red: "bg-red-600 hover:bg-red-700 focus:ring-red-500",
+        blue: "bg-blue-600 hover:bg-blue-700 focus:ring-blue-500",
+      },
+    },
+    defaults: {
+      size: :md,
+      color: :indigo,
+    }
+  )
+end
+```
+
+```erb
+<!-- In your views -->
+<%= link_to :Avo, "https://avohq.io", class: button_classes.render(color: :blue, size: :sm) %>
+<%= link_to :Avo, "https://avohq.io", class: button_classes.render %>
+<%= link_to :Avo, "https://avohq.io", class: button_classes.render(color: :red, size: :xl) %>
+```
+
+### Output
+
+![](sample.jpg)
+
+## Other packages
+
+ - [`active_storage-blurhash`](https://github.com/avo-hq/active_storage-blurhash) - A plug-n-play [blurhash](https://blurha.sh/) integration for images stored in ActiveStorage
+ - [`avo`](https://github.com/avo-hq/avo) - Build Content management systems with Ruby on Rails
+ - [`prop_initializer`](https://github.com/avo-hq/prop_initializer) - A flexible tool for defining properties on Ruby classes.
+ - [`stimulus-confetti`](https://github.com/avo-hq/stimulus-confetti) - The easiest way to add confetti to your StimulusJS app
+
+## Try Avo ⭐️
+
+If you enjoyed this gem try out [Avo](https://github.com/avo-hq/avo). It helps developers build Internal Tools, Admin Panels, CMSes, CRMs, and any other type of Business Apps 10x faster on top of Ruby on Rails.
+
+[![](./logo-on-white.png)](https://github.com/avo-hq/avo)
+
+## Contributing
+
+1. Fork it `git clone https://github.com/avo-hq/class_variants`
+1. Create your feature branch `git checkout -b my-new-feature`
+1. Commit your changes `git commit -am 'Add some feature'`
+1. Push to the branch `git push origin my-new-feature`
+1. Create new Pull Request
+
+## License
+This package is available as open source under the terms of the MIT License.
+
+## Cutting a release
+
+```bash
+# Build
+gem build class_variants.gemspec -o latest.gem
+# Publish
+gem push --host https://rubygems.org/ ./latest.gem
+# Cut a tag
+git tag v0.0.6 -a -m "Version 0.0.6"
+# Push tag to repo
+git push --follow-tags
+# Go to the repo and generate release from tag
+```

metadata

@@ -1,47 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: class_variants
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Adrian Marin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-07 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: benchmark-ips
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 2024-10-24 00:00:00.000000000 Z
+dependencies: []
 description: Easily configure styles and apply them as classes.
 email: adrian@adrianthedev.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - lib/class_variants.rb
 - lib/class_variants/action_view/helpers.rb
 - lib/class_variants/instance.rb
 - lib/class_variants/railtie.rb
 - lib/class_variants/version.rb
+- readme.md
 homepage: https://github.com/avo-hq/class_variants
 licenses:
 - MIT
 metadata:
-  bug_tracker_uri: https://github.com/avo-hq/class_variants/issues
   homepage_uri: https://github.com/avo-hq/class_variants
   source_code_uri: https://github.com/avo-hq/class_variants
+  bug_tracker_uri: https://github.com/avo-hq/class_variants/issues
+  changelog_uri: https://github.com/avo-hq/class_variants/releases
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -50,14 +39,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Easily configure styles and apply them as classes.