fontist 1.2.1 → 1.6.0

data/lib/fontist/manifest.rb

@@ -0,0 +1,2 @@
+require_relative "manifest/locations"
+require_relative "manifest/install"

data/lib/fontist/manifest/common.rb

@@ -0,0 +1,60 @@
+module Fontist
+  module Manifest
+    class Common
+      def initialize(manifest)
+        @manifest = manifest
+      end
+
+      def self.call(manifest)
+        new(manifest).call
+      end
+
+      def call
+        font_names.zip(font_paths).to_h
+      end
+
+      private
+
+      def font_names
+        fonts.keys
+      end
+
+      def fonts
+        @fonts ||= begin
+          unless File.exist?(@manifest)
+            raise Fontist::Errors::ManifestCouldNotBeFoundError
+          end
+
+          fonts = YAML.load_file(@manifest)
+          unless fonts.is_a?(Hash)
+            raise Fontist::Errors::ManifestCouldNotBeReadError
+          end
+
+          fonts
+        end
+      end
+
+      def font_paths
+        fonts.map do |font, styles|
+          styles_to_ary = [styles].flatten
+          style_paths_map(font, styles_to_ary)
+        end
+      end
+
+      def style_paths_map(font, names)
+        paths = style_paths(font, names)
+        names.zip(paths).to_h
+      end
+
+      def style_paths(font, names)
+        names.map do |style|
+          file_paths(font, style)
+        end
+      end
+
+      def file_paths(_font, _style)
+        raise NotImplementedError.new("Implement #file_paths in child class")
+      end
+    end
+  end
+end

data/lib/fontist/manifest/install.rb

@@ -0,0 +1,36 @@
+require_relative "common"
+
+module Fontist
+  module Manifest
+    class Install < Common
+      def initialize(manifest, confirmation: "no")
+        @manifest = manifest
+        @confirmation = confirmation
+      end
+
+      def self.call(manifest, confirmation: "no")
+        new(manifest, confirmation: confirmation).call
+      end
+
+      private
+
+      def file_paths(font, style)
+        paths = find_installed_font(font, style)
+        return paths unless paths.empty?
+
+        install_font(font)
+        find_installed_font(font, style)
+      end
+
+      def find_installed_font(font, style)
+        Fontist::SystemFont.find_with_style(font, style)
+      end
+
+      def install_font(font)
+        Fontist::Font.try_install(font, confirmation: @confirmation)
+      rescue Fontist::Errors::LicensingError
+        [] # try to install other fonts
+      end
+    end
+  end
+end

data/lib/fontist/manifest/locations.rb

@@ -0,0 +1,13 @@
+require_relative "common"
+
+module Fontist
+  module Manifest
+    class Locations < Common
+      private
+
+      def file_paths(font, style)
+        Fontist::SystemFont.find_with_style(font, style)
+      end
+    end
+  end
+end

data/lib/fontist/registry.rb

@@ -32,6 +32,7 @@ module Fontist
         license: formula.instance.license,
         homepage: formula.instance.homepage ,
         description: formula.instance.description,
+        license_required: formula.instance.license_required,
       }
     end
 

data/lib/fontist/system_font.rb

@@ -1,7 +1,8 @@
 module Fontist
   class SystemFont
-    def initialize(font:, sources: nil)
+    def initialize(font:, style: nil, sources: nil)
       @font = font
+      @style = style
       @user_sources = sources || []
     end
 
@@ -9,28 +10,59 @@ module Fontist
       new(font: font, sources: sources).find
     end
 
+    def self.find_with_style(font, style)
+      new(font: font, style: style).find_with_style
+    end
+
     def find
-      paths = font_paths.grep(/#{font}/i)
+      paths = grep_font_paths(font)
       paths = lookup_using_font_name || []  if paths.empty?
 
       paths.empty? ? nil : paths
     end
 
+    def find_with_style
+      paths = lookup_using_font_and_style
+      return paths unless paths.empty?
+
+      grep_font_paths(font, style)
+    end
+
     private
 
-    attr_reader :font, :user_sources
+    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
 
-        passwd ? path.gsub("{username}", passwd.name) : path
+        username ? path.gsub("{username}", username) : path
       end
     end
 
+    def grep_font_paths(font, style = nil)
+      pattern = prepare_pattern(font, style)
+
+      paths = font_paths.map { |path| [File.basename(path), path] }.to_h
+      files = paths.keys
+      matched = files.grep(pattern)
+      paths.values_at(*matched).compact
+    end
+
+    def prepare_pattern(font, style = nil)
+      style = nil if style&.casecmp?("regular")
+
+      s = [font, style].compact.map { |x| Regexp.quote(x) }
+        .join(".*")
+        .gsub("\\ ", "\s?") # space independent
+
+      Regexp.new(s, Regexp::IGNORECASE)
+    end
+
     def font_paths
-      Dir.glob((
+      @font_paths ||= Dir.glob((
         user_sources +
         normalize_default_paths +
         [fontist_fonts_path.join("**")]
@@ -46,23 +78,8 @@ module Fontist
       @fontist_fonts_path ||= Fontist.fonts_path
     end
 
-
     def user_os
-      @user_os ||= (
-        host_os = RbConfig::CONFIG["host_os"]
-        case host_os
-        when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
-          :windows
-        when /darwin|mac os/
-          :macos
-        when /linux/
-          :linux
-        when /solaris|bsd/
-          :unix
-        else
-          raise Fontist::Error, "unknown os: #{host_os.inspect}"
-        end
-      )
+      Fontist::Utils::System.user_os
     end
 
     def map_name_to_valid_font_names
@@ -71,11 +88,25 @@ module Fontist
     end
 
     def system_path_file
-      File.open(Fontist.lib_path.join("fontist", "system.yml"))
+      File.open(Fontist.system_file_path)
     end
 
     def default_sources
       @default_sources ||= YAML.load(system_path_file)["system"][user_os.to_s]
     end
+
+    def lookup_using_font_and_style
+      styles = Formula.find_styles(font, style)
+      filenames = styles.map(&:font)
+      filenames.flat_map do |filename|
+        search_font_paths(filename)
+      end
+    end
+
+    def search_font_paths(filename)
+      font_paths.select do |path|
+        File.basename(path) == filename
+      end
+    end
   end
 end

data/lib/fontist/utils.rb

@@ -1,7 +1,12 @@
+require "fontist/utils/ui"
+require "fontist/utils/system"
 require "fontist/utils/dsl"
+require "fontist/utils/dsl/font"
 require "fontist/utils/downloader"
 require "fontist/utils/zip_extractor"
 require "fontist/utils/exe_extractor"
+require "fontist/utils/msi_extractor"
+require "fontist/utils/seven_zip_extractor"
 
 module Fontist
   module Utils

data/lib/fontist/utils/cache.rb

@@ -0,0 +1,88 @@
+module Fontist
+  module Utils
+    class Cache
+      def fetch(key, bar: nil)
+        map = load_cache
+        if cache_exist?(map[key])
+          print_bar(bar, map[key]) if bar
+
+          return downloaded_file(map[key])
+        end
+
+        generated_file = yield
+        path = save_cache(generated_file, key)
+
+        downloaded_file(path)
+      end
+
+      private
+
+      def cache_map_path
+        Fontist.downloads_path.join("map.yml")
+      end
+
+      def load_cache
+        cache_map_path.exist? ? YAML.load_file(cache_map_path) : {}
+      end
+
+      def downloaded_file(path)
+        File.new(downloaded_path(path))
+      end
+
+      def cache_exist?(path)
+        path && File.exist?(downloaded_path(path))
+      end
+
+      def downloaded_path(path)
+        Fontist.downloads_path.join(path)
+      end
+
+      def print_bar(bar, path)
+        File.size(downloaded_path(path)).tap do |size|
+          bar.total = size
+          bar.increment(size)
+          bar.finish("cache")
+        end
+      end
+
+      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))
+
+        path
+      end
+
+      def move_to_downloads(source)
+        create_downloads_directory
+        path = generate_file_path(source)
+        move(source, path)
+        relative_to_downloads(path)
+      end
+
+      def create_downloads_directory
+        unless Fontist.downloads_path.exist?
+          FileUtils.mkdir_p(Fontist.downloads_path)
+        end
+      end
+
+      def generate_file_path(source)
+        dir = Dir.mktmpdir(nil, Fontist.downloads_path)
+        filename = source.original_filename
+        File.join(dir, filename)
+      end
+
+      def move(source_file, target_path)
+        # Windows requires file descriptors to be closed before files are moved
+        source_file.close
+        FileUtils.mv(source_file.path, target_path)
+      end
+
+      def relative_to_downloads(path)
+        Pathname.new(path).relative_path_from(Fontist.downloads_path).to_s
+      end
+    end
+  end
+end

data/lib/fontist/utils/downloader.rb

@@ -1,16 +1,21 @@
+require_relative "cache"
+
 module Fontist
   module Utils
     class Downloader
       def initialize(file, file_size: nil, sha: nil, progress_bar: nil)
         # TODO: If the first mirror fails, try the second one
         @file = file
-        @progress_bar = progress_bar
         @sha = [sha].flatten.compact
         @file_size = (file_size || default_file_size).to_i
+        @progress_bar = set_progress_bar(progress_bar)
+        @cache = Cache.new
       end
 
       def download
-        file = download_file
+        file = @cache.fetch(@file, bar: @progress_bar) do
+          download_file
+        end
 
         if !sha.empty? && !sha.include?(Digest::SHA256.file(file).to_s)
           raise(Fontist::Errors::TamperedFileError.new(
@@ -42,33 +47,89 @@ module Fontist
         options[:download_path] || Fontist.root_path.join("tmp")
       end
 
-      def download_file
-        bar = ProgressBar.new(file_size / byte_to_megabyte)
+      def set_progress_bar(progress_bar)
+        if ENV.fetch("TEST_ENV", "") === "CI" || progress_bar
+          ProgressBar.new(@file_size)
+        else
+          NullProgressBar.new
+        end
+      end
 
-        Down.download(
+      def download_file
+        file = Down.download(
           @file,
           open_timeout: 10,
           read_timeout: 10,
+          content_length_proc: ->(content_length) {
+            @progress_bar.total = content_length if content_length
+          },
           progress_proc: -> (progress) {
-            bar.increment(progress / byte_to_megabyte) if @progress_bar === true
+            @progress_bar.increment(progress)
           }
         )
 
+        @progress_bar.finish
+
+        file
       rescue Down::NotFound
         raise(Fontist::Errors::InvalidResourceError.new("Invalid URL: #{@file}"))
       end
     end
 
+    class NullProgressBar
+      def total=(_)
+        # do nothing
+      end
+
+      def increment(_)
+        # do nothing
+      end
+
+      def finish(_ = nil)
+        # do nothing
+      end
+    end
+
     class ProgressBar
       def initialize(total)
         @counter = 1
         @total  = total
       end
 
+      def total=(total)
+        @total = total
+      end
+
       def increment(progress)
-        complete = sprintf("%#.2f%%", ((@counter.to_f / @total.to_f) * 100))
-        print "\r\e[0KDownloads: #{@counter}MB/#{@total}MB (#{complete})"
         @counter = progress
+        Fontist.ui.print "\r\e[0KDownloads: #{counter_mb}MB/#{total_mb}MB " \
+                         "(#{completeness})"
+      end
+
+      def finish(message = nil)
+        if message
+          Fontist.ui.print " (#{message})\n"
+        else
+          Fontist.ui.print "\n"
+        end
+      end
+
+      private
+
+      def completeness
+        sprintf("%#.2f%%", (@counter.fdiv(@total) * 100)) # rubocop:disable Style/FormatStringToken, Metrics/LineLength
+      end
+
+      def counter_mb
+        @counter / byte_to_megabyte
+      end
+
+      def total_mb
+        @total / byte_to_megabyte
+      end
+
+      def byte_to_megabyte
+        @byte_to_megabyte ||= 1024 * 1024
       end
     end
   end