fontist 1.3.0 → 1.7.0

data/lib/fontist/utils.rb

@@ -1,8 +1,13 @@
 require "fontist/utils/ui"
+require "fontist/utils/system"
 require "fontist/utils/dsl"
+require "fontist/utils/dsl/font"
+require "fontist/utils/dsl/collection_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,3 +1,5 @@
+require_relative "cache"
+
 module Fontist
   module Utils
     class Downloader
@@ -5,12 +7,15 @@ module Fontist
         # TODO: If the first mirror fails, try the second one
         @file = file
         @sha = [sha].flatten.compact
-        @progress_bar = set_progress_bar(progress_bar)
         @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(
@@ -43,36 +48,88 @@ module Fontist
       end
 
       def set_progress_bar(progress_bar)
-        ENV.fetch("TEST_ENV", "") === "CI" ? false : progress_bar
+        if ENV.fetch("TEST_ENV", "") === "CI" || progress_bar
+          ProgressBar.new(@file_size)
+        else
+          NullProgressBar.new
+        end
       end
 
       def download_file
-        bar = ProgressBar.new(file_size / byte_to_megabyte)
-
-        Down.download(
+        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

data/lib/fontist/utils/dsl.rb

@@ -47,6 +47,10 @@ module Fontist
         instance.temp_resource.merge!(filename: name)
       end
 
+      def source_filename(name)
+        instance.temp_resource.merge!(source_filename: name)
+      end
+
       def provides_font(font, options = {})
         font_styles = instance.extract_font_styles(options)
         instance.font_list.push(name: font, styles: font_styles)
@@ -65,6 +69,10 @@ module Fontist
         instance.license_required = false
       end
 
+      def copyright(copyright)
+        instance.copyright = copyright
+      end
+
       def license_url(url)
         instance.license_url = url
       end

data/lib/fontist/utils/dsl/collection_font.rb

@@ -0,0 +1,36 @@
+module Fontist
+  module Utils
+    module Dsl
+      class CollectionFont
+        REQUIRED_ATTRIBUTES = %i[style].freeze
+
+        attr_reader :attributes
+
+        def initialize(attributes)
+          REQUIRED_ATTRIBUTES.each do |required_attribute|
+            unless attributes[required_attribute]
+              raise(Fontist::Errors::MissingAttributeError.new(
+                      "Missing attribute: #{required_attribute}"
+                    ))
+            end
+          end
+
+          self.attributes = attributes
+        end
+
+        def attributes=(attrs)
+          @attributes = { family_name: attrs[:family_name],
+                          type: attrs[:style],
+                          collection: attrs[:full_name],
+                          full_name: attrs[:full_name],
+                          post_script_name: attrs[:post_script_name],
+                          version: attrs[:version],
+                          description: attrs[:description],
+                          copyright: attrs[:copyright],
+                          font: attrs[:filename],
+                          source_font: attrs[:source_filename] }
+        end
+      end
+    end
+  end
+end

data/lib/fontist/utils/dsl/font.rb

@@ -0,0 +1,38 @@
+module Fontist
+  module Utils
+    module Dsl
+      class Font
+        REQUIRED_ATTRIBUTES = %i[family_name
+                                 style
+                                 full_name
+                                 filename].freeze
+
+        attr_reader :attributes
+
+        def initialize(attributes)
+          REQUIRED_ATTRIBUTES.each do |required_attribute|
+            unless attributes[required_attribute]
+              raise(Fontist::Errors::MissingAttributeError.new(
+                      "Missing attribute: #{required_attribute}"
+                    ))
+            end
+          end
+
+          self.attributes = attributes
+        end
+
+        def attributes=(attrs)
+          @attributes = { family_name: attrs[:family_name],
+                          type: attrs[:style],
+                          full_name: attrs[:full_name],
+                          post_script_name: attrs[:post_script_name],
+                          version: attrs[:version],
+                          description: attrs[:description],
+                          copyright: attrs[:copyright],
+                          font: attrs[:filename],
+                          source_font: attrs[:source_filename] }
+        end
+      end
+    end
+  end
+end

data/lib/fontist/utils/exe_extractor.rb

@@ -1,20 +1,23 @@
 module Fontist
   module Utils
     module ExeExtractor
-      def cab_extract(exe_file, download: true,  font_ext: /.tt|.ttc/i)
+      def cab_extract(exe_file, download: true, font_ext: /.ttf|.otf|.ttc/i)
         download = @downloaded === true ? false : download
 
         exe_file = download_file(exe_file).path if download
+
+        Fontist.ui.say(%(Installing font "#{key}".))
         cab_file = decompressor.search(exe_file)
-        cabbed_fonts = grep_fonts(cab_file.files, font_ext) || []
+        cabbed_fonts = grep_fonts(cab_file.files) || []
         fonts_paths = extract_cabbed_fonts_to_assets(cabbed_fonts)
 
-        yield(fonts_paths) if block_given?
+        block_given? ? yield(fonts_paths) : fonts_paths
       end
 
-      def exe_extract(source)
+      def exe_extract(source, subarchive: nil)
         cab_file = decompressor.search(download_file(source).path)
-        yield(build_cab_file_hash(cab_file.files)) if block_given?
+        subarchive_path = extract_subarchive(cab_file.files, subarchive)
+        block_given? ? yield(subarchive_path) : subarchive_path
       end
 
       private
@@ -26,10 +29,10 @@ module Fontist
         )
       end
 
-      def grep_fonts(file, font_ext)
+      def grep_fonts(file)
         Array.new.tap do |fonts|
           while file
-            fonts.push(file) if file.filename.match(font_ext)
+            fonts.push(file) if font_file?(file.filename)
             file = file.next
           end
         end
@@ -38,7 +41,8 @@ module Fontist
       def extract_cabbed_fonts_to_assets(cabbed_fonts)
         Array.new.tap do |fonts|
           cabbed_fonts.each do |font|
-            font_path = fonts_path.join(font.filename).to_s
+            target_filename = target_filename(font.filename)
+            font_path = fonts_path.join(target_filename).to_s
             decompressor.extract(font, font_path)
 
             fonts.push(font_path)
@@ -46,26 +50,25 @@ module Fontist
         end
       end
 
-      def build_cab_file_hash(file)
-        Hash.new.tap do |cab_files|
-          while file
-            filename = file.filename
-            if filename.include?("cab")
-              file_path = temp_dir.join(filename).to_s
+      def extract_subarchive(file, subarchive = nil)
+        while file
+          filename = file.filename
 
-              decompressor.extract(file, file_path)
-              cab_files[filename.to_s] = file_path
-            end
+          if subarchive_found?(filename, subarchive)
+            file_path = File.join(Dir.mktmpdir, filename)
+            decompressor.extract(file, file_path)
 
-            file = file.next
+            return file_path
           end
+
+          file = file.next
         end
       end
 
-      def temp_dir
-        @temp_dir ||= raise(
-          NotImplementedError.new("You must implement this method"),
-        )
+      def subarchive_found?(filename, subarchive)
+        return subarchive == filename if subarchive
+
+        filename.include?("cab") || filename.include?("msi")
       end
     end
   end

data/lib/fontist/utils/msi_extractor.rb

@@ -0,0 +1,31 @@
+module Fontist
+  module Utils
+    module MsiExtractor
+      def msi_extract(resource)
+        file = @downloaded ? resource : download_file(resource)
+
+        cab_content = read_the_largest_file(file)
+
+        cab_file = Tempfile.new(["data", ".cab"], mode: File::BINARY)
+        cab_file.write(cab_content)
+
+        block_given? ? yield(cab_file.path) : cab_file.path
+      end
+
+      private
+
+      def read_the_largest_file(file)
+        ole = storage.open(file)
+        the_largest_file = ole.dir.entries(".").max_by { |x| ole.file.size(x) }
+        ole.file.read(the_largest_file)
+      end
+
+      def storage
+        @storage ||= begin
+                       require "ole/storage"
+                       Ole::Storage
+                     end
+      end
+    end
+  end
+end

data/lib/fontist/utils/seven_zip_extractor.rb

@@ -0,0 +1,41 @@
+module Fontist
+  module Utils
+    module SevenZipExtractor
+      def seven_zip_extract(resource, extension: /\.cab$/)
+        file = download_file(resource)
+
+        extract_seven_zip_file(file, extension)
+      end
+
+      private
+
+      def extract_seven_zip_file(file, extension)
+        File.open(file, "rb") do |zip_file|
+          reader.open(zip_file) do |szr|
+            path = extract_by_extension(szr, extension)
+
+            return block_given? ? yield(path) : path
+          end
+        end
+      end
+
+      def reader
+        @reader ||= begin
+                      require "seven_zip_ruby"
+                      SevenZipRuby::Reader
+                    end
+      end
+
+      def extract_by_extension(szr, extension)
+        cab_entry = szr.entries.detect do |entry|
+          entry.file? && entry.path.match(extension)
+        end
+
+        tmp_dir = Dir.mktmpdir
+        szr.extract(cab_entry, tmp_dir)
+        filename = Pathname.new(cab_entry.path).basename
+        File.join(tmp_dir, filename)
+      end
+    end
+  end
+end