fontist 1.17.1 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91726c53a66563f2b0a32417d45d246617b85586cc7c9573b24c5b83533c5444
-  data.tar.gz: de8e1aba5de04fb720c85a6c98e708dcbae944bf439c15f4dc29c3f27e4d0831
+  metadata.gz: 2f726f1ac899163c9c7346d540f5bcaf831d522dd59f3e3afd5bed661560ea40
+  data.tar.gz: a94c77482bd16d9f751b2d3d713e13bf1aefd78703d7bba973c8d2649469035d
 SHA512:
-  metadata.gz: d05de7120339d223fc716ad1f99a60c80ec54deb37bbe77692cff0295d3ccc4b7263ae5bc2ed2beae3dc82f18f0684d85b47f01ca4c5730e04ec4cb82357be2c
-  data.tar.gz: 381a74039161a1e9d5ea9b560afbc9c551083c67462002f9c590da83fe69283fd8d0506983554c19d9f0ded9fba33a3b71a5d7db11a82d3689ebd7b885a9cfc2
+  metadata.gz: 9d0fbfe9abf98ee2b28b2cf7f1aa73d0d3003519345d2f68f684043fb462f5df26a19a662e005ff07eb882923e3becbd52c616254ab6a704423a08f7c4588797
+  data.tar.gz: 74dd96f8a564fbcfab6d6372e0729b4aab1c3e80d14fd358626e8beaec505acdeb21b3e4de1eb589a13c9a490c8f595dc1e3ca40fc9650ae24dc29e68234a214

data/.github/workflows/test-and-release.yml

@@ -45,6 +45,7 @@ jobs:
           bundler-cache: true
 
       - if: matrix.os == 'macos-latest'
+        name: Run tests including dev ones
         run: |
           brew install lcdf-typetools
           bundle exec rspec

data/README.adoc

@@ -78,6 +78,9 @@ NOTE: See <<preferred-family-change>> for the differences between
 `-v, --verbose`:: Set the log level to debug. It prints formulas excluded
 during installation and information for developers of fontist.
 
+`-c, --no-cache`:: Prefer direct download even when a file is already cached in
+a system.
+
 === Install fonts: `fontist install`
 
 Fontist checks whether this font is already installed, and if not, then installs
@@ -299,6 +302,41 @@ Roboto Mono:
     - "/Users/user/.fontist/fonts/RobotoMono-VariableFont_wght.ttf"
 ----
 
+=== Work with fontist config: `fontist config`
+
+Fontist supports system-wide settings for the following parameters:
+
+`fonts_path`:: Sets path where to install fonts (default: `~/.fontist/fonts`)
+
+`open_timeout`:: Sets timeout for opening a connection during download
+(default: `10`)
+
+`read_timeout`:: Sets timeout for reading the opened connection during download
+(default: `10`)
+
+Show current attributes in the config:
+
+[source,sh]
+----
+$ fontist config show
+Current config:
+read_timeout: 5
+----
+
+Assign a value to an attribute:
+
+[source,sh]
+----
+$ fontist config set read_timeout 60
+----
+
+Restore a default value of an attribute:
+
+[source,sh]
+----
+$ fontist config delete read_timeout
+----
+
 === Work with Fontconfig: `fontist fontconfig`
 
 Fontconfig is a software designed to provide fonts to other programs. It is
@@ -341,7 +379,7 @@ List of all commands could be seen by:
 fontist help
 ----
 
-=== Configuration
+=== Configuration with environment variables
 
 By default Fontist uses the `~/.fontist` directory to store fonts and its
 files. It could be changed with the `FONTIST_PATH` environment variable.
@@ -621,6 +659,15 @@ Apple Support site:
 WARNING: Fontist does not allow installing macOS-specific fonts on non-macOS
 platforms due to font license restrictions of those fonts.
 
+=== Known problematic fonts
+
+* NISC18030.ttf (GB18030 Bitmap) - macOS, more info in
+https://github.com/fontist/fontist/issues/344[the NISC18030 issue]
+
+The full list of known problematic fonts:
+
+* https://github.com/fontist/fontist/blob/main/lib/fontist/exclude.yml[List of fonts excluded from usage]
+
 
 == Advanced usage
 
@@ -826,7 +873,7 @@ For file paths, specify the file path as argument:
 
 [source,sh]
 ----
-wget https://www.latofonts.com/download/lato2ofl-zip/
+wget https://www.latofonts.com/files/Lato2OFL.zip
 fontist create-formula lato.zip
 ----
 
@@ -834,7 +881,7 @@ For URLs, simply specify the URL as the argument:
 
 [source,sh]
 ----
-fontist create-formula https://www.latofonts.com/download/lato2ofl-zip/
+fontist create-formula https://www.latofonts.com/files/Lato2OFL.zip
 # > file created at lato.yml because the file downloaded is lato.zip
 ----
 
@@ -843,7 +890,7 @@ private formula repository location.
 
 [source,sh]
 ----
-fontist create-formula https://www.latofonts.com/download/lato2ofl-zip/
+fontist create-formula https://www.latofonts.com/files/Lato2OFL.zip
 cp lato.yml ~/.fontist/formulas/Formulas/
 ----
 

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 "json", "~> 2.0"
   spec.add_runtime_dependency "nokogiri", "~> 1.0"
   spec.add_runtime_dependency "mime-types", "~> 3.0"
   spec.add_runtime_dependency "sys-uname", "~> 1.2"

data/lib/fontist/cli/class_options.rb

@@ -1,9 +1,37 @@
 module Fontist
   class CLI < Thor
     module ClassOptions
+      # rubocop:disable Metrics/MethodLength
+      def self.included(base)
+        base.class_option :preferred_family,
+                          type: :boolean,
+                          desc: "Use Preferred Family when available"
+
+        base.class_option :quiet,
+                          aliases: :q,
+                          type: :boolean,
+                          desc: "Hide all messages"
+
+        base.class_option :verbose,
+                          aliases: :v,
+                          type: :boolean,
+                          desc: "Print debug messages"
+
+        base.class_option :no_cache,
+                          aliases: :c,
+                          type: :boolean,
+                          desc: "Avoid using cache during download"
+
+        base.class_option :formulas_path,
+                          type: :string,
+                          desc: "Path to formulas"
+      end
+      # rubocop:enable Metrics/MethodLength
+
       def handle_class_options(options)
         Fontist.preferred_family = options[:preferred_family]
         Fontist.log_level = log_level(options)
+        Fontist.use_cache = !options[:no_cache]
 
         if options[:formulas_path]
           Fontist.formulas_path = Pathname.new(options[:formulas_path])

data/lib/fontist/cli.rb

@@ -4,6 +4,7 @@ require "fontist/repo_cli"
 require "fontist/cache_cli"
 require "fontist/import_cli"
 require "fontist/fontconfig_cli"
+require "fontist/config_cli"
 
 module Fontist
   class CLI < Thor
@@ -26,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],
@@ -58,22 +60,6 @@ module Fontist
       false
     end
 
-    class_option :preferred_family,
-                 type: :boolean,
-                 desc: "Use Preferred Family when available"
-
-    class_option :quiet,
-                 aliases: :q,
-                 type: :boolean,
-                 desc: "Hide all messages"
-
-    class_option :verbose,
-                 aliases: :v,
-                 type: :boolean,
-                 desc: "Print debug 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 already installed in system"
@@ -221,6 +207,9 @@ module Fontist
     desc "fontconfig SUBCOMMAND ...ARGS", "Manage fontconfig"
     subcommand "fontconfig", Fontist::FontconfigCLI
 
+    desc "config SUBCOMMAND ...ARGS", "Manage fontist config"
+    subcommand "config", Fontist::ConfigCLI
+
     desc "cache SUBCOMMAND ...ARGS", "Manage fontist cache"
     subcommand "cache", Fontist::CacheCLI
 

data/lib/fontist/config.rb

@@ -0,0 +1,78 @@
+module Fontist
+  class Config
+    include Singleton
+
+    def initialize
+      @custom_values = load_config_file
+    end
+
+    def values
+      default_values.merge(@custom_values)
+    end
+
+    def custom_values
+      @custom_values
+    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)
+      if respond_to?("#{attr}=")
+        public_send("#{attr}=", v)
+      else
+        @custom_values[attr] = v
+      end
+
+      persist
+    end
+
+    def delete(key)
+      @custom_values.delete(key.to_sym)
+
+      persist
+    end
+
+    def default_value(key)
+      default_values[key.to_sym]
+    end
+
+    def default_values
+      { 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(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).transform_keys(&:to_sym)
+    end
+
+    def normalize_value(value)
+      return value.to_i if value.to_i.to_s == value # detect integer
+
+      value
+    end
+  end
+end

data/lib/fontist/config_cli.rb

@@ -0,0 +1,58 @@
+module Fontist
+  class ConfigCLI < Thor
+    include CLI::ClassOptions
+
+    desc "show", "Show values of the current config"
+    def show
+      handle_class_options(options)
+      values = Config.instance.custom_values
+
+      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"
+    def set(key, value)
+      handle_class_options(options)
+      Config.instance.set(key, value)
+      Fontist.ui.success("'#{key}' set to '#{value}'.")
+      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"
+    def delete(key)
+      handle_class_options(options)
+      Config.instance.delete(key)
+      Fontist.ui.success(
+        "'#{key}' reset to default ('#{Config.instance.default_value(key)}').",
+      )
+      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)
+      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/exclude.yml

@@ -0,0 +1 @@
+- NISC18030.ttf

data/lib/fontist/import/google/new_fonts_fetcher.rb

@@ -9,8 +9,9 @@ module Fontist
         REPO_URL = "https://github.com/google/fonts.git".freeze
         SKIPLIST_PATH = File.expand_path("skiplist.yml", __dir__)
 
-        def initialize(logging: false)
+        def initialize(logging: false, limit: nil)
           @logging = logging
+          @limit = limit
         end
 
         def call
@@ -30,11 +31,20 @@ module Fontist
         end
 
         def fetch_new_paths
-          fetch_fonts_paths.select do |path|
-            log_font(path) do
+          new_paths = []
+
+          fetch_fonts_paths.each do |path|
+            new = log_font(path) do
               new?(path)
             end
+
+            next unless new
+
+            new_paths << path
+            return new_paths if @limit && new_paths.size >= @limit
           end
+
+          new_paths
         end
 
         def fetch_fonts_paths

data/lib/fontist/import/google.rb

@@ -1,6 +1,8 @@
 module Fontist
   module Import
     module Google
+      DEFAULT_MAX_COUNT = 100
+
       def self.metadata_name(path)
         metadata_path = File.join(path, "METADATA.pb")
         return unless File.exist?(metadata_path)

data/lib/fontist/import/google_import.rb

@@ -6,16 +6,21 @@ require_relative "create_formula"
 module Fontist
   module Import
     class GoogleImport
+      def initialize(options)
+        @max_count = options[:max_count] || Google::DEFAULT_MAX_COUNT
+      end
+
       def call
         fonts = new_fonts
         create_formulas(fonts)
-        rebuild_index
+        rebuild_index unless fonts.empty?
       end
 
       private
 
       def new_fonts
-        Fontist::Import::Google::NewFontsFetcher.new(logging: true).call
+        Fontist::Import::Google::NewFontsFetcher.new(logging: true,
+                                                     limit: @max_count).call
       end
 
       def create_formulas(fonts)

data/lib/fontist/import/macos.rb

@@ -8,6 +8,10 @@ module Fontist
       FONT_XML = "/System/Library/AssetsV2/com_apple_MobileAsset_Font6/com_apple_MobileAsset_Font6.xml".freeze # rubocop:disable Layout/LineLength
       HOMEPAGE = "https://support.apple.com/en-om/HT211240#document".freeze
 
+      def initialize(font_xml = FONT_XML)
+        @font_xml = font_xml
+      end
+
       def call
         links.each do |link|
           create_formula(link)
@@ -21,7 +25,7 @@ module Fontist
       private
 
       def links
-        data = Plist.parse_xml(FONT_XML)
+        data = Plist.parse_xml(@font_xml)
         data["Assets"].map do |x|
           x.values_at("__BaseURL", "__RelativePath").join
         end

data/lib/fontist/import_cli.rb

@@ -1,12 +1,19 @@
+require_relative "import/google"
+
 module Fontist
   class ImportCLI < Thor
     include CLI::ClassOptions
 
     desc "google", "Import Google fonts"
+    option :max_count,
+           type: :numeric, aliases: :n,
+           desc: "Limit the number of formulas to import " \
+                 "(default is #{Fontist::Import::Google::DEFAULT_MAX_COUNT})."
+
     def google
       handle_class_options(options)
       require "fontist/import/google_import"
-      Fontist::Import::GoogleImport.new.call
+      Fontist::Import::GoogleImport.new(options).call
       CLI::STATUS_SUCCESS
     end
 

data/lib/fontist/system_font.rb

@@ -16,9 +16,8 @@ module Fontist
     end
 
     def self.load_system_font_paths
-      config_path = Fontist.system_file_path
       os = Fontist::Utils::System.user_os.to_s
-      templates = YAML.load_file(config_path)["system"][os]["paths"]
+      templates = system_config["system"][os]["paths"]
       patterns = expand_paths(templates)
 
       Dir.glob(patterns)
@@ -26,6 +25,10 @@ module Fontist
       # "Case sensitivity depends on your system"
     end
 
+    def self.system_config
+      YAML.load_file(Fontist.system_file_path)
+    end
+
     def self.reset_system_font_paths_cache
       @system_font_paths = nil
     end

data/lib/fontist/system_index.rb

@@ -66,6 +66,10 @@ module Fontist
       Fontist.preferred_family? ? PreferredFamily.new : DefaultFamily.new
     end
 
+    def excluded_fonts
+      @excluded_fonts ||= YAML.load_file(Fontist.excluded_fonts_path)
+    end
+
     def initialize(index_path, font_paths_fetcher, family)
       @index_path = index_path
       @font_paths_fetcher = font_paths_fetcher
@@ -154,16 +158,26 @@ module Fontist
     end
 
     def detect_fonts(path)
+      return if excluded?(path)
+
+      gather_fonts(path)
+    rescue Errors::FontFileError => e
+      print_recognition_error(e, path)
+    end
+
+    def excluded?(path)
+      excluded_fonts.include?(File.basename(path))
+    end
+
+    def gather_fonts(path)
       case File.extname(path).gsub(/^\./, "").downcase
       when "ttf", "otf"
         detect_file_font(path)
       when "ttc"
         detect_collection_fonts(path)
       else
-        raise Errors::UnknownFontTypeError.new(path)
+        print_recognition_error(Errors::UnknownFontTypeError.new(path), path)
       end
-    rescue Errors::FontFileError => e
-      print_recognition_error(e, path)
     end
 
     def print_recognition_error(exception, path)

data/lib/fontist/utils/cache.rb

@@ -9,7 +9,7 @@ module Fontist
 
       def fetch(key)
         map = load_cache
-        if cache_exist?(map[key])
+        if Fontist.use_cache? && cache_exist?(map[key])
           print(map[key])
 
           return downloaded_file(map[key])

data/lib/fontist/utils/downloader.rb

@@ -80,8 +80,8 @@ module Fontist
       def do_download_file_with_progress_bar(progress_bar)
         Down.download(
           url,
-          open_timeout: 10,
-          read_timeout: 10,
+          open_timeout: Fontist.open_timeout,
+          read_timeout: Fontist.read_timeout,
           max_redirects: 10,
           headers: headers,
           content_length_proc: ->(content_length) {

data/lib/fontist/utils/file_magic.rb

@@ -0,0 +1,35 @@
+module Fontist
+  module Utils
+    class FileMagic
+      MAP_MAGIC_TO_TYPE = {
+        "\x00\x01\x00\x00\x00" => :ttf,
+        "\x4f\x54\x54\x4f" => :otf,
+        "\x74\x74\x63\x66" => :ttc,
+      }.freeze
+
+      def self.detect(path)
+        new(path).detect
+      end
+
+      def self.max_magic
+        @max_magic ||= MAP_MAGIC_TO_TYPE.keys.map(&:bytesize).max
+      end
+
+      def initialize(path)
+        @path = path
+      end
+
+      def detect
+        beginning = File.binread(@path, self.class.max_magic)
+
+        MAP_MAGIC_TO_TYPE.each do |magic, type|
+          slice = beginning.byteslice(0, magic.bytesize)
+
+          return type if slice == magic
+        end
+
+        nil
+      end
+    end
+  end
+end

data/lib/fontist/version.rb

@@ -1,3 +1,3 @@
 module Fontist
-  VERSION = "1.17.1".freeze
+  VERSION = "1.19.0".freeze
 end

data/lib/fontist.rb

@@ -13,6 +13,7 @@ require "fontist/formula"
 require "fontist/system_font"
 require "fontist/manifest"
 require "fontist/helpers"
+require "fontist/config"
 
 module Fontist
   def self.ui
@@ -36,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
@@ -75,6 +76,10 @@ module Fontist
     Fontist.lib_path.join("fontist", "system.yml")
   end
 
+  def self.excluded_fonts_path
+    Fontist.lib_path.join("fontist", "exclude.yml")
+  end
+
   def self.system_index_path
     Fontist.fontist_path.join("system_index.default_family.yml")
   end
@@ -119,6 +124,30 @@ module Fontist
     @preferred_family = bool
   end
 
+  def self.open_timeout
+    config[:open_timeout]
+  end
+
+  def self.read_timeout
+    config[:read_timeout]
+  end
+
+  def self.config
+    Fontist::Config.instance.values
+  end
+
+  def self.config_path
+    Fontist.fontist_path.join("config.yml")
+  end
+
+  def self.use_cache?
+    instance_variable_defined?("@use_cache") ? @use_cache : true
+  end
+
+  def self.use_cache=(bool)
+    @use_cache = bool
+  end
+
   def self.log_level=(level)
     Fontist.ui.level = level
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fontist
 version: !ruby/object:Gem::Version
-  version: 1.17.1
+  version: 1.19.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-11 00:00:00.000000000 Z
+date: 2024-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: down
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -306,7 +320,10 @@ files:
 - lib/fontist/cli.rb
 - lib/fontist/cli/class_options.rb
 - lib/fontist/collection_file.rb
+- lib/fontist/config.rb
+- lib/fontist/config_cli.rb
 - lib/fontist/errors.rb
+- lib/fontist/exclude.yml
 - lib/fontist/font.rb
 - lib/fontist/font_file.rb
 - lib/fontist/font_installer.rb
@@ -365,6 +382,7 @@ files:
 - lib/fontist/utils.rb
 - lib/fontist/utils/cache.rb
 - lib/fontist/utils/downloader.rb
+- lib/fontist/utils/file_magic.rb
 - lib/fontist/utils/locking.rb
 - lib/fontist/utils/system.rb
 - lib/fontist/utils/ui.rb