html_attrs 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81f6299891fbc21d5780803b427e30dfb8e07b6280e518ff974e1e5d9f5d5bbc
-  data.tar.gz: 58442fc06a5a775c197aba3ad445e23f15f7f68c3a9f69a07e9900b22640193f
+  metadata.gz: 4e275871a3e81adcaa8d6856c397adab49166f15b6f4357ae3e3606864b1559c
+  data.tar.gz: 73891eb35e4a0372a31c588f016ec14b1f7a834cccebea57718503b33a63eb18
 SHA512:
-  metadata.gz: 4cd21bb1474c4ce8be233580048c8dd604e7249ab40d84e55e4eddbda1a3f2f1a2deb9ca7ecc74e665905a61dcab2df23f76341834845ba4ed9e7a9a3ab58e6a
-  data.tar.gz: 492c60112a6c93c069f5e93ef43203d2a0f75b61456e40714d027c9604c45dec847dd1ea4fece6b91ceb1ae6025bac1e7ea1b2c65764299897e10ec87f141762
+  metadata.gz: 11166749fdd6b6680acb6a07f8743ca106c76679adde0804339b2e20ed57e1896d5fa6823f25aed5b1266447feaa2b7d0abe65fadae30e00fc49e07eb6aefd90
+  data.tar.gz: cdc3bf3931938151fa88fcb7c1a873d81776e779ff350c7643553b9e53e88a5c1382048fb15e85cad2e85628f2cfb6d523aa5200c5920fa72bd7c01ef47c7491

data/Gemfile.lock

@@ -1,9 +1,8 @@
 PATH
   remote: .
   specs:
-    html_attrs (0.1.0)
+    html_attrs (1.1.0)
       actionview (>= 6.0)
-      activesupport (>= 6.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -16,7 +16,7 @@ $ bundle add html_attrs
 ```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: '#'
@@ -28,6 +28,7 @@ html_attrs = html_attrs.smart_merge(
   data: { controller: 'popover slideover', action: 'click->popover#toggle' },
   href: '#'
 }
+# Note: #smart_merge returns an HtmlAttrs object which is a subclass of Hash, so you can use it just like a hash.
 ```
 
 You can use this in helpers that accept HTML attributes as a hash, e.g:
@@ -62,7 +63,35 @@ You can also use the `to_s` method to get the string representation of the HTML
 </a>
 ```
 
+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.
+
+If one hash that has a string key and the other has a symbol key or vice-versa, we'll convert everything to whatever the first hash has.
+
+## 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' }
+```
+
+You can also just set `mergeable_attributes: :all` to merge everything. Or you can just use `smart_merge_all` which merges everything by default.
 
+```ruby
+{ class: 'bg-primary-500', id: 'test', aria_label: 'Help' }
+  .smart_merge_all(class: 'text-red-500', aria_label: 'Another', href: '/test')
+# => { class: 'bg-primary-500 text-red-500', id: 'test', aria_label: 'Help Another', href: '/test' }
+```
+
+
+## Other ways to use
 Alternative, you can use the `HtmlAttrs` class directly, e.g:
 ```ruby
 HtmlAttrs.smart_merge(
@@ -81,18 +110,18 @@ 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`.
+Under the hood, `HtmlAttrs` is a simple wrapper around `Hash`, so you can use it just like any other hash. The only difference is `#smart_merge`, `#smart_merge_all` 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.
+<br/>
 
-## Configuring mergeable attributes
+## Interested in a powerful Rails UI library?
 
-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' }
-```
+I am working on a super-powerful Rails UI library - components as well as templates & patterns.
+
+[Please check this out if you're interested](https://owaiskhan.me/rails-ui-library).
+<br/>
+<br/>
+<br/>
 
 ## Development
 

data/lib/html_attrs.rb

@@ -1,16 +1,37 @@
 # frozen_string_literal: true
 
 require 'action_view'
-require 'active_support/core_ext/hash/indifferent_access'
 
-class HtmlAttrs < HashWithIndifferentAccess
-  VERSION = '1.0.0'
+class HtmlAttrs < Hash
+  VERSION = '1.1.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)
+  def initialize(constructor = nil)
+    if constructor.respond_to?(:to_hash)
+      super()
+      update(constructor)
+
+      hash = constructor.is_a?(Hash) ? constructor : constructor.to_hash
+      self.default = hash.default if hash.default
+      self.default_proc = hash.default_proc if hash.default_proc
+    elsif constructor.nil?
+      super()
+    else
+      super(constructor)
+    end
+  end
+
+  def smart_merge(target)
+    if target.is_a?(Hash) && target.key?(:mergeable_attributes)
+      mergeable_attributes = target.delete(:mergeable_attributes)
+    end
     mergeable_attributes ||= DEFAULT_MERGEABLE_ATTRIBUTES
-    self.class.smart_merge(self, other, mergeable_attributes: mergeable_attributes)
+    self.class.smart_merge(self, target, mergeable_attributes: mergeable_attributes)
+  end
+
+  def smart_merge_all(target)
+    target[:mergeable_attributes] = :all if target.is_a?(Hash)
+    smart_merge(target)
   end
 
   def to_s
@@ -18,37 +39,48 @@ class HtmlAttrs < HashWithIndifferentAccess
   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)
+      raise 'Expected target to be a hash or nil' unless target.is_a?(Hash)
+      raise 'Expected other to be a hash or nil' unless other.is_a?(Hash)
+
+      other = other.dup
+      target = target.dup
 
       target.each do |key, value|
-        other[key] =
-          if other.key?(key) && attribute_mergeable?(key, mergeable_attributes)
-            smart_merge(other[key], value, mergeable_attributes: :all)
+        other_type_of_key = key.is_a?(Symbol) ? key.to_s : key.to_sym
+
+        key_with_value = if other.key?(key)
+                           key
+                         elsif other.key?(other_type_of_key)
+                           other_type_of_key
+                         else
+                           nil
+                         end
+
+        other[key_with_value || key] =
+          if key_with_value && attribute_mergeable?(key, mergeable_attributes)
+            smart_merge(other[key_with_value], 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)
+      raise 'Expected target to be an array or nil' unless target.is_a?(Array)
+      raise 'Expected other to be an array or nil' unless other.is_a?(Array)
 
-      return (other || []).concat(target || [])
+      return (other.dup || []).concat(target.dup || [])
     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)
+      raise 'Expected target to be a string or nil' unless target.is_a?(String)
+      raise 'Expected other to be a string or nil' unless other.is_a?(String)
 
       return [other.presence, target.presence].compact.join(' ')
     end
@@ -56,6 +88,10 @@ class HtmlAttrs < HashWithIndifferentAccess
     target
   end
 
+  def self.smart_merge_all(other, target)
+    smart_merge(other, target, mergeable_attributes: :all)
+  end
+
   def self.attribute_mergeable?(attribute, mergeable_attributes)
     return true if mergeable_attributes == :all
 
@@ -75,4 +111,12 @@ class Hash
   def as_html_attrs
     HtmlAttrs.new(self)
   end
+
+  def smart_merge(target)
+    as_html_attrs.smart_merge(target)
+  end
+
+  def smart_merge_all(target)
+    as_html_attrs.smart_merge_all(target)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html_attrs
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Owais
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-16 00:00:00.000000000 Z
+date: 2024-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !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