fontist 1.8.2 → 1.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fea467133e3e6a8a287dd36a2a03790fb63859f983b0398f0f558de519a0a64
-  data.tar.gz: b8c717aef31834b5a9b3c3f903dacf0d267ddd85aa6f0a1eca34566a45b219bf
+  metadata.gz: 8b8f20509f7376c4f88906c9f5d95d02f965351433b2b9f47c46d7e9e5afbb1e
+  data.tar.gz: e4c71f47525f2c82f0d098eca47629bc808bd1bbff7c83b39f4ede42fd507c05
 SHA512:
-  metadata.gz: 20d44b20267db6f15f1b36be660f91690cef7c6f4b0653341231b3f18658ec0f88ea8225884b7b2ac1d06f3e8aa5be79aea600fed5be91513f43031a10b5de5b
-  data.tar.gz: 6138e6bed40c741f21c6d116f021aef9f6c7cca24506337fe681ba5e6c6e996c8e8e6a84e50103601231d6cab9f5cafc7b5527b418d65fbd6c1477c67ceda201
+  metadata.gz: 82f8dc79feec65cd9a1ec567f6168dd9ff06fb7ba4ac7d8fbc58e450dba52380ba98d1d9f559b102ab4c997321565e2ee7fe04ac1b34100b7ce3c66078367b20
+  data.tar.gz: 2c80173b5683ed435c609f40bdfae52a0be258a1f491228fba93f2feedea1f28141461708b5c2a84385b5dde84af52792465c21dcf709dfd0f9a4f42d142cf57

data/lib/fontist/cli.rb

@@ -9,15 +9,17 @@ module Fontist
     STATUS_LICENSING_ERROR = 4
     STATUS_MANIFEST_COULD_NOT_BE_FOUND_ERROR = 5
     STATUS_MANIFEST_COULD_NOT_BE_READ_ERROR = 6
+    STATUS_FONT_INDEX_CORRUPTED = 7
 
     ERROR_TO_STATUS = {
-      Fontist::Errors::NonSupportedFontError => [STATUS_NON_SUPPORTED_FONT_ERROR],
+      Fontist::Errors::UnsupportedFontError => [STATUS_NON_SUPPORTED_FONT_ERROR],
       Fontist::Errors::MissingFontError => [STATUS_MISSING_FONT_ERROR],
       Fontist::Errors::LicensingError => [STATUS_LICENSING_ERROR],
       Fontist::Errors::ManifestCouldNotBeFoundError => [STATUS_MANIFEST_COULD_NOT_BE_FOUND_ERROR,
                                                         "Manifest could not be found."],
       Fontist::Errors::ManifestCouldNotBeReadError => [STATUS_MANIFEST_COULD_NOT_BE_READ_ERROR,
                                                        "Manifest could not be read."],
+      Fontist::Errors::FontIndexCorrupted => [STATUS_FONT_INDEX_CORRUPTED],
     }.freeze
 
     def self.exit_on_failure?
@@ -105,7 +107,8 @@ module Fontist
     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"
+    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)
       require "fontist/import/create_formula"
       name = Fontist::Import::CreateFormula.new(url, options).call

data/lib/fontist/errors.rb

@@ -1,7 +1,9 @@
 module Fontist
   module Errors
     class GeneralError < StandardError; end
+
     class BinaryCallError < GeneralError; end
+    class FontIndexCorrupted < GeneralError; end
     class FontNotFoundError < GeneralError; end
     class FormulaIndexNotFoundError < GeneralError; end
     class InvalidResourceError < GeneralError; end
@@ -9,10 +11,56 @@ module Fontist
     class ManifestCouldNotBeFoundError < GeneralError; end
     class ManifestCouldNotBeReadError < GeneralError; end
     class MissingAttributeError < GeneralError; end
-    class MissingFontError < GeneralError; end
-    class NonSupportedFontError < GeneralError; end
     class TamperedFileError < GeneralError; end
     class TimeoutError < GeneralError; end
     class UnknownFontTypeError < GeneralError; end
+
+    class FontError < GeneralError
+      attr_reader :font, :style
+
+      def initialize(msg, font = nil, style = nil)
+        @font = font
+        @style = style
+
+        super(msg)
+      end
+
+      def name
+        messages = []
+        messages << "Font name: '#{@font}'"
+        messages << "Style: '#{@style}'" if @style
+        messages.join("; ")
+      end
+    end
+
+    class MissingFontError < FontError
+      def initialize(font, style = nil)
+        name = prepare_name(font, style)
+        msg = "#{name} font is missing, please run `fontist install '#{font}'` to download the font."
+
+        super(msg, font, style)
+      end
+
+      private
+
+      def prepare_name(font, style)
+        names = []
+        names << "'#{font}'"
+        names << "'#{style}'" if style
+        names.join(" ")
+      end
+    end
+
+    class UnsupportedFontError < FontError
+      def initialize(font)
+        msg = <<~MSG.chomp
+          Font '#{font}' 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
+
+        super(msg, font)
+      end
+    end
   end
 end

data/lib/fontist/font.rb

@@ -96,12 +96,7 @@ module Fontist
 
     def downloadable_font
       if formula
-        raise(
-          Fontist::Errors::MissingFontError,
-          "#{name} fonts are missing, please run " \
-          "`fontist install '#{name}'` to " \
-          "download the font."
-        )
+        raise Fontist::Errors::MissingFontError.new(name)
       end
     end
 
@@ -236,14 +231,7 @@ module Fontist
     end
 
     def raise_non_supported_font
-      raise Fontist::Errors::NonSupportedFontError.new(
-        "Font '#{@name}' not found locally nor available in the Fontist " \
-        "formula repository.\n" \
-        "Perhaps it is available at the latest Fontist formula " \
-        "repository.\n" \
-        "You can update the formula repository using the command " \
-        "`fontist update` and try again."
-      )
+      raise Fontist::Errors::UnsupportedFontError.new(@name)
     end
   end
 end

data/lib/fontist/manifest/locations.rb

@@ -55,7 +55,7 @@ module Fontist
       def file_paths(font, style)
         find_font_with_name(font, style).tap do |x|
           if x["paths"].empty?
-            raise Errors::MissingFontError.new("Could not find font #{font} #{style}.")
+            raise Errors::MissingFontError.new(font, style)
           end
         end
       end

data/lib/fontist/system_font.rb

@@ -9,6 +9,33 @@ module Fontist
       @user_sources = sources || []
     end
 
+    def self.font_paths
+      system_font_paths + fontist_font_paths
+    end
+
+    def self.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"]
+      patterns = expand_paths(templates)
+
+      Dir.glob(patterns)
+    end
+
+    def self.expand_paths(paths)
+      paths.map do |path|
+        require "etc"
+        passwd = Etc.getpwuid
+        username = passwd ? passwd.name : Etc.getlogin
+
+        username ? path.gsub("{username}", username) : path
+      end
+    end
+
+    def self.fontist_font_paths
+      Dir.glob(Fontist.fonts_path.join("**"))
+    end
+
     def self.find(font, sources: [])
       new(font: font, sources: sources).find
     end
@@ -36,50 +63,20 @@ module Fontist
 
     attr_reader :font, :style, :user_sources
 
-    def normalize_default_paths
-      @normalize_default_paths ||= default_sources["paths"].map do |path|
-        require "etc"
-        passwd = Etc.getpwuid
-        username = passwd ? passwd.name : Etc.getlogin
-
-        username ? path.gsub("{username}", username) : path
-      end
-    end
-
-    def font_paths
-      @font_paths ||= Dir.glob((
-        user_sources +
-        normalize_default_paths +
-        [fontist_fonts_path.join("**")]
-      ).flatten.uniq)
-    end
-
-    def fontist_fonts_path
-      @fontist_fonts_path ||= Fontist.fonts_path
-    end
-
-    def user_os
-      Fontist::Utils::System.user_os
-    end
-
-    def system_path_file
-      File.open(Fontist.system_file_path)
-    end
-
-    def default_sources
-      @default_sources ||= YAML.safe_load(system_path_file)["system"][user_os.to_s]
-    end
-
     def find_styles
       find_by_index || find_by_formulas
     end
 
     def find_by_index
-      SystemIndex.new(font_paths).find(font, style)
+      SystemIndex.new(all_paths).find(font, style)
     end
 
     def find_by_formulas
-      FormulaPaths.new(font_paths).find(font, style)
+      FormulaPaths.new(all_paths).find(font, style)
+    end
+
+    def all_paths
+      @all_paths ||= Dir.glob(user_sources) + self.class.font_paths
     end
   end
 end

data/lib/fontist/system_index.rb

@@ -2,8 +2,18 @@ require "ttfunk"
 
 module Fontist
   class SystemIndex
+    include Utils::Locking
+
     attr_reader :font_paths
 
+    def self.find(font, style)
+      new(SystemFont.font_paths).find(font, style)
+    end
+
+    def self.rebuild
+      new(SystemFont.font_paths).rebuild
+    end
+
     def initialize(font_paths)
       @font_paths = font_paths
     end
@@ -17,6 +27,10 @@ module Fontist
       fonts.empty? ? nil : fonts
     end
 
+    def rebuild
+      build_system_index
+    end
+
     private
 
     def system_index
@@ -24,21 +38,49 @@ module Fontist
     end
 
     def build_system_index
+      lock(lock_path) do
+        do_build_system_index
+      end
+    end
+
+    def lock_path
+      Fontist.system_index_path.to_s + ".lock"
+    end
+
+    def do_build_system_index
       previous_index = load_system_index
       updated_index = detect_paths(font_paths, previous_index)
       updated_index.tap do |index|
-        save_index(index)
+        save_index(index) if changed?(updated_index, previous_index)
       end
     end
 
+    def changed?(this, other)
+      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) : []
-      index.group_by { |x| x[:path] }
+
+      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.
+          MSG
+        end
+      end
+
+      index
     end
 
-    def detect_paths(paths, indexed)
+    def detect_paths(paths, index)
+      by_path = index.group_by { |x| x[:path] }
+
       paths.flat_map do |path|
-        next indexed[path] if indexed[path]
+        next by_path[path] if by_path[path]
 
         detect_fonts(path)
       end

data/lib/fontist/utils.rb

@@ -1,4 +1,5 @@
 require "fontist/utils/ui"
+require "fontist/utils/locking"
 require "fontist/utils/system"
 require "fontist/utils/dsl"
 require "fontist/utils/dsl/font"

data/lib/fontist/utils/cache.rb

@@ -1,6 +1,8 @@
 module Fontist
   module Utils
     class Cache
+      include Locking
+
       def fetch(key, bar: nil)
         map = load_cache
         if cache_exist?(map[key])
@@ -48,13 +50,19 @@ module Fontist
       def save_cache(generated_file, key)
         path = move_to_downloads(generated_file)
 
-        map = load_cache
-        map[key] = path
-        File.write(cache_map_path, YAML.dump(map))
+        lock(lock_path) do
+          map = load_cache
+          map[key] = path
+          File.write(cache_map_path, YAML.dump(map))
+        end
 
         path
       end
 
+      def lock_path
+        cache_map_path.to_s + ".lock"
+      end
+
       def move_to_downloads(source)
         create_downloads_directory
         path = generate_file_path(source)

data/lib/fontist/utils/locking.rb

@@ -0,0 +1,17 @@
+module Fontist
+  module Utils
+    module Locking
+      def lock(lock_path)
+        File.dirname(lock_path).tap do |dir|
+          FileUtils.mkdir_p(dir) unless File.exist?(dir)
+        end
+
+        f = File.open(lock_path, File::CREAT)
+        f.flock(File::LOCK_EX)
+        yield
+      ensure
+        f.flock(File::LOCK_UN)
+      end
+    end
+  end
+end

data/lib/fontist/version.rb

@@ -1,3 +1,3 @@
 module Fontist
-  VERSION = "1.8.2".freeze
+  VERSION = "1.8.3".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fontist
 version: !ruby/object:Gem::Version
-  version: 1.8.2
+  version: 1.8.3
 platform: ruby
 authors:
 - Ribose Inc.
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-30 00:00:00.000000000 Z
+date: 2021-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: down
@@ -357,6 +357,7 @@ files:
 - lib/fontist/utils/dsl/collection_font.rb
 - lib/fontist/utils/dsl/font.rb
 - lib/fontist/utils/exe_extractor.rb
+- lib/fontist/utils/locking.rb
 - lib/fontist/utils/msi_extractor.rb
 - lib/fontist/utils/seven_zip_extractor.rb
 - lib/fontist/utils/system.rb