RubyGems - favicon_factory - Versions diffs - 0.1.0 → 0.2.0 - Mend

favicon_factory 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (4) hide show

checksums.yaml +4 -4
data/lib/favicon_factory/version.rb +1 -1
data/lib/favicon_factory.rb +137 -60
metadata +16 -2

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4c019833e1b1397a11142ee88f5ea2c9924aeb6c101316898babdd09ec526bb
-  data.tar.gz: b242b7a4575f87eb36047f9986481d8064b523fad955693613c85e41e618057a
+  metadata.gz: 1105c6329d7279577f8d478e3be7e80984c3b374b38f66686b293299fa1dc5d8
+  data.tar.gz: 58300ea64d615ccd2876493467916a47fa6150708e45bbe0e0183ac5b151997d
 SHA512:
-  metadata.gz: 91e5b2c1db12ebdada6679e6d07452ad53acf26970de15e9ee3120806fc1bd6468b54e31a9146913f9c40b23e6569decdfbe8ef220d4f40a3cac5c9f9e239259
-  data.tar.gz: afa68fb6c33b90cca3a358872f48c77574ca3ac6570ebd46faedd6f527f5c83600919dbf4f61c77264a4d4ec8efa833f7da08259b5745777a72d1a646f4b01ab
+  metadata.gz: d673025100bef413b41b4026f60e1b435cd8b8f5343a5d928771a6aa33aa72b2b942b8333e92f9923ac2c90798352482b0b221a3dfc38054d74f8649336a4f2f
+  data.tar.gz: 76ff8e945a1fe543bcb04ed2198fa3e2ebaedcc03511666b497f88a90b6972ec660f428c236904465238b53a2101d6e0965ee02bdca63c31389e23680d83743c

data/lib/favicon_factory/version.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module FaviconFactory
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/favicon_factory.rb CHANGED Viewed

@@ -1,29 +1,19 @@
 # frozen_string_literal: true
 require_relative "favicon_factory/version"
-require "mini_magick"
 require "tty/which"
 require "tty/option"
-module FaviconFactory
-  SVG_DENSITY = 1_000
+autoload(:MiniMagick, "mini_magick")
+autoload(:Vips, "vips")
+module FaviconFactory
   Params = Data.define(:favicon_svg, :background) do
     def dir
       File.dirname(favicon_svg)
     end
   end
-  PngParams = Data.define(:favicon_svg, :background, :size) do
-    def self.from_params(size, params)
-      new(**params.to_h, size: size)
-    end
-    def dir
-      File.dirname(favicon_svg)
-    end
-  end
   class Command
     include TTY::Option
@@ -56,8 +46,8 @@ module FaviconFactory
     option :background do
       short "-b"
       long "--background string"
-      default "white"
-      desc "Background color for apple-touch-icon.png"
+      default "#ffffff"
+      desc "Background hex color for apple-touch-icon.png"
     end
     flag :help do
@@ -69,46 +59,33 @@ module FaviconFactory
   class Cli
     def self.call
-      exit new(ARGV, $stderr).call
+      adapter = BaseAdapter.find
+      if adapter.nil?
+        stderr.puts "Error: Neither vips or imagemagick found, install one"
+        exit 1
+      end
+      exit new(adapter: adapter, argv: ARGV, file: File, stderr: $stderr).call
     end
-    attr_reader :stderr
-    def initialize(argv, stderr)
+    def initialize(adapter:, argv:, file:, stderr:)
+      @adapter = adapter
       @argv = argv
+      @file = file
       @stderr = stderr
     end
     def call
-      stderr.puts "imagemagick v7 not found, please install for best results" unless MiniMagick.imagemagick7?
-      stderr.puts "inkscape not found, install inkscape for best results" unless TTY::Which.which("inkscape")
-      params, status = parse(@argv)
+      params, status = parse(argv)
       return status if status >= 0
-      [
-        Thread.new { create("favicon.ico", params) },
-        Thread.new { create("icon-192.png", PngParams.from_params(192, params)) },
-        Thread.new { create("icon-512.png", PngParams.from_params(512, params)) },
-        Thread.new { create("apple-touch-icon.png", params) },
-        Thread.new { create("manifest.webmanifest", params) }
-      ]
-        .each(&:join)
-      stderr.puts <<~TEXT
-        Info: Add the following to the `<head>`
-          <!-- favicons generated with the favicon_factory gem -->
-          <link rel="icon" href="/favicon.svg" type="image/svg+xml">
-          <link rel="icon" href="/favicon.ico" sizes="32x32">
-          <link rel="apple-touch-icon" href="/apple-touch-icon.png">
-          <link rel="manifest" href="/manifest.webmanifest">
-      TEXT
+      adapter.new(file: file, params: params, stderr: stderr).create_icons
       0
     end
     private
+    attr_reader :stderr, :file, :adapter, :argv
     def parse(argv)
       command = Command.new.parse(argv)
       params = command.params
@@ -118,19 +95,67 @@ module FaviconFactory
       params = params.to_h
       favicon_svg = params.fetch(:favicon_svg)
       return exit_message(1, "Error: #{favicon_svg} does not end with .svg") unless favicon_svg.end_with?(".svg")
-      return exit_message(1, "Error: #{favicon_svg} does not exist") unless File.exist?(favicon_svg)
+      return exit_message(1, "Error: #{favicon_svg} does not exist") unless file.exist?(favicon_svg)
-      [Params.new(favicon_svg: favicon_svg, background: params.fetch(:background)), -1]
+      background = params.fetch(:background)
+      unless hex?(background)
+        return exit_message(1, "Error: #{background} is not a valid color, use a hex value like #0099ff")
+      end
+      [Params.new(favicon_svg: favicon_svg, background: background), -1]
+    end
+    def hex?(string)
+      string = string.delete_prefix("#")
+      string.split("").all? { |char| char.match?(/^[0-9a-fA-F]$/) }
     end
     def exit_message(status, message)
       stderr.puts message
       [nil, status]
     end
+  end
+  class BaseAdapter
+    class << self
+      def find
+        if TTY::Which.which("vips") || TTY::Which.which("libvips")
+          VipsAdapter
+        elsif TTY::Which.which("magick") || TTY::Which.which("convert")
+          ImageMagickAdapter
+        end
+      end
+    end
+    def initialize(file:, params:, stderr:)
+      @file = file
+      @params = params
+      @stderr = stderr
+    end
+    def create_icons
+      create_by_name
+        .keys
+        .map { |name| Thread.new { create(name, params) } }
+        .each(&:join)
+      stderr.puts <<~TEXT
+        Info: Add the following to the `<head>`
+          <!-- favicons generated with the favicon_factory gem -->
+          <link rel="icon" href="/favicon.svg" type="image/svg+xml">
+          <link rel="icon" href="/favicon.ico" sizes="32x32">
+          <link rel="apple-touch-icon" href="/apple-touch-icon.png">
+          <link rel="manifest" href="/manifest.webmanifest">
+      TEXT
+    end
+    private
+    attr_reader :params, :stderr, :file
     def create(name, params)
-      path = File.join(params.dir, name)
-      if File.exist?(path)
+      path = file.join(params.dir, name)
+      if file.exist?(path)
         stderr.puts "Info: Skipping #{path} because it already exists"
         return
       end
@@ -142,13 +167,76 @@ module FaviconFactory
     def create_by_name
       {
         "favicon.ico" => method(:ico!),
-        "icon-192.png" => method(:png!),
-        "icon-512.png" => method(:png!),
+        "icon-192.png" => method(:png_192!),
+        "icon-512.png" => method(:png_512!),
         "apple-touch-icon.png" => method(:touch!),
         "manifest.webmanifest" => method(:manifest!)
       }
     end
+    def png_192!(path, params)
+      png!(path, params, 192)
+    end
+    def png_512!(path, params)
+      png!(path, params, 512)
+    end
+    def manifest!(path, _params)
+      file.write(path, <<~MANIFEST)
+        {
+          "icons": [
+            { "src": "/icon-192.png", "type": "image/png", "sizes": "192x192" },
+            { "src": "/icon-512.png", "type": "image/png", "sizes": "512x512" }
+          ]
+        }
+      MANIFEST
+    end
+  end
+  class VipsAdapter < BaseAdapter
+    def ico!(path, params)
+      png = Vips::Image.thumbnail(params.favicon_svg, 32).write_to_buffer(".png")
+      # https://www.meziantou.net/creating-ico-files-from-multiple-images-in-dotnet.htm
+      ico = [0, 1, 1].pack("S<*") + [32, 32, 0, 0].pack("C*") + [1, 32].pack("S<*") + [png.size, 22].pack("L<*") + png
+      file.write(path, ico)
+    end
+    def png!(path, params, size)
+      Vips::Image.thumbnail(params.favicon_svg, size).write_to_file(path)
+    end
+    def touch!(path, params)
+      svg = Vips::Image.thumbnail(params.favicon_svg, 160).gravity("centre", 180, 180)
+      image = square(180, params.background).composite(svg, :over)
+      image.write_to_file(path)
+    end
+    private
+    def square(size, hex)
+      pixel = (Vips::Image.black(1, 1) + hex2rgb(hex)).cast(:uchar)
+      pixel.embed 0, 0, size, size, extend: :copy
+    end
+    def hex2rgb(hex)
+      hex = hex.delete_prefix("#")
+      r = hex[0..1].to_i(16)
+      g = hex[2..3].to_i(16)
+      b = hex[4..5].to_i(16)
+      [r, g, b]
+    end
+  end
+  class ImageMagickAdapter < BaseAdapter
+    SVG_DENSITY = 1_000
+    def initialize(**)
+      super
+      stderr.puts "Warn: Install imagemagick v7 for best results, using v6" unless MiniMagick.imagemagick7?
+      stderr.puts "Warn: Inkscape not found, install it for best results" unless TTY::Which.which("inkscape")
+    end
     def ico!(path, params)
       MiniMagick::Tool::Convert.new do |convert|
         convert.density(SVG_DENSITY).background("none")
@@ -158,11 +246,11 @@ module FaviconFactory
       end
     end
-    def png!(path, params)
+    def png!(path, params, size)
       MiniMagick::Tool::Convert.new do |convert|
         convert.density(SVG_DENSITY).background("none")
         convert << params.favicon_svg
-        convert.resize("#{params.size}x#{params.size}")
+        convert.resize("#{size}x#{size}")
         convert << path
       end
     end
@@ -175,16 +263,5 @@ module FaviconFactory
         convert << path
       end
     end
-    def manifest!(path, _params)
-      File.write(path, <<~MANIFEST)
-        {
-          "icons": [
-            { "src": "/icon-192.png", "type": "image/png", "sizes": "192x192" },
-            { "src": "/icon-512.png", "type": "image/png", "sizes": "512x512" }
-          ]
-        }
-      MANIFEST
-    end
   end
 end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: favicon_factory
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - 3v0k4
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-27 00:00:00.000000000 Z
+date: 2024-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_magick
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.12'
+- !ruby/object:Gem::Dependency
+  name: ruby-vips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: tty-option
   requirement: !ruby/object:Gem::Requirement