fontist 1.9.1 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06c95de209b578a95a9b0d2bf19d196164ece01155a61685060c638af668743c
-  data.tar.gz: a2d621f546be67a09e94c4cad68f432642ec6c47d745c688e919652e3049ec7a
+  metadata.gz: d2ed5346597364ad2d6cf6d2ecdc575baee6590f164cd79888a85c7ae0a67ed5
+  data.tar.gz: f7378c2d93061211db416dfa4ce7e49450dfd50ec01618f79dedb483d1a258ee
 SHA512:
-  metadata.gz: 938f320740216d01c7dc7e48b7a4a6070bba45d437be0e3b2c5846b3d1c28321967653b4b1ad13a6f112cab3e7ae72e74f708bd027022e875b2e4268693200bb
-  data.tar.gz: 602c750adddfc95ed2b7d83257a085b69c464c563ccbd314dc120f86c074d1e0aec243aacafba5bf4e73969ade9bc953b360764209db78fce7362102d1bff8fc
+  metadata.gz: 30e8c3f17d17c275e1942a07c113feda490e426afa762e4a6c93a283a99f97010da04b4bd954c13e8cc2504211ad273b9aeb84b6af12232d46cd1d19b7c8b244
+  data.tar.gz: 6d8e216241908538339ecb0a06a92f0b31a590eef0ffe2e81bee78a97b18204f4fc4f2b70113a79ea1d87f6c815b125bfb58e6db500942c5d1019098bb3812a0

data/lib/fontist.rb

@@ -11,7 +11,6 @@ require "fontist/repo"
 require "fontist/font"
 require "fontist/formula"
 require "fontist/system_font"
-require "fontist/fontist_font"
 require "fontist/manifest"
 require "fontist/helpers"
 
@@ -65,15 +64,32 @@ module Fontist
   end
 
   def self.system_index_path
-    Fontist.fontist_path.join("system_index.yml")
+    Fontist.fontist_path.join("system_index.default_family.yml")
+  end
+
+  def self.system_preferred_family_index_path
+    Fontist.fontist_path.join("system_index.preferred_family.yml")
+  end
+
+  def self.fontist_index_path
+    Fontist.fontist_path.join("fontist_index.default_family.yml")
+  end
+
+  def self.fontist_preferred_family_index_path
+    Fontist.fontist_path.join("fontist_index.preferred_family.yml")
   end
 
   def self.formula_index_path
-    @formula_index_path || Fontist.formula_index_dir.join("formula_index.yml")
+    Fontist.formula_index_dir.join("formula_index.default_family.yml")
   end
 
-  def self.formula_index_path=(path)
-    @formula_index_path = path
+  def self.formula_preferred_family_index_path
+    @formula_preferred_family_index_path ||
+      Fontist.formula_index_dir.join("formula_index.preferred_family.yml")
+  end
+
+  def self.formula_preferred_family_index_path=(path)
+    @formula_preferred_family_index_path = path
   end
 
   def self.formula_filename_index_path
@@ -88,4 +104,12 @@ module Fontist
   def self.formula_index_dir
     Fontist.fontist_path
   end
+
+  def self.preferred_family?
+    !!@preferred_family
+  end
+
+  def self.preferred_family=(bool)
+    @preferred_family = bool
+  end
 end

data/lib/fontist/cli.rb

@@ -32,6 +32,10 @@ module Fontist
       false
     end
 
+    class_option :preferred_family,
+                 type: :boolean,
+                 desc: "Use Preferred Family when available"
+
     desc "install FONT", "Install font"
     option :force, type: :boolean, aliases: :f,
                    desc: "Install even if it's already installed in system"
@@ -39,6 +43,7 @@ module Fontist
     option :hide_licenses, type: :boolean, desc: "Hide license texts"
     option :no_progress, type: :boolean, desc: "Hide download progress"
     def install(font)
+      handle_class_options(options)
       Fontist::Font.install(
         font,
         force: options[:force],
@@ -53,6 +58,7 @@ module Fontist
 
     desc "uninstall/remove FONT", "Uninstall font by font or formula"
     def uninstall(font)
+      handle_class_options(options)
       fonts_paths = Fontist::Font.uninstall(font)
       Fontist.ui.success("These fonts are removed:")
       Fontist.ui.success(fonts_paths.join("\n"))
@@ -64,6 +70,7 @@ module Fontist
 
     desc "status [FONT]", "Show paths of FONT or all fonts"
     def status(font = nil)
+      handle_class_options(options)
       paths = Fontist::Font.status(font)
       return error("No font is installed.", STATUS_MISSING_FONT_ERROR) if paths.empty?
 
@@ -74,6 +81,7 @@ module Fontist
 
     desc "list [FONT]", "List installation status of FONT or fonts in fontist"
     def list(font = nil)
+      handle_class_options(options)
       formulas = Fontist::Font.list(font)
       print_list(formulas)
       success
@@ -83,6 +91,7 @@ module Fontist
 
     desc "update", "Update formulas"
     def update
+      handle_class_options(options)
       Formula.update_formulas_repo
       Fontist.ui.success("Formulas have been successfully updated.")
       success
@@ -94,6 +103,7 @@ module Fontist
     desc "manifest-locations MANIFEST",
          "Get locations of fonts from MANIFEST (yaml)"
     def manifest_locations(manifest)
+      handle_class_options(options)
       paths = Fontist::Manifest::Locations.from_file(manifest)
       print_yaml(paths)
       success
@@ -105,6 +115,7 @@ module Fontist
     option :accept_all_licenses, type: :boolean, aliases: "--confirm-license", desc: "Accept all license agreements"
     option :hide_licenses, type: :boolean, desc: "Hide license texts"
     def manifest_install(manifest)
+      handle_class_options(options)
       paths = Fontist::Manifest::Install.from_file(
         manifest,
         confirmation: options[:accept_all_licenses] ? "yes" : "no",
@@ -124,6 +135,7 @@ module Fontist
     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."
     def create_formula(url)
+      handle_class_options(options)
       require "fontist/import/create_formula"
       name = Fontist::Import::CreateFormula.new(url, options).call
       Fontist.ui.say("#{name} formula has been successfully created")
@@ -141,6 +153,8 @@ module Fontist
                        desc: "Updates indexes in the main repo (for backward " \
                              "compatibility with versions prior to 1.9)"
     def rebuild_index
+      handle_class_options(options)
+
       if options[:main_repo]
         Fontist::Index.rebuild_for_main_repo
       else
@@ -153,6 +167,7 @@ module Fontist
 
     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
@@ -162,6 +177,10 @@ module Fontist
 
     private
 
+    def handle_class_options(options)
+      Fontist.preferred_family = options[:preferred_family]
+    end
+
     def success
       STATUS_SUCCESS
     end

data/lib/fontist/font.rb

@@ -166,7 +166,7 @@ module Fontist
     end
 
     def uninstall_font
-      paths = find_fontist_font
+      paths = find_fontist_paths
       return unless paths
 
       paths.each do |path|
@@ -176,8 +176,13 @@ module Fontist
       paths
     end
 
-    def find_fontist_font
-      Fontist::FontistFont.find(name)
+    def find_fontist_paths
+      fonts = Fontist::SystemIndex.fontist_index.find(name, nil)
+      return unless fonts
+
+      fonts.map do |font|
+        font[:path]
+      end
     end
 
     def installed_paths

data/lib/fontist/import/formula_builder.rb

@@ -129,7 +129,7 @@ module Fontist
 
         fonts = groups.map do |name, group|
           { name: name,
-            styles: group.map(&style_type) }
+            styles: styles_from_files(group, style_type) }
         end
 
         fonts.sort_by do |x|
@@ -137,6 +137,10 @@ module Fontist
         end
       end
 
+      def styles_from_files(files, style_type)
+        files.map(&style_type).sort_by { |x| x[:type] }
+      end
+
       def extract
         @extractor.operations
       end

data/lib/fontist/import/google_import.rb

@@ -156,6 +156,10 @@ module Fontist
           h.merge!(family_name: style.family_name,
                    type: style.style,
                    full_name: style.full_name)
+          if style.preferred_family_name
+            h[:preferred_family_name] = style.preferred_family_name
+          end
+          h[:preferred_type] = style.preferred_style if style.preferred_style
           h.merge!(style.to_h.select do |k, _|
             %i(post_script_name version description copyright).include?(k)
           end.compact)

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

@@ -10,7 +10,8 @@ module Fontist
           otfinfo: Otfinfo::OtfinfoRequirement.new,
         }.freeze
 
-        STYLE_ATTRIBUTES = %i[family_name type full_name post_script_name
+        STYLE_ATTRIBUTES = %i[family_name type preferred_family_name
+                              preferred_type full_name post_script_name
                               version description copyright font
                               source_font].freeze
 
@@ -35,11 +36,19 @@ module Fontist
         end
 
         def family_name
-          info["Preferred family"] || info["Family"]
+          info["Family"]
         end
 
         def type
-          info["Preferred subfamily"] || info["Subfamily"]
+          info["Subfamily"]
+        end
+
+        def preferred_family_name
+          info["Preferred family"]
+        end
+
+        def preferred_type
+          info["Preferred subfamily"]
         end
 
         def full_name

data/lib/fontist/import/otf_style.rb

@@ -7,8 +7,8 @@ module Fontist
       end
 
       def call
-        style = { family_name: @info["Preferred family"] || @info["Family"],
-                  style: @info["Preferred subfamily"] || @info["Subfamily"],
+        style = { family_name: @info["Family"],
+                  style: @info["Subfamily"],
                   full_name: @info["Full name"],
                   post_script_name: @info["PostScript name"],
                   version: version(@info["Version"]),
@@ -16,6 +16,14 @@ module Fontist
                   filename: File.basename(@path),
                   copyright: @info["Copyright"] }
 
+        if @info["Preferred family"]
+          style[:preferred_family_name] = @info["Preferred family"]
+        end
+
+        if @info["Preferred subfamily"]
+          style[:preferred_style] = @info["Preferred subfamily"]
+        end
+
         OpenStruct.new(style)
       end
 

data/lib/fontist/import/otfinfo/template.erb

@@ -2,6 +2,12 @@
           {
             family_name: "<%= s.family_name %>",
             style: "<%= s.style %>",
+            <%- if s.preferred_family_name -%>
+            preferred_family_name: "<%= s.preferred_family_name %>",
+            <%- end -%>
+            <%- if s.preferred_style -%>
+            preferred_type: "<%= s.preferred_style %>",
+            <%- end -%>
             full_name: "<%= s.full_name %>",
             <%- if s.post_script_name -%>
             post_script_name: "<%= s.post_script_name %>",

data/lib/fontist/index.rb

@@ -19,25 +19,28 @@ module Fontist
     end
 
     def self.do_rebuild_for_main_repo_with
-      Fontist.formula_index_path = Fontist.formulas_repo_path.join("index.yml")
+      Fontist.formula_preferred_family_index_path =
+        Fontist.formulas_repo_path.join("index.yml")
       Fontist.formula_filename_index_path =
         Fontist.formulas_repo_path.join("filename_index.yml")
 
       rebuild
 
-      Fontist.formula_index_path = nil
+      Fontist.formula_preferred_family_index_path = nil
       Fontist.formula_filename_index_path = nil
     end
 
     def self.rebuild
-      Fontist::Indexes::FontIndex.rebuild
+      Fontist::Indexes::DefaultFamilyFontIndex.rebuild
+      Fontist::Indexes::PreferredFamilyFontIndex.rebuild
       Fontist::Indexes::FilenameIndex.rebuild
 
       reset_cache
     end
 
     def self.reset_cache
-      Fontist::Indexes::FontIndex.reset_cache
+      Fontist::Indexes::DefaultFamilyFontIndex.reset_cache
+      Fontist::Indexes::PreferredFamilyFontIndex.reset_cache
       Fontist::Indexes::FilenameIndex.reset_cache
     end
   end

data/lib/fontist/indexes/default_family_font_index.rb

@@ -0,0 +1,21 @@
+require_relative "base_index"
+
+module Fontist
+  module Indexes
+    class DefaultFamilyFontIndex < BaseIndex
+      def self.path
+        Fontist.formula_index_path
+      end
+
+      def add_formula(formula)
+        formula.fonts.each do |font|
+          add_index_formula(font.name, formula.to_index_formula)
+        end
+      end
+
+      def normalize_key(key)
+        key.downcase
+      end
+    end
+  end
+end

data/lib/fontist/indexes/font_index.rb

@@ -1,21 +1,16 @@
-require_relative "base_index"
+require_relative "default_family_font_index"
+require_relative "preferred_family_font_index"
 
 module Fontist
   module Indexes
-    class FontIndex < BaseIndex
-      def self.path
-        Fontist.formula_index_path
-      end
-
-      def add_formula(formula)
-        formula.fonts.each do |font|
-          add_index_formula(font.name, formula.to_index_formula)
+    class FontIndex
+      def self.from_yaml
+        if Fontist.preferred_family?
+          PreferredFamilyFontIndex.from_yaml
+        else
+          DefaultFamilyFontIndex.from_yaml
         end
       end
-
-      def normalize_key(key)
-        key.downcase
-      end
     end
   end
 end

data/lib/fontist/indexes/preferred_family_font_index.rb

@@ -0,0 +1,24 @@
+require_relative "base_index"
+
+module Fontist
+  module Indexes
+    class PreferredFamilyFontIndex < BaseIndex
+      def self.path
+        Fontist.formula_preferred_family_index_path
+      end
+
+      def add_formula(formula)
+        formula.fonts.each do |font|
+          font.styles.each do |style|
+            font_name = style.preferred_family_name || font.name
+            add_index_formula(font_name, formula.to_index_formula)
+          end
+        end
+      end
+
+      def normalize_key(key)
+        key.downcase
+      end
+    end
+  end
+end

data/lib/fontist/system_font.rb

@@ -3,10 +3,9 @@ require_relative "formula_paths"
 
 module Fontist
   class SystemFont
-    def initialize(font:, style: nil, sources: nil)
+    def initialize(font:, style: nil)
       @font = font
       @style = style
-      @user_sources = sources || []
     end
 
     def self.font_paths
@@ -36,8 +35,8 @@ module Fontist
       Dir.glob(Fontist.fonts_path.join("**"))
     end
 
-    def self.find(font, sources: [])
-      new(font: font, sources: sources).find
+    def self.find(font)
+      new(font: font).find
     end
 
     def self.find_styles(font, style)
@@ -57,18 +56,14 @@ module Fontist
 
     private
 
-    attr_reader :font, :style, :user_sources
+    attr_reader :font, :style
 
     def find_by_index
-      SystemIndex.new(all_paths).find(font, style)
+      SystemIndex.system_index.find(font, style)
     end
 
     def find_by_formulas
-      FormulaPaths.new(all_paths).find(font, style)
-    end
-
-    def all_paths
-      @all_paths ||= Dir.glob(user_sources) + self.class.font_paths
+      FormulaPaths.new(self.class.font_paths).find(font, style)
     end
   end
 end

data/lib/fontist/system_index.rb

@@ -4,22 +4,73 @@ module Fontist
   class SystemIndex
     include Utils::Locking
 
+    class DefaultFamily
+      def family_name(name)
+        name.font_family
+      end
+
+      def type(name)
+        name.font_subfamily
+      end
+    end
+
+    class PreferredFamily
+      def family_name(name)
+        return name.font_family if name.preferred_family.empty?
+
+        name.preferred_family
+      end
+
+      def type(name)
+        return name.font_subfamily if name.preferred_subfamily.empty?
+
+        name.preferred_subfamily
+      end
+    end
+
+    PLATFORM_MACINTOSH = 1
+    PLATFORM_MICROSOFT = 3
+
+    ENCODING_MAC_ROMAN = 0
+    ENCODING_MS_UNICODE_BMP = 1
+
+    LANGUAGE_MAC_ENGLISH = 0
+    LANGUAGE_MS_ENGLISH_AMERICAN = 0x409
+
     attr_reader :font_paths
 
-    def self.find(font, style)
-      new(SystemFont.font_paths).find(font, style)
+    def self.system_index
+      if Fontist.preferred_family?
+        new(Fontist.system_preferred_family_index_path,
+            SystemFont.font_paths,
+            PreferredFamily.new)
+      else
+        new(Fontist.system_index_path,
+            SystemFont.font_paths,
+            DefaultFamily.new)
+      end
     end
 
-    def self.rebuild
-      new(SystemFont.font_paths).rebuild
+    def self.fontist_index
+      if Fontist.preferred_family?
+        new(Fontist.fontist_preferred_family_index_path,
+            SystemFont.fontist_font_paths,
+            PreferredFamily.new)
+      else
+        new(Fontist.fontist_index_path,
+            SystemFont.fontist_font_paths,
+            DefaultFamily.new)
+      end
     end
 
-    def initialize(font_paths)
+    def initialize(index_path, font_paths, family)
+      @index_path = index_path
       @font_paths = font_paths
+      @family = family
     end
 
     def find(font, style)
-      fonts = system_index.select do |file|
+      fonts = index.select do |file|
         file[:family_name].casecmp?(font) &&
           (style.nil? || file[:type].casecmp?(style))
       end
@@ -28,27 +79,27 @@ module Fontist
     end
 
     def rebuild
-      build_system_index
+      build_index
     end
 
     private
 
-    def system_index
-      @system_index ||= build_system_index
+    def index
+      @index ||= build_index
     end
 
-    def build_system_index
+    def build_index
       lock(lock_path) do
-        do_build_system_index
+        do_build_index
       end
     end
 
     def lock_path
-      Fontist.system_index_path.to_s + ".lock"
+      "#{@index_path}.lock"
     end
 
-    def do_build_system_index
-      previous_index = load_system_index
+    def do_build_index
+      previous_index = load_index
       updated_index = detect_paths(font_paths, previous_index)
       updated_index.tap do |index|
         save_index(index) if changed?(updated_index, previous_index)
@@ -59,21 +110,23 @@ module Fontist
       this.map { |x| x[:path] }.uniq.sort != other.map { |x| x[:path] }.uniq.sort
     end
 
-    def load_system_index
-      index = File.exist?(Fontist.system_index_path) ? YAML.load_file(Fontist.system_index_path) : []
+    def load_index
+      index = File.exist?(@index_path) ? YAML.load_file(@index_path) : []
+      check_index(index)
+      index
+    end
 
+    def check_index(index)
       index.each do |item|
         missing_keys = %i[path full_name family_name type] - item.keys
         unless missing_keys.empty?
           raise(Errors::FontIndexCorrupted, <<~MSG.chomp)
             Font index is corrupted.
             Item #{item.inspect} misses required attributes: #{missing_keys.join(', ')}.
-            You can remove the index file (#{Fontist.system_index_path}) and try again.
+            You can remove the index file (#{@index_path}) and try again.
           MSG
         end
       end
-
-      index
     end
 
     def detect_paths(paths, index)
@@ -98,7 +151,9 @@ module Fontist
     end
 
     def detect_file_font(path)
-      file = TTFunk::File.open(path)
+      content = File.read(path, mode: "rb")
+      file = TTFunk::File.new(content)
+
       parse_font(file, path)
     rescue StandardError
       warn $!.message
@@ -111,6 +166,9 @@ module Fontist
           parse_font(file, path)
         end
       end
+    rescue StandardError
+      warn $!.message
+      warn "Warning: File at #{path} not recognized as a font file."
     end
 
     def parse_font(file, path)
@@ -118,20 +176,42 @@ module Fontist
 
       {
         path: path,
-        full_name: parse_text(x.font_name.first),
-        family_name: parse_text(x.preferred_family.first || x.font_family.first),
-        type: parse_text(x.preferred_subfamily.first || x.font_subfamily.first),
+        full_name: english_name(x.font_name),
+        family_name: english_name(@family.family_name(x)),
+        type: english_name(@family.type(x)),
       }
     end
 
-    def parse_text(text)
+    def english_name(name)
+      visible_characters(find_english(name))
+    end
+
+    def find_english(name)
+      name.find { |x| microsoft_english?(x) } ||
+        name.find { |x| mac_english?(x) } ||
+        name.last
+    end
+
+    def microsoft_english?(string)
+      string.platform_id == PLATFORM_MICROSOFT &&
+        string.encoding_id == ENCODING_MS_UNICODE_BMP &&
+        string.language_id == LANGUAGE_MS_ENGLISH_AMERICAN
+    end
+
+    def mac_english?(string)
+      string.platform_id == PLATFORM_MACINTOSH &&
+        string.encoding_id == ENCODING_MAC_ROMAN &&
+        string.language_id == LANGUAGE_MAC_ENGLISH
+    end
+
+    def visible_characters(text)
       text.gsub(/[^[:print:]]/, "").to_s
     end
 
     def save_index(index)
-      dir = File.dirname(Fontist.system_index_path)
+      dir = File.dirname(@index_path)
       FileUtils.mkdir_p(dir) unless File.exist?(dir)
-      File.write(Fontist.system_index_path, YAML.dump(index))
+      File.write(@index_path, YAML.dump(index))
     end
   end
 end

data/lib/fontist/version.rb

@@ -1,3 +1,3 @@
 module Fontist
-  VERSION = "1.9.1".freeze
+  VERSION = "1.10.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fontist
 version: !ruby/object:Gem::Version
-  version: 1.9.1
+  version: 1.10.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-06 00:00:00.000000000 Z
+date: 2021-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: down
@@ -262,7 +262,6 @@ files:
 - lib/fontist/font.rb
 - lib/fontist/font_installer.rb
 - lib/fontist/font_path.rb
-- lib/fontist/fontist_font.rb
 - lib/fontist/formula.rb
 - lib/fontist/formula_paths.rb
 - lib/fontist/helpers.rb
@@ -296,9 +295,11 @@ files:
 - lib/fontist/import/text_helper.rb
 - lib/fontist/index.rb
 - lib/fontist/indexes/base_index.rb
+- lib/fontist/indexes/default_family_font_index.rb
 - lib/fontist/indexes/filename_index.rb
 - lib/fontist/indexes/font_index.rb
 - lib/fontist/indexes/index_formula.rb
+- lib/fontist/indexes/preferred_family_font_index.rb
 - lib/fontist/manifest.rb
 - lib/fontist/manifest/install.rb
 - lib/fontist/manifest/locations.rb

data/lib/fontist/fontist_font.rb

@@ -1,24 +0,0 @@
-module Fontist
-  class FontistFont
-    def initialize(font_name:)
-      @font_name = font_name
-    end
-
-    def self.find(name)
-      new(font_name: name).find
-    end
-
-    def find
-      styles = FormulaPaths.new(font_paths).find(@font_name)
-      return unless styles
-
-      styles.map { |x| x[:path] }
-    end
-
-    private
-
-    def font_paths
-      Dir.glob(Fontist.fonts_path.join("**"))
-    end
-  end
-end