html_attrs 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 81f6299891fbc21d5780803b427e30dfb8e07b6280e518ff974e1e5d9f5d5bbc
+  data.tar.gz: 58442fc06a5a775c197aba3ad445e23f15f7f68c3a9f69a07e9900b22640193f
+SHA512:
+  metadata.gz: 4cd21bb1474c4ce8be233580048c8dd604e7249ab40d84e55e4eddbda1a3f2f1a2deb9ca7ecc74e665905a61dcab2df23f76341834845ba4ed9e7a9a3ab58e6a
+  data.tar.gz: 492c60112a6c93c069f5e93ef43203d2a0f75b61456e40714d027c9604c45dec847dd1ea4fece6b91ceb1ae6025bac1e7ea1b2c65764299897e10ec87f141762

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in html_attrs.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "standard", "~> 1.3"

data/Gemfile.lock

@@ -0,0 +1,107 @@
+PATH
+  remote: .
+  specs:
+    html_attrs (0.1.0)
+      actionview (>= 6.0)
+      activesupport (>= 6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionview (7.1.3.2)
+      activesupport (= 7.1.3.2)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activesupport (7.1.3.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.6)
+    builder (3.2.4)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    drb (2.2.1)
+    erubi (1.12.0)
+    i18n (1.14.4)
+      concurrent-ruby (~> 1.0)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    minitest (5.22.2)
+    mutex_m (0.2.0)
+    nokogiri (1.16.2-arm64-darwin)
+      racc (~> 1.4)
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.3)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    rubocop (1.62.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.2)
+      parser (>= 3.3.0.4)
+    rubocop-performance (1.20.2)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+    ruby-progressbar (1.13.0)
+    standard (1.34.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.60)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.3)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.3.1)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.20.2)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  html_attrs!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.4.13

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Owais
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,109 @@
+# HtmlAttrs
+
+A simple gem to merge HTML attributes in Ruby. It's incredibly useful when you're working with HTML attributes in a Rails app.
+
+For example, you're accepting arguments in a component or partial from somewhere else that you then need to merge smartly (can be tailwind classes, data attributes for stimulus controllers, etc)
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+```shell
+$ bundle add html_attrs
+```
+
+## Usage
+
+```ruby
+html_attrs = {
+  class: 'bg-primary-500', data: { controller: 'popover', action: 'click->popover#toggle' }
+}.as_html_attrs
+
+html_attrs = html_attrs.smart_merge(
+  class: 'border border-primary-500', data: { controller: 'slideover' }, href: '#'
+)
+
+# Will produce:
+{
+  class: 'bg-primary-500 border border-primary-500',
+  data: { controller: 'popover slideover', action: 'click->popover#toggle' },
+  href: '#'
+}
+```
+
+You can use this in helpers that accept HTML attributes as a hash, e.g:
+```erb
+<%= content_tag(:a, 'Hello', html_attrs) %>
+
+<%# Will produce: %>
+<a
+  class="bg-primary-500 border border-primary-500"
+  data-controller="popover slideover"
+  data-action="click->popover#toggle"
+  href="#"
+>
+  Hello
+</a>
+```
+
+
+You can also use the `to_s` method to get the string representation of the HTML attributes, if you need to use it in a string context.
+```erb
+<a <%= html_attrs.to_s %> id='home'>Hello</a>
+
+<%# Will produce: %>
+<a
+  class="bg-primary-500 border border-primary-500"
+  data-controller="popover slideover"
+  data-action="click->popover#toggle"
+  href="#"
+  id='home'
+>
+  Hello
+</a>
+```
+
+
+Alternative, you can use the `HtmlAttrs` class directly, e.g:
+```ruby
+HtmlAttrs.smart_merge(
+  { class: 'bg-primary-500', data: { controller: 'popover' } },
+  { id: 'test', class: 'border' }
+)
+# => { class: 'bg-primary-500 border', data: { controller: 'popover' }, id: 'test' }
+```
+
+Or, you can also instantiate a new `HtmlAttrs` object and use the `smart_merge` method, e.g:
+```ruby
+html_attrs = HtmlAttrs.new(class: 'bg-primary-500', data: { controller: 'popover' })
+# => { class: 'bg-primary-500', id: 'test', aria_label: 'Help', download: 'test.jpeg' }
+
+html_attrs.smart_merge( id: 'test', class: 'border')
+# => { class: 'bg-primary-500 border', data: { controller: 'popover' }, id: 'test' }
+```
+
+Under the hood, `HtmlAttrs` is a simple wrapper around `ActiveSupport::HashWithIndifferentAccess`, so you can use it just like any other hash. The only difference is `#smart_merge` and `to_s`.
+
+Merging is done recursively. Strings are merged by concatenating them with a space. Arrays are merged with simple concatenation. Hashes are merged recursively using the above rules. Everything else is merged normally, just like with `Hash#merge`. Super simple, but super powerful.
+
+## Configuring mergeable attributes
+
+By default, this gem merges `class`, `style` and `data` attributes recursively. Which should usually be more than enough. You can easily customize this by specifying `mergeable_attributes:` when calling `smart_merge`. e.g:
+```ruby
+HtmlAttrs.new(class: 'bg-primary-500', id: 'test', aria_label: 'Help')
+  .smart_merge(aria_label: 'Another', href: '/test', mergeable_attributes: [:aria_label])
+# => { class: 'bg-primary-500', id: 'test', aria_label: 'Help Another', href: '/test' }
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. 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 [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/owaiswiz/html_attrs.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/html_attrs.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'action_view'
+require 'active_support/core_ext/hash/indifferent_access'
+
+class HtmlAttrs < HashWithIndifferentAccess
+  VERSION = '1.0.0'
+  DEFAULT_MERGEABLE_ATTRIBUTES = %i[class style data].to_set
+
+  def smart_merge(other)
+    mergeable_attributes = other.delete(:mergeable_attributes) if other.is_a?(Hash) && other.key?(:mergeable_attributes)
+    mergeable_attributes ||= DEFAULT_MERGEABLE_ATTRIBUTES
+    self.class.smart_merge(self, other, mergeable_attributes: mergeable_attributes)
+  end
+
+  def to_s
+    self.class.attributes(self)
+  end
+
+  def self.smart_merge(other, target, mergeable_attributes: DEFAULT_MERGEABLE_ATTRIBUTES)
+    other  = other.with_indifferent_access if other.is_a?(Hash) && !other.is_a?(HashWithIndifferentAccess)
+    target = target.with_indifferent_access if target.is_a?(Hash) && !target.is_a?(HashWithIndifferentAccess)
+
+    return other if target.nil?
+    return target if other.nil?
+
+    if target.is_a?(Hash) || other.is_a?(Hash)
+      raise 'Expected target to be a hash or nil' if !target.nil? && !target.is_a?(Hash)
+      raise 'Expected other to be a hash or nil' if !other.nil? && !other.is_a?(Hash)
+
+      target.each do |key, value|
+        other[key] =
+          if other.key?(key) && attribute_mergeable?(key, mergeable_attributes)
+            smart_merge(other[key], value, mergeable_attributes: :all)
+          else
+            value
+          end
+      end
+      return other
+    end
+
+    if target.is_a?(Array) || other.is_a?(Array)
+      raise 'Expected target to be an array or nil' if !target.nil? && !target.is_a?(Array)
+      raise 'Expected other to be an array or nil' if !other.nil? && !other.is_a?(Array)
+
+      return (other || []).concat(target || [])
+    end
+
+    if target.is_a?(String) || other.is_a?(String)
+      raise 'Expected target to be a string or nil' if !target.nil? && !target.is_a?(String)
+      raise 'Expected other to be a string or nil' if !other.nil? && !other.is_a?(String)
+
+      return [other.presence, target.presence].compact.join(' ')
+    end
+
+    target
+  end
+
+  def self.attribute_mergeable?(attribute, mergeable_attributes)
+    return true if mergeable_attributes == :all
+
+    mergeable_attributes.include?(attribute.to_sym)
+  end
+
+  def self.attributes(hash)
+    tag_helper.tag_options(hash).to_s.strip.html_safe
+  end
+
+  def self.tag_helper
+    @tag_helper ||= ActionView::Helpers::TagBuilder.new(nil)
+  end
+end
+
+class Hash
+  def as_html_attrs
+    HtmlAttrs.new(self)
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: html_attrs
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Owais
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: A gem that provides a way to smartly merge HTML attributes
+email:
+- owaiswiz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/html_attrs.rb
+homepage: https://github.com/owaiswiz/html_attrs
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/owaiswiz/html_attrs
+  source_code_uri: https://github.com/owaiswiz/html_attrs
+  changelog_uri: https://github.com/owaiswiz/html_attrs/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: A gem that provides a way to smartly merge HTML attributes
+test_files: []