heroicons_helper 0.4.1 → 0.6.0

data/lib/heroicons_helper/icon.rb

@@ -1,19 +1,22 @@
 # frozen_string_literal: true
 
+require "set"
+
 module HeroiconsHelper
   # Icon to show heroicons by name and variant.
   class Icon
-    attr_reader :path, :attributes, :width, :height, :symbol, :variant, :keywords
+    attr_reader :path, :attributes, :width, :height, :name, :variant, :keywords
 
     VARIANT_OUTLINE = "outline"
     VARIANT_SOLID = "solid"
-    VARIANTS = [VARIANT_OUTLINE, VARIANT_SOLID].freeze
+    VARIANT_MINI = "mini"
+    VALID_VARIANTS = Set.new([VARIANT_OUTLINE, VARIANT_SOLID, VARIANT_MINI]).freeze
 
-    def initialize(symbol, variant, attributes: {})
-      @symbol = symbol.to_s
+    def initialize(name, variant, attributes: {})
+      @name = name.to_s
       @variant = variant.to_s
 
-      heroicon = get_heroicon(@symbol, @variant)
+      heroicon = get_heroicon(@name, @variant)
 
       @path = heroicon["path"]
       @width = heroicon["width"]
@@ -30,7 +33,7 @@ module HeroiconsHelper
 
     # Returns an string representing a <svg> tag
     def to_svg
-      "<svg xmlns=\"http://www.w3.org/2000/svg\" #{html_attributes}>#{@path}</svg>"
+      "<!-- Heroicon name: #{@variant}/#{@name} --><svg xmlns=\"http://www.w3.org/2000/svg\" #{html_attributes}>#{@path}</svg>"
     end
 
     private def html_attributes
@@ -52,9 +55,9 @@ module HeroiconsHelper
       accessible
     end
 
-    # prepare the octicon class
+    # prepare the heroicon class
     private def classes
-      "heroicon heroicon-#{@symbol}-#{@variant} #{@attributes[:class]} ".strip
+      "heroicon heroicon-#{@name}-#{@variant} #{@attributes[:class]} ".strip
     end
 
     private def variant_attributes
@@ -64,7 +67,7 @@ module HeroiconsHelper
           fill: "none",
           stroke: "currentColor",
         }
-      when VARIANT_SOLID
+      when VARIANT_SOLID, VARIANT_MINI
         {
           fill: "currentColor",
         }
@@ -75,7 +78,7 @@ module HeroiconsHelper
       "0 0 #{@width} #{@height}"
     end
 
-    # determine the height and width of the octicon based on :size option
+    # determine the height and width of the heroicon based on :size option
     private def size
       size = {
         width: @width,
@@ -101,17 +104,17 @@ module HeroiconsHelper
       (width.to_i * @height) / @width
     end
 
-    private def get_heroicon(symbol, variant)
-      raise ArgumentError, "Icon name can't be empty" if symbol.empty?
+    private def get_heroicon(name, variant)
+      raise ArgumentError, "Icon name can't be empty" if name.empty?
 
-      raise ArgumentError, "Variant `#{variant.inspect}` is invalid; must be one of #{VARIANTS.join(", ")}" unless VARIANTS.include?(variant)
+      raise ArgumentError, "Variant `#{variant.inspect}` is invalid; must be one of #{VALID_VARIANTS.join(", ")}" unless VALID_VARIANTS.include?(variant)
 
-      icon = HeroiconsHelper::ICON_SYMBOLS[symbol]
+      icon = HeroiconsHelper::ICON_NAMES[name]
 
-      raise ArgumentError, "Couldn't find Heroicon for `#{symbol.inspect}`" unless icon
+      raise ArgumentError, "Couldn't find Heroicon for `#{name.inspect}`" unless icon
 
       icon_variant = icon["variants"][variant]
-      raise ArgumentError, "Heroicon for `#{symbol.inspect}` doesn't have variant `#{variant.inspect}`" unless icon_variant
+      raise ArgumentError, "Heroicon for `#{name.inspect}` doesn't have variant `#{variant.inspect}`" unless icon_variant
 
       {
         "name" => icon["name"],

data/lib/heroicons_helper/version.rb

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

data/lib/heroicons_helper.rb

@@ -7,9 +7,22 @@ require "json"
 
 module HeroiconsHelper
   file_data = File.read(File.join(File.dirname(__FILE__), "./heroicons_helper/data.json"))
-  ICON_SYMBOLS = JSON.parse(file_data).freeze
+  ICON_NAMES = JSON.parse(file_data).freeze
 
-  def heroicon(symbol, variant:, **attributes)
-    ::HeroiconsHelper::Icon.new(symbol, variant, attributes: attributes)
+  def heroicon(name, variant:, **attributes)
+    cache_key = HeroiconsHelper::Cache.get_key(
+      name: name,
+      variant: variant,
+      height: attributes[:height],
+      width: attributes[:width]
+    )
+
+    cached_heroicon = HeroiconsHelper::Cache.read(cache_key)
+    return cached_heroicon unless cached_heroicon.nil?
+
+    heroicon = ::HeroiconsHelper::Icon.new(name, variant, attributes: attributes)
+    HeroiconsHelper::Cache.set(cache_key, heroicon)
+
+    heroicon
   end
 end

data/package-lock.json

@@ -9,7 +9,7 @@
         "cheerio": "1.0.0-rc.11",
         "fs-extra": "^7.0.1",
         "globby": "11.0.0",
-        "heroicons": "^1.0.6",
+        "heroicons": "^2.0.0",
         "lodash.merge": "4.6.2",
         "trim-newlines": "3.0.1",
         "yargs": "15.1.0"
@@ -289,9 +289,9 @@
       "dev": true
     },
     "node_modules/entities": {
-      "version": "4.3.0",
-      "resolved": "https://registry.npmjs.org/entities/-/entities-4.3.0.tgz",
-      "integrity": "sha512-/iP1rZrSEJ0DTlPiX+jbzlA3eVkY/e8L8SozroF395fIqE3TYF/Nz7YOMAawta+vLmyJ/hkGNNPcSbMADCCXbg==",
+      "version": "4.3.1",
+      "resolved": "https://registry.npmjs.org/entities/-/entities-4.3.1.tgz",
+      "integrity": "sha512-o4q/dYJlmyjP2zfnaWDUC6A3BQFmVTX+tZPezK7k0GLSU9QYCauscf5Y+qcEPzKL+EixVouYDgLQK5H9GrLpkg==",
       "dev": true,
       "engines": {
         "node": ">=0.12"
@@ -412,9 +412,9 @@
       "dev": true
     },
     "node_modules/heroicons": {
-      "version": "1.0.6",
-      "resolved": "https://registry.npmjs.org/heroicons/-/heroicons-1.0.6.tgz",
-      "integrity": "sha512-5bxTsG2hyNBF0l+BrFlZlR5YngQNMfl0ggJjIRkMSADBQbaZMoTg47OIQzq6f1mpEZ85HEIgSC4wt5AeFM9J2Q==",
+      "version": "2.0.7",
+      "resolved": "https://registry.npmjs.org/heroicons/-/heroicons-2.0.7.tgz",
+      "integrity": "sha512-BuYwHlgmMIPy1lut5ADTZnsk/FqenSx9f9UxbbABDtTO2GV0Ec/k7VgDs6CCcEnaZ8IDH9mbzyeS/HVpqpxXnQ==",
       "dev": true
     },
     "node_modules/htmlparser2": {
@@ -784,7 +784,7 @@
     "node_modules/which-module": {
       "version": "2.0.0",
       "resolved": "https://registry.npmjs.org/which-module/-/which-module-2.0.0.tgz",
-      "integrity": "sha1-2e8H3Od7mQK4o6j6SzHD4/fm6Ho=",
+      "integrity": "sha512-B+enWhmw6cjfVC7kS8Pj9pCrKSc5txArRyaYGe088shv/FGWH+0Rjx/xPgtsWfsUtS27FkP697E4DDhgrgoc0Q==",
       "dev": true
     },
     "node_modules/wrap-ansi": {
@@ -1043,9 +1043,9 @@
       "dev": true
     },
     "entities": {
-      "version": "4.3.0",
-      "resolved": "https://registry.npmjs.org/entities/-/entities-4.3.0.tgz",
-      "integrity": "sha512-/iP1rZrSEJ0DTlPiX+jbzlA3eVkY/e8L8SozroF395fIqE3TYF/Nz7YOMAawta+vLmyJ/hkGNNPcSbMADCCXbg==",
+      "version": "4.3.1",
+      "resolved": "https://registry.npmjs.org/entities/-/entities-4.3.1.tgz",
+      "integrity": "sha512-o4q/dYJlmyjP2zfnaWDUC6A3BQFmVTX+tZPezK7k0GLSU9QYCauscf5Y+qcEPzKL+EixVouYDgLQK5H9GrLpkg==",
       "dev": true
     },
     "fast-glob": {
@@ -1136,9 +1136,9 @@
       "dev": true
     },
     "heroicons": {
-      "version": "1.0.6",
-      "resolved": "https://registry.npmjs.org/heroicons/-/heroicons-1.0.6.tgz",
-      "integrity": "sha512-5bxTsG2hyNBF0l+BrFlZlR5YngQNMfl0ggJjIRkMSADBQbaZMoTg47OIQzq6f1mpEZ85HEIgSC4wt5AeFM9J2Q==",
+      "version": "2.0.7",
+      "resolved": "https://registry.npmjs.org/heroicons/-/heroicons-2.0.7.tgz",
+      "integrity": "sha512-BuYwHlgmMIPy1lut5ADTZnsk/FqenSx9f9UxbbABDtTO2GV0Ec/k7VgDs6CCcEnaZ8IDH9mbzyeS/HVpqpxXnQ==",
       "dev": true
     },
     "htmlparser2": {
@@ -1391,7 +1391,7 @@
     "which-module": {
       "version": "2.0.0",
       "resolved": "https://registry.npmjs.org/which-module/-/which-module-2.0.0.tgz",
-      "integrity": "sha1-2e8H3Od7mQK4o6j6SzHD4/fm6Ho=",
+      "integrity": "sha512-B+enWhmw6cjfVC7kS8Pj9pCrKSc5txArRyaYGe088shv/FGWH+0Rjx/xPgtsWfsUtS27FkP697E4DDhgrgoc0Q==",
       "dev": true
     },
     "wrap-ansi": {

data/package.json

@@ -3,7 +3,7 @@
   "private": true,
   "devDependencies": {
     "cheerio": "1.0.0-rc.11",
-    "heroicons": "^1.0.6",
+    "heroicons": "^2.0.0",
     "fs-extra": "^7.0.1",
     "globby": "11.0.0",
     "lodash.merge": "4.6.2",

data/script/keywords.json

@@ -1,3 +1,3 @@
 {
-  "archive": ["box", "catalog"]
+  "archive-box": ["box", "catalog"]
 }

data/script/update_heroicons

@@ -19,8 +19,9 @@ const { argv } = yargs
     type: "array",
     describe: "Input SVG files",
     default: [
-      "node_modules/heroicons/outline/*.svg",
-      "node_modules/heroicons/solid/*.svg",
+      "node_modules/heroicons/24/outline/*.svg",
+      "node_modules/heroicons/24/solid/*.svg",
+      "node_modules/heroicons/20/solid/*.svg",
     ],
   })
   .option("output", {
@@ -38,45 +39,28 @@ const svgFilepaths = filepaths.filter(
 
 if (svgFilepaths.length === 0) {
   // eslint-disable-next-line no-console
-  console.error(`No input SVG file(s) found in ${icon_file_path.join(", ")}`);
+  console.error(`No input SVG file(s) found in ${filepaths.join(", ")}`);
   process.exit(1);
 }
 
 let exitCode = 0;
 
-const validTypes = ["solid", "outline"];
-const defaultOutlineWidth = "24";
-const defaultSolidWidth = "20";
+const validTypes = ["solid", "outline", "mini"];
+const defaultOutlineWidth = parseInt("24");
+const defaultSolidWidth = parseInt("24");
+const defaultMiniWidth = parseInt("20");
 
 const icons = svgFilepaths.map((filepath) => {
   try {
-    let filename = path.parse(filepath).base;
-    const type = path.parse(filepath).dir.split("/").pop();
-    let widthSize;
-    switch (type) {
-      case "outline":
-        widthSize = defaultOutlineWidth;
-        break;
-      case "solid":
-        widthSize = defaultSolidWidth;
-        break;
-      default:
-        throw new Error(`Unknown icon type: ${type}`);
-    }
-
-    const filenamePattern = /(.+)(?:-[0-9]{1,2})?-([0-9]{2}).svg$/;
-    const filenameReplacePattern = /\.svg$/;
-
-    if (!filenamePattern.test(filename)) {
-      filename = filename.replace(filenameReplacePattern, `-${widthSize}.svg`);
-    }
-
-    const [, name, height] = filename.match(filenamePattern);
+    const filename = path.parse(filepath).base;
+    let splitDir = path.parse(filepath).dir.split("/");
+    let type = splitDir.pop();
+    const size = splitDir.pop();
 
     const svg = fs.readFileSync(path.resolve(filepath), "utf8");
     const svgElement = cheerio.load(svg)("svg");
-    let svgWidth = parseInt(svgElement.attr("width"));
-    let svgHeight = parseInt(svgElement.attr("height"));
+    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();
 
@@ -94,12 +78,6 @@ const icons = svgFilepaths.map((filepath) => {
       throw new Error(`${filename}: Missing viewBox attribute.`);
     }
 
-    if (svgHeight != parseInt(height)) {
-      throw new Error(
-        `${filename}: Height in filename (${height}) does not match height attribute of SVG (${svgHeight})`
-      );
-    }
-
     const viewBoxPattern = /0 0 ([0-9]+) ([0-9]+)/;
 
     if (!viewBoxPattern.test(svgViewBox)) {
@@ -122,6 +100,11 @@ const icons = svgFilepaths.map((filepath) => {
       );
     }
 
+    if (svgWidth == defaultMiniWidth && type == "solid") {
+      type = "mini";
+    }
+    const name = filename.slice(0, -4);
+
     return {
       name,
       keywords: keywords[name] || [],

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heroicons_helper
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Garen J. Torikian
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-11 00:00:00.000000000 Z
+date: 2022-08-26 00:00:00.000000000 Z
 dependencies: []
 description: A package that distributes Heroicons as a gem, for easy inclusion in
   Ruby projects.