html-attributes-utils 0.9.2 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3808ce542e4f9fd7160573fe17ff2ebc2e8c918235f1f2d901b1f14f29dbfa5a
-  data.tar.gz: 7481b962ddd46b11916f19a09d7bd83dd9837d0a79bf81e122b25a15b2c205b8
+  metadata.gz: 61d705b8b6000833dbd60e659fcca312f61e6d4cfbd10a3f25bcc13845f6ef27
+  data.tar.gz: a5fc3a72c775fd555f94efd98f03a9324010fb0ac9b80385eeddb0b8923a8f0f
 SHA512:
-  metadata.gz: 7135311cae1f633bc62f6f833ab2aa78356390ee44d323388d223b273daa1ce4c4ba72ef3acadeae31d64f68ba275db40560e006deb066f6ec1b3ab197d4da0d
-  data.tar.gz: 29b428ff663d2bf89cac66ec754f8dd4a01232c9af07ad7e9f6b1a74bcdc1b58ea140d7b7cce883848373332106108556681eb773d9d76b7cc1b5274492b4e9c
+  metadata.gz: cf02f936411794118c6e001d8ab67452394442859450133e4402d4a04f6c305620e3f215bdb5f340dc55e3249328641efa3d85cb130000a2915ab0756cd651a4
+  data.tar.gz: '09d8ca2b7e2444332f64b50b4fe93e19ee6aae4408688f993455e8db19d33b2de36df51c242db97373aa8a1787401f4c651c83587df9ce6bfeb7edc525b6e4a0'

data/README.md

@@ -1,5 +1,13 @@
 # HTML Attributes Utilities
 
+[![Tests](https://github.com/DFE-Digital/html-attributes-utils/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/DFE-Digital/html-attributes-utils/actions/workflows/tests.yml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/da15b0accce3baf10c34/maintainability)](https://codeclimate.com/github/DFE-Digital/html-attributes-utils/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/da15b0accce3baf10c34/test_coverage)](https://codeclimate.com/github/DFE-Digital/html-attributes-utils/test_coverage)
+![GitHub](https://img.shields.io/github/license/dfe-digital/html-attributes-utils)
+![Supported ruby versions](https://img.shields.io/badge/ruby-%3E%3D%202.7.6-red)
+![Supported rails versions](https://img.shields.io/badge/rails-%3E%3D%206.1.6-red)
+
+
 This is a small library intended to make it easier to deal with HTML
 attributes. It was written to reduce overlap in the
 [govuk-components](https://github.com/DFE-Digital/govuk-components) and

data/lib/html_attributes_utils.rb

@@ -8,14 +8,16 @@ module HTMLAttributesUtils
   # They are stored as nested arrays so when we're walking multiple
   # levels on the deep merge the structure can be identified. This means
   # the library works with the Rails-preferred format of
-  # `aria: { describedby: "xyz" }` rather than `aria-describdby: `xyz`
+  # `aria: { describedby: "xyz" }` rather than `"aria-describdby" => "xyz"`
   DEFAULT_MERGEABLE_ATTRIBUTES = [
     %i(class),
     %i(aria controls),
     %i(aria describedby),
     %i(aria flowto),
     %i(aria labelledby),
+    %i(data aria controls),
     %i(aria owns),
+    %i(rel),
   ].freeze
 
   refine Hash do
@@ -47,12 +49,7 @@ module HTMLAttributesUtils
       originals.each_with_object(originals) { |(key, value), merged|
         next unless overrides.key?(key)
 
-        merged[key] = combine_values(
-          value,
-          overrides[key],
-          parents: [*parents, *key],
-          mergeable_attributes: mergeable_attributes
-        )
+        merged[key] = process_pair(key, value, parents: parents, overrides: overrides, mergeable_attributes: mergeable_attributes)
 
         overrides.delete(key)
       }.merge(overrides)
@@ -76,19 +73,40 @@ module HTMLAttributesUtils
 
   private
 
+    def process_pair(key, value, parents:, overrides:, mergeable_attributes:)
+      combine_values(
+        value,
+        overrides[key],
+        parents: [*parents, *key],
+        mergeable_attributes: mergeable_attributes
+      )
+    end
+
     def tidy_value(value)
       case value
-      when Hash
-        value.deep_tidy_html_attributes.presence
-      when Array
-        (value.empty?) ? nil : value.map { |v| tidy_value(v) }.compact
-      when TrueClass, FalseClass
-        value
-      else
-        value.to_s.strip.presence
+      when TrueClass, FalseClass then value
+      when Hash                  then tidy_hash(value)
+      when Array                 then tidy_array(value)
+      else                            tidy_remaining(value)
       end
     end
 
+    def tidy_hash(hash)
+      return nil if hash.empty?
+
+      hash.deep_tidy_html_attributes
+    end
+
+    def tidy_array(array)
+      return nil if array.empty?
+
+      array.map { |v| tidy_value(v) }.compact
+    end
+
+    def tidy_remaining(value)
+      value.to_s.strip.presence
+    end
+
     def combine_values(value, override, **kwargs)
       case split_attribute_list(value, **kwargs)
       when Array
@@ -116,9 +134,7 @@ module HTMLAttributesUtils
     end
 
     def split_attribute_list(value, parents:, mergeable_attributes:)
-      return value.split if value.is_a?(String) && mergeable_attributes.include?(parents)
-
-      value
+      mergeable_attributes.include?(parents) ? try_split(value) : value
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html-attributes-utils
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 1.0.1
 platform: ruby
 authors:
 - Peter Yates
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-26 00:00:00.000000000 Z
+date: 2023-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -115,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: HTML attribute hash utilities