fontist 1.13.1 → 1.14.1

data/lib/fontist/cli.rb

@@ -1,10 +1,13 @@
 require "thor"
+require "fontist/cli/class_options"
 require "fontist/repo_cli"
 require "fontist/import_cli"
-require "fontist/google_cli"
+require "fontist/fontconfig_cli"
 
 module Fontist
   class CLI < Thor
+    include ClassOptions
+
     STATUS_SUCCESS = 0
     STATUS_UNKNOWN_ERROR = 1
     STATUS_NON_SUPPORTED_FONT_ERROR = 2
@@ -18,6 +21,9 @@ module Fontist
     STATUS_REPO_COULD_NOT_BE_UPDATED = 10
     STATUS_MANUAL_FONT_ERROR = 11
     STATUS_SIZE_LIMIT_ERROR = 12
+    STATUS_FORMULA_NOT_FOUND = 13
+    STATUS_FONTCONFIG_NOT_FOUND = 14
+    STATUS_FONTCONFIG_FILE_NOT_FOUND = 15
 
     ERROR_TO_STATUS = {
       Fontist::Errors::UnsupportedFontError => [STATUS_NON_SUPPORTED_FONT_ERROR],
@@ -39,6 +45,10 @@ module Fontist
       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],
+      Fontist::Errors::FontconfigNotFoundError => [STATUS_FONTCONFIG_NOT_FOUND],
+      Fontist::Errors::FontconfigFileNotFoundError =>
+        [STATUS_FONTCONFIG_FILE_NOT_FOUND],
     }.freeze
 
     def self.exit_on_failure?
@@ -49,9 +59,18 @@ 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"
+                   desc: "Install even if already installed in system"
+    option :formula, type: :boolean, aliases: :F,
+                     desc: "Install whole formula instead of a font"
     option :accept_all_licenses, type: :boolean,
                                  aliases: ["--confirm-license", :a],
                                  desc: "Accept all license agreements"
@@ -62,13 +81,15 @@ module Fontist
     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"
+                      desc: "Install the smallest font by file size 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 " \
+           desc: "Specify upper limit for file size of a formula to be installed" \
                  "(default is #{Fontist.formula_size_limit_in_megabytes} MB)"
+    option :update_fontconfig, type: :boolean, aliases: :u,
+                               desc: "Update fontconfig"
     def install(font)
       handle_class_options(options)
       confirmation = options[:accept_all_licenses] ? "yes" : "no"
@@ -134,8 +155,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(
@@ -178,28 +203,17 @@ module Fontist
       STATUS_SUCCESS
     end
 
-    desc "import-sil", "Import formulas from SIL"
-    def import_sil
-      handle_class_options(options)
-      require "fontist/import/sil_import"
-      Fontist::Import::SilImport.new.call
-    end
-
     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
+    desc "fontconfig SUBCOMMAND ...ARGS", "Manage fontconfig"
+    subcommand "fontconfig", Fontist::FontconfigCLI
 
     private
 
-    def handle_class_options(options)
-      Fontist.preferred_family = options[:preferred_family]
-    end
-
     def success
       STATUS_SUCCESS
     end

data/lib/fontist/errors.rb

@@ -4,6 +4,18 @@ module Fontist
 
     class BinaryCallError < GeneralError; end
 
+    class FontconfigNotFoundError < GeneralError
+      def initialize
+        super("Could not find fontconfig.")
+      end
+    end
+
+    class FontconfigFileNotFoundError < GeneralError
+      def initialize
+        super("Fontist file could not be found in fontconfig configuration.")
+      end
+    end
+
     class FontIndexCorrupted < GeneralError; end
 
     class FontNotFoundError < GeneralError; end
@@ -12,6 +24,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

data/lib/fontist/font.rb

@@ -1,6 +1,7 @@
 require "fontist/font_installer"
 require "fontist/font_path"
 require "fontist/formula_picker"
+require "fontist/fontconfig"
 
 module Fontist
   class Font
@@ -14,6 +15,8 @@ module Fontist
       @smallest = options[:smallest]
       @newest = options[:newest]
       @size_limit = options[:size_limit]
+      @by_formula = options[:formula]
+      @update_fontconfig = options[:update_fontconfig]
 
       check_or_create_fontist_path!
     end
@@ -48,6 +51,8 @@ module Fontist
     end
 
     def install
+      return install_formula if @by_formula
+
       (find_system_font unless @force) || download_font || manual_font ||
         raise_non_supported_font
     end
@@ -103,6 +108,22 @@ 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
@@ -147,14 +168,22 @@ module Fontist
     def download_font
       return if sufficient_formulas.empty?
 
-      sufficient_formulas.flat_map do |formula|
-        confirmation = check_and_confirm_required_license(formula)
-        paths = font_installer(formula).install(confirmation: confirmation)
+      paths = sufficient_formulas.flat_map do |formula|
+        request_formula_installation(formula)
+      end
 
-        Fontist.ui.say("Fonts installed at:")
-        paths.each do |path|
-          Fontist.ui.say("- #{path}")
-        end
+      update_fontconfig
+
+      paths
+    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
 
@@ -197,6 +226,12 @@ module Fontist
       MSG
     end
 
+    def update_fontconfig
+      return unless @update_fontconfig
+
+      Fontconfig.update
+    end
+
     def manual_font
       return if manual_formulas.empty?
 

data/lib/fontist/fontconfig.rb

@@ -0,0 +1,87 @@
+module Fontist
+  class Fontconfig
+    def self.update
+      new.update
+    end
+
+    def self.remove(options = {})
+      new(options).remove
+    end
+
+    def initialize(options = {})
+      @options = options
+    end
+
+    def update
+      ensure_fontconfig_installed
+      create_config
+      regenerate_fontconfig_cache
+    end
+
+    def remove
+      return handle_file_not_found unless config_exists?
+
+      regenerate_fontconfig_cache if fontconfig_installed?
+      remove_config
+    end
+
+    private
+
+    def ensure_fontconfig_installed
+      raise Errors::FontconfigNotFoundError unless fontconfig_installed?
+    end
+
+    def fontconfig_installed?
+      Utils::System.fontconfig_installed?
+    end
+
+    def create_config
+      return if File.exist?(config_path)
+
+      FileUtils.mkdir_p(File.dirname(config_path))
+      File.write(config_path, config_content)
+    end
+
+    def config_path
+      File.join(xdg_config_home, "fontconfig", "conf.d", "10-fontist.conf")
+    end
+
+    def xdg_config_home
+      ENV["XDG_CONFIG_HOME"] || File.join(Dir.home, ".config")
+    end
+
+    def config_content
+      <<~CONTENT
+        <?xml version='1.0'?>
+        <!DOCTYPE fontconfig SYSTEM 'fonts.dtd'>
+        <fontconfig>
+          <dir>#{Fontist.fonts_path}</dir>
+        </fontconfig>
+      CONTENT
+    end
+
+    def regenerate_fontconfig_cache
+      Helpers.run("fc-cache -f")
+    end
+
+    def ensure_file_exists
+      return if @options[:force]
+
+      raise Errors::FontconfigFileNotFoundError unless File.exist?(config_path)
+    end
+
+    def config_exists?
+      File.exist?(config_path)
+    end
+
+    def handle_file_not_found
+      return if @options[:force]
+
+      raise Errors::FontconfigFileNotFoundError
+    end
+
+    def remove_config
+      FileUtils.rm(config_path)
+    end
+  end
+end

data/lib/fontist/fontconfig_cli.rb

@@ -0,0 +1,29 @@
+module Fontist
+  class FontconfigCLI < Thor
+    include CLI::ClassOptions
+
+    desc "update", "Update fontconfig configuration to use fontist fonts"
+    def update
+      handle_class_options(options)
+      Fontconfig.update
+      Fontist.ui.success("Fontconfig file has been successfully updated.")
+      CLI::STATUS_SUCCESS
+    rescue Errors::FontconfigNotFoundError => e
+      Fontist.ui.error(e.message)
+      CLI::STATUS_FONTCONFIG_NOT_FOUND
+    end
+
+    desc "remove", "Remove fontist file in fontconfig configuration"
+    option :force, type: :boolean, aliases: :f,
+                   desc: "Proceed even if does not exist"
+    def remove
+      handle_class_options(options)
+      Fontconfig.remove(options)
+      Fontist.ui.success("Fontconfig file has been successfully removed.")
+      CLI::STATUS_SUCCESS
+    rescue Errors::FontconfigFileNotFoundError => e
+      Fontist.ui.error(e.message)
+      CLI::STATUS_FONTCONFIG_FILE_NOT_FOUND
+    end
+  end
+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)
@@ -72,7 +79,7 @@ module Fontist
     end
 
     def key
-      @data["key"] || default_key
+      key_from_path
     end
 
     def description
@@ -137,7 +144,7 @@ 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

data/lib/fontist/helpers.rb

@@ -3,5 +3,26 @@ module Fontist
     def self.parse_to_object(data)
       JSON.parse(data.to_json, object_class: OpenStruct)
     end
+
+    def self.run(command)
+      Fontist.ui.debug("Run `#{command}`")
+
+      result = `#{command}`
+      unless $CHILD_STATUS.to_i.zero?
+        raise Errors::BinaryCallError,
+              "Failed to run #{command}, status: #{$CHILD_STATUS}"
+      end
+
+      result
+    end
+
+    def self.silence_stream(stream)
+      old_stream = stream.dup
+      stream.reopen(RbConfig::CONFIG["host_os"] =~ /mswin|mingw/ ? "NUL:" : "/dev/null") # rubocop:disable Performance/RegexpMatch, Metrics/LineLength
+      stream.sync = true
+      yield
+    ensure
+      stream.reopen(old_stream)
+    end
   end
 end

data/lib/fontist/import/create_formula.rb

@@ -55,12 +55,32 @@ module Fontist
       end
 
       def save(builder)
-        filename = Import.name_to_filename(builder.name)
-        path = @options[:formula_dir] ? File.join(@options[:formula_dir], filename) : filename
+        path = vacant_path
         yaml = YAML.dump(Helpers::HashHelper.stringify_keys(builder.formula))
         File.write(path, yaml)
         path
       end
+
+      def vacant_path
+        path = path_from_name
+        return path unless @options[:keep_existing] && File.exist?(path)
+
+        2.upto(9) do |i|
+          candidate = path.sub(/\.yml$/, "#{i}.yml")
+          return candidate unless File.exist?(candidate)
+        end
+
+        raise Errors::GeneralError, "Formula #{path} already exists."
+      end
+
+      def path_from_name
+        filename = Import.name_to_filename(builder.name)
+        if @options[:formula_dir]
+          File.join(@options[:formula_dir], filename)
+        else
+          filename
+        end
+      end
     end
   end
 end

data/lib/fontist/import/files/collection_file.rb

@@ -26,9 +26,9 @@ module Fontist
 
         def read
           switch_to_temp_dir do |tmp_dir|
-            extract_ttfs(tmp_dir).map do |path|
-              Otf::FontFile.new(path)
-            end
+            extract_ttfs(tmp_dir)
+              .map { |path| Otf::FontFile.new(path) }
+              .reject { |font_file| hidden_or_pua_encoded?(font_file) }
           end
         end
 
@@ -47,6 +47,10 @@ module Fontist
           end
         end
 
+        def hidden_or_pua_encoded?(font_file)
+          font_file.family_name.start_with?(".")
+        end
+
         def detect_extension
           base_extension = "ttc"
 

data/lib/fontist/import/formula_builder.rb

@@ -4,9 +4,10 @@ require_relative "text_helper"
 module Fontist
   module Import
     class FormulaBuilder
-      FORMULA_ATTRIBUTES = %i[description homepage resources
+      FORMULA_ATTRIBUTES = %i[platforms description homepage resources
                               font_collections fonts extract copyright
-                              license_url open_license digest command].freeze
+                              license_url requires_license_agreement
+                              open_license digest command].freeze
 
       attr_writer :archive,
                   :url,
@@ -28,9 +29,15 @@ module Fontist
       def name
         return @options[:name] if @options[:name]
 
-        unique_names = both_fonts.map(&:family_name).uniq
-        TextHelper.longest_common_prefix(unique_names) ||
-          both_fonts.first.family_name
+        common = %i[family_name type]
+          .map { |attr| both_fonts.map(&attr).uniq }
+          .map { |names| TextHelper.longest_common_prefix(names) }
+          .map { |prefix| prefix unless prefix == "Regular" }
+          .compact
+          .join(" ")
+        return common unless common.empty?
+
+        both_fonts.map(&:family_name).first
       end
 
       private
@@ -50,6 +57,10 @@ module Fontist
         files
       end
 
+      def platforms
+        @options[:platforms]
+      end
+
       def description
         name
       end
@@ -175,12 +186,17 @@ module Fontist
         both_fonts.map(&:license_url).compact.first
       end
 
+      def requires_license_agreement
+        @options[:requires_license_agreement]
+      end
+
       def open_license
-        unless @license_text
+        unless @license_text || requires_license_agreement
           Fontist.ui.error("WARN: please add license manually")
-          return
         end
 
+        return unless @license_text
+
         Fontist.ui.error("WARN: ensure it's an open license, otherwise " \
                          "change the 'open_license' attribute to " \
                          "'requires_license_agreement'")

data/lib/fontist/import/helpers/system_helper.rb

@@ -4,15 +4,7 @@ module Fontist
       module SystemHelper
         class << self
           def run(command)
-            Fontist.ui.say("Run `#{command}`") if Fontist.debug?
-
-            result = `#{command}`
-            unless $CHILD_STATUS.to_i.zero?
-              raise Errors::BinaryCallError,
-                    "Failed to run #{command}, status: #{$CHILD_STATUS}"
-            end
-
-            result
+            Fontist::Helpers.run(command)
           end
         end
       end