heroicon-rails 0.1.6 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0214bfedc0c7488301225dcc5db5ee1fc4b18c6d9c8527e37f8a9cfc7ab4a5c
-  data.tar.gz: 6c0750926dcfd9de8fb09e170fdeda5d1838f01363f179f598763b672867f094
+  metadata.gz: 0fd24c0a8c60585d43fd4a309683be26a7d35acf5dbb03fe15954e82fbc0f0fb
+  data.tar.gz: 7b826a26b7d0d63344d440f1d2a1fe9ba5a186459811715a3abecb34ae37988f
 SHA512:
-  metadata.gz: c694424cf64b65d23e5561aadaa590e726df4ce4a22f6dedc9ed53e5f30348c1a1ee2f68cdbc151b7df147a654273e733950be5827af7737efab5759f1764e96
-  data.tar.gz: 8db9fd21bdb5a4fad0cc7c36bd004994b2e443070b756d2697a216c0431b14c027fb08a1ea11ddc8b4fb986fb1c997e1ed5b3ea01d52133aa166bc7b1f547933
+  metadata.gz: 2e0cf0ea42905ff83e9b421ef5c4bc4aec5561391badd97cacaf97668b662650dd494c6096fbf48c5eaa4ebcf39213e832ddd080885e43dc2db77d4667ec5da8
+  data.tar.gz: 433d722e0d39c230365b3be72081749ee36ff063515f26854675adeae71e4167b1f193c237004b4c4e1c2f5a61192d85e94dc842295a0047e3d0329ff6964e4d

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
-## [0.1.0] - 2023-11-26
-
+## [0.1.6] - Initial stable release
 - Initial release
+## [0.1.7] - Updates for accessibility
+- Update all svg elements to have a role="img"
+- Update all svg elements to have a descriptive <title> element
+- Update all svg elements to have an aria-labelledby attribute referencing the <title> element
+

data/heroicon-rails.gemspec

@@ -32,8 +32,8 @@ Gem::Specification.new do |spec|
 
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"
-  spec.add_runtime_dependency "activesupport", ">= 5.2.7"
-  spec.add_dependency "nokogiri", ">= 1.15.5"
+  spec.add_runtime_dependency "activesupport", ">= 7.0.8"
+  spec.add_dependency "nokogiri", ">= 1.14.3"
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/heroicon/rails/heroicon_helper.rb

@@ -3,20 +3,39 @@ require 'active_support/core_ext/string/output_safety'
 module HeroiconHelper
   HEROICONS_PATH = File.expand_path("assets/heroicons", __dir__)
 
+  # Returns an SVG icon from the Heroicons library with customizable dimensions.
+  # @param name [String] the name of the icon
+  # @param type [String] the style of the icon (default: "solid")
+  # @param options [Hash] additional options including custom CSS classes
+  # @return [String] HTML safe string with the SVG content or error message
   def heroicon(name, type: "solid", **options)
-    css_classes = options.delete(:class) || ""
-
+    custom_class = options.delete(:class) || ""
     gem_root = Gem::Specification.find_by_name("heroicon-rails").gem_dir
-    file_path = File.join(gem_root, "lib", "heroicon", "rails", "assets", "heroicons", type, "#{name}.svg")
-    svg_content = File.read(file_path)
-    doc = Nokogiri::HTML::DocumentFragment.parse(svg_content)
-    svg = doc.at_css("svg")
-    default_css = type == "mini" ? "w-5 h-5" : "w-6 h-6"
-    css_classes = "#{default_css} #{css_classes}".strip
+    icon_path = File.join(gem_root, "lib", "heroicon", "rails", "assets", "heroicons", type, "#{name}.svg")
+    icon_content = File.read(icon_path)
+    icon_doc = Nokogiri::HTML::DocumentFragment.parse(icon_content)
+    svg = icon_doc.at_css("svg")
+
+    # Identify custom width and height classes
+    custom_width_class = custom_class[/\bw-\d+/]
+    custom_height_class = custom_class[/\bh-\d+/]
+
+    # Define default classes, replace with custom if present
+    default_width = custom_width_class ? '' : (type == "mini" ? "w-5" : "w-6")
+    default_height = custom_height_class ? '' : (type == "mini" ? "h-5" : "h-6")
+    css_classes = "#{default_width} #{default_height} #{custom_class}".strip
     svg[:class] = css_classes unless css_classes.empty?
 
-    doc.to_html.html_safe
-  rescue StandardError
-    "heroicon '#{name}' not found"
+    # Enhance accessibility
+    svg[:role] = "img"
+    svg["aria-labelledby"] = "#{name}-icon"
+    title_element = Nokogiri::XML::Node.new("title", icon_doc)
+    title_element.content = name.humanize
+    title_element[:id] = "#{name}-icon"
+    svg.prepend_child(title_element)
+
+    icon_doc.to_html.html_safe
+  rescue StandardError => e
+    "Icon '#{name}' not found. Error: #{e.message}"
   end
 end

data/lib/heroicon/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Heroicon
   module Rails
-    VERSION = "0.1.6"
+    VERSION = "0.2.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heroicon-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.3
 platform: ruby
 authors:
 - Carl Weis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-26 00:00:00.000000000 Z
+date: 2024-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.7
+        version: 7.0.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.7
+        version: 7.0.8
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.15.5
+        version: 1.14.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.15.5
+        version: 1.14.3
 description: This gem simplifies the process of using Heroicons, a popular SVG icon
   library, in Ruby on Rails applications. It offers a convenient helper method that
   allows developers to easily embed any Heroicon with customizable types (solid, outline,