fontist 1.19.0 → 1.21.1

data/docs/package.json

@@ -0,0 +1,17 @@
+{
+  "scripts": {
+    "dev": "vitepress dev",
+    "build": "vitepress build",
+    "preview": "vitepress preview",
+    "format": "prettier -w ."
+  },
+  "type": "module",
+  "devDependencies": {
+    "@types/node": "latest",
+    "prettier": "^3.2.4",
+    "typescript": "latest",
+    "vitepress": "^1.0.0-rc.44",
+    "vue": "^3.4.15",
+    "vue-tsc": "^1.8.27"
+  }
+}

data/docs/reference/index.md

@@ -0,0 +1,143 @@
+# Fontist CLI reference
+
+<!-- This can be converted to a folder & multiple pages at any time. -->
+
+## `fontist cache`
+
+The only subcommand available on `fontist cache` is `fontist cache clear`. It clears the `~/.fontist` cache.
+
+```sh
+fontist cache clear
+```
+
+```
+Cache has been successfully removed.
+```
+
+## `fontist config`
+
+`fontist config` lets you edit the Fontist config file from the command line instead of opening an editor. There are four subcommands available:
+
+- `fontist config delete <key>`
+- `fontist config keys`
+- `fontist config set <key> <value>`
+- `fontist config show`
+
+Here's an example of these commands being used to edit the config file:
+
+```sh
+fontist config keys
+fontist config set font_path /var/myfonts
+fontist config delete font_path
+fontist config show
+```
+
+```
+$ fontist config keys
+Available keys:
+fonts_path (default: /home/octocat/.fontist/fonts)
+open_timeout (default: 10)
+read_timeout (default: 10)
+
+$ fontist config set fonts_path /var/myfonts
+'fonts_path' set to '/var/myfonts'.
+
+$ fontist config delete fonts_path
+'fonts_path' reset to default ('/home/octocat/.fontist/fonts').
+
+$ fontist config show
+Config is empty.
+```
+
+### Config reference
+
+<!-- Move this into its own '/reference/config' page if this grows a lot. -->
+
+- **`fonts_path`:** Where to put the `.ttf` files. Defaults to `~/.fontist/fonts`
+
+- **`open_timeout`:** Defaults to 10.
+
+- **`read_timeout`:** Defaults to 10.
+
+## `fontist status [font-name]`
+
+Prints the paths to a particular installed font or all fonts if the `font-name` is omitted. This searches **all fonts available on your system** even those not managed by Fontist.
+
+```sh
+fontist status
+```
+
+```
+Fonts found at:
+- /usr/share/fonts/truetype/ubuntu/UbuntuMono-B.ttf
+- /usr/share/fonts/truetype/ubuntu/UbuntuMono-BI.ttf
+- /usr/share/fonts/truetype/ubuntu/UbuntuMono-R.ttf
+- /usr/share/fonts/truetype/ubuntu/UbuntuMono-RI.ttf
+- /home/octocat/.fontist/fonts/Arial.ttf (from ms_truetype formula)
+- /home/octocat/.fontist/fonts/ArialBI.ttf (from ms_truetype formula)
+- /home/octocat/.fontist/fonts/ArialBd.ttf (from ms_truetype formula)
+- /home/octocat/.fontist/fonts/ArialI.ttf (from ms_truetype formula)
+```
+
+Here's an example narrowed to a specific font:
+
+```sh
+fontist status "Open Sans"
+```
+
+```
+Fonts found at:
+- /home/octocat/.fontist/fonts/OpenSans-Bold.ttf (from open_sans formula)
+- /home/octocat/.fontist/fonts/OpenSans-BoldItalic.ttf (from open_sans formula)
+- /home/octocat/.fontist/fonts/OpenSans-Italic.ttf (from open_sans formula)
+- /home/octocat/.fontist/fonts/OpenSans-Regular.ttf (from open_sans formula)
+```
+
+## `fontist list [font-name]`
+
+Lists the installation status of `font-name` or all fonts if no font name provided.
+
+```sh
+fontist status
+```
+
+```
+Fonts found at:
+- /usr/share/fonts/truetype/ubuntu/UbuntuMono-B.ttf
+- /usr/share/fonts/truetype/ubuntu/UbuntuMono-BI.ttf
+- /usr/share/fonts/truetype/ubuntu/UbuntuMono-R.ttf
+- /usr/share/fonts/truetype/ubuntu/UbuntuMono-RI.ttf
+- /home/octocat/.fontist/fonts/Arial.ttf (from ms_truetype formula)
+- /home/octocat/.fontist/fonts/ArialBI.ttf (from ms_truetype formula)
+- /home/octocat/.fontist/fonts/ArialBd.ttf (from ms_truetype formula)
+- /home/octocat/.fontist/fonts/ArialI.ttf (from ms_truetype formula)
+```
+
+Here's an example getting the status of a specific font:
+
+```sh
+fontist status "Fira Mono"
+```
+
+```
+Font "Fira Mono" not found locally.
+'Fira Mono' font is missing, please run `fontist install 'Fira Mono'` to download the font.
+```
+
+## Environment variables
+
+### `FONTIST_PATH`
+
+By default Fontist uses the `~/.fontist` directory to store fonts and its files. It can be changed with the `FONTIST_PATH` environment variable.
+
+```sh
+FONTIST_PATH=/var/fontist2 fontist update
+```
+
+## Excluded fonts
+
+`fontist` excludes some fonts from usage when they break other software:
+
+- `NISC18030.ttf` (GB18030 Bitmap) - macOS [fontist/fontist#344](https://github.com/fontist/fontist/issues/344)
+
+[📑 View the up-to-date list of known problematic fonts on GitHub](https://github.com/fontist/fontist/blob/main/lib/fontist/exclude.yml)

data/exe/fontist

@@ -4,8 +4,7 @@ require "fontist"
 require "fontist/cli"
 
 fontist_cli = proc {
-  status_code = Fontist::CLI.start(ARGV)
-  exit status_code.is_a?(Integer) ? status_code : 1
+  Fontist::CLI.start(ARGV)
 }
 
 if ENV["SOCKS_PROXY"]

data/fontist.gemspec

@@ -31,6 +31,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "down", "~> 5.0"
   spec.add_runtime_dependency "extract_ttc", "~> 0.1"
+  spec.add_runtime_dependency "fuzzy_match", "~> 2.1"
   spec.add_runtime_dependency "json", "~> 2.0"
   spec.add_runtime_dependency "nokogiri", "~> 1.0"
   spec.add_runtime_dependency "mime-types", "~> 3.0"
@@ -50,4 +51,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rubocop", "~> 1.22.1"
   spec.add_development_dependency "rubocop-rails", "~> 2.9"
   spec.add_development_dependency "rubocop-performance", "~> 1.10"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
 end

data/lib/fontist/cli/class_options.rb

@@ -22,6 +22,12 @@ module Fontist
                           type: :boolean,
                           desc: "Avoid using cache during download"
 
+        base.class_option :interactive,
+                          aliases: :i,
+                          type: :boolean,
+                          default: true,
+                          desc: "Interactive mode"
+
         base.class_option :formulas_path,
                           type: :string,
                           desc: "Path to formulas"
@@ -32,6 +38,7 @@ module Fontist
         Fontist.preferred_family = options[:preferred_family]
         Fontist.log_level = log_level(options)
         Fontist.use_cache = !options[:no_cache]
+        Fontist.interactive = options[:interactive]
 
         if options[:formulas_path]
           Fontist.formulas_path = Pathname.new(options[:formulas_path])

data/lib/fontist/cli/thor_ext.rb

@@ -0,0 +1,79 @@
+require "fontist/utils/ui"
+
+module Fontist
+  module ThorExt
+    # Sources:
+    # - https://github.com/mattbrictson/gem/blob/main/lib/example/thor_ext.rb
+    # - https://mattbrictson.com/blog/fixing-thor-cli-behavior
+    #
+    # Configures Thor to behave more like a typical CLI, with better help
+    # and error handling.
+    #
+    # - Passing -h or --help to a command will show help for that command.
+    # - Unrecognized options will be treated as errors.
+    # - Error messages will be printed in red to stderr, without stack trace.
+    # - Errors will cause Thor to exit with a non-zero status.
+    #
+    # To take advantage of this behavior, your CLI should subclass Thor
+    # and extend this module.
+    #
+    #   class CLI < Thor
+    #     extend ThorExt::Start
+    #   end
+    #
+    # Start your CLI with:
+    #
+    #   CLI.start
+    #
+    # In tests, prevent Kernel.exit from being called when an error occurs,
+    # like this:
+    #
+    #   CLI.start(args, exit_on_failure: false)
+    module Start
+      def self.extended(base)
+        super
+        base.check_unknown_options!
+      end
+
+      def start(given_args = ARGV, config = {})
+        config[:shell] ||= Thor::Base.shell.new
+        handle_help_switches(given_args) do |args|
+          dispatch(nil, args, nil, config)
+        end
+      rescue StandardError => e
+        handle_exception_on_start(e, config)
+      end
+
+      private
+
+      # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+      def handle_help_switches(given_args)
+        yield(given_args.dup)
+      rescue Thor::UnknownArgumentError => e
+        retry_with_args = []
+
+        if given_args.first == "help"
+          retry_with_args = ["help"] if given_args.length > 1
+        elsif e.unknown.intersect?(%w[-h --help])
+          retry_with_args = ["help", (given_args - e.unknown).first]
+        end
+        raise unless retry_with_args.any?
+
+        yield(retry_with_args)
+      end
+
+      def handle_exception_on_start(error, config)
+        return if error.is_a?(Errno::EPIPE)
+        raise if Fontist.ui.debug? || !config.fetch(:exit_on_failure, true)
+
+        message = error.message.to_s
+        if message.empty? || !error.is_a?(Thor::Error)
+          message.prepend("[#{error.class}] ")
+        end
+        config[:shell]&.say_error(message, :red)
+        exit(false)
+      end
+      # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
+    end
+  end
+end

data/lib/fontist/cli.rb

@@ -1,5 +1,6 @@
 require "thor"
 require "fontist/cli/class_options"
+require "fontist/cli/thor_ext"
 require "fontist/repo_cli"
 require "fontist/cache_cli"
 require "fontist/import_cli"
@@ -9,6 +10,7 @@ require "fontist/config_cli"
 module Fontist
   class CLI < Thor
     include ClassOptions
+    extend ThorExt::Start
 
     STATUS_SUCCESS = 0
     STATUS_UNKNOWN_ERROR = 1

data/lib/fontist/config.rb

@@ -44,7 +44,8 @@ module Fontist
     def default_values
       { fonts_path: Fontist.fontist_path.join("fonts"),
         open_timeout: 10,
-        read_timeout: 10 }
+        read_timeout: 10,
+        google_fonts_key: nil }
     end
 
     def persist

data/lib/fontist/font.rb

@@ -2,6 +2,7 @@ require "fontist/font_installer"
 require "fontist/font_path"
 require "fontist/formula_picker"
 require "fontist/fontconfig"
+require "fontist/formula_suggestion"
 
 module Fontist
   class Font
@@ -109,17 +110,48 @@ module Fontist
     end
 
     def install_formula
-      download_formula || raise_formula_not_found
+      download_formula || make_suggestions || raise_formula_not_found
     end
 
     def download_formula
-      formula = Formula.find_by_key(@name)
+      formula = Formula.find_by_key_or_name(@name)
       return unless formula
       return unless formula.downloadable?
 
       request_formula_installation(formula)
     end
 
+    def make_suggestions
+      return unless Fontist.interactive?
+
+      suggestions = fuzzy_search_formulas
+      return if suggestions.empty?
+
+      choice = offer_to_choose(suggestions)
+      return unless choice
+
+      request_formula_installation(choice)
+    end
+
+    def fuzzy_search_formulas
+      @formula_suggestion ||= FormulaSuggestion.new
+      @formula_suggestion.find(@name)
+    end
+
+    def offer_to_choose(formulas)
+      Fontist.ui.say("Formula '#{@name}' not found. Did you mean?")
+
+      formulas.each_with_index do |formula, index|
+        Fontist.ui.say("[#{index}] #{formula.name}")
+      end
+
+      choice = Fontist.ui.ask("Please type number or " \
+                              "press ENTER to skip installation:").chomp
+      return unless choice.to_i.to_s == choice
+
+      formulas[choice.to_i]
+    end
+
     def raise_formula_not_found
       raise Errors::FormulaNotFoundError.new(@name)
     end
@@ -184,6 +216,11 @@ module Fontist
       confirmation = check_and_confirm_required_license(formula)
       paths = font_installer(formula).install(confirmation: confirmation)
 
+      if paths.nil? || paths.empty?
+        Fontist.ui.error("Fonts not found in formula #{formula}")
+        return
+      end
+
       Fontist.ui.say("Fonts installed at:")
       paths.each do |path|
         Fontist.ui.say("- #{path}")
@@ -193,7 +230,7 @@ module Fontist
     def check_and_confirm_required_license(formula)
       return @confirmation unless formula.license_required
 
-      show_license(formula.license) unless @hide_licenses
+      show_license(formula) unless @hide_licenses
       return @confirmation if @confirmation.casecmp?("yes")
 
       confirmation = ask_for_agreement
@@ -204,8 +241,8 @@ module Fontist
       )
     end
 
-    def show_license(license)
-      Fontist.ui.say(license_agrement_message(license))
+    def show_license(formula)
+      Fontist.ui.say(license_agrement_message(formula))
     end
 
     def ask_for_agreement
@@ -215,20 +252,28 @@ module Fontist
       )
     end
 
-    def license_agrement_message(license)
+    def license_agrement_message(formula)
+      human_name = human_name(formula)
+
       <<~MSG
-        FONT LICENSE ACCEPTANCE REQUIRED FOR "#{name}":
+        FONT LICENSE ACCEPTANCE REQUIRED FOR "#{human_name}":
 
         Fontist can install this font if you accept its licensing conditions.
 
-        FONT LICENSE BEGIN ("#{name}")
+        FONT LICENSE BEGIN ("#{human_name}")
         -----------------------------------------------------------------------
-        #{license}
+        #{formula.license}
         -----------------------------------------------------------------------
-        FONT LICENSE END ("#{name}")
+        FONT LICENSE END ("#{human_name}")
       MSG
     end
 
+    def human_name(formula)
+      return formula.name if @by_formula
+
+      formula.font_by_name(@name).name
+    end
+
     def update_fontconfig
       return unless @update_fontconfig
 

data/lib/fontist/font_installer.rb

@@ -1,5 +1,7 @@
 require "fontist/utils"
 require "excavate"
+require_relative "resources/archive_resource"
+require_relative "resources/google_resource"
 
 module Fontist
   class FontInstaller
@@ -48,63 +50,32 @@ module Fontist
     end
 
     def install_font
-      fonts_paths = run_in_temp_dir { extract }
+      fonts_paths = do_install_font
       fonts_paths.empty? ? nil : fonts_paths
     end
 
-    def run_in_temp_dir
-      Dir.mktmpdir(nil, Dir.tmpdir) do |dir|
-        @temp_dir = Pathname.new(dir)
-
-        result = yield
-
-        @temp_dir = nil
-
-        result
-      end
-    end
-
-    def extract
-      archive = download_file(@formula.resources.first)
-
-      install_fonts_from_archive(archive)
-    end
-
-    def install_fonts_from_archive(archive)
-      Fontist.ui.say(%(Installing font "#{@formula.key}".))
+    def do_install_font
+      Fontist.ui.say(%(Installing from formula "#{@formula.key}".))
 
       Array.new.tap do |fonts_paths|
-        Excavate::Archive.new(archive.path).files(recursive_packages: true) do |path|
+        resource.files(source_files) do |path|
           fonts_paths << install_font_file(path) if font_file?(path)
         end
       end
     end
 
-    def download_file(source)
-      errors = []
-      source.urls.each do |request|
-        url = request.respond_to?(:url) ? request.url : request
-        Fontist.ui.say(%(Downloading font "#{@formula.key}" from #{url}))
-
-        result = try_download_file(request, source)
-        return result unless result.is_a?(Errors::InvalidResourceError)
-
-        errors << result
-      end
+    def resource
+      resource_class = if @formula.source == "google"
+                         Resources::GoogleResource
+                       else
+                         Resources::ArchiveResource
+                       end
 
-      raise Errors::InvalidResourceError, errors.join(" ")
+      resource_class.new(resource_options, no_progress: @no_progress)
     end
 
-    def try_download_file(request, source)
-      Fontist::Utils::Downloader.download(
-        request,
-        sha: source.sha256,
-        file_size: source.file_size,
-        progress_bar: !@no_progress
-      )
-    rescue Errors::InvalidResourceError => e
-      Fontist.ui.say(e.message)
-      e
+    def resource_options
+      @formula.resources.first
     end
 
     def font_file?(path)
@@ -116,16 +87,16 @@ module Fontist
     end
 
     def source_files
-      @source_files ||= @formula.fonts.flat_map do |font|
-        next [] if @font_name && !font.name.casecmp?(@font_name)
-
-        font_files(font)
+      @source_files ||= fonts.flat_map do |font|
+        font.styles.map do |style|
+          style.source_font || style.font
+        end
       end
     end
 
-    def font_files(font)
-      font.styles.map do |style|
-        style.source_font || style.font
+    def fonts
+      @formula.fonts.select do |font|
+        @font_name.nil? || font.name.casecmp?(@font_name)
       end
     end
 

data/lib/fontist/formula.rb

@@ -5,6 +5,11 @@ require "git"
 
 module Fontist
   class Formula
+    NAMESPACES = {
+      "sil" => "SIL",
+      "macos" => "macOS",
+    }.freeze
+
     def self.update_formulas_repo
       Update.call
     end
@@ -15,6 +20,12 @@ module Fontist
       end
     end
 
+    def self.all_keys
+      Dir[Fontist.formulas_path.join("**/*.yml").to_s].map do |path|
+        path.sub("#{Fontist.formulas_path}/", "").sub(".yml", "")
+      end
+    end
+
     def self.find(font_name)
       Indexes::FontIndex.from_yaml.load_formulas(font_name).first
     end
@@ -45,6 +56,10 @@ module Fontist
       end.flatten
     end
 
+    def self.find_by_key_or_name(name)
+      find_by_key(name) || find_by_name(name)
+    end
+
     def self.find_by_key(key)
       path = Fontist.formulas_path.join("#{key}.yml")
       return unless File.exist?(path)
@@ -52,6 +67,16 @@ module Fontist
       new_from_file(path)
     end
 
+    def self.find_by_name(name)
+      key = name_to_key(name)
+
+      find_by_key(key)
+    end
+
+    def self.name_to_key(name)
+      name.downcase.gsub(" ", "_")
+    end
+
     def self.find_by_font_file(font_file)
       key = Indexes::FilenameIndex
         .from_yaml
@@ -69,7 +94,7 @@ module Fontist
 
     def initialize(data, path)
       @data = data
-      @path = path
+      @path = real_path(path)
     end
 
     def to_index_formula
@@ -84,12 +109,24 @@ module Fontist
       @data.key?("resources")
     end
 
+    def source
+      return unless @data["resources"]
+
+      @data["resources"].values.first["source"]
+    end
+
     def path
       @path
     end
 
     def key
-      key_from_path
+      @key ||= {}
+      @key[@path] ||= key_from_path
+    end
+
+    def name
+      @name ||= {}
+      @name[key] ||= namespace.empty? ? base_name : "#{namespace}/#{base_name}"
     end
 
     def description
@@ -142,6 +179,12 @@ module Fontist
       @data["instructions"]
     end
 
+    def font_by_name(name)
+      fonts.find do |font|
+        font.name.casecmp?(name)
+      end
+    end
+
     def fonts_by_name(name)
       fonts.select do |font|
         font.name.casecmp?(name)
@@ -166,9 +209,40 @@ module Fontist
 
     private
 
+    def real_path(path)
+      Dir.glob(path).first
+    end
+
     def key_from_path
       escaped = Regexp.escape("#{Fontist.formulas_path}/")
-      @path.sub(Regexp.new("^#{escaped}"), "").sub(/\.yml$/, "")
+      @path.sub(Regexp.new("^#{escaped}"), "").sub(/\.yml$/, "").to_s
+    end
+
+    def namespace
+      namespace_from_mappings || namespace_from_key
+    end
+
+    def namespace_from_mappings
+      parts = key.split("/")
+      namespace_from_key = parts.take(parts.size - 1).join("/")
+      NAMESPACES[namespace_from_key]
+    end
+
+    def namespace_from_key
+      parts = key.downcase.gsub("_", " ").split("/")
+      parts.take(parts.size - 1).map do |namespace|
+        namespace.split.map(&:capitalize).join(" ")
+      end.join("/")
+    end
+
+    def base_name
+      @data["name"] || base_name_from_key
+    end
+
+    def base_name_from_key
+      key.split("/").last
+        .downcase.gsub("_", " ")
+        .split.map(&:capitalize).join(" ")
     end
 
     def fonts_by_family