tag_options 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5802916aaa57253843bc9fa02aed005828d4ffa30a8ccf514b9949c5c0859d2d
-  data.tar.gz: 80ee0b00682ee8d94595039cd1569c0152d0dedb225a78672986416118bec6fe
+  metadata.gz: c947925081a723a10b0cb16c68efa3895556df3f87246bb0b9795d8b942e01f3
+  data.tar.gz: c8b215bf6c0a2f8ee726055350c78c07efbe9575f22defb6ab483a01df23eb5d
 SHA512:
-  metadata.gz: f498f2aa015310a8b4d3800dcb435c5b946665f5f53bf54630a80666e3c56f05c54b75788ea84b2d57829d2369404408621a4b2b7adeec1c5668fad2e61ac37a
-  data.tar.gz: 9e04caa1298cec89d34af81daa7c11b51c18020c3bb013aaf7b104de5f1e5c80d545aeaae334929d3c2796d5fa00f31aafb59028b588bf9aefd218278e56bb9c
+  metadata.gz: 8764d6f0ebd02bebdc40bf449a58a21b5eea8ac8746fabb5c45980403f121efde6f210011b396f788ca8d6ca8cb5c553c032cdffff71c53a4558af3f1406d07c
+  data.tar.gz: 0caa39cf680e022b64609c224e359188e1025d9c52bddb2c80ae5e1d60e9a1cdadf3b45581e927119971d552b1c4014f8ed4e0a809be6c4199229bcea30849b5

data/CHANGELOG.md

@@ -2,9 +2,22 @@
 
 ## [Unreleased]
 
+
+## [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

@@ -41,6 +41,7 @@ Would render:
   - [General Usage](#general-usage)
     - [combine!](#combine)
     - [set!](#set)
+    - [default!](#default)
   - [Conditional Usage](#conditional-usage)
   - [Custom Property Resolvers](#custom-property-resolvers)
   - [Development](#development)
@@ -74,6 +75,12 @@ TagOptions::Hash.new(hash)
 => {: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!
 
 Combine HTML attributes with an existing `TagOptions::Hash` by chaining `at` and
@@ -129,6 +136,19 @@ options.at(:class).set!("block")
 => {:class=>"block"}
 ```
 
+### default!
+
+Chaining `at` and `default!` functions nearly the same as `set!` with all the
+same usage patterns. The only difference is that the default method will only
+set the specified values if the value is not already specified.
+
+```ruby
+options = TagOptions::Hash.new(class: "flex")
+options.at(:class).default!("block")
+options.at(:role).default!("alert")
+=> {:class=>"flex", :role=>"alert"}
+```
+
 ## Conditional Usage
 
 Both the `combine!` and `set!` allow for values to be conditionally added to

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,16 +24,17 @@ 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] ||= TagOptions::Hash.new
-        data = data[key]
-        unless data.is_a?(TagOptions::Hash)
+        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
       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
 
@@ -15,6 +18,11 @@ module TagOptions
       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)
@@ -22,6 +30,12 @@ module TagOptions
 
     private
 
+    def set_default!(value)
+      root = @opt_hash.dig(*@keys)
+      root[@value_key] = value unless root.key?(@value_key)
+      @opt_hash
+    end
+
     def set_value!(value)
       @opt_hash.dig(*@keys)[@value_key] = value
       @opt_hash

data/lib/tag_options/resolver.rb

@@ -1,7 +1,7 @@
 module TagOptions
   class Resolver
     def initialize(*values, **conditional_values)
-      @values = [*values, *resolve_conditional_values(conditional_values)]
+      @values = [*values.flatten, *resolve_conditional_values(conditional_values)]
     end
 
     def self.call(...)

data/lib/tag_options/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tag_options
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Alex Monroe
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-01 00:00:00.000000000 Z
+date: 2023-03-02 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