tag_options 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e2a2a1f14c436d95569da59c07b36ea56ca1ef5f0a69546cb445423243d69ab
-  data.tar.gz: 2a5f69f7f214a7a00d3dfd47d7b627968960c6525ee4c65ec91a4590cdbab140
+  metadata.gz: c947925081a723a10b0cb16c68efa3895556df3f87246bb0b9795d8b942e01f3
+  data.tar.gz: c8b215bf6c0a2f8ee726055350c78c07efbe9575f22defb6ab483a01df23eb5d
 SHA512:
-  metadata.gz: 2eee9711c6e3cf2163ef43aa45ea15c50fa247c1dada13d21e225e0cab19dbc5e52cb3843168d23cd33434d8e496e4a6da12247232cc881af3ec5f98a1adf0ff
-  data.tar.gz: cb281c5639b6381795d7d7f975ef5cf558ac0f9065ad38ac25d9c62e7257748b84df3d07a9f72d161709ae436c4712196aa26805bffc359522b1db0719305fcc
+  metadata.gz: 8764d6f0ebd02bebdc40bf449a58a21b5eea8ac8746fabb5c45980403f121efde6f210011b396f788ca8d6ca8cb5c553c032cdffff71c53a4558af3f1406d07c
+  data.tar.gz: 0caa39cf680e022b64609c224e359188e1025d9c52bddb2c80ae5e1d60e9a1cdadf3b45581e927119971d552b1c4014f8ed4e0a809be6c4199229bcea30849b5

data/CHANGELOG.md

@@ -2,14 +2,22 @@
 
 ## [Unreleased]
 
-## [1.2.0] - 2023-03-01
+
+## [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

data/README.md

@@ -72,11 +72,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 +89,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 +97,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 +105,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 +113,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 +121,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 +133,7 @@ existing values.
 ```ruby
 options = TagOptions::Hash.new(class: "flex")
 options.at(:class).set!("block")
-=> {"class"=>"block"}
+=> {:class=>"block"}
 ```
 
 ### default!
@@ -143,7 +146,7 @@ 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"}
 ```
 
 ## Conditional Usage
@@ -156,7 +159,7 @@ unconditionally and key/value pairs have their key added _IF_ the value is true.
 # 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"}
 ```
 
 ## Custom Property Resolvers
@@ -181,7 +184,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
 

data/lib/tag_options/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tag_options
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Alex Monroe
@@ -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