heroicons_helper 0.7.1 → 0.8.0

data/lib/heroicons_helper/icon.rb

@@ -6,36 +6,37 @@ require "active_support/core_ext/string/output_safety"
 module HeroiconsHelper
   # Icon to show heroicons by name and variant.
   class Icon
-    attr_reader :path, :attributes, :width, :height, :name, :variant, :keywords
+    attr_reader :inner, :attributes, :width, :height, :name, :variant, :keywords
 
     VARIANT_OUTLINE = "outline"
     VARIANT_SOLID = "solid"
     VARIANT_MINI = "mini"
-    VALID_VARIANTS = Set.new([VARIANT_OUTLINE, VARIANT_SOLID, VARIANT_MINI]).freeze
+    VARIANT_MICRO = "micro"
+    VALID_VARIANTS = Set.new([VARIANT_OUTLINE, VARIANT_SOLID, VARIANT_MINI, VARIANT_MICRO]).freeze
 
-    def initialize(name, variant, unsafe: false, attributes: {})
+    def initialize(name, variant, size: nil, attributes: {})
       @name = name.to_s
       @variant = variant.to_s
-      @unsafe = unsafe
 
       heroicon = get_heroicon(@name, @variant)
 
-      @path = safe? ? ActiveSupport::SafeBuffer.new(heroicon["path"]) : heroicon["path"]
-      @width = heroicon["width"]
-      @height = heroicon["height"]
+      @inner = heroicon["inner"]
+      @width = size || heroicon["width"]
+      @height = size || heroicon["height"]
       @keywords = heroicon["keywords"]
-      @attributes = attributes.dup.compact
-      @attributes[:class] = classes
-      @attributes[:viewBox] = viewbox
-      @attributes.merge!(size)
-      @attributes[:version] = "1.1"
-      @attributes.merge!(variant_attributes)
-      @attributes.merge!(a11y)
+      @attributes = attributes.merge(heroicon["attributes"])
+      @attributes.merge!({
+        "class" => classes,
+        "viewBox" => viewbox,
+        "version" => "1.1",
+      })
+        .merge!(a11y)
+        .compact!
     end
 
     # Returns an string representing a <svg> tag
     def to_svg
-      "<!-- Heroicon name: #{@variant}/#{@name} --><svg xmlns=\"http://www.w3.org/2000/svg\" #{html_attributes}>#{@path}</svg>"
+      "<svg #{html_attributes}>#{@inner}</svg>"
     end
 
     private def safe?
@@ -53,9 +54,9 @@ module HeroiconsHelper
       accessible = {}
 
       if @attributes[:"aria-label"].nil? && @attributes["aria-label"].nil?
-        accessible[:"aria-hidden"] = "true"
+        accessible["aria-hidden"] = "true"
       else
-        accessible[:role] = "img"
+        accessible["role"] = "img"
       end
 
       accessible
@@ -63,44 +64,13 @@ module HeroiconsHelper
 
     # prepare the heroicon class
     private def classes
-      "heroicon heroicon-#{@name}-#{@variant} #{@attributes[:class]} ".strip
-    end
-
-    private def variant_attributes
-      case @variant
-      when VARIANT_OUTLINE
-        {
-          fill: "none",
-        }
-      when VARIANT_SOLID, VARIANT_MINI
-        {
-          fill: "currentColor",
-        }
-      end
+      "heroicon heroicon-#{@variant}-#{@name} #{@attributes[:class]} ".strip
     end
 
     private def viewbox
       "0 0 #{@width} #{@height}"
     end
 
-    # determine the height and width of the heroicon based on :size option
-    private def size
-      size = {
-        width: @width,
-        height: @height,
-      }
-
-      # Specific size
-      unless @attributes[:width].nil? && @attributes[:height].nil?
-        size[:width]  = @attributes[:width].nil? ? calculate_width(@attributes[:height]) : @attributes[:width]
-        size[:height] = @attributes[:height].nil? ? calculate_height(@attributes[:width]) : @attributes[:height]
-        @width = size[:width]
-        @height = size[:height]
-      end
-
-      size
-    end
-
     private def calculate_width(height)
       (height.to_i * @width) / @height
     end
@@ -114,7 +84,7 @@ module HeroiconsHelper
 
       raise ArgumentError, "Variant `#{variant.inspect}` is invalid; must be one of #{VALID_VARIANTS.join(", ")}" unless VALID_VARIANTS.include?(variant)
 
-      icon = HeroiconsHelper::ICON_NAMES[name]
+      icon = HeroiconsHelper::ICONS[name]
 
       raise ArgumentError, "Couldn't find Heroicon for `#{name.inspect}`" unless icon
 
@@ -127,7 +97,8 @@ module HeroiconsHelper
         "keywords" => icon["keywords"] || [],
         "width" => icon_variant["width"],
         "height" => icon_variant["height"],
-        "path" => icon_variant["path"],
+        "attributes" => icon_variant["attributes"],
+        "inner" => icon_variant["inner"],
       }
     end
   end

data/lib/heroicons_helper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HeroiconsHelper
-  VERSION = "0.7.1"
+  VERSION = "0.8.0"
 end

data/lib/heroicons_helper.rb

@@ -7,20 +7,20 @@ require "json"
 
 module HeroiconsHelper
   file_data = File.read(File.join(File.dirname(__FILE__), "./heroicons_helper/data.json"))
-  ICON_NAMES = JSON.parse(file_data).freeze
+  ICONS = JSON.parse(file_data).freeze
 
-  def heroicon(name, variant:, unsafe: false, **attributes)
+  def heroicon(name, variant:, size: nil, **attributes)
     cache_key = HeroiconsHelper::Cache.get_key(
       name: name,
       variant: variant,
-      unsafe: unsafe,
+      size: size,
       attributes: attributes,
     )
 
     cached_heroicon = HeroiconsHelper::Cache.read(cache_key)
     return cached_heroicon unless cached_heroicon.nil?
 
-    heroicon = ::HeroiconsHelper::Icon.new(name, variant, unsafe: unsafe, attributes: attributes)
+    heroicon = ::HeroiconsHelper::Icon.new(name, variant, size: size, attributes: attributes)
     HeroiconsHelper::Cache.set(cache_key, heroicon)
 
     heroicon

data/package-lock.json

@@ -301,9 +301,9 @@
       }
     },
     "node_modules/fast-glob": {
-      "version": "3.3.1",
-      "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.1.tgz",
-      "integrity": "sha512-kNFPyjhh5cKjrUltxs+wFx+ZkbRaxxmZ+X0ZU31SOsxCEtP9VPgtq2teZw1DebupL5GmDaNQ6yKMMVcM41iqDg==",
+      "version": "3.3.2",
+      "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.2.tgz",
+      "integrity": "sha512-oX2ruAFQwf/Orj8m737Y5adxDQO0LAB7/S5MnxCdTNDd4p6BsyIVsv9JQsATbTSq8KHRpLwIHbVlUNatxd+1Ow==",
       "dev": true,
       "dependencies": {
         "@nodelib/fs.stat": "^2.0.2",
@@ -317,9 +317,9 @@
       }
     },
     "node_modules/fastq": {
-      "version": "1.15.0",
-      "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.15.0.tgz",
-      "integrity": "sha512-wBrocU2LCXXa+lWBt8RoIRD89Fi8OdABODa/kEnyeyjS5aZO5/GNvI5sEINADqP/h8M29UHTHUb53sUu5Ihqdw==",
+      "version": "1.17.1",
+      "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.17.1.tgz",
+      "integrity": "sha512-sRVD3lWVIXWg6By68ZN7vho9a1pQcN/WBFaAAsDDFzlJjvoGx0P8z7V1t72grFJfJhu3YPZBuu25f7Kaw2jN1w==",
       "dev": true,
       "dependencies": {
         "reusify": "^1.0.4"
@@ -412,9 +412,9 @@
       "dev": true
     },
     "node_modules/heroicons": {
-      "version": "2.0.18",
-      "resolved": "https://registry.npmjs.org/heroicons/-/heroicons-2.0.18.tgz",
-      "integrity": "sha512-3iaqznaz5GJ8Mox/eDfKHo7tYKuPiZV4vbg6pB6wjJhBa7ZKQlXT1KuUnsjkEiPy/ezyiqppOX6wUqYguMIq8w==",
+      "version": "2.1.3",
+      "resolved": "https://registry.npmjs.org/heroicons/-/heroicons-2.1.3.tgz",
+      "integrity": "sha512-Fom8AaUho83oeGPCne9oo1F6A+2r4BPmY59qOkML4LIu+xQNS/yv8OmcrxCuiVs7X42oTRAnFbOJHGDwIlI8HA==",
       "dev": true
     },
     "node_modules/htmlparser2": {
@@ -437,9 +437,9 @@
       }
     },
     "node_modules/ignore": {
-      "version": "5.2.4",
-      "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.2.4.tgz",
-      "integrity": "sha512-MAb38BcSbH0eHNBxn7ql2NH/kX33OkB3lZ1BNdh7ENeRChHTYsTvWrMubiIAMNS2llXEEgZ1MUOBtXChP3kaFQ==",
+      "version": "5.3.1",
+      "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.1.tgz",
+      "integrity": "sha512-5Fytz/IraMjqpwfd34ke28PTVMjZjJG2MPn5t7OE4eUCUNf8BAa7b5WUS9/Qvr6mwOQS7Mk6vdsMno5he+T8Xw==",
       "dev": true,
       "engines": {
         "node": ">= 4"
@@ -767,9 +767,9 @@
       }
     },
     "node_modules/tslib": {
-      "version": "2.6.1",
-      "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.6.1.tgz",
-      "integrity": "sha512-t0hLfiEKfMUoqhG+U1oid7Pva4bbDPHYfJNiB7BiIjRkj1pyC++4N3huJfqY6aRH6VTB0rvtzQwjM4K6qpfOig==",
+      "version": "2.6.2",
+      "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.6.2.tgz",
+      "integrity": "sha512-AEYxH93jGFPn/a2iVAwW87VuUIkR1FVUKB77NwMF7nBTDkDrrT/Hpt/IrCJ0QXhW27jTBDcf5ZY7w6RiqTMw2Q==",
       "dev": true
     },
     "node_modules/universalify": {

data/script/update_heroicons

@@ -19,9 +19,10 @@ const { argv } = yargs
     type: "array",
     describe: "Input SVG files",
     default: [
+      "node_modules/heroicons/16/solid/*.svg",
+      "node_modules/heroicons/20/solid/*.svg",
       "node_modules/heroicons/24/outline/*.svg",
       "node_modules/heroicons/24/solid/*.svg",
-      "node_modules/heroicons/20/solid/*.svg",
     ],
   })
   .option("output", {
@@ -45,24 +46,31 @@ if (svgFilepaths.length === 0) {
 
 let exitCode = 0;
 
-const validTypes = ["solid", "outline", "mini"];
+const validTypes = ["micro", "mini", "outline", "solid"];
 const defaultOutlineWidth = parseInt("24");
 const defaultSolidWidth = parseInt("24");
 const defaultMiniWidth = parseInt("20");
+const defaultMicroWidth = parseInt("16");
+
+function omit(obj, key) {
+  const { [key]: ignore, ...rest } = obj;
+  return rest;
+}
 
 const icons = svgFilepaths.map((filepath) => {
   try {
     const filename = path.parse(filepath).base;
     let splitDir = path.parse(filepath).dir.split("/");
-    let type = splitDir.pop();
+    let variant = splitDir.pop();
     const size = splitDir.pop();
 
     const svg = fs.readFileSync(path.resolve(filepath), "utf8");
     const svgElement = cheerio.load(svg)("svg");
+    let svgAttributes = omit(svgElement[0].attribs, "aria-hidden");
     let svgWidth = parseInt(svgElement.attr("width")) || parseInt(size);
     let svgHeight = parseInt(svgElement.attr("height")) || parseInt(size);
     const svgViewBox = svgElement.attr("viewBox");
-    const svgPath = trimNewlines(svgElement.html()).trim();
+    const svgInner = trimNewlines(svgElement.html()).trim();
 
     if (!svgWidth) {
       svgWidth = parseInt(widthSize);
@@ -100,18 +108,21 @@ const icons = svgFilepaths.map((filepath) => {
       );
     }
 
-    if (svgWidth == defaultMiniWidth && type == "solid") {
-      type = "mini";
+    if (svgWidth == defaultMicroWidth && variant == "solid") {
+      variant = "micro";
+    } else if (svgWidth == defaultMiniWidth && variant == "solid") {
+      variant = "mini";
     }
     const name = filename.slice(0, -4);
 
     return {
       name,
       keywords: keywords[name] || [],
-      type: type,
+      variant: variant,
       width: svgWidth,
       height: svgHeight,
-      path: svgPath,
+      attributes: svgAttributes,
+      inner: svgInner,
     };
   } catch (error) {
     // eslint-disable-next-line no-console
@@ -138,10 +149,11 @@ const iconsByName = icons.reduce(
         name: icon.name,
         keywords: icon.keywords,
         variants: {
-          [icon.type]: {
+          [icon.variant]: {
+            attributes: icon.attributes,
             width: icon.width,
             height: icon.height,
-            path: icon.path,
+            inner: icon.inner,
           },
         },
       },

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heroicons_helper
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Garen J. Torikian
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-08-14 00:00:00.000000000 Z
+date: 2024-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.18
+rubygems_version: 3.4.6
 signing_key: 
 specification_version: 4
 summary: Heroicons port for Ruby