fontist 1.11.7 → 1.13.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3a779a1f127060501e1c69c59986bcd1a616ab699c5cff439cec4aafc27a0a2
-  data.tar.gz: cbcfe4d0a06ccfbcb309b2c59aac6a58ce09d804c6b23cec5970a6d67b697d43
+  metadata.gz: 2e0bff9ea15b251c5c03206705574e12cfc9fc4bc779d197d73d20a05977e745
+  data.tar.gz: 33a6538507cc014c1fd4a0b1b11fa908560ae8319e9de13d33120c02a86953b4
 SHA512:
-  metadata.gz: d17e2fa944c7ddfd142869d1db9df35fae4ae7aa58c6188290529d31be66b9043e300b0cff2e4cb13545fb1bbdc707820fa4c88f557c914cb59ad4b7a1fef46f
-  data.tar.gz: 98db0b18012107e2a39644d9c892a7ef5330543526da993f1b346300bba2bcefa02b2b17ff417a716f7e6f3e84d0b7589eda24d4b154366a290010bbe8f9ad0a
+  metadata.gz: bf17d3b2dd7a687f97db3bd24200d0bd07821bab47ac0c0ce8eeb1156ec1fc95b39660dfb75e6eb13e00080968de1168c83cca7d54caee0c09139d0a167651d6
+  data.tar.gz: 18b6c0294686dcf739b2d1654b8c3e8488d823cb2de1d62659f834c7f8ca443615170d29f3f3bb2b705b27b07cb8a79d80ca6a185d09979c8c0f2f37f8af547f

data/.rubocop.yml

@@ -2,21 +2,4 @@ inherit_from:
   - 'https://raw.githubusercontent.com/fontist/oss-guides/master/ci/rubocop.yml'
 
 AllCops:
-  Exclude:
-    - 'lib/fontist/import/google/fonts_public.pb.rb'
-    - 'lib/fontist/formula_template.rb'
-
-Rails:
-  Enabled: false
-
-Layout/LineLength:
-  Exclude:
-    - 'lib/fontist/formulas/**/*.rb'
-
-Layout/FirstHashElementIndentation:
-  Exclude:
-    - 'lib/fontist/formulas/**/*.rb'
-
-Layout/HeredocIndentation:
-  Exclude:
-    - 'lib/fontist/formulas/**/*.rb'
+  SuggestExtensions: false

data/README.adoc

@@ -117,6 +117,26 @@ NOTE: Specifying the formula's name or the font's filename is not supported.
 
 NOTE: The `install` command is similar to the `Font.install` library call.
 
+If there are several formulas with a requested font, then `fontist` searches
+for the newest version of the font among formulas with size below a limit
+(300 MB). This behavior can be changed with options.
+
+NOTE: If styles of a font are spread among several formulas, then all
+available formulas would be installed.
+
+Supported options:
+
+-f, [--force]:: Install even if it's already installed in system
+-F, [--formula]:: Install by formula instead of font
+-a, [--accept-all-licenses]:: Accept all license agreements
+-h, [--hide-licenses]:: Hide license texts
+-p, [--no-progress]:: Hide download progress
+-V, [--version=VERSION]:: Install particular version of a font
+-s, [--smallest]:: Install the smallest formula
+-n, [--newest]:: Install the newest version of a font
+-S, [--size-limit=N]:: Specify size limit for a formula to be installed
+                       (default is 300 MB)
+
 === Uninstall fonts
 
 Uninstalls any font supported by Fontist.
@@ -618,7 +638,7 @@ repository https://github.com/fontist/formulas[formulas]:
 
 [source,sh]
 ----
-cd ~/.fontist/versions/v2/formulas
+cd ~/.fontist/versions/{last_version}/formulas
 git add Formulas/google
 git commit -m "Google Fonts update"
 git push
@@ -640,12 +660,44 @@ They can be updated with:
 [source,sh]
 ----
 fontist import-sil
-cd ~/.fontist/formulas
-git add Formulas/sil index.yml filename_index.yml
+cd ~/.fontist/versions/{last_version}/formulas
+git add Formulas/sil
 git commit -m "SIL fonts update"
 git push
 ----
 
+=== Dynamically importing formulas from macOS
+
+macOS provides https://support.apple.com/en-om/HT211240#download[fonts] which
+can be manually downloaded with the Font Book app. When such font is requested,
+fontist prints information on how to install it.
+
+In order to know which fonts are available in a current version of macOS,
+for each version there is a formula containing all supported fonts.
+
+A new formula can be generated with:
+
+[source,sh]
+----
+fontist import macos --name "Big Sur" --fonts-link "https://support.apple.com/en-om/HT211240#download"
+cd ~/.fontist/versions/{last_version}/formulas
+git add Formulas/macos
+git commit -m "Add Big Sur macOS formula"
+git push
+----
+
+Here `--fonts-link` is a link to a page containing a list of available fonts
+in the Font Book app.
+
+If the import is run on a different version of macOS, then a proper version
+should be set in the `platforms` attribute of the generated formula:
+
+[source,yaml]
+----
+platforms:
+- macos-20
+----
+
 
 == Development
 

data/fontist.gemspec

@@ -29,15 +29,17 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "down", "~> 5.0"
   spec.add_runtime_dependency "extract_ttc", "~> 0.1"
+  spec.add_runtime_dependency "nokogiri", "~> 1.0"
+  spec.add_runtime_dependency "sys-uname", "~> 1.2"
   spec.add_runtime_dependency "thor", "~> 1.0.1"
   spec.add_runtime_dependency "git", "~> 1.0"
   spec.add_runtime_dependency "ttfunk", "~> 1.6"
+  spec.add_runtime_dependency "plist", "~> 3.0"
   spec.add_runtime_dependency "excavate", "~> 0.1"
 
   spec.add_development_dependency "pry"
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "gem-release"
-  spec.add_development_dependency "nokogiri", "~> 1.0"
   spec.add_development_dependency "rake", "~> 13"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec-benchmark", "~> 0.6"

data/lib/fontist/cli/class_options.rb

@@ -0,0 +1,14 @@
+module Fontist
+  class CLI < Thor
+    module ClassOptions
+      def handle_class_options(options)
+        Fontist.preferred_family = options[:preferred_family]
+        Fontist.log_level = options[:quiet] ? :fatal : :info
+
+        if options[:formulas_path]
+          Fontist.formulas_path = Pathname.new(options[:formulas_path])
+        end
+      end
+    end
+  end
+end

data/lib/fontist/cli.rb

@@ -1,9 +1,13 @@
 require "thor"
+require "fontist/cli/class_options"
 require "fontist/repo_cli"
+require "fontist/import_cli"
 require "fontist/google_cli"
 
 module Fontist
   class CLI < Thor
+    include ClassOptions
+
     STATUS_SUCCESS = 0
     STATUS_UNKNOWN_ERROR = 1
     STATUS_NON_SUPPORTED_FONT_ERROR = 2
@@ -15,18 +19,31 @@ module Fontist
     STATUS_REPO_NOT_FOUND = 8
     STATUS_MAIN_REPO_NOT_FOUND = 9
     STATUS_REPO_COULD_NOT_BE_UPDATED = 10
+    STATUS_MANUAL_FONT_ERROR = 11
+    STATUS_SIZE_LIMIT_ERROR = 12
+    STATUS_FORMULA_NOT_FOUND = 13
 
     ERROR_TO_STATUS = {
       Fontist::Errors::UnsupportedFontError => [STATUS_NON_SUPPORTED_FONT_ERROR],
       Fontist::Errors::MissingFontError => [STATUS_MISSING_FONT_ERROR],
+      Fontist::Errors::SizeLimitError => [
+        STATUS_SIZE_LIMIT_ERROR,
+        :append,
+        "Please specify higher `--size-limit`, or use the `--newest` or " \
+        "`--smallest` options.",
+      ],
+      Fontist::Errors::ManualFontError => [STATUS_MANUAL_FONT_ERROR],
       Fontist::Errors::LicensingError => [STATUS_LICENSING_ERROR],
       Fontist::Errors::ManifestCouldNotBeFoundError => [STATUS_MANIFEST_COULD_NOT_BE_FOUND_ERROR,
+                                                        :overwrite,
                                                         "Manifest could not be found."],
       Fontist::Errors::ManifestCouldNotBeReadError => [STATUS_MANIFEST_COULD_NOT_BE_READ_ERROR,
+                                                       :overwrite,
                                                        "Manifest could not be read."],
       Fontist::Errors::FontIndexCorrupted => [STATUS_FONT_INDEX_CORRUPTED],
       Fontist::Errors::RepoNotFoundError => [STATUS_REPO_NOT_FOUND],
       Fontist::Errors::MainRepoNotFoundError => [STATUS_MAIN_REPO_NOT_FOUND],
+      Fontist::Errors::FormulaNotFoundError => [STATUS_FORMULA_NOT_FOUND],
     }.freeze
 
     def self.exit_on_failure?
@@ -37,21 +54,39 @@ module Fontist
                  type: :boolean,
                  desc: "Use Preferred Family when available"
 
+    class_option :quiet,
+                 aliases: :q,
+                 type: :boolean,
+                 desc: "Hide all messages"
+
+    class_option :formulas_path, type: :string, desc: "Path to formulas"
+
     desc "install FONT", "Install font"
     option :force, type: :boolean, aliases: :f,
                    desc: "Install even if it's already installed in system"
-    option :accept_all_licenses, type: :boolean, aliases: "--confirm-license", desc: "Accept all license agreements"
-    option :hide_licenses, type: :boolean, desc: "Hide license texts"
-    option :no_progress, type: :boolean, desc: "Hide download progress"
+    option :formula, type: :boolean, aliases: :F,
+                     desc: "Install by formula instead of font"
+    option :accept_all_licenses, type: :boolean,
+                                 aliases: ["--confirm-license", :a],
+                                 desc: "Accept all license agreements"
+    option :hide_licenses, type: :boolean, aliases: :h,
+                           desc: "Hide license texts"
+    option :no_progress, type: :boolean, aliases: :p,
+                         desc: "Hide download progress"
+    option :version, type: :string, aliases: :V,
+                     desc: "Specify particular version of a font"
+    option :smallest, type: :boolean, aliases: :s,
+                      desc: "Install the smallest formula if several"
+    option :newest, type: :boolean, aliases: :n,
+                    desc: "Install the newest version of a font if several"
+    option :size_limit,
+           type: :numeric, aliases: :S,
+           desc: "Specify size limit for formula " \
+                 "(default is #{Fontist.formula_size_limit_in_megabytes} MB)"
     def install(font)
       handle_class_options(options)
-      Fontist::Font.install(
-        font,
-        force: options[:force],
-        confirmation: options[:accept_all_licenses] ? "yes" : "no",
-        hide_licenses: options[:hide_licenses],
-        no_progress: options[:no_progress]
-      )
+      confirmation = options[:accept_all_licenses] ? "yes" : "no"
+      Fontist::Font.install(font, options.merge(confirmation: confirmation))
       success
     rescue Fontist::Errors::GeneralError => e
       handle_error(e)
@@ -113,8 +148,12 @@ module Fontist
     end
 
     desc "manifest-install MANIFEST", "Install fonts from MANIFEST (yaml)"
-    option :accept_all_licenses, type: :boolean, aliases: "--confirm-license", desc: "Accept all license agreements"
-    option :hide_licenses, type: :boolean, desc: "Hide license texts"
+    option :accept_all_licenses, type: :boolean,
+                                 aliases: ["--confirm-license", :a],
+                                 desc: "Accept all license agreements"
+    option :hide_licenses, type: :boolean,
+                           aliases: :h,
+                           desc: "Hide license texts"
     def manifest_install(manifest)
       handle_class_options(options)
       paths = Fontist::Manifest::Install.from_file(
@@ -167,24 +206,31 @@ module Fontist
     desc "repo SUBCOMMAND ...ARGS", "Manage custom repositories"
     subcommand "repo", Fontist::RepoCLI
 
+    desc "import SUBCOMMAND ...ARGS", "Manage imports"
+    subcommand "import", Fontist::ImportCLI
+
     desc "google SUBCOMMAND ...ARGS", "Manage Google formulas"
     subcommand "google", Fontist::GoogleCLI
 
     private
 
-    def handle_class_options(options)
-      Fontist.preferred_family = options[:preferred_family]
-    end
-
     def success
       STATUS_SUCCESS
     end
 
     def handle_error(exception)
-      status, message = ERROR_TO_STATUS[exception.class]
+      status, mode, message = ERROR_TO_STATUS[exception.class]
       raise exception unless status
 
-      error(message || exception.message, status)
+      text = if message && mode == :overwrite
+               message
+             elsif message
+               "#{exception.message} #{message}"
+             else
+               exception.message
+             end
+
+      error(text, status)
     end
 
     def error(message, status)
@@ -205,10 +251,15 @@ module Fontist
           Fontist.ui.say(" #{font.name}")
 
           styles.each do |style, installed|
+            opts = []
+            opts << "manual" if formula.manual?
+            opts << (installed ? "installed" : "uninstalled")
+            msg = "  #{style.type} (#{opts.join(', ')})"
+
             if installed
-              Fontist.ui.success("  #{style.type} (installed)")
+              Fontist.ui.success(msg)
             else
-              Fontist.ui.error("  #{style.type} (uninstalled)")
+              Fontist.ui.error(msg)
             end
           end
         end

data/lib/fontist/errors.rb

@@ -12,6 +12,16 @@ module Fontist
     # it depends on this exception to automatically download formulas
     class FormulaIndexNotFoundError < GeneralError; end
 
+    class FormulaNotFoundError < GeneralError
+      def initialize(formula)
+        super(<<~MSG.chomp)
+          Formula '#{formula}' not found locally nor available in the Fontist formula repository.
+          Perhaps it is available at the latest Fontist formula repository.
+          You can update the formula repository using the command `fontist update` and try again.
+        MSG
+      end
+    end
+
     class MainRepoNotFoundError < FormulaIndexNotFoundError; end
 
     class InvalidResourceError < GeneralError; end
@@ -28,6 +38,8 @@ module Fontist
 
     class RepoCouldNotBeUpdatedError < GeneralError; end
 
+    class SizeLimitError < GeneralError; end
+
     class TamperedFileError < GeneralError; end
 
     class TimeoutError < GeneralError; end
@@ -72,6 +84,14 @@ module Fontist
       end
     end
 
+    class ManualFontError < FontError
+      def initialize(font, formula)
+        msg = "'#{font}' font is missing.\n\n#{formula.instructions}"
+
+        super(msg, font)
+      end
+    end
+
     class UnsupportedFontError < FontError
       def initialize(font)
         msg = <<~MSG.chomp

data/lib/fontist/font.rb

@@ -1,5 +1,6 @@
 require "fontist/font_installer"
 require "fontist/font_path"
+require "fontist/formula_picker"
 
 module Fontist
   class Font
@@ -9,6 +10,11 @@ module Fontist
       @hide_licenses = options[:hide_licenses]
       @no_progress = options[:no_progress] || false
       @force = options[:force] || false
+      @version = options[:version]
+      @smallest = options[:smallest]
+      @newest = options[:newest]
+      @size_limit = options[:size_limit]
+      @by_formula = options[:formula]
 
       check_or_create_fontist_path!
     end
@@ -38,21 +44,27 @@ module Fontist
     end
 
     def find
-      find_system_font || downloadable_font || raise_non_supported_font
+      find_system_font || downloadable_font || manual_font ||
+        raise_non_supported_font
     end
 
     def install
-      (find_system_font unless @force) || download_font || raise_non_supported_font
+      return install_formula if @by_formula
+
+      (find_system_font unless @force) || download_font || manual_font ||
+        raise_non_supported_font
     end
 
     def uninstall
-      uninstall_font || downloadable_font || raise_non_supported_font
+      uninstall_font || downloadable_font || manual_font ||
+        raise_non_supported_font
     end
 
     def status
       return installed_paths unless @name
 
-      find_system_font || downloadable_font || raise_non_supported_font
+      find_system_font || downloadable_font || manual_font ||
+        raise_non_supported_font
     end
 
     def list
@@ -94,12 +106,42 @@ module Fontist
       end
     end
 
+    def install_formula
+      download_formula || raise_formula_not_found
+    end
+
+    def download_formula
+      formula = Formula.find_by_key(@name)
+      return unless formula
+      return unless formula.downloadable?
+
+      request_formula_installation(formula)
+    end
+
+    def raise_formula_not_found
+      raise Errors::FormulaNotFoundError.new(@name)
+    end
+
     def font_installer(formula)
       FontInstaller.new(formula, no_progress: @no_progress)
     end
 
-    def formula
-      @formula ||= formulas.first
+    def sufficient_formulas
+      @sufficient_formulas ||=
+        FormulaPicker.new(@name,
+                          size_limit: @size_limit,
+                          version: @version,
+                          smallest: @smallest,
+                          newest: @newest)
+          .call(downloadable_formulas)
+    end
+
+    def downloadable_formulas
+      @downloadable_formulas ||= formulas.select(&:downloadable?)
+    end
+
+    def manual_formulas
+      @manual_formulas ||= formulas.reject(&:downloadable?)
     end
 
     def formulas
@@ -108,27 +150,34 @@ module Fontist
     end
 
     def supported_formula?(formula)
-      formula.platforms.nil? ||
-        formula.platforms.include?(Fontist::Utils::System.user_os.to_s)
+      return true if formula.platforms.nil?
+
+      formula.platforms.any? do |platform|
+        Utils::System.match?(platform)
+      end
     end
 
     def downloadable_font
-      if formula
-        raise Fontist::Errors::MissingFontError.new(name)
-      end
+      return if downloadable_formulas.empty?
+
+      raise Fontist::Errors::MissingFontError.new(name)
     end
 
     def download_font
-      return if formulas.empty?
+      return if sufficient_formulas.empty?
 
-      formulas.flat_map do |formula|
-        confirmation = check_and_confirm_required_license(formula)
-        paths = font_installer(formula).install(confirmation: confirmation)
+      sufficient_formulas.flat_map do |formula|
+        request_formula_installation(formula)
+      end
+    end
 
-        Fontist.ui.say("Fonts installed at:")
-        paths.each do |path|
-          Fontist.ui.say("- #{path}")
-        end
+    def request_formula_installation(formula)
+      confirmation = check_and_confirm_required_license(formula)
+      paths = font_installer(formula).install(confirmation: confirmation)
+
+      Fontist.ui.say("Fonts installed at:")
+      paths.each do |path|
+        Fontist.ui.say("- #{path}")
       end
     end
 
@@ -171,6 +220,12 @@ module Fontist
       MSG
     end
 
+    def manual_font
+      return if manual_formulas.empty?
+
+      raise Fontist::Errors::ManualFontError.new(name, manual_formulas.first)
+    end
+
     def uninstall_font
       paths = find_fontist_paths
       return unless paths
@@ -221,7 +276,7 @@ module Fontist
 
     def list_styles(formulas)
       map_to_hash(formulas) do |formula|
-        map_to_hash(formula.fonts) do |font|
+        map_to_hash(requested_fonts(formula.fonts)) do |font|
           map_to_hash(font.styles) do |style|
             installed(style)
           end
@@ -233,6 +288,14 @@ module Fontist
       elements.map { |e| [e, yield(e)] }.to_h
     end
 
+    def requested_fonts(fonts)
+      return fonts unless @name
+
+      fonts.select do |font|
+        font.name.casecmp?(name)
+      end
+    end
+
     def installed(style)
       path(style) ? true : false
     end

data/lib/fontist/formula.rb

@@ -45,6 +45,13 @@ module Fontist
       end.flatten
     end
 
+    def self.find_by_key(key)
+      path = Fontist.formulas_path.join("#{key}.yml")
+      return unless File.exist?(path)
+
+      new_from_file(path)
+    end
+
     def self.new_from_file(path)
       data = YAML.load_file(path)
       new(data, path)
@@ -59,12 +66,20 @@ module Fontist
       Indexes::IndexFormula.new(path)
     end
 
+    def manual?
+      !downloadable?
+    end
+
+    def downloadable?
+      @data.key?("resources")
+    end
+
     def path
       @path
     end
 
     def key
-      @data["key"] || default_key
+      key_from_path
     end
 
     def description
@@ -99,12 +114,28 @@ module Fontist
       Helpers.parse_to_object(@data["extract"])
     end
 
+    def file_size
+      return unless @data["resources"]
+
+      @data["resources"].values.first["file_size"]&.to_i
+    end
+
     def resources
-      Helpers.parse_to_object(@data["resources"].values)
+      Helpers.parse_to_object(@data["resources"]&.values)
+    end
+
+    def instructions
+      @data["instructions"]
+    end
+
+    def fonts_by_name(name)
+      fonts.select do |font|
+        font.name.casecmp?(name)
+      end
     end
 
     def fonts
-      @fonts ||= Helpers.parse_to_object(hash_collection_fonts + hash_fonts)
+      @fonts ||= Helpers.parse_to_object(fonts_by_family)
     end
 
     def digest
@@ -113,11 +144,46 @@ module Fontist
 
     private
 
-    def default_key
+    def key_from_path
       escaped = Regexp.escape(Fontist.formulas_path.to_s + "/")
       @path.sub(Regexp.new("^" + escaped), "").sub(/\.yml$/, "")
     end
 
+    def fonts_by_family
+      return hash_all_fonts unless Fontist.preferred_family?
+
+      preferred_family_fonts
+    end
+
+    def preferred_family_fonts
+      groups = preferred_family_styles.group_by do |style|
+        style["family_name"]
+      end
+
+      groups.map do |font_name, font_styles|
+        { "name" => font_name, "styles" => font_styles }
+      end
+    end
+
+    def preferred_family_styles
+      hash_all_fonts.flat_map do |font|
+        font["styles"].map do |style|
+          style.merge(preferred_style(style))
+        end
+      end
+    end
+
+    def preferred_style(style)
+      { "family_name" => style["preferred_family_name"] || style["family_name"],
+        "type" => style["preferred_type"] || style["type"],
+        "default_family_name" => style["family_name"],
+        "default_type" => style["type"] }
+    end
+
+    def hash_all_fonts
+      hash_collection_fonts + hash_fonts
+    end
+
     def hash_collection_fonts
       return [] unless @data["font_collections"]
 
@@ -126,8 +192,7 @@ module Fontist
                       "source_font" => coll["source_filename"] }
 
         coll["fonts"].map do |font|
-          { "name" => font["name"],
-            "styles" => font["styles"].map { |s| filenames.merge(s) } }
+          font.merge("styles" => font["styles"].map { |s| filenames.merge(s) })
         end
       end
     end