fontist 1.11.1 → 1.11.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f06401d4ccf76cfda39bcd4eae443dbfb2f5284876c4f5a9361fcb56bb97f5a
-  data.tar.gz: 5730fc169549b7b3dda74f6e9cae5d3fb3b15c27d1f7d107f16ab5b1be9cdeb8
+  metadata.gz: ebc9110896000190889a313f291012ebc3b84a7296230398ee61c9822c44ea87
+  data.tar.gz: 9de28427a3a46124e8ded2880de764ad9bb632bc9c919babe15123fc38eebdb3
 SHA512:
-  metadata.gz: bcc0837022c84b93e97e07a19494cd2b28bd51a41834809d4833fb1a453a0314fa37f6249ddb171e6b8f12e8f31c56fa660f661376895c7d9f1a417542626a1c
-  data.tar.gz: c46f1f7610213bf168f485d724e215bd2fd5f276802481a647eba9580e4dfc8d0307e3b014a3ee29ceda992548f294251d1600a64efc3086ff1b101420ced3a1
+  metadata.gz: 005c1c9a434bbfa11da8602be4180e20056798afccf4c302204e6d986c6a288d7ee6cbfb387c597db79fe4ae86e50aa22729d4553813b7f025d27a1033c83f19
+  data.tar.gz: 8584ca32768a87ce2ddfd95275e6f22a9b61074df2db8b407f587931cc2729b444dd257f6435fd564bd0588a2bcf5d6e2634f611cf73a87d76ec517a86de4edf

data/.github/workflows/metanorma.yml

@@ -2,11 +2,8 @@ name: metanorma
 
 on:
   push:
-    # restore the main branch after metanorma upgrade
-    # branches: [ main ]
-    branches: [ unknown ]
-  # restore after metanorma upgrade
-  # pull_request:
+    branches: [ main ]
+  pull_request:
 
 jobs:
   test:

data/.github/workflows/rspec.yml

@@ -14,7 +14,7 @@ jobs:
       fail-fast: false
       matrix:
         ruby: [ '2.4', '2.5', '2.6', '2.7', '3.0' ]
-        os: [ ubuntu-latest, windows-latest, macos-latest ]
+        os: [ ubuntu-18.04, ubuntu-latest, windows-latest, macos-latest ]
         experimental: [ false ]
 
     steps:

data/README.adoc

@@ -51,6 +51,34 @@ has the following requirements:
 
 These dependencies are generally present on all systems.
 
+=== Upgrading Fontist
+
+==== To v1.10+
+
+Fontist versions beyond v1.10 utilize a new formula format.
+After the upgrade, please run `fontist update` to fetch the latest formulas.
+
+Starting from v1.10, Fontist uses the "`default family`" instead of the "`preferred family`"
+when grouping styles.
+
+For example, a request for the "`Lato`" font prior to v1.10 will return all
+styles: "`Black`", "`Black Italic`", "`Bold`", and 15 other styles.
+
+From v1.10 onwards, Fontist will return _only_ the 4 default styles:
+"`Regular`", "`Italic`", "`Bold`" and "`Bold Italic`".
+
+In order to fetch other styles, you have to specify the exact font
+"`subfamily`", such as "`Lato Black`", or "`Lato Heavy`", or use
+the `--preferred-family` option with CLI and `Fontist.preferred_family = true`
+with the Ruby library.
+
+NOTE: Prior to v1.10 there was a bug with the "`Courier`" font formula, which
+allowed the font to be installed when requesting the font name "`Courier`", but
+its font location was only obtainable using the full "`Courier New`" font name.
+From v1.10 onwards the behavior has been made consistent -- only the proper
+"`Courier New`" name should be used.
+
+
 == Usage of the `fontist` command
 
 === Fontist command-line interface
@@ -62,13 +90,18 @@ code higher or equal than 1.
 
 All searches are case-insensitive for ease of use.
 
+=== Global options
+
+All commands support the following options:
+
+* `--preferred-family` Use the preferred family names when searching for fonts. This format was used prior to v1.10.
+
 === Install fonts
 
 Fontist checks whether this font is already installed, and if not, then installs
 the font and returns its installed paths.
 
-Only the font name (not formula name, nor font filename) could be used as its
-argument.
+The font name is the only argument to be supplied (the font family name).
 
 [source,sh]
 ----
@@ -80,6 +113,8 @@ These fonts are found or installed:
 /Users/user/.fontist/fonts/SEGOEUIZ.TTF
 ----
 
+NOTE: Specifying the formula's name or the font's filename is not supported.
+
 NOTE: The `install` command is similar to the `Font.install` library call.
 
 === Uninstall fonts
@@ -350,6 +385,16 @@ operation you would do in any ruby object.
 
 === `Fontist::Manifest`
 
+==== Global options
+
+Fontist can be switched to use the preferred family names. This format was
+used prior to v1.10.
+
+[source,ruby]
+----
+Fontist.preferred_family = true
+----
+
 [[fontist-locations]]
 ==== `Fontist::Manifest::Locations`
 
@@ -565,7 +610,7 @@ In case an update is found, it could be fetched to the library by:
 
 [source,sh]
 ----
-bin/import_google
+bin/fontist google import
 ----
 
 The script would update formulas which should be committed to a separate
@@ -573,8 +618,8 @@ repository https://github.com/fontist/formulas[formulas]:
 
 [source,sh]
 ----
-cd ~/.fontist/formulas
-git add Formulas/google index.yml filename_index.yml
+cd ~/.fontist/versions/v2/formulas
+git add Formulas/google
 git commit -m "Google Fonts update"
 git push
 ----
@@ -640,8 +685,8 @@ one, please refer to its documentation.
 There is an ability to use private fonts via private Fontist repositories.
 
 A Fontist repository is a Git repo which contains YAML formula files. Formulas can be created
-manually (see https://github.com/fontist/formulas/tree/master/Formulas)[examples],
-or #auto-generate-a-formula[auto-generated from an archive].
+manually (see https://github.com/fontist/formulas/tree/master/Formulas[examples]),
+or xref:Authoring Fontist formulas[auto-generated from an archive].
 
 A repository can be either a HTTPS or SSH Git repo. In case of SSH, a
 corresponding SSH key should be setup with `ssh-agent` in order to access this
@@ -740,9 +785,10 @@ sub-licenses to third parties, under the copyright covering the contribution to
 use the contribution by all means.
 
 We are following Sandi Metz's Rules for this gem, you can read the
-http://robots.thoughtbot.com/post/50655960596/sandi-metz-rules-for-developers[description of the rules here] All new code should follow these
-rules. If you make changes in a pre-existing file that violates these rules you
-should fix the violations as part of your contribution.
+http://robots.thoughtbot.com/post/50655960596/sandi-metz-rules-for-developers[description of the rules here].
+All new code should follow these rules. If you make changes in a pre-existing
+file that violates these rules you should fix the violations as part of your
+contribution.
 
 Here are a few technical guidelines to follow:
 

data/fontist.gemspec

@@ -28,22 +28,22 @@ Gem::Specification.new do |spec|
   spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
 
   spec.add_runtime_dependency "down", "~> 5.0"
+  spec.add_runtime_dependency "extract_ttc", "~> 0.1"
   spec.add_runtime_dependency "thor", "~> 1.0.1"
   spec.add_runtime_dependency "git", "~> 1.0"
   spec.add_runtime_dependency "ttfunk", "~> 1.6"
   spec.add_runtime_dependency "excavate", "~> 0.1"
 
-  spec.add_development_dependency "extract_ttc", "~> 0.1"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "gem-release"
   spec.add_development_dependency "nokogiri", "~> 1.0"
   spec.add_development_dependency "rake", "~> 13"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-benchmark", "~> 0.6"
   spec.add_development_dependency "rubocop", "1.5.2"
   spec.add_development_dependency "rubocop-rails"
   spec.add_development_dependency "rubocop-performance"
-  spec.add_development_dependency "ruby-protocol-buffers", "~> 1.0"
 
   spec.add_runtime_dependency "socksify"
 end

data/lib/fontist/cli.rb

@@ -1,5 +1,6 @@
 require "thor"
 require "fontist/repo_cli"
+require "fontist/google_cli"
 
 module Fontist
   class CLI < Thor
@@ -149,18 +150,9 @@ module Fontist
       It is done automatically when formulas are updated, or private formulas
       are set up.
     LONGDESC
-    option :main_repo, type: :boolean,
-                       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
-        Fontist::Index.rebuild
-      end
-
+      Fontist::Index.rebuild
       Fontist.ui.say("Formula index has been rebuilt.")
       STATUS_SUCCESS
     end
@@ -175,6 +167,9 @@ module Fontist
     desc "repo SUBCOMMAND ...ARGS", "Manage custom repositories"
     subcommand "repo", Fontist::RepoCLI
 
+    desc "google SUBCOMMAND ...ARGS", "Manage Google formulas"
+    subcommand "google", Fontist::GoogleCLI
+
     private
 
     def handle_class_options(options)

data/lib/fontist/font_installer.rb

@@ -54,16 +54,30 @@ module Fontist
     end
 
     def download_file(source)
-      request = source.urls.first
-      url = request.respond_to?(:url) ? request.url : request
-      Fontist.ui.say(%(Downloading font "#{@formula.key}" from #{url}))
+      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
+
+      raise Errors::InvalidResourceError, errors.join(" ")
+    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
     end
 
     def font_file?(path)

data/lib/fontist/formula.rb

@@ -103,6 +103,10 @@ module Fontist
       @fonts ||= Helpers.parse_to_object(hash_collection_fonts + hash_fonts)
     end
 
+    def digest
+      @data["digest"]
+    end
+
     private
 
     def default_key

data/lib/fontist/google_cli.rb

@@ -0,0 +1,29 @@
+module Fontist
+  class GoogleCLI < Thor
+    class_option :formulas_path, type: :string, desc: "Path to formulas"
+
+    desc "check", "Check Google fonts for updates"
+    def check
+      handle_class_options(options)
+      require "fontist/import/google_check"
+      Fontist::Import::GoogleCheck.new.call
+      CLI::STATUS_SUCCESS
+    end
+
+    desc "import", "Import Google fonts"
+    def import
+      handle_class_options(options)
+      require "fontist/import/google_import"
+      Fontist::Import::GoogleImport.new.call
+      CLI::STATUS_SUCCESS
+    end
+
+    private
+
+    def handle_class_options(options)
+      if options[:formulas_path]
+        Fontist.formulas_path = Pathname.new(options[:formulas_path])
+      end
+    end
+  end
+end

data/lib/fontist/import/formula_builder.rb

@@ -6,7 +6,7 @@ module Fontist
     class FormulaBuilder
       FORMULA_ATTRIBUTES = %i[name description homepage resources
                               font_collections fonts extract copyright
-                              license_url open_license command].freeze
+                              license_url open_license digest command].freeze
 
       attr_accessor :archive,
                     :url,
@@ -60,6 +60,18 @@ module Fontist
       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 }
+      end
+
+      def resource_options_with_sha
         urls = []
         sha = []
         downloads do |url, path|
@@ -167,6 +179,10 @@ module Fontist
         TextHelper.cleanup(@license_text)
       end
 
+      def digest
+        @options[:digest]
+      end
+
       def command
         Shellwords.shelljoin(ARGV)
       end

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

@@ -1,4 +1,3 @@
-require_relative "fonts_public.pb"
 require_relative "../google"
 require_relative "../otf_parser"
 
@@ -6,7 +5,7 @@ module Fontist
   module Import
     module Google
       class NewFontsFetcher
-        REPO_PATH = Fontist.root_path.join("tmp", "fonts")
+        REPO_PATH = Fontist.fontist_path.join("google", "fonts")
         REPO_URL = "https://github.com/google/fonts.git".freeze
         SKIPLIST_PATH = File.expand_path("skiplist.yml", __dir__)
 
@@ -25,7 +24,8 @@ module Fontist
           if Dir.exist?(REPO_PATH)
             `cd #{REPO_PATH} && git pull`
           else
-            `git clone #{REPO_URL} #{REPO_PATH}`
+            FileUtils.mkdir_p(File.dirname(REPO_PATH))
+            `git clone --depth 1 #{REPO_URL} #{REPO_PATH}`
           end
         end
 
@@ -53,23 +53,11 @@ module Fontist
         end
 
         def new?(path)
-          metadata = fetch_metadata(path)
-          return unless metadata
-
-          font_new?(metadata, path)
-        end
-
-        def fetch_metadata(path)
-          metadata_path = File.join(path, "METADATA.pb")
-          return unless File.exists?(metadata_path)
-
-          ::Google::Fonts::FamilyProto.parse_from_text(File.read(metadata_path))
-        end
-
-        def font_new?(metadata, path)
-          return if in_skiplist?(metadata.name)
-          return if up_to_date?(metadata, path)
-          return unless downloadable?(metadata.name)
+          metadata_name = Google.metadata_name(path)
+          return unless metadata_name
+          return if in_skiplist?(metadata_name)
+          return if up_to_date?(metadata_name, path)
+          return unless downloadable?(metadata_name)
 
           true
         end
@@ -79,29 +67,47 @@ module Fontist
           @skiplist.include?(name)
         end
 
-        def up_to_date?(metadata, path)
-          formula = formula(metadata.name)
+        def up_to_date?(metadata_name, path)
+          formula = formula(metadata_name)
           return false unless formula
 
-          styles = formula.fonts.map(&:styles).flatten
+          repo_digest_up_to_date?(formula, path) ||
+            fonts_up_to_date?(formula, path)
+        end
+
+        def repo_digest_up_to_date?(formula, path)
+          return unless formula.digest
 
-          styles.all? do |style|
-            style.version == otfinfo_version(font_path(style.font, path))
+          formula.digest == Google.digest(path)
+        end
+
+        def fonts_up_to_date?(formula, path)
+          styles = formula_styles(formula)
+          repo_fonts(path).all? do |font|
+            style = styles.find { |s| s.font == repo_to_archive_name(font) }
+            return false unless style
+
+            otfinfo_version(font) == style.version
           end
         end
 
-        def formula(font_name)
-          klass = font_name.gsub(/ /, "").sub(/\S/, &:upcase)
-          @formulas ||= Fontist::Formula.all
-          @formulas["Fontist::Formulas::#{klass}Font"]
+        def formula_styles(formula)
+          formula.fonts.map(&:styles).flatten
         end
 
-        def font_path(filename, directory)
-          File.join(directory, fix_variable_filename(filename))
+        def repo_fonts(path)
+          Dir.glob(File.join(path, "*.{ttf,otf}"))
         end
 
-        def fix_variable_filename(filename)
-          filename.sub("-VariableFont_wght", "[wght]")
+        def repo_to_archive_name(font_path)
+          File.basename(font_path)
+            .sub("[wght]", "-VariableFont_wght")
+            .sub("[opsz]", "-Regular-VariableFont_opsz")
+        end
+
+        def formula(font_name)
+          path = Fontist::Import::Google.formula_path(font_name)
+          Formula.new_from_file(path) if File.exist?(path)
         end
 
         def otfinfo_version(path)
@@ -110,10 +116,15 @@ module Fontist
         end
 
         def downloadable?(name)
+          retries ||= 0
+          retries += 1
           Down.open("https://fonts.google.com/download?family=#{name}")
           true
         rescue Down::NotFound
           false
+        rescue Down::TimeoutError
+          retry unless retries >= 3
+          false
         end
       end
     end

data/lib/fontist/import/google.rb

@@ -1,11 +1,29 @@
 module Fontist
   module Import
     module Google
+      def self.metadata_name(path)
+        metadata_path = File.join(path, "METADATA.pb")
+        return unless File.exists?(metadata_path)
+
+        File.foreach(metadata_path) do |line|
+          name = line.match(/^name: "(.+)"/)
+          return name[1] if name
+        end
+      end
+
       def self.formula_path(name)
         filename = name.downcase.gsub(" ", "_") + ".yml"
         Fontist.formulas_path.join("google", filename)
       end
 
+      def self.digest(path)
+        checksums = Dir.glob(File.join(path, "*.{ttf,otf,ttc}"))
+          .sort
+          .map { |x| Digest::SHA256.file(x).to_s }
+
+        Digest::SHA256.hexdigest(checksums.to_s)
+      end
+
       def self.style_version(text)
         return unless text
 

data/lib/fontist/import/google_check.rb

@@ -4,17 +4,12 @@ module Fontist
   module Import
     class GoogleCheck
       def call
-        fetch_formulas
         fonts = new_fonts
         indicate(fonts)
       end
 
       private
 
-      def fetch_formulas
-        Formula.update_formulas_repo
-      end
-
       def new_fonts
         Fontist::Import::Google::NewFontsFetcher.new(logging: true).call
       end
@@ -26,8 +21,6 @@ module Fontist
         new_paths.each do |path|
           puts path
         end
-
-        abort
       end
     end
   end