fontist 1.12.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 709582759b1009bae25d302ab0590ed5f6fe92fe55d68d1cb57c918942b4f005
-  data.tar.gz: 165f75a0625995d8fcc388d46a26168008383d98d2705cb1ea5ed519abe41e80
+  metadata.gz: 43f3bc7643cf7694fb753d9c62509f7134a26d68fb41a2e06c9c9e25f33ae2c5
+  data.tar.gz: 3269f7aedc78eed761697ff862701bf6ca27679e9be90972d8983e913a15beea
 SHA512:
-  metadata.gz: fd3d62de512ff44e1d9b47c192889fdcefa5db9abea1f0966ac3d761c4ef5567fa547b7d57b4eda52720040d3ca82a03eec2e3d72b24d1f9522dbde1e092c625
-  data.tar.gz: 3adf2dcebf7714cc81fc3a6955ac69fdf7affe3e90a845f011f52d284332c856112bef7f8e98cf6d96175c043df299ad0965148ef96308b38c6eace46547ef52
+  metadata.gz: a92d2d69bed9e8e33fc9785f198c9878d1a02dda4de65f290ecff30336adec6117cfd18cc09d52545f318a917b40e02b4d796049384b6b6c12fee05d2056283f
+  data.tar.gz: ffdb9a02c723a5a8c04c26c3f3d5a0d0bba4e875fd750bee67a3c68698d2f2e9057ff936019523d3eb9a359bbbf19de566c45acb99fff99b745952039add7e30

data/.rubocop.yml

@@ -1,5 +1,5 @@
 inherit_from:
   - 'https://raw.githubusercontent.com/fontist/oss-guides/master/ci/rubocop.yml'
 
-Rails:
-  Enabled: false
+AllCops:
+  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.

data/lib/fontist/cli.rb

@@ -17,15 +17,24 @@ module Fontist
     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],
@@ -43,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)
@@ -187,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)

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

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
@@ -102,6 +107,16 @@ module Fontist
       FontInstaller.new(formula, no_progress: @no_progress)
     end
 
+    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
@@ -130,9 +145,9 @@ module Fontist
     end
 
     def download_font
-      return if downloadable_formulas.empty?
+      return if sufficient_formulas.empty?
 
-      downloadable_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)
 

data/lib/fontist/formula.rb

@@ -107,6 +107,12 @@ 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)
     end
@@ -115,8 +121,14 @@ module Fontist
       @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
@@ -130,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"]
 
@@ -138,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

data/lib/fontist/import/formula_builder.rb

@@ -73,7 +73,7 @@ module Fontist
       end
 
       def resource_options_without_sha
-        { urls: [@url] + mirrors }
+        { urls: [@url] + mirrors, file_size: file_size }
       end
 
       def resource_options_with_sha
@@ -86,7 +86,7 @@ module Fontist
 
         sha = prepare_sha256(sha)
 
-        { urls: urls, sha256: sha }
+        { urls: urls, sha256: sha, file_size: file_size }
       end
 
       def downloads
@@ -120,6 +120,10 @@ module Fontist
         output
       end
 
+      def file_size
+        File.size(@archive)
+      end
+
       def font_collections
         return if @font_collection_files.empty?
 

data/lib/fontist/indexes/default_family_font_index.rb

@@ -9,7 +9,10 @@ module Fontist
 
       def add_formula(formula)
         formula.fonts.each do |font|
-          add_index_formula(font.name, formula.to_index_formula)
+          font.styles.each do |style|
+            font_name = style.default_family_name || font.name
+            add_index_formula(font_name, formula.to_index_formula)
+          end
         end
       end
 

data/lib/fontist/style_version.rb

@@ -0,0 +1,39 @@
+module Fontist
+  class StyleVersion
+    def initialize(text)
+      @text = text
+    end
+
+    def value
+      @value ||= numbers || default_value
+    end
+
+    def numbers
+      string_version&.split(".")&.map(&:strip)
+    end
+
+    def string_version
+      @text&.split(";")&.first
+    end
+
+    def default_value
+      ["0"]
+    end
+
+    def <=>(other)
+      value <=> other.value
+    end
+
+    def ==(other)
+      value == other.value
+    end
+
+    def eql?(other)
+      value.eql?(other.value)
+    end
+
+    def hash
+      value.hash
+    end
+  end
+end

data/lib/fontist/version.rb

@@ -1,3 +1,3 @@
 module Fontist
-  VERSION = "1.12.0".freeze
+  VERSION = "1.13.0".freeze
 end

data/lib/fontist.rb

@@ -107,6 +107,10 @@ module Fontist
     Fontist.fontist_version_path
   end
 
+  def self.formula_size_limit_in_megabytes
+    300
+  end
+
   def self.preferred_family?
     !!@preferred_family
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fontist
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.13.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-23 00:00:00.000000000 Z
+date: 2021-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: down
@@ -304,6 +304,7 @@ files:
 - lib/fontist/font_installer.rb
 - lib/fontist/font_path.rb
 - lib/fontist/formula.rb
+- lib/fontist/formula_picker.rb
 - lib/fontist/google_cli.rb
 - lib/fontist/helpers.rb
 - lib/fontist/import.rb
@@ -346,6 +347,7 @@ files:
 - lib/fontist/manifest/locations.rb
 - lib/fontist/repo.rb
 - lib/fontist/repo_cli.rb
+- lib/fontist/style_version.rb
 - lib/fontist/system.yml
 - lib/fontist/system_font.rb
 - lib/fontist/system_index.rb