html-attributes-utils 0.9.0 → 0.9.2a1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a383443446570cb37c2c67e608c4bcde35ecf1b255eca392cbcc263d5a36ae76
-  data.tar.gz: 2b81b3e7929301ee349b330dae54131b79f93afe417db7e57b934cc4c8a96615
+  metadata.gz: 631ae9c1de4c05565e53583b4d4ad4b11919fb8b4ee65bd0fe8e751ce1cb71cd
+  data.tar.gz: 59f130f0f247944cb2c3d72f7a76ebc55bd21f4fb1ce373e8fa0cd99e2b034b1
 SHA512:
-  metadata.gz: 9c2568b9c1a67be8cad3df9ccd4eb5f11a9e612c27da3438acddc2587eaaee2d12138adf9397aeb43bb0d05e57b3fa3735df9caf0437a8cb6d53b8eddc937e59
-  data.tar.gz: ce81b1c86dcbf9e464a9268d02e595a60ee6eb30ba5fd0e5fa829a5f8ed233bee252da1a06716ba9ff0a06a565a70010d71d372acc42796e7c104c6ab222d98f
+  metadata.gz: 7419b9e2b423592a8ed9d2c062ba251229833e129d62eb3c4749140e530dd62dbade2e19bdadcbaea0bf5a8d9cef72a7524c23af9db7260f4108920fd13bca27
+  data.tar.gz: cf98c264969fb7b22db802c1020f69d8d1659a9dd701bf1768611c4ad0ae134c4e12c18dafbd3e8ad52bc283cad7f1cc0d2fe3fb476cca96d41a34eff96f5c87

data/README.md

@@ -1,3 +1,41 @@
 # HTML Attributes Utilities
 
-This is a small library intended to make it easier to deal with hashes of attributes.
+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
+[govuk-formbuilder](https://github.com/DFE-Digital/govuk-formbuilder) libraries.
+
+It provides refinements for `Hash` that allow:
+
+* deep merging while protecting default values from being overwritten
+* tidying hashes by removing key/value pairs that have empty or nil values
+
+## Example use
+
+```ruby
+require "html_attributes_utils"
+
+def MyPresenter
+  using HTMLAttributesUtils
+
+  def initialize(custom_attributes = {})
+    @custom_attributes = custom_attributes
+  end
+
+  def attributes
+    default_attributes
+      .deep_merge_html_attributes(@custom_attributes)
+      .deep_tidy_html_attributes
+  end
+
+private
+
+  def default_attributes
+    { lang: "en-GB", class: "govuk-juggling-widget" }
+  end
+end
+
+MyPresenter.new(lang: "fr", class: "stripes", some_other_attr: "").attributes
+
+=> { lang: "fr", class: ["govuk-juggling-widget", "stripes"] }
+```

data/lib/html_attributes_utils.rb

@@ -1,6 +1,23 @@
 require "active_support/core_ext/hash/keys"
 
 module HTMLAttributesUtils
+  # DEFAULT_MERGEABLE_ATTRIBUTES is a list of HTML attributes where the value
+  # contain multiple elements separated by spaces. We use it to target values
+  # to split so the arrays can be cleanly merged.
+  #
+  # 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`
+  DEFAULT_MERGEABLE_ATTRIBUTES = [
+    %i(class),
+    %i(aria controls),
+    %i(aria describedby),
+    %i(aria flowto),
+    %i(aria labelledby),
+    %i(aria owns),
+  ].freeze
+
   refine Hash do
     # Merge the incoming hash into the current one in a way that suits
     # HTML attributes.
@@ -21,18 +38,19 @@ module HTMLAttributesUtils
     #
     #   => { class: "blue", data: { size: "medium", controller: "reply" } }
     #
-    def deep_merge_html_attributes(custom, parents = [], mergeable_attributes: default_mergeable_attributes)
+    def deep_merge_html_attributes(custom, parents = [], mergeable_attributes: DEFAULT_MERGEABLE_ATTRIBUTES)
       return custom unless custom.is_a?(Hash)
 
       overrides = custom.deep_symbolize_keys
+      originals = deep_symbolize_keys
 
-      deep_symbolize_keys.each_with_object(deep_symbolize_keys) { |(key, value), merged|
+      originals.each_with_object(originals) { |(key, value), merged|
         next unless overrides.key?(key)
 
         merged[key] = combine_values(
           value,
           overrides[key],
-          parents: parents << key,
+          parents: [*parents, *key],
           mergeable_attributes: mergeable_attributes
         )
 
@@ -53,9 +71,7 @@ module HTMLAttributesUtils
     #   => { class: "blue" }
     #
     def deep_tidy_html_attributes
-      each_with_object({}) do |(key, value), tidy|
-        (tidy[key] = tidy_value(value)) unless skippable_value?(value)
-      end
+      each_with_object({}) { |(k, v), tidied| (tidied[k] = tidy_value(v)) unless v.nil? }.compact
     end
 
   private
@@ -65,27 +81,14 @@ module HTMLAttributesUtils
       when Hash
         value.deep_tidy_html_attributes.presence
       when Array
-        value.reject(&:blank?).presence
-      when String
-        value.strip.presence
-      else
+        (value.empty?) ? nil : value.map { |v| tidy_value(v) }.compact
+      when TrueClass, FalseClass
         value
+      else
+        value.to_s.strip.presence
       end
     end
 
-    # Identiy attribute values we don't care about.
-    #
-    # We can't check for this using Rails' `#presence` because we want `false` to be
-    # included so some HTML attributes that default to on can be disabled, like
-    # `autocomplete: false`
-    #
-    # FIXME: there is probably a nicer way of doing this...
-    def skippable_value?(value)
-      return false if [true, false].include?(value)
-
-      value.blank?
-    end
-
     def combine_values(value, override, **kwargs)
       case split_attribute_list(value, **kwargs)
       when Array
@@ -117,16 +120,5 @@ module HTMLAttributesUtils
 
       value
     end
-
-    def default_mergeable_attributes
-      [
-        %i(class),
-        %i(aria controls),
-        %i(aria describedby),
-        %i(aria flowto),
-        %i(aria labelledby),
-        %i(aria owns),
-      ]
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html-attributes-utils
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.2a1
 platform: ruby
 authors:
 - Peter Yates
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-23 00:00:00.000000000 Z
+date: 2022-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 4.3.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
 description: A small collection of utilities to ease working with hashes of HTML attributes
 email:
 - peter.yates@graphia.co.uk
@@ -97,9 +111,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.3.7
 signing_key: