fontist 1.20.0 → 1.21.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b84dad2469698853e57c647d63890c7f054f888db3d7c53367e7c17ac3ca3951
-  data.tar.gz: ebc3c36071d189946c187af9c7a1e340ed703dc37b1eb40b821ce7557b4f2b3a
+  metadata.gz: 0cc55cf30c5781a41e3ff4ff617acacb24367c3148dc6c1db104ff5a1aad8105
+  data.tar.gz: 118207311bf22488c6adbff254fd3646d24f5b1f09f09d8eaf319489798c5002
 SHA512:
-  metadata.gz: 3cb8a0632dde13a856ac227b3dfd6af2082fa9e4a4c27357e94664cfb3861b26ed16af5dd0891eb1542d3ec2ae4d82dbc8f57c8ae593f39610c071885f6e45d3
-  data.tar.gz: a792eceef4a821e48acce6ccb7d863a9fbc7602ac8197f488a927a1e1563947740ff4863a6162af004dbfcc40789433980ce31aed0b2a674d6b10d74009b3b7d
+  metadata.gz: aebf180824a2e45fc23e6d795e98fa8394e735d1a0c6f58d5ec5740ea2343e31787d9075db3060a071ce3a8dc0b193502e6b76e76fba58c345522cc47ddd4b74
+  data.tar.gz: e411af70f8dd20ab8f7a55540fa24b5741a37813420fd14b0e3518f30a1d0a477565add1da666f6f91207ec90343ab2eabc04cd791d69a22c3c6c08c01ea639f

data/.github/workflows/test-and-release.yml

@@ -16,6 +16,7 @@ env:
 # does not cause bundler gem reinstalls
 # bundler/rubygems 2.3.22 is a minimal requirement to support gnu/musl differentiation
 # https://github.com/rubygems/rubygems/pull/4488
+  GOOGLE_FONTS_API_KEY: ${{secrets.FONTIST_CI_GOOGLE_FONTS_API_KEY}}
 
 jobs:
   prepare:
@@ -83,7 +84,7 @@ jobs:
     needs: prepare
     if: needs.prepare.outputs.push-for-tag != 'true'
 
-    continue-on-error: ${{ matrix.ruby.experimental || matrix.os == 'windows-latest' }} # workaround https://github.com/metanorma/metanorma/issues/288
+    continue-on-error: true # ${{ matrix.ruby.experimental || matrix.os == 'windows-latest' }} # workaround https://github.com/metanorma/metanorma/issues/288
     strategy:
       fail-fast: false
       max-parallel: 5

data/README.adoc

@@ -1066,7 +1066,7 @@ Fontist's https://github.com/fontist/formulas[formula library] includes support
 for all openly-licensed fonts provided through Google Fonts, and maintains
 Fontist formulas for all such fonts.
 
-https://github.com/fontist/formulas/blob/v3/.github/workflows/google.yml[A GHA
+https://github.com/fontist/formulas/blob/v4/.github/workflows/google.yml[A GHA
 workflow] checks for updated fonts on Google Fonts daily. In case an update is
 found, it's added to the repo by the workflow.
 

data/exe/fontist

@@ -4,8 +4,7 @@ require "fontist"
 require "fontist/cli"
 
 fontist_cli = proc {
-  status_code = Fontist::CLI.start(ARGV)
-  exit status_code.is_a?(Integer) ? status_code : 1
+  Fontist::CLI.start(ARGV)
 }
 
 if ENV["SOCKS_PROXY"]

data/lib/fontist/cli/thor_ext.rb

@@ -0,0 +1,79 @@
+require "fontist/utils/ui"
+
+module Fontist
+  module ThorExt
+    # Sources:
+    # - https://github.com/mattbrictson/gem/blob/main/lib/example/thor_ext.rb
+    # - https://mattbrictson.com/blog/fixing-thor-cli-behavior
+    #
+    # Configures Thor to behave more like a typical CLI, with better help
+    # and error handling.
+    #
+    # - Passing -h or --help to a command will show help for that command.
+    # - Unrecognized options will be treated as errors.
+    # - Error messages will be printed in red to stderr, without stack trace.
+    # - Errors will cause Thor to exit with a non-zero status.
+    #
+    # To take advantage of this behavior, your CLI should subclass Thor
+    # and extend this module.
+    #
+    #   class CLI < Thor
+    #     extend ThorExt::Start
+    #   end
+    #
+    # Start your CLI with:
+    #
+    #   CLI.start
+    #
+    # In tests, prevent Kernel.exit from being called when an error occurs,
+    # like this:
+    #
+    #   CLI.start(args, exit_on_failure: false)
+    module Start
+      def self.extended(base)
+        super
+        base.check_unknown_options!
+      end
+
+      def start(given_args = ARGV, config = {})
+        config[:shell] ||= Thor::Base.shell.new
+        handle_help_switches(given_args) do |args|
+          dispatch(nil, args, nil, config)
+        end
+      rescue StandardError => e
+        handle_exception_on_start(e, config)
+      end
+
+      private
+
+      # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+      def handle_help_switches(given_args)
+        yield(given_args.dup)
+      rescue Thor::UnknownArgumentError => e
+        retry_with_args = []
+
+        if given_args.first == "help"
+          retry_with_args = ["help"] if given_args.length > 1
+        elsif e.unknown.intersect?(%w[-h --help])
+          retry_with_args = ["help", (given_args - e.unknown).first]
+        end
+        raise unless retry_with_args.any?
+
+        yield(retry_with_args)
+      end
+
+      def handle_exception_on_start(error, config)
+        return if error.is_a?(Errno::EPIPE)
+        raise if Fontist.ui.debug? || !config.fetch(:exit_on_failure, true)
+
+        message = error.message.to_s
+        if message.empty? || !error.is_a?(Thor::Error)
+          message.prepend("[#{error.class}] ")
+        end
+        config[:shell]&.say_error(message, :red)
+        exit(false)
+      end
+      # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
+    end
+  end
+end

data/lib/fontist/cli.rb

@@ -1,5 +1,6 @@
 require "thor"
 require "fontist/cli/class_options"
+require "fontist/cli/thor_ext"
 require "fontist/repo_cli"
 require "fontist/cache_cli"
 require "fontist/import_cli"
@@ -9,6 +10,7 @@ require "fontist/config_cli"
 module Fontist
   class CLI < Thor
     include ClassOptions
+    extend ThorExt::Start
 
     STATUS_SUCCESS = 0
     STATUS_UNKNOWN_ERROR = 1

data/lib/fontist/config.rb

@@ -44,7 +44,8 @@ module Fontist
     def default_values
       { fonts_path: Fontist.fontist_path.join("fonts"),
         open_timeout: 10,
-        read_timeout: 10 }
+        read_timeout: 10,
+        google_fonts_key: nil }
     end
 
     def persist

data/lib/fontist/font.rb

@@ -216,6 +216,11 @@ module Fontist
       confirmation = check_and_confirm_required_license(formula)
       paths = font_installer(formula).install(confirmation: confirmation)
 
+      if paths.nil? || paths.empty?
+        Fontist.ui.error("Fonts not found in formula #{formula}")
+        return
+      end
+
       Fontist.ui.say("Fonts installed at:")
       paths.each do |path|
         Fontist.ui.say("- #{path}")

data/lib/fontist/font_installer.rb

@@ -1,5 +1,7 @@
 require "fontist/utils"
 require "excavate"
+require_relative "resources/archive_resource"
+require_relative "resources/google_resource"
 
 module Fontist
   class FontInstaller
@@ -48,63 +50,32 @@ module Fontist
     end
 
     def install_font
-      fonts_paths = run_in_temp_dir { extract }
+      fonts_paths = do_install_font
       fonts_paths.empty? ? nil : fonts_paths
     end
 
-    def run_in_temp_dir
-      Dir.mktmpdir(nil, Dir.tmpdir) do |dir|
-        @temp_dir = Pathname.new(dir)
-
-        result = yield
-
-        @temp_dir = nil
-
-        result
-      end
-    end
-
-    def extract
-      archive = download_file(@formula.resources.first)
-
-      install_fonts_from_archive(archive)
-    end
-
-    def install_fonts_from_archive(archive)
-      Fontist.ui.say(%(Installing font "#{@formula.key}".))
+    def do_install_font
+      Fontist.ui.say(%(Installing from formula "#{@formula.key}".))
 
       Array.new.tap do |fonts_paths|
-        Excavate::Archive.new(archive.path).files(recursive_packages: true) do |path|
+        resource.files(source_files) do |path|
           fonts_paths << install_font_file(path) if font_file?(path)
         end
       end
     end
 
-    def download_file(source)
-      errors = []
-      source.urls.each do |request|
-        url = request.respond_to?(:url) ? request.url : request
-        Fontist.ui.say(%(Downloading font "#{@formula.key}" from #{url}))
-
-        result = try_download_file(request, source)
-        return result unless result.is_a?(Errors::InvalidResourceError)
-
-        errors << result
-      end
+    def resource
+      resource_class = if @formula.source == "google"
+                         Resources::GoogleResource
+                       else
+                         Resources::ArchiveResource
+                       end
 
-      raise Errors::InvalidResourceError, errors.join(" ")
+      resource_class.new(resource_options, no_progress: @no_progress)
     end
 
-    def try_download_file(request, source)
-      Fontist::Utils::Downloader.download(
-        request,
-        sha: source.sha256,
-        file_size: source.file_size,
-        progress_bar: !@no_progress
-      )
-    rescue Errors::InvalidResourceError => e
-      Fontist.ui.say(e.message)
-      e
+    def resource_options
+      @formula.resources.first
     end
 
     def font_file?(path)
@@ -116,16 +87,16 @@ module Fontist
     end
 
     def source_files
-      @source_files ||= @formula.fonts.flat_map do |font|
-        next [] if @font_name && !font.name.casecmp?(@font_name)
-
-        font_files(font)
+      @source_files ||= fonts.flat_map do |font|
+        font.styles.map do |style|
+          style.source_font || style.font
+        end
       end
     end
 
-    def font_files(font)
-      font.styles.map do |style|
-        style.source_font || style.font
+    def fonts
+      @formula.fonts.select do |font|
+        @font_name.nil? || font.name.casecmp?(@font_name)
       end
     end
 

data/lib/fontist/formula.rb

@@ -109,6 +109,12 @@ module Fontist
       @data.key?("resources")
     end
 
+    def source
+      return unless @data["resources"]
+
+      @data["resources"].values.first["source"]
+    end
+
     def path
       @path
     end

data/lib/fontist/helpers.rb

@@ -1,3 +1,5 @@
+require "ostruct"
+
 module Fontist
   module Helpers
     def self.parse_to_object(data)

data/lib/fontist/import/create_formula.rb

@@ -1,6 +1,5 @@
 require "fontist/import"
 require_relative "recursive_extraction"
-require_relative "helpers/hash_helper"
 require_relative "formula_builder"
 
 module Fontist
@@ -12,31 +11,102 @@ module Fontist
       end
 
       def call
-        save(builder)
+        builder.save
       end
 
       private
 
       def builder
         builder = FormulaBuilder.new
-        setup_strings(builder, archive)
+        setup_strings(builder)
         setup_files(builder)
         builder
       end
 
-      def setup_strings(builder, archive)
-        builder.archive = archive
-        builder.url = @url
+      def setup_strings(builder)
         builder.options = @options
+        builder.resources = resources
       end
 
       def setup_files(builder)
-        builder.extractor = extractor
+        builder.operations = extractor.operations
         builder.font_files = extractor.font_files
         builder.font_collection_files = extractor.font_collection_files
         builder.license_text = extractor.license_text
       end
 
+      def resources
+        @resources ||= { filename(archive) => resource_options }
+      end
+
+      def filename(file)
+        if file.respond_to?(:original_filename)
+          file.original_filename
+        else
+          File.basename(file)
+        end
+      end
+
+      def resource_options
+        if @options[:skip_sha]
+          resource_options_without_sha
+        else
+          resource_options_with_sha
+        end
+      end
+
+      def resource_options_without_sha
+        { urls: [@url] + mirrors, file_size: file_size }
+      end
+
+      def resource_options_with_sha
+        urls = []
+        sha = []
+        downloads do |url, path|
+          urls << url
+          sha << Digest::SHA256.file(path).to_s
+        end
+
+        sha = prepare_sha256(sha)
+
+        { urls: urls, sha256: sha, file_size: file_size }
+      end
+
+      def downloads
+        yield @url, archive
+
+        mirrors.each do |url|
+          path = download_mirror(url)
+          next unless path
+
+          yield url, path
+        end
+      end
+
+      def mirrors
+        @options[:mirror] || []
+      end
+
+      def download_mirror(url)
+        Fontist::Utils::Downloader.download(url, progress_bar: true).path
+      rescue Errors::InvalidResourceError
+        Fontist.ui.error("WARN: a mirror is not found '#{url}'")
+        nil
+      end
+
+      def prepare_sha256(input)
+        output = input.uniq
+        return output.first if output.size == 1
+
+        checksums = output.join(", ")
+        Fontist.ui.error("WARN: SHA256 differs (#{checksums})")
+        output
+      end
+
+      def file_size
+        File.size(archive)
+      end
+
       def extractor
         @extractor ||=
           RecursiveExtraction.new(archive,
@@ -53,34 +123,6 @@ module Fontist
 
         Fontist::Utils::Downloader.download(url, progress_bar: true).path
       end
-
-      def save(builder)
-        path = vacant_path
-        yaml = YAML.dump(Helpers::HashHelper.stringify_keys(builder.formula))
-        File.write(path, yaml)
-        path
-      end
-
-      def vacant_path
-        path = path_from_name
-        return path unless @options[:keep_existing] && File.exist?(path)
-
-        2.upto(9) do |i|
-          candidate = path.sub(/\.yml$/, "#{i}.yml")
-          return candidate unless File.exist?(candidate)
-        end
-
-        raise Errors::GeneralError, "Formula #{path} already exists."
-      end
-
-      def path_from_name
-        filename = Import.name_to_filename(builder.name)
-        if @options[:formula_dir]
-          File.join(@options[:formula_dir], filename)
-        else
-          filename
-        end
-      end
     end
   end
 end

data/lib/fontist/import/formula_builder.rb

@@ -1,49 +1,70 @@
 require "shellwords"
 require_relative "text_helper"
+require_relative "helpers/hash_helper"
 
 module Fontist
   module Import
     class FormulaBuilder
-      FORMULA_ATTRIBUTES = %i[platforms description homepage resources
+      FORMULA_ATTRIBUTES = %i[name platforms description homepage resources
                               font_collections fonts extract copyright
                               license_url requires_license_agreement
                               open_license digest command].freeze
 
-      attr_writer :archive,
-                  :url,
-                  :extractor,
+      attr_writer :resources,
                   :options,
                   :font_files,
                   :font_collection_files,
                   :license_text,
-                  :homepage
+                  :operations
 
       def initialize
         @options = {}
+        @font_files = []
+        @font_collection_files = []
       end
 
       def formula
         formula_attributes.map { |name| [name, send(name)] }.to_h.compact
       end
 
+      def save
+        path = vacant_path
+        yaml = YAML.dump(Helpers::HashHelper.stringify_keys(formula))
+        File.write(path, yaml)
+        path
+      end
+
+      private
+
+      def formula_attributes
+        FORMULA_ATTRIBUTES
+      end
+
       def name
+        @name ||= generate_name
+      end
+
+      def generate_name
         return @options[:name] if @options[:name]
 
-        common = %i[family_name type]
-          .map { |attr| both_fonts.map(&attr).uniq }
-          .map { |names| TextHelper.longest_common_prefix(names) }
-          .map { |prefix| prefix unless prefix == "Regular" }
-          .compact
-          .join(" ")
+        common = common_prefix
         return common unless common.empty?
 
         both_fonts.map(&:family_name).first
       end
 
-      private
+      def common_prefix
+        family_prefix = common_prefix_by_attr(:family_name)
+        style_prefix = common_prefix_by_attr(:type)
 
-      def formula_attributes
-        FORMULA_ATTRIBUTES
+        [family_prefix, style_prefix].compact.join(" ")
+      end
+
+      def common_prefix_by_attr(attr)
+        names = both_fonts.map(&attr).uniq
+        prefix = TextHelper.longest_common_prefix(names)
+
+        prefix unless prefix == "Regular"
       end
 
       def both_fonts
@@ -70,69 +91,7 @@ module Fontist
       end
 
       def resources
-        filename = name.gsub(" ", "_") + "." + @extractor.extension
-
-        { filename => resource_options }
-      end
-
-      def resource_options
-        if @options[:skip_sha]
-          resource_options_without_sha
-        else
-          resource_options_with_sha
-        end
-      end
-
-      def resource_options_without_sha
-        { urls: [@url] + mirrors, file_size: file_size }
-      end
-
-      def resource_options_with_sha
-        urls = []
-        sha = []
-        downloads do |url, path|
-          urls << url
-          sha << Digest::SHA256.file(path).to_s
-        end
-
-        sha = prepare_sha256(sha)
-
-        { urls: urls, sha256: sha, file_size: file_size }
-      end
-
-      def downloads
-        yield @url, @archive
-
-        mirrors.each do |url|
-          path = download(url)
-          next unless path
-
-          yield url, path
-        end
-      end
-
-      def mirrors
-        @options[:mirror] || []
-      end
-
-      def download(url)
-        Fontist::Utils::Downloader.download(url, progress_bar: true).path
-      rescue Errors::InvalidResourceError
-        Fontist.ui.error("WARN: a mirror is not found '#{url}'")
-        nil
-      end
-
-      def prepare_sha256(input)
-        output = input.uniq
-        return output.first if output.size == 1
-
-        checksums = output.join(", ")
-        Fontist.ui.error("WARN: SHA256 differs (#{checksums})")
-        output
-      end
-
-      def file_size
-        File.size(@archive)
+        @resources || raise("Resources should be set.")
       end
 
       def font_collections
@@ -175,7 +134,7 @@ module Fontist
       end
 
       def extract
-        @extractor.operations
+        @operations || {}
       end
 
       def copyright
@@ -197,9 +156,11 @@ module Fontist
 
         return unless @license_text
 
-        Fontist.ui.error("WARN: ensure it's an open license, otherwise " \
-                         "change the 'open_license' attribute to " \
-                         "'requires_license_agreement'")
+        unless @options[:open_license]
+          Fontist.ui.error("WARN: ensure it's an open license, otherwise " \
+                           "change the 'open_license' attribute to " \
+                           "'requires_license_agreement'")
+        end
 
         TextHelper.cleanup(@license_text)
       end
@@ -211,6 +172,27 @@ module Fontist
       def command
         Shellwords.shelljoin(ARGV)
       end
+
+      def vacant_path
+        path = path_from_name
+        return path unless @options[:keep_existing] && File.exist?(path)
+
+        2.upto(9) do |i|
+          candidate = path.sub(/\.yml$/, "#{i}.yml")
+          return candidate unless File.exist?(candidate)
+        end
+
+        raise Errors::GeneralError, "Formula #{path} already exists."
+      end
+
+      def path_from_name
+        filename = Import.name_to_filename(name)
+        if @options[:formula_dir]
+          File.join(@options[:formula_dir], filename)
+        else
+          filename
+        end
+      end
     end
   end
 end

data/lib/fontist/import/google/api.rb

@@ -0,0 +1,25 @@
+module Fontist
+  module Import
+    module Google
+      class Api
+        class << self
+          def items
+            db["items"]
+          end
+
+          def db
+            @db ||= JSON.parse(Net::HTTP.get(URI(url)))
+          end
+
+          def url
+            "https://www.googleapis.com/webfonts/v1/webfonts?key=#{api_key}"
+          end
+
+          def api_key
+            Fontist.google_fonts_key
+          end
+        end
+      end
+    end
+  end
+end