fontist 1.11.6 → 1.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebc9110896000190889a313f291012ebc3b84a7296230398ee61c9822c44ea87
-  data.tar.gz: 9de28427a3a46124e8ded2880de764ad9bb632bc9c919babe15123fc38eebdb3
+  metadata.gz: f376e0b45e530b28be9d60c132b3840d4485103995fc435c0512b07bf6e20435
+  data.tar.gz: b8c8aa1f3de0b627bcaffe09b45398dd60a0ba2a3a2163599263461acb179292
 SHA512:
-  metadata.gz: 005c1c9a434bbfa11da8602be4180e20056798afccf4c302204e6d986c6a288d7ee6cbfb387c597db79fe4ae86e50aa22729d4553813b7f025d27a1033c83f19
-  data.tar.gz: 8584ca32768a87ce2ddfd95275e6f22a9b61074df2db8b407f587931cc2729b444dd257f6435fd564bd0588a2bcf5d6e2634f611cf73a87d76ec517a86de4edf
+  metadata.gz: 157c06d56119a5e94a7a15b33b7b1e65695eb94af595f618bbbcf382f8d201d8db7f1a51ed2e3b20cf56d0339a7bd33dc2be82900de1851e29ee31225d2f8054
+  data.tar.gz: 3fabd78041974540dc3504c293e335cfd39d241c5cd80da8fd0eef2b6b0a0e6a49701baf4c13e4c151ff397c8aaa6d9d542b37a45b52610ca404bb0abcef004a

data/.github/workflows/rspec.yml

@@ -33,7 +33,15 @@ jobs:
         env:
           TEST_ENV: CI
 
-      - if: matrix.os != 'macos-latest'
+      - if: matrix.os == 'windows-latest' && matrix.ruby == '2.4'
+        run: curl -O https://curl.se/ca/cacert.pem
+
+      - if: matrix.os == 'windows-latest' && matrix.ruby == '2.4'
+        run: bundle exec rspec --tag ~dev
+        env:
+          SSL_CERT_FILE: cacert.pem
+
+      - if: matrix.os != 'macos-latest' || matrix.os == 'windows-latest' && matrix.ruby == '2.4'
         run: bundle exec rspec --tag ~dev
         env:
           TEST_ENV: CI

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,25 @@ 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
+-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 +637,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 +659,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.rb

@@ -1,5 +1,6 @@
 require "thor"
 require "fontist/repo_cli"
+require "fontist/import_cli"
 require "fontist/google_cli"
 
 module Fontist
@@ -15,14 +16,25 @@ 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
 
     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],
@@ -40,18 +52,27 @@ module Fontist
     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 :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)
@@ -167,6 +188,9 @@ 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
 
@@ -181,10 +205,18 @@ module Fontist
     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 +237,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

@@ -28,6 +28,8 @@ module Fontist
 
     class RepoCouldNotBeUpdatedError < GeneralError; end
 
+    class SizeLimitError < GeneralError; end
+
     class TamperedFileError < GeneralError; end
 
     class TimeoutError < GeneralError; end
@@ -72,6 +74,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,10 @@ 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]
 
       check_or_create_fontist_path!
     end
@@ -38,21 +43,25 @@ 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
+      (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
@@ -62,7 +71,7 @@ module Fontist
     end
 
     def all
-      Fontist::Formula.all.map(&:fonts).flatten
+      all_formulas.map(&:fonts).flatten
     end
 
     private
@@ -98,24 +107,47 @@ module Fontist
       FontInstaller.new(formula, no_progress: @no_progress)
     end
 
-    def formula
-      @formula ||= Fontist::Formula.find(name)
+    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
       @formulas ||= Fontist::Formula.find_many(name)
+        .select { |f| supported_formula?(f) }
     end
 
-    def downloadable_font
-      if formula
-        raise Fontist::Errors::MissingFontError.new(name)
+    def supported_formula?(formula)
+      return true if formula.platforms.nil?
+
+      formula.platforms.any? do |platform|
+        Utils::System.match?(platform)
       end
     end
 
+    def downloadable_font
+      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|
+      sufficient_formulas.flat_map do |formula|
         confirmation = check_and_confirm_required_license(formula)
         paths = font_installer(formula).install(confirmation: confirmation)
 
@@ -165,6 +197,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
@@ -190,7 +228,7 @@ module Fontist
     end
 
     def all_formulas
-      Fontist::Formula.all
+      Fontist::Formula.all.select { |f| supported_formula?(f) }
     end
 
     def path(style)
@@ -215,7 +253,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
@@ -227,6 +265,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

@@ -59,6 +59,14 @@ module Fontist
       Indexes::IndexFormula.new(path)
     end
 
+    def manual?
+      !downloadable?
+    end
+
+    def downloadable?
+      @data.key?("resources")
+    end
+
     def path
       @path
     end
@@ -91,16 +99,36 @@ module Fontist
       @data["requires_license_agreement"] ? true : false
     end
 
+    def platforms
+      @data["platforms"]
+    end
+
     def extract
       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
@@ -114,6 +142,41 @@ module Fontist
       @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"]
 
@@ -122,8 +185,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

data/lib/fontist/formula_picker.rb

@@ -0,0 +1,126 @@
+require "fontist/style_version"
+
+module Fontist
+  class FormulaPicker
+    def initialize(font_name, size_limit:, version:, smallest:, newest:)
+      @font_name = font_name
+      @size_limit = size_limit || Fontist.formula_size_limit_in_megabytes
+      @version = version
+      @smallest = smallest
+      @newest = newest
+    end
+
+    def call(formulas)
+      return [] if formulas.size.zero?
+      return formulas if contain_different_styles?(formulas)
+      return by_version(formulas) if version_is_passed?
+      return newest(formulas) if newest_is_passed?
+      return smallest(formulas) if smallest_is_passed?
+
+      default_way(formulas)
+    end
+
+    private
+
+    def version_is_passed?
+      !@version.nil?
+    end
+
+    def by_version(formulas)
+      formulas.each do |formula|
+        fonts = formula.fonts_by_name(@font_name)
+        fonts.each do |font|
+          font.styles.each do |style|
+            version = StyleVersion.new(style.version)
+            return [formula] if version == passed_version
+          end
+        end
+      end
+
+      []
+    end
+
+    def passed_version
+      @passed_version ||= StyleVersion.new(@version)
+    end
+
+    def newest_is_passed?
+      @newest
+    end
+
+    def newest(formulas)
+      newest_formulas = filter_by_max_version(formulas)
+      smallest(newest_formulas)
+    end
+
+    def smallest_is_passed?
+      @smallest
+    end
+
+    def smallest(formulas)
+      [choose_smallest_formula(formulas)]
+    end
+
+    def default_way(formulas)
+      size_limited_formulas = filter_by_size_limit(formulas)
+      raise_size_limit_error if size_limited_formulas.empty?
+      newest(size_limited_formulas)
+    end
+
+    def contain_different_styles?(formulas)
+      styles_by_formula = formulas.map do |formula|
+        fonts = formula.fonts_by_name(@font_name)
+        styles = fonts.flat_map do |font|
+          font.styles.map(&:type)
+        end
+
+        styles.uniq.sort
+      end
+
+      styles_by_formula.uniq.size > 1
+    end
+
+    def filter_by_size_limit(formulas)
+      formulas.select do |formula|
+        formula.file_size.nil? || formula.file_size < size_limit_in_bytes
+      end
+    end
+
+    def size_limit_in_bytes
+      @size_limit_in_bytes ||= @size_limit * 1024 * 1024
+    end
+
+    def raise_size_limit_error
+      raise Errors::SizeLimitError,
+            "There are only formulas above the size limit " \
+            "(#{@size_limit} MB)."
+    end
+
+    def filter_by_max_version(formulas)
+      formulas_with_version = detect_formula_version(formulas)
+      max_version = formulas_with_version.map(&:first).max
+      formulas_with_version.select do |version, _formula|
+        version == max_version
+      end.map(&:last)
+    end
+
+    def detect_formula_version(formulas)
+      formulas.map do |formula|
+        fonts = formula.fonts_by_name(@font_name)
+        versions = fonts.flat_map do |font|
+          font.styles.map do |style|
+            StyleVersion.new(style.version)
+          end
+        end
+
+        [versions.max, formula]
+      end
+    end
+
+    def choose_smallest_formula(formulas)
+      formulas.min_by do |formula|
+        formula.file_size || 0
+      end
+    end
+  end
+end