fontist 1.18.2 → 1.20.0

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/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.rb

@@ -27,6 +27,7 @@ module Fontist
     STATUS_FONTCONFIG_NOT_FOUND = 14
     STATUS_FONTCONFIG_FILE_NOT_FOUND = 15
     STATUS_FONTIST_VERSION_ERROR = 15
+    STATUS_INVALID_CONFIG_ATTRIBUTE = 16
 
     ERROR_TO_STATUS = {
       Fontist::Errors::UnsupportedFontError => [STATUS_NON_SUPPORTED_FONT_ERROR],

data/lib/fontist/config.rb

@@ -15,42 +15,58 @@ module Fontist
     end
 
     def set(key, value)
+      attr = key.to_sym
+      unless default_values.key?(attr)
+        raise Errors::InvalidConfigAttributeError,
+              "No such attribute '#{attr}' exists."
+      end
+
       v = normalize_value(value)
-      @custom_values[key.to_s] = v
+      if respond_to?("#{attr}=")
+        public_send("#{attr}=", v)
+      else
+        @custom_values[attr] = v
+      end
 
       persist
     end
 
     def delete(key)
-      @custom_values.delete(key.to_s)
+      @custom_values.delete(key.to_sym)
 
       persist
     end
 
     def default_value(key)
-      default_values[key.to_s]
+      default_values[key.to_sym]
     end
 
     def default_values
-      { open_timeout: 10,
-        read_timeout: 10 }.transform_keys(&:to_s)
+      { fonts_path: Fontist.fontist_path.join("fonts"),
+        open_timeout: 10,
+        read_timeout: 10 }
     end
 
     def persist
+      values = @custom_values.transform_keys(&:to_s)
       FileUtils.mkdir_p(File.dirname(Fontist.config_path))
-      File.write(Fontist.config_path, YAML.dump(@custom_values))
+      File.write(Fontist.config_path, YAML.dump(values))
     end
 
     def load
       @custom_values = load_config_file
     end
 
+    def fonts_path=(value)
+      @custom_values[:fonts_path] = File.expand_path(value)
+    end
+
     private
 
     def load_config_file
       return {} unless File.exist?(Fontist.config_path)
 
-      YAML.load_file(Fontist.config_path)
+      YAML.load_file(Fontist.config_path).transform_keys(&:to_sym)
     end
 
     def normalize_value(value)

data/lib/fontist/config_cli.rb

@@ -2,15 +2,19 @@ module Fontist
   class ConfigCLI < Thor
     include CLI::ClassOptions
 
-    STATUS_SUCCESS = 0
-
     desc "show", "Show values of the current config"
     def show
       handle_class_options(options)
       values = Config.instance.custom_values
-      Fontist.ui.success("Current config:")
-      Fontist.ui.success(format_hash(values))
-      STATUS_SUCCESS
+
+      if values.empty?
+        Fontist.ui.success("Config is empty.")
+      else
+        Fontist.ui.success("Current config:")
+        Fontist.ui.success(format_hash(values))
+      end
+
+      CLI::STATUS_SUCCESS
     end
 
     desc "set KEY VALUE", "Set the KEY attribute to VALUE in the current config"
@@ -18,7 +22,10 @@ module Fontist
       handle_class_options(options)
       Config.instance.set(key, value)
       Fontist.ui.success("'#{key}' set to '#{value}'.")
-      STATUS_SUCCESS
+      CLI::STATUS_SUCCESS
+    rescue Errors::InvalidConfigAttributeError => e
+      Fontist.ui.error(e.message)
+      CLI::STATUS_INVALID_CONFIG_ATTRIBUTE
     end
 
     desc "delete KEY", "Delete the KEY attribute from the current config"
@@ -28,13 +35,24 @@ module Fontist
       Fontist.ui.success(
         "'#{key}' reset to default ('#{Config.instance.default_value(key)}').",
       )
-      STATUS_SUCCESS
+      CLI::STATUS_SUCCESS
+    end
+
+    desc "keys", "Print all available config attributes"
+    def keys
+      handle_class_options(options)
+      Fontist.ui.say("Available keys:")
+      Config.instance.default_values.each do |key, value|
+        Fontist.ui.say("#{key} (default: #{value})")
+      end
+      CLI::STATUS_SUCCESS
     end
 
     private
 
     def format_hash(hash)
-      YAML.dump(hash).gsub(/^---.*$/, "").strip
+      h = hash.transform_keys(&:to_s)
+      YAML.dump(h).gsub(/^---.*$/, "").strip
     end
   end
 end

data/lib/fontist/errors.rb

@@ -40,6 +40,8 @@ module Fontist
 
     class MainRepoNotFoundError < FormulaIndexNotFoundError; end
 
+    class InvalidConfigAttributeError < GeneralError; end
+
     class InvalidResourceError < GeneralError; end
 
     class LicensingError < GeneralError; end

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
@@ -193,7 +225,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 +236,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 +247,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/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
@@ -89,7 +114,13 @@ module Fontist
     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 +173,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 +203,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

data/lib/fontist/formula_suggestion.rb

@@ -0,0 +1,55 @@
+require "fuzzy_match"
+
+module Fontist
+  class FormulaSuggestion
+    MINIMUM_REQUIRED_SCORE = 0.6
+
+    def initialize
+      @fuzzy_match = prepare_search_engine
+    end
+
+    def find(name)
+      @fuzzy_match.find_all_with_score(normalize(name))
+        .tap { |res| Fontist.ui.debug(prettify_result(res)) }
+        .select { |_key, score, _| score >= MINIMUM_REQUIRED_SCORE }
+        .take(10)
+        .map(&:first)
+        .map { |x| Formula.find_by_key_or_name(x) }
+        .select(&:downloadable?)
+    end
+
+    private
+
+    def normalize(name)
+      name.gsub(" ", "_")
+    end
+
+    def prepare_search_engine
+      dict = Formula.all_keys
+      stop_words = namespaces(dict).map { |ns| /^#{Regexp.escape(ns)}/i }
+
+      FuzzyMatch.new(dict, stop_words: stop_words)
+    end
+
+    def namespaces(keys)
+      keys.map do |key|
+        parts = key.split("/")
+        parts.size
+        parts.take(parts.size - 1).join("/")
+      end.uniq
+    end
+
+    def prettify_result(result)
+      list = result.map do |key, dice, leve|
+        sprintf(
+          "%<dice>.3f %<leve>.3f %<key>s",
+          dice: dice,
+          leve: leve,
+          key: key,
+        )
+      end
+
+      "FuzzyMatch:\n#{list.join("\n")}"
+    end
+  end
+end

data/lib/fontist/version.rb

@@ -1,3 +1,3 @@
 module Fontist
-  VERSION = "1.18.2".freeze
+  VERSION = "1.20.0".freeze
 end

data/lib/fontist.rb

@@ -37,7 +37,7 @@ module Fontist
   end
 
   def self.fonts_path
-    Fontist.fontist_path.join("fonts")
+    Pathname.new(config[:fonts_path])
   end
 
   def self.formulas_repo_path
@@ -151,4 +151,12 @@ module Fontist
   def self.log_level=(level)
     Fontist.ui.level = level
   end
+
+  def self.interactive?
+    @interactive || false
+  end
+
+  def self.interactive=(bool)
+    @interactive = bool
+  end
 end