tag_options 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c947925081a723a10b0cb16c68efa3895556df3f87246bb0b9795d8b942e01f3
-  data.tar.gz: c8b215bf6c0a2f8ee726055350c78c07efbe9575f22defb6ab483a01df23eb5d
+  metadata.gz: 5cee8f74f051ffc41909e62f0a613904ce5f342a6be1fd8d961b8f7663d66087
+  data.tar.gz: 5e8c5f2b69fe32e13330a99f4d112a412bc4e6b3a78a5233d66f11a3ad032e7c
 SHA512:
-  metadata.gz: 8764d6f0ebd02bebdc40bf449a58a21b5eea8ac8746fabb5c45980403f121efde6f210011b396f788ca8d6ca8cb5c553c032cdffff71c53a4558af3f1406d07c
-  data.tar.gz: 0caa39cf680e022b64609c224e359188e1025d9c52bddb2c80ae5e1d60e9a1cdadf3b45581e927119971d552b1c4014f8ed4e0a809be6c4199229bcea30849b5
+  metadata.gz: d6613c09fbf756a9a15e3a4001e478a0c225f643c1dd3f8b58be3e63fe8c3afb0dab00bed9d8984ca75ae58b37ae4fbb4e26d0410b7d36bb0cf59f52fecbd869
+  data.tar.gz: ed905332c293482cd3610c5374bb9a7b27328cd1c245bb55c6d69fc10b4c36e7c67f6a38ca3a32ef3a0f879344c9751b9a22ae18f91f1ed21d4bf5a6b7a8cac4

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## [Unreleased]
 
+## [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 +31,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)
@@ -149,11 +150,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 +183,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_at.rb

@@ -28,8 +28,27 @@ module TagOptions
       set_value! @resolver.call(*values, **conditions)
     end
 
+    def remove!(*values, **conditions)
+      @opt_hash.populate!(*@keys)
+      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.dig(*@keys)[@value_key] = @resolver.call(*values)
+      @opt_hash
+    end
+
     def set_default!(value)
       root = @opt_hash.dig(*@keys)
       root[@value_key] = value unless root.key?(@value_key)

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.0"
 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.0
 platform: ruby
 authors:
 - Alex Monroe
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-02 00:00:00.000000000 Z
+date: 2023-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport