tag_options 1.2.1 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c947925081a723a10b0cb16c68efa3895556df3f87246bb0b9795d8b942e01f3
-  data.tar.gz: c8b215bf6c0a2f8ee726055350c78c07efbe9575f22defb6ab483a01df23eb5d
+  metadata.gz: 416b4a714b85d92ffe1d81481749e7e75f3ebb6a5ef2f9c40330a544dd3cd774
+  data.tar.gz: ef14412ef73a773aaec41c5f2cd7f9a715e7f3368b5d1338d4d85dfaf6af0d4c
 SHA512:
-  metadata.gz: 8764d6f0ebd02bebdc40bf449a58a21b5eea8ac8746fabb5c45980403f121efde6f210011b396f788ca8d6ca8cb5c553c032cdffff71c53a4558af3f1406d07c
-  data.tar.gz: 0caa39cf680e022b64609c224e359188e1025d9c52bddb2c80ae5e1d60e9a1cdadf3b45581e927119971d552b1c4014f8ed4e0a809be6c4199229bcea30849b5
+  metadata.gz: 664555bb319ec2add3dc7887b80b3e8e4ce84e288707c2a73eb003e72474549505bd401cebab4adc3eae78ed624a60ff28f9f50af9b431bae2322a5038a5b821
+  data.tar.gz: 0c5693a2ab6f3ad7ed39a1f4b29a0b0683394cfd6b1895f8d9a33379aa72c63d241f0285055296c7cd228a8741d482f5fee030cc5dd8751e07ad128119fb213c

data/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 ## [Unreleased]
 
+## [1.3.1] - 2023-03-06
+
+- Fixed a bug where keys with empty values were being populated when using
+`at()` against a non-existant key and the values passed to `combine!`, `set!`,
+  or `default` resolved to no values or where `remove!` removed all values.
+
+## [1.3.0] - 2023-03-03
+
+- Added `at().remove!` option for removing values.
+
+**NOTE**: If you have implemented custom resolvers, you will need to modify them
+in order to support `remove!`. For examples, see the [built-in
+handlers](https://github.com/wamonroe/tag_options/tree/main/lib/tag_options/resolvers)
+for more information.
 
 ## [1.2.1] - 2023-03-02
 
@@ -23,7 +37,8 @@
 ## [1.0.0] - 2022-06-14
 
 - Rewrote and simplified TagOptions::Hash and supporting classes.
-- BREAKING CHANGES, read documentation for updated usage before updating.
+
+**BREAKING CHANGES**: Read documentation for updated usage before updating.
 
 ## [0.9.3] - 2021-11-11
 

data/README.md

@@ -42,6 +42,7 @@ Would render:
     - [combine!](#combine)
     - [set!](#set)
     - [default!](#default)
+    - [remove!](#remove)
   - [Conditional Usage](#conditional-usage)
   - [Custom Property Resolvers](#custom-property-resolvers)
   - [Development](#development)
@@ -64,7 +65,7 @@ bundle install
 
 ## General Usage
 
-Initialize a `TagOptions::Hash` directly or by passing an existing `Hash`.
+Instantiate a `TagOptions::Hash` directly or by passing an existing `Hash`.
 
 ```ruby
 TagOptions::Hash.new
@@ -75,6 +76,24 @@ TagOptions::Hash.new(hash)
 => {:class=>"flex"}
 ```
 
+Similar to `Array()`, you can also instantiate a new `TagOptions::Hash` by
+passing a has to `TagOptions::Hash()`.
+
+```ruby
+hash = {class: "flex"}
+TagOptions::Hash(hash)
+=> {:class=>"flex"}
+```
+
+The values of the hash passed to `TagOptions::Hash.new` or `TagOptions::Hash()`
+are automatically converted to strings.
+
+```ruby
+hash = {disabled: true}
+TagOptions::Hash.new(hash)
+=> {:disabled=>"true"}
+```
+
 `TagOptions::Hash` inherits from `ActiveSupport::HashWithIndifferentAccess`,
 implementing a hash where keys `:foo` and `"foo"` are considered to be the same.
 It differs from `ActiveSupport::HashWithIndifferentAccess`, however, by storing
@@ -149,11 +168,31 @@ options.at(:role).default!("alert")
 => {:class=>"flex", :role=>"alert"}
 ```
 
+### remove!
+
+Remove HTML attributes from an existing `TagOptions::Hash` by chaining `at` and
+`remove!`.
+
+```ruby
+options = TagOptions::Hash.new(class: "flex ml-1 mr-1")
+options.at(:class).remove!("mr-1")
+=> {:class=>"flex ml-1"}
+```
+
+In addition to string values, you can also pass regular expression to `remove!`.
+
+```ruby
+options = TagOptions::Hash.new(class: "flex ml-1 mr-2")
+options.at(:class).remove!(/m.-\d/)
+=> {:class=>"flex"}
+```
+
 ## Conditional Usage
 
-Both the `combine!` and `set!` allow for values to be conditionally added to
-HTML attributes using an argument array. Where the values are added
-unconditionally and key/value pairs have their key added _IF_ the value is true.
+The `combine!`, `set!`, `default!`, and `remove!` methods allow for values to be
+conditionally resolved using an argument array. Where the values are passed
+unconditionally and key/value pairs have their key passed _IF_ the value is
+true.
 
 ```ruby
 # assuming `centered?` returns `true`
@@ -162,6 +201,27 @@ options.at(:class).combine!("mt-1", "mx-auto": centered?, "mx-2": !centered?)
 => {:class=>"flex mt-1 mx-auto"}
 ```
 
+```ruby
+# assuming `centered?` returns `true`
+options = TagOptions::Hash.new(class: "flex")
+options.at(:class).set!("block", "mx-auto": centered?, "mx-2": !centered?)
+=> {:class=>"block mx-auto"}
+```
+
+```ruby
+# assuming `centered?` returns `true`
+options = TagOptions::Hash.new(role: "alert")
+options.at(:class).default!("flex", "mx-auto": centered?, "mx-2": !centered?)
+=> {:role=>"alert", :class=>"flex mx-auto"}
+```
+
+```ruby
+# assuming `centered?` returns `true`
+options = TagOptions::Hash.new(class: "flex mx-auto mx-2")
+options.at(:class).remove!("mt-1", "mx-auto": centered?, "mx-2": !centered?)
+=> {:class=>"flex mx-2"}
+```
+
 ## Custom Property Resolvers
 
 Chaining `at` to `combine!` or `set!` processes HTML properties similar to

data/lib/tag_options/hash.rb

@@ -1,5 +1,6 @@
 require "active_support/callbacks"
 require "active_support/core_ext/hash/indifferent_access"
+require "active_support/core_ext/object/blank"
 require "tag_options/convert_key"
 require "tag_options/hash_at"
 require "tag_options/errors/not_hash_error"
@@ -14,8 +15,9 @@ module TagOptions
     def initialize(hash = {})
       run_callbacks :initialize do
         hash.each do |key, value|
-          self[convert_key(key)] = value.is_a?(::Hash) ? self.class.new(value) : value
+          self[convert_key(key)] = value.is_a?(::Hash) ? self.class.new(value) : value.to_s
         end
+        remove_blank!
       end
     end
 
@@ -24,21 +26,50 @@ module TagOptions
     end
 
     def dig(*keys)
-      keys = keys.map { |key| convert_key(key) }
-      keys.size.zero? ? self : super(*keys)
+      return self if keys.size.zero?
+
+      dug_keys = []
+      data = self
+      keys.each_with_index do |key, index|
+        key = convert_key(key)
+        return nil unless data.key?(key)
+
+        data = data[key]
+        dug_keys << key
+        last_key = index == keys.size - 1
+        unless last_key || data.is_a?(self.class)
+          raise TagOptions::Errors::NotHashError.new(dug_keys, type: data.class)
+        end
+      end
+      data
     end
 
     def populate!(*keys)
       populated_keys = []
       data = self
       keys.each do |key|
-        data[convert_key(key)] ||= self.class.new
-        data = data[convert_key(key)]
+        key = convert_key(key)
+        data[key] ||= self.class.new
+        data = data[key]
+        populated_keys << key
         unless data.is_a?(self.class)
           raise TagOptions::Errors::NotHashError.new(populated_keys, type: data.class)
         end
       end
       self
     end
+
+    def remove_blank!(hash = self, parent_hash: nil)
+      hash.each do |key, value|
+        if value.blank?
+          hash.delete(key)
+          remove_blank!(parent_hash, parent_hash: nil) if parent_hash
+        elsif value.is_a?(Hash)
+          remove_blank!(value, parent_hash: hash)
+          remove_blank!(parent_hash, parent_hash: nil) if parent_hash
+        end
+      end
+      hash
+    end
   end
 end

data/lib/tag_options/hash_at.rb

@@ -13,30 +13,53 @@ module TagOptions
     end
 
     def combine!(*values, **conditions)
-      @opt_hash.populate!(*@keys)
       current_value = @opt_hash.dig(*@keys, @value_key)
       set_value! @resolver.call(current_value, *values, **conditions)
     end
 
     def default!(*values, **conditions)
-      @opt_hash.populate!(*@keys)
       set_default! @resolver.call(*values, **conditions)
     end
 
     def set!(*values, **conditions)
-      @opt_hash.populate!(*@keys)
       set_value! @resolver.call(*values, **conditions)
     end
 
+    def remove!(*values, **conditions)
+      regex_values, values = values.flatten.partition { |v| v.is_a?(Regexp) }
+      remove_values!(*regex_values, *@resolver.values(*values, **conditions))
+    end
+
     private
 
+    def remove_values!(*values_to_remove)
+      values = @resolver.values(@opt_hash.dig(*@keys)&.[](@value_key))
+      values_to_remove.each do |value|
+        if value.is_a?(Regexp)
+          values.reject! { |current_value| value.match?(current_value) }
+        else
+          values.reject! { |current_value| value == current_value }
+        end
+      end
+      @opt_hash.populate!(*@keys)
+      @opt_hash.dig(*@keys)[@value_key] = @resolver.call(*values)
+      @opt_hash.remove_blank!
+      @opt_hash
+    end
+
     def set_default!(value)
+      return @opt_hash if value.blank?
+
+      @opt_hash.populate!(*@keys)
       root = @opt_hash.dig(*@keys)
       root[@value_key] = value unless root.key?(@value_key)
       @opt_hash
     end
 
     def set_value!(value)
+      return @opt_hash if value.blank?
+
+      @opt_hash.populate!(*@keys)
       @opt_hash.dig(*@keys)[@value_key] = value
       @opt_hash
     end

data/lib/tag_options/resolver.rb

@@ -8,6 +8,10 @@ module TagOptions
       new(...).call
     end
 
+    def self.values(...)
+      new(...).values
+    end
+
     private
 
     def resolve_conditional_values(conditional_values)

data/lib/tag_options/resolvers/default.rb

@@ -4,7 +4,11 @@ module TagOptions
   module Resolvers
     class Default < Resolver
       def call
-        @values.map { |v| v.to_s.split }.flatten.compact.uniq.join(" ")
+        values.join(" ")
+      end
+
+      def values
+        @values.map { |v| v.to_s.split }.flatten.compact.uniq
       end
     end
   end

data/lib/tag_options/resolvers/style.rb

@@ -4,7 +4,11 @@ module TagOptions
   module Resolvers
     class Style < Resolver
       def call
-        styles.map { |p, v| "#{p}: #{v};" }.join(" ")
+        values.join(" ")
+      end
+
+      def values
+        styles.map { |p, v| "#{p}: #{v};" }
       end
 
       private

data/lib/tag_options/version.rb

@@ -1,3 +1,3 @@
 module TagOptions
-  VERSION = "1.2.1"
+  VERSION = "1.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tag_options
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.1
 platform: ruby
 authors:
 - Alex Monroe
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-02 00:00:00.000000000 Z
+date: 2023-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport