fontist 1.16.0 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14a836d048cc0ce0d74885f256e3d7cb48466efcadd75008207e1568927ca8cc
-  data.tar.gz: 468355d3c50412aef7642ad44abf204edbf827a81d3ccfe327f274a90cddedcd
+  metadata.gz: e1c609003084e7675dfd55c7488c57b9f216a7e9f6412e2dd707e589bdb5f11e
+  data.tar.gz: ff531fc17364227dc60b47eaa64fe5547bc9c1d30e05c94364109d79d7276b5e
 SHA512:
-  metadata.gz: 62e88a6ac1766b61ffe5db70b36f9b0bb8316d80c048d8df8de57e39e3387de1fd60c3cff1094f0b235d7bfab0979d2b4e4ed01eba12125852f745327e8641b1
-  data.tar.gz: 97338d5eee1a8df78555281d9bc765499f30c86b98913bae5b21729745e5e983ed257e8ee51d543802e69dc734eee64f464dd8b319c534c3b06c768a65267817
+  metadata.gz: 2bcb373787926878310fa113e4454ac09e203c82708bd2edb3df796ce1e92f7e038a5c54011aade53f7cbc2ac2f20c311e449d5d5304a0235b93bfb0433750de
+  data.tar.gz: 6ad5b3863ed427316065477a3c873264ffa6d543bb86be696396e61d8f727533bc8bb50268ce8818b45bb15da387e6913b88f2c1a9abb7ed4a4944e0a8d57691

data/README.adoc

@@ -73,6 +73,10 @@ All commands support the following global options:
 NOTE: See <<preferred-family-change>> for the differences between
 "`preferred family`" and "`default family`".
 
+`-q, --quiet`:: Print as little information as possible, mostly critical errors.
+
+`-v, --verbose`:: Set the log level to debug. It prints formulas excluded
+during installation and information for developers of fontist.
 
 === Install fonts: `fontist install`
 
@@ -125,6 +129,12 @@ for the newest version of the font among formulas with size below a limit
 NOTE: If styles of a font are spread among several formulas, then all
 available styles from all formulas would be installed.
 
+NOTE: Some formulas may have the `min_fontist` attribute, which defines the
+minimum version of fontist by which they can be installed. If `fontist` is of a
+older version, then the formula is avoided to use. In order to see which
+formulas were excluded from the search, the `-v, --verbose` option can be
+specified.
+
 Supported options:
 
 `-f, [--force]`:: Install even if already installed in system
@@ -969,6 +979,15 @@ $ fontist install --formula ms_truetype
 
 WARNING: This section is only for Fontist maintainers.
 
+=== Formulas versioning
+
+To add a new attribute, change how formula is treated or completely replace the structure, there are 2 ways to change a formula format:
+
+1. Use the `min_fontist` attribute in a formula. It sets a requirement for fontist to install the formula only if its version is equal or more than a specified version.
+2. Use a new branch in the formulas repo, e.g. "v2", "v3", "v4", etc. After creating a new branch, it should be defined in https://github.com/fontist/fontist/blob/v1.16.0/lib/fontist.rb#L51[`Fontist.formulas_version`]
+
+NOTE: Using a new branch would require all users to re-download the entire formulas repo. Since this method has a significant overhead, the former one (`min_fontist`) should be used whenever possible.
+
 === Dynamically importing formulas from Google Fonts
 
 https://fonts.google.com[Google Fonts] provides probably the largest collection

data/fontist.gemspec

@@ -38,7 +38,7 @@ Gem::Specification.new do |spec|
   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.3"
+  spec.add_runtime_dependency "excavate", "~> 0.3", '>= 0.3.4'
   spec.add_runtime_dependency "socksify", "~> 1.7"
 
   spec.add_development_dependency "pry", "~> 0.14"

data/lib/fontist/cli/class_options.rb

@@ -3,12 +3,19 @@ module Fontist
     module ClassOptions
       def handle_class_options(options)
         Fontist.preferred_family = options[:preferred_family]
-        Fontist.log_level = options[:quiet] ? :fatal : :info
+        Fontist.log_level = log_level(options)
 
         if options[:formulas_path]
           Fontist.formulas_path = Pathname.new(options[:formulas_path])
         end
       end
+
+      def log_level(options)
+        return :debug if options[:verbose]
+        return :fatal if options[:quiet]
+
+        :info
+      end
     end
   end
 end

data/lib/fontist/cli.rb

@@ -25,6 +25,7 @@ module Fontist
     STATUS_FORMULA_NOT_FOUND = 13
     STATUS_FONTCONFIG_NOT_FOUND = 14
     STATUS_FONTCONFIG_FILE_NOT_FOUND = 15
+    STATUS_FONTIST_VERSION_ERROR = 15
 
     ERROR_TO_STATUS = {
       Fontist::Errors::UnsupportedFontError => [STATUS_NON_SUPPORTED_FONT_ERROR],
@@ -50,6 +51,7 @@ module Fontist
       Fontist::Errors::FontconfigNotFoundError => [STATUS_FONTCONFIG_NOT_FOUND],
       Fontist::Errors::FontconfigFileNotFoundError =>
         [STATUS_FONTCONFIG_FILE_NOT_FOUND],
+      Fontist::Errors::FontistVersionError => [STATUS_FONTIST_VERSION_ERROR],
     }.freeze
 
     def self.exit_on_failure?
@@ -65,6 +67,11 @@ module Fontist
                  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"
@@ -179,9 +186,10 @@ module Fontist
     desc "create-formula URL", "Create a new formula with fonts from URL"
     option :name, desc: "Example: Times New Roman"
     option :mirror, repeatable: true
-    option :subarchive, desc: "Subarchive to choose when there are several ones"
     option :subdir, desc: "Subdirectory to take fonts from, starting with the " \
       "root dir, e.g.: stixfonts-2.10/fonts/static_otf. May include `fnmatch` patterns."
+    option :file_pattern, desc: "File pattern, e.g. '*.otf'. " \
+      "Uses `fnmatch` patterns."
     def create_formula(url)
       handle_class_options(options)
       require "fontist/import/create_formula"

data/lib/fontist/errors.rb

@@ -18,6 +18,8 @@ module Fontist
 
     class FontIndexCorrupted < GeneralError; end
 
+    class FontistVersionError < GeneralError; end
+
     class FontNotFoundError < GeneralError; end
 
     # for backward compatibility with metanorma,

data/lib/fontist/font_installer.rb

@@ -10,9 +10,8 @@ module Fontist
     end
 
     def install(confirmation:)
-      if @formula.license_required && !"yes".casecmp?(confirmation)
-        raise(Fontist::Errors::LicensingError)
-      end
+      raise_fontist_version_error unless supported_version?
+      raise_licensing_error unless license_is_accepted?(confirmation)
 
       install_font
     end
@@ -21,6 +20,33 @@ module Fontist
 
     attr_reader :formula
 
+    def supported_version?
+      return true unless @formula.min_fontist
+
+      fontist_version = Gem::Version.new(Fontist::VERSION)
+      min_fontist_required = Gem::Version.new(@formula.min_fontist)
+
+      fontist_version >= min_fontist_required
+    end
+
+    def raise_fontist_version_error
+      raise Fontist::Errors::FontistVersionError,
+            "Formula requires higher version of fontist. " \
+            "Please upgrade fontist.\n" \
+            "Minimum required version: #{formula.min_fontist}. " \
+            "Current fontist version: #{Fontist::VERSION}."
+    end
+
+    def license_is_accepted?(confirmation)
+      return true unless @formula.license_required
+
+      "yes".casecmp?(confirmation)
+    end
+
+    def raise_licensing_error
+      raise(Fontist::Errors::LicensingError)
+    end
+
     def install_font
       fonts_paths = run_in_temp_dir { extract }
       fonts_paths.empty? ? nil : fonts_paths

data/lib/fontist/formula.rb

@@ -120,6 +120,10 @@ module Fontist
       @data["platforms"]
     end
 
+    def min_fontist
+      @data["min_fontist"]
+    end
+
     def extract
       Helpers.parse_to_object(@data["extract"])
     end

data/lib/fontist/formula_picker.rb

@@ -5,66 +5,117 @@ module Fontist
     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
+
+      @options  = {}
+      @version  = @options[:version]  = version  if version
+      @smallest = @options[:smallest] = smallest if smallest
+      @newest   = @options[:newest]   = newest   if newest
     end
 
     def call(formulas)
       return [] if formulas.empty?
-      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)
+      list = filter(formulas)
+      return [] if list.empty?
+
+      choose(list)
     end
 
     private
 
-    def version_is_passed?
-      !@version.nil?
+    def filter(formulas)
+      list = formulas
+
+      list = filter_by_passed_version(formulas) if @version
+      return [] if list.empty?
+
+      list = ensure_size_limit(list) if @options.empty?
+
+      ensure_fontist_version(list)
     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
+    def ensure_fontist_version(formulas)
+      suitable, unsuitable = filter_by_fontist_version(formulas)
+      raise_fontist_version_error(unsuitable) if suitable.empty?
+
+      suitable
+    end
+
+    def filter_by_fontist_version(formulas)
+      suitable, unsuitable = formulas.partition do |f|
+        f.min_fontist.nil? ||
+          Gem::Version.new(Fontist::VERSION) >= Gem::Version.new(f.min_fontist)
+      end
+
+      unless unsuitable.empty?
+        print_formulas_with_unsuitable_fontist_version(unsuitable)
+      end
+
+      [suitable, unsuitable]
+    end
+
+    def print_formulas_with_unsuitable_fontist_version(formulas)
+      Fontist.ui.debug(
+        "Some formulas were excluded from choice, because they require " \
+        "higher version of fontist: #{formulas_versions(formulas)}. " \
+        "Current fontist version: #{Fontist::VERSION}.",
+      )
+    end
+
+    def raise_fontist_version_error(formulas)
+      raise Fontist::Errors::FontistVersionError,
+            "Suitable formulas require higher version of fontist. " \
+            "Please upgrade fontist.\n" \
+            "Minimum required version: #{formulas_versions(formulas)}. " \
+            "Current fontist version: #{Fontist::VERSION}."
+    end
+
+    def formulas_versions(formulas)
+      formulas.map { |f| "#{f.key} (#{f.min_fontist})" }.join(", ")
+    end
+
+    def filter_by_passed_version(formulas)
+      formulas.select do |formula|
+        contain_passed_version?(formula)
+      end
+    end
+
+    def contain_passed_version?(formula)
+      fonts = formula.fonts_by_name(@font_name)
+      fonts.each do |font|
+        font.styles.each do |style|
+          version = StyleVersion.new(style.version)
+          return true if version == passed_version
         end
       end
 
-      []
+      false
     end
 
     def passed_version
       @passed_version ||= StyleVersion.new(@version)
     end
 
-    def newest_is_passed?
-      @newest
-    end
+    def choose(formulas)
+      return formulas if contain_different_styles?(formulas)
 
-    def newest(formulas)
-      newest_formulas = filter_by_max_version(formulas)
-      smallest(newest_formulas)
-    end
+      list = formulas
+
+      if @options.empty? || @newest
+        list = choose_max_version(list)
+      end
 
-    def smallest_is_passed?
-      @smallest
+      smallest(list)
     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)
+    def choose_smallest_formula(formulas)
+      formulas.min_by do |formula|
+        formula.file_size || 0
+      end
     end
 
     def contain_different_styles?(formulas)
@@ -80,6 +131,13 @@ module Fontist
       styles_by_formula.uniq.size > 1
     end
 
+    def ensure_size_limit(formulas)
+      list = filter_by_size_limit(formulas)
+      raise_size_limit_error if list.empty?
+
+      list
+    end
+
     def filter_by_size_limit(formulas)
       formulas.select do |formula|
         formula.file_size.nil? || resources_cached?(formula) ||
@@ -97,7 +155,7 @@ module Fontist
             "(#{@size_limit} MB)."
     end
 
-    def filter_by_max_version(formulas)
+    def choose_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|
@@ -118,12 +176,6 @@ module Fontist
       end
     end
 
-    def choose_smallest_formula(formulas)
-      formulas.min_by do |formula|
-        formula.file_size || 0
-      end
-    end
-
     def resources_cached?(formula)
       Utils::Cache.new.already_fetched?(
         formula.resources.flat_map(&:urls),

data/lib/fontist/import/create_formula.rb

@@ -40,8 +40,8 @@ module Fontist
       def extractor
         @extractor ||=
           RecursiveExtraction.new(archive,
-                                  subarchive: @options[:subarchive],
-                                  subdir: @options[:subdir])
+                                  subdir: @options[:subdir],
+                                  file_pattern: @options[:file_pattern])
       end
 
       def archive

data/lib/fontist/import/otf/font_file.rb

@@ -70,7 +70,9 @@ module Fontist
         end
 
         def font
-          File.basename(@path, ".*") + "." + @extension
+          basename = File.basename(@path, ".*").chomp(".#{@extension}")
+
+          "#{basename}.#{@extension}"
         end
 
         def source_font

data/lib/fontist/import/recursive_extraction.rb

@@ -8,9 +8,10 @@ module Fontist
       LICENSE_PATTERN =
         /(ofl\.txt|ufl\.txt|licenses?\.txt|license(\.md)?|copying)$/i.freeze
 
-      def initialize(archive, subarchive: nil, subdir: nil)
+      def initialize(archive, subdir: nil, file_pattern: nil)
         @archive = archive
         @subdir = subdir
+        @file_pattern = file_pattern
         @operations = {}
         @font_files = []
         @collection_files = []
@@ -72,10 +73,11 @@ module Fontist
 
       def extract_data(archive)
         Excavate::Archive.new(path(archive)).files(recursive_packages: true) do |path|
+          Fontist.ui.debug(path)
           next unless File.file?(path)
 
           match_license(path)
-          match_font(path) if font_directory?(path)
+          match_font(path) if font_candidate?(path)
         end
       end
 
@@ -110,6 +112,10 @@ module Fontist
         end
       end
 
+      def font_candidate?(path)
+        font_directory?(path) && file_pattern?(path)
+      end
+
       def font_directory?(path)
         return true unless subdirectory_pattern
 
@@ -119,6 +125,12 @@ module Fontist
       def subdirectory_pattern
         @subdirectory_pattern ||= "*" + @subdir.chomp("/") if @subdir
       end
+
+      def file_pattern?(path)
+        return true unless @file_pattern
+
+        File.fnmatch?(@file_pattern, File.basename(path))
+      end
     end
   end
 end

data/lib/fontist/version.rb

@@ -1,3 +1,3 @@
 module Fontist
-  VERSION = "1.16.0".freeze
+  VERSION = "1.17.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fontist
 version: !ruby/object:Gem::Version
-  version: 1.16.0
+  version: 1.17.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-07-29 00:00:00.000000000 Z
+date: 2023-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: down
@@ -143,6 +143,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -150,6 +153,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.4
 - !ruby/object:Gem::Dependency
   name: socksify
   requirement: !ruby/object:Gem::Requirement