tag_options 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e2a2a1f14c436d95569da59c07b36ea56ca1ef5f0a69546cb445423243d69ab
-  data.tar.gz: 2a5f69f7f214a7a00d3dfd47d7b627968960c6525ee4c65ec91a4590cdbab140
+  metadata.gz: 5cee8f74f051ffc41909e62f0a613904ce5f342a6be1fd8d961b8f7663d66087
+  data.tar.gz: 5e8c5f2b69fe32e13330a99f4d112a412bc4e6b3a78a5233d66f11a3ad032e7c
 SHA512:
-  metadata.gz: 2eee9711c6e3cf2163ef43aa45ea15c50fa247c1dada13d21e225e0cab19dbc5e52cb3843168d23cd33434d8e496e4a6da12247232cc881af3ec5f98a1adf0ff
-  data.tar.gz: cb281c5639b6381795d7d7f975ef5cf558ac0f9065ad38ac25d9c62e7257748b84df3d07a9f72d161709ae436c4712196aa26805bffc359522b1db0719305fcc
+  metadata.gz: d6613c09fbf756a9a15e3a4001e478a0c225f643c1dd3f8b58be3e63fe8c3afb0dab00bed9d8984ca75ae58b37ae4fbb4e26d0410b7d36bb0cf59f52fecbd869
+  data.tar.gz: ed905332c293482cd3610c5374bb9a7b27328cd1c245bb55c6d69fc10b4c36e7c67f6a38ca3a32ef3a0f879344c9751b9a22ae18f91f1ed21d4bf5a6b7a8cac4

data/CHANGELOG.md

@@ -2,20 +2,37 @@
 
 ## [Unreleased]
 
-## [1.2.0] - 2023-03-01
+## [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
+
+- Fixed bug introduced when switching to
+  `ActiveSupport::HashWithIndifferentAccess` that prevented a `TagOptions::Hash`
+  from being passed to a method using double splat, e.g. `some_method
+  **options`.
+
+## [1.2.0] - 2023-03-02
 
 - Added `at().default!` option for setting values that are not already present.
 - Fix for passing an array of values to `combine1` or `set!`
 
 ## [1.1.0] - 2023-03-01
 
-- Switched to inheriting from ActiveSupport::HashWithIndifferentAccess.
+- Switched to inheriting from `ActiveSupport::HashWithIndifferentAccess`.
 - Added before/after/around initialize callback support.
 
 ## [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)
@@ -72,11 +73,14 @@ TagOptions::Hash.new
 
 hash = {class: "flex"}
 TagOptions::Hash.new(hash)
-=> {"class"=>"flex"}
+=> {:class=>"flex"}
 ```
 
 `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
+the keys as symbols instead of strings to make it easier to pass the hash as
+an method argument using double splat, e.g. `some_method **options`.
 
 ### combine!
 
@@ -86,7 +90,7 @@ Combine HTML attributes with an existing `TagOptions::Hash` by chaining `at` and
 ```ruby
 options = TagOptions::Hash.new(class: "flex")
 options.at(:class).combine!("mt-1")
-=> {"class"=>"flex mt-1"}
+=> {:class=>"flex mt-1"}
 ```
 
 Values can also be specified as arrays.
@@ -94,7 +98,7 @@ Values can also be specified as arrays.
 ```ruby
 options = TagOptions::Hash.new(class: "flex")
 options.at(:class).combine!(["mt-1", "mx-2"])
-=> {"class"=>"flex mt-1 mx-2"}
+=> {:class=>"flex mt-1 mx-2"}
 ```
 
 HTML attributes are only added if they don't already exist.
@@ -102,7 +106,7 @@ HTML attributes are only added if they don't already exist.
 ```ruby
 options = TagOptions::Hash.new(class: "flex")
 options.at(:class).combine!("flex flex-col")
-=> {"class"=>"flex flex-col"}
+=> {:class=>"flex flex-col"}
 ```
 
 You can also combine values on nested hashes.
@@ -110,7 +114,7 @@ You can also combine values on nested hashes.
 ```ruby
 options = TagOptions::Hash.new(class: "flex", data: {controller: "dropdown"})
 options.at(:data, :controller).combine!("toggle")
-=> {"class"=>"flex", "data"=>{"controller"=>"dropdown toggle"}}
+=> {:class=>"flex", :data=>{:controller=>"dropdown toggle"}
 ```
 
 If a nested hash doesn't already exist it will be automatically added.
@@ -118,7 +122,7 @@ If a nested hash doesn't already exist it will be automatically added.
 ```ruby
 options = TagOptions::Hash.new(class: "flex")
 options.at(:data, :controller).combine!("dropdown")
-=> {"class"=>"flex", "data"=>{"controller"=>"dropdown"}}
+=> {:class=>"flex", :data=>{:controller=>"dropdown"}
 ```
 
 ### set!
@@ -130,7 +134,7 @@ existing values.
 ```ruby
 options = TagOptions::Hash.new(class: "flex")
 options.at(:class).set!("block")
-=> {"class"=>"block"}
+=> {:class=>"block"}
 ```
 
 ### default!
@@ -143,20 +147,61 @@ set the specified values if the value is not already specified.
 options = TagOptions::Hash.new(class: "flex")
 options.at(:class).default!("block")
 options.at(:role).default!("alert")
-=> {"class"=>"flex", "role"=>"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`
 options = TagOptions::Hash.new(class: "flex")
 options.at(:class).combine!("mt-1", "mx-auto": centered?, "mx-2": !centered?)
-=> {"class"=>"flex mt-1 mx-auto"}
+=> {: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
@@ -181,7 +226,7 @@ pass `as: :style` to `at`.
 ```ruby
 options = TagOptions::Hash.new(style: "display: block; margin-left: 0;")
 options.at(:style, as: :style).combine!("display: flex; margin-right: 0;")
-=> {"style"=>"display: flex; margin-left: 0; margin-right: 0;"}
+=> {:style=>"display: flex; margin-left: 0; margin-right: 0;"}
 ```
 
 A `TagOptions::Resolver` class is available if you wish to implement your own

data/lib/tag_options/convert_key.rb

@@ -0,0 +1,7 @@
+module TagOptions
+  module ConvertKey
+    def convert_key(key)
+      key&.to_s&.to_sym
+    end
+  end
+end

data/lib/tag_options/hash.rb

@@ -1,17 +1,20 @@
 require "active_support/callbacks"
 require "active_support/core_ext/hash/indifferent_access"
+require "tag_options/convert_key"
 require "tag_options/hash_at"
 require "tag_options/errors/not_hash_error"
 
 module TagOptions
   class Hash < ActiveSupport::HashWithIndifferentAccess
     include ActiveSupport::Callbacks
+    include ConvertKey
+
     define_callbacks :initialize
 
     def initialize(hash = {})
       run_callbacks :initialize do
         hash.each do |key, value|
-          self[key] = value.is_a?(::Hash) ? self.class.new(value) : value
+          self[convert_key(key)] = value.is_a?(::Hash) ? self.class.new(value) : value
         end
       end
     end
@@ -21,15 +24,16 @@ module TagOptions
     end
 
     def dig(*keys)
-      keys.size.zero? ? self : super
+      keys = keys.map { |key| convert_key(key) }
+      keys.size.zero? ? self : super(*keys)
     end
 
     def populate!(*keys)
       populated_keys = []
       data = self
       keys.each do |key|
-        data[key] ||= self.class.new
-        data = data[key]
+        data[convert_key(key)] ||= self.class.new
+        data = data[convert_key(key)]
         unless data.is_a?(self.class)
           raise TagOptions::Errors::NotHashError.new(populated_keys, type: data.class)
         end

data/lib/tag_options/hash_at.rb

@@ -1,11 +1,14 @@
 require "tag_options/configuration"
+require "tag_options/convert_key"
 
 module TagOptions
   class HashAt
+    include ConvertKey
+
     def initialize(opt_hash:, keys:, as:)
       @opt_hash = opt_hash
-      @keys = keys[..-2]
-      @value_key = keys[-1]
+      @keys = keys[..-2].map { |key| convert_key(key) }
+      @value_key = convert_key(keys[-1])
       @resolver = TagOptions.configuration.resolver(as)
     end
 
@@ -25,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.0"
+  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.0
+  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
@@ -51,6 +51,7 @@ files:
 - Rakefile
 - lib/tag_options.rb
 - lib/tag_options/configuration.rb
+- lib/tag_options/convert_key.rb
 - lib/tag_options/error.rb
 - lib/tag_options/errors/not_hash_error.rb
 - lib/tag_options/errors/resolver_error.rb