tag_options 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 900cd0b42ae1f34b69b7cf227cb4f6bc91cb560f3b04424cdf3e2fd41e5d3f61
-  data.tar.gz: b4af6738e8d551d795bab1ef057bb47f49de8d73ba32068c839d04bf50e78a43
+  metadata.gz: 6e2a2a1f14c436d95569da59c07b36ea56ca1ef5f0a69546cb445423243d69ab
+  data.tar.gz: 2a5f69f7f214a7a00d3dfd47d7b627968960c6525ee4c65ec91a4590cdbab140
 SHA512:
-  metadata.gz: 3322cbce916927b777b7e915e181102cdbc7497c42095edc0e11f009d9a6a3884e8649ce6826d0199ba0ac3e9fe1a8c039bc5bd8c490a6db027714f08e6d88c4
-  data.tar.gz: 0d1ebc95b92d489d19c49b33acead9abe88a9fc5932865941454100e11bb877db6baacf7380a85f0495c3d47d3807d02e6d8bbfe08d654dbfb6b17a2940c8393
+  metadata.gz: 2eee9711c6e3cf2163ef43aa45ea15c50fa247c1dada13d21e225e0cab19dbc5e52cb3843168d23cd33434d8e496e4a6da12247232cc881af3ec5f98a1adf0ff
+  data.tar.gz: cb281c5639b6381795d7d7f975ef5cf558ac0f9065ad38ac25d9c62e7257748b84df3d07a9f72d161709ae436c4712196aa26805bffc359522b1db0719305fcc

data/CHANGELOG.md

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

@@ -1,5 +1,7 @@
 # Tag Options
 
+[![Test](https://github.com/wamonroe/tag_options/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/wamonroe/tag_options/actions/workflows/test.yml)
+
 Simple library for manipulating options passed to the Rails `tag`,
 `content_tag`, and other tag helpers.
 
@@ -33,16 +35,18 @@ Would render:
 
 ## Table of Contents
 
-- [Installation](#installation)
-- [General Usage](#general-usage)
-  - [combine!](#combine)
-  - [set!](#set)
-- [Conditional Usage](#conditional-usage)
-- [Property Resolvers](#property-resolvers)
-- [Development](#development)
-- [Contributing](#contributing)
-- [To Do](#to-do)
-- [License](#license)
+- [Tag Options](#tag-options)
+  - [Table of Contents](#table-of-contents)
+  - [Installation](#installation)
+  - [General Usage](#general-usage)
+    - [combine!](#combine)
+    - [set!](#set)
+    - [default!](#default)
+  - [Conditional Usage](#conditional-usage)
+  - [Custom Property Resolvers](#custom-property-resolvers)
+  - [Development](#development)
+  - [Contributing](#contributing)
+  - [License](#license)
 
 ## Installation
 
@@ -68,9 +72,12 @@ 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.
+
 ### combine!
 
 Combine HTML attributes with an existing `TagOptions::Hash` by chaining `at` and
@@ -79,7 +86,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.
@@ -87,7 +94,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.
@@ -95,7 +102,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.
@@ -103,7 +110,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.
@@ -111,7 +118,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!
@@ -123,7 +130,20 @@ existing values.
 ```ruby
 options = TagOptions::Hash.new(class: "flex")
 options.at(:class).set!("block")
-=> {:class=>"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
@@ -136,7 +156,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
@@ -161,7 +181,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
@@ -185,7 +205,7 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 - `bin/console` for an interactive prompt that will allow you to experiment
 - `bin/rubocop` to run RuboCop to check the code style and formatting
 
-To install this gem onto your local machine, run `bundle exec rake install`. To
+To build this gem on your local machine, run `bundle exec rake build`. To
 release a new version, update the version number in `version.rb`, and then run
 `bundle exec rake release`, which will create a git tag for the version, push
 git commits and the created tag, and push the `.gem` file to

data/lib/tag_options/hash.rb

@@ -1,11 +1,18 @@
+require "active_support/callbacks"
+require "active_support/core_ext/hash/indifferent_access"
 require "tag_options/hash_at"
 require "tag_options/errors/not_hash_error"
 
 module TagOptions
-  class Hash < ::Hash
+  class Hash < ActiveSupport::HashWithIndifferentAccess
+    include ActiveSupport::Callbacks
+    define_callbacks :initialize
+
     def initialize(hash = {})
-      hash.each do |key, value|
-        self[key] = value.is_a?(::Hash) ? TagOptions::Hash.new(value) : value
+      run_callbacks :initialize do
+        hash.each do |key, value|
+          self[key] = value.is_a?(::Hash) ? self.class.new(value) : value
+        end
       end
     end
 
@@ -21,9 +28,9 @@ module TagOptions
       populated_keys = []
       data = self
       keys.each do |key|
-        data[key] ||= TagOptions::Hash.new
+        data[key] ||= self.class.new
         data = data[key]
-        unless data.is_a?(TagOptions::Hash)
+        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

@@ -15,6 +15,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 +27,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.0.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: tag_options
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Alex Monroe
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-15 00:00:00.000000000 Z
+date: 2023-03-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -68,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Simple library for manipulating options passed to various Rails tag helpers.