katalyst-html-attributes 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c34f229d9784bc7a7a2e3294863b74545363475502ebd8fd596a92065f5ffa59
+  data.tar.gz: 0c3fbe888484371b8311364d9975f0d0665ed794b47c37507231a3a9b7f771b6
+SHA512:
+  metadata.gz: 1c14e664a778f6b53489f8ffd6b2dd5fbe3246acff220d72dc1c77ea4a9c8227e4f21d952ee361dc6682d028d2346662f28e48f4c9addf9a83ecfdcb2c0ca00e
+  data.tar.gz: bd3db38303941162806e219224c880f0656590e001c9f95d4d3a91a4f76c85d0997ae6e282b27e0a28d2571ae15ef4b9636c60e683df0f063a7337abbbeed659

data/README.md

@@ -0,0 +1,32 @@
+# HTML Attributes Utilities
+
+This is a small library intended to make it easier to deal with HTML
+attributes in View Components. It is based on 
+https://github.com/x-govuk/html-attributes-utils
+
+It uses 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
+class MyViewComponent < ViewComponent::Base
+  include Katalyst::HtmlAttributes
+  
+  def initialize(**html_attributes)
+    super
+  end
+  
+  def call
+    tag.div(**html_attributes)
+  end
+
+  def default_html_attributes
+    {
+      class: "my-class"
+    }
+  end
+end
+```

data/lib/katalyst/html_attributes/has_html_attributes.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "html_attributes_utils"
+
+module Katalyst
+  module HtmlAttributes
+    # Adds HTML attributes to a component.
+    # Accepts HTML attributes from the constructor or via `html_attributes=`.
+    # These are merged with the default attributes defined in the component.
+    # Adds support for custom html attributes for other tags, e.g.:
+    #   define_html_attribute_methods :table_attributes, default: {}
+    #   tag.table(**table_attributes)
+    module HasHtmlAttributes
+      extend ActiveSupport::Concern
+
+      using HTMLAttributesUtils
+
+      MERGEABLE_ATTRIBUTES = [
+        *HTMLAttributesUtils::DEFAULT_MERGEABLE_ATTRIBUTES,
+        %i[data controller],
+        %i[data action],
+      ].freeze
+
+      FLATTENABLE_ATTRIBUTES = [
+        %i[data controller],
+        %i[data action],
+      ].freeze
+
+      refine NilClass do
+        def flatten_html(*)
+          self
+        end
+      end
+
+      refine Hash do
+        def merge_html(attributes)
+          result = deep_merge_html_attributes(attributes, mergeable_attributes: MERGEABLE_ATTRIBUTES)
+          FLATTENABLE_ATTRIBUTES.each_with_object(result) do |path, flattened|
+            flattened.flatten_html(*path)
+          end
+        end
+
+        def flatten_html(key, *path)
+          if path.empty?
+            self[key] = self[key].join(" ") if self[key].is_a?(Array)
+          else
+            self[key].flatten_html(*path)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/katalyst/html_attributes.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "html_attributes/has_html_attributes"
+
+module Katalyst
+  module HtmlAttributes
+    extend ActiveSupport::Concern
+
+    class_methods do
+      using HasHtmlAttributes
+
+      def define_html_attribute_methods(name, default: {})
+        define_method("default_#{name}") { default }
+        private("default_#{name}")
+
+        define_method(name) do
+          send("default_#{name}").merge_html(instance_variable_get("@#{name}") || {})
+        end
+
+        define_method("#{name}=") do |options|
+          instance_variable_set("@#{name}", options.slice(:id, :aria, :class, :data).merge(options.fetch(:html, {})))
+        end
+      end
+    end
+
+    included do
+      define_html_attribute_methods :html_attributes, default: {}
+    end
+
+    def initialize(**options)
+      super(**options.except(:id, :aria, :class, :data, :html))
+
+      self.html_attributes = options
+    end
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: katalyst-html-attributes
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Katalyst Interactive
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-12-04 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: html-attributes-utils
+  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'
+description:
+email:
+- developers@katalyst.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/katalyst/html_attributes.rb
+- lib/katalyst/html_attributes/has_html_attributes.rb
+homepage: https://github.com/katalyst/html-attributes
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.20
+signing_key:
+specification_version: 4
+summary: HTML Attributes utilities for use with ViewComponents
+test_files: []