fontist 1.8.13 → 1.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a094865cc9cb315ad328f795c59934f06663e8c43ff2931a0644da7aef7d8c7d
-  data.tar.gz: 170ee4d526e74992ee56593fb5fb715c400fe07c2ade9307faebcdcd8e32e47c
+  metadata.gz: e2cce6f6f02c9c70f594e7b6084ac854a74b903f27b49252047e898d47137a1f
+  data.tar.gz: d9cb729ca432229c90bf2cb0da204cf0cc401f997e1cd915e853e240613e35ea
 SHA512:
-  metadata.gz: 52ec33b7a2000ec5af4ae65165c0b0cdd22f1b0389b6c3ec89ed3a135ca3e55ac810a71cf9ce4621ae2398dcb77ed1dd2c8a45b077a2bfb8a1afc4a5d4d5efab
-  data.tar.gz: 30635f72fb0d39f2ecb0657b36ee89f6a48647e8f23ec896f8837323e76eb7964d3feeda3cf899f6d698e06681e815000e132c6c4a556695f340d59a351db214
+  metadata.gz: 6a5f1250db7da8b327716fcb1a22abf71c2ab3c57f58b4954efc82b2273f7e880c3d8519693925b13d3c3adf81fb5f261a912b13d95e69f0711b5716bd349d53
+  data.tar.gz: 293524c79e1be4ebbc8ef6db50a7de91e195d5921abd9e8fd1791597bfd80616bfe4d8d82eada54e71fcbdfaeab1baf6d72659e334111cf460b84c0d5193be1a

data/.github/workflows/metanorma.yml

@@ -2,7 +2,7 @@ name: metanorma
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main, v1.9.x ]
   pull_request:
 
 jobs:
@@ -13,7 +13,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.4', '2.5', '2.6', '2.7', '3.0' ]
+        ruby: [ '2.5', '2.6', '2.7', '3.0' ]
         os: [ ubuntu-latest, windows-latest, macos-latest ]
         experimental: [ true ]
     steps:

data/.github/workflows/rspec.yml

@@ -2,7 +2,7 @@ name: rspec
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main, v1.9.x ]
   pull_request:
 
 jobs:

data/README.md

@@ -399,6 +399,70 @@ bin/rspec
 All formulas are kept in the [formulas][fontist-formulas] repository. If you'd
 like to add a new one or change any existing, please refer to its documentation.
 
+### Private repos
+
+There is an ability to use private fonts via private fontist repo. Fontist repo
+is a git repo which contains YAML formula files. Formulas can be created
+manually (see [examples](https://github.com/fontist/formulas/tree/master/Formulas)),
+or [auto-generated from an archive](#auto-generate-a-formula).
+
+A repo can be either HTTPS or SSH Git repo. In case of SSH, a corresponding SSH key
+should be setup with ssh-agent in order to access this private repo.
+
+The `repo setup` command fetches a repo's formulas, and saves repo's name and url
+for later use.
+
+Internally all repos are stored at `~/.fontist/formulas/Formulas/private`.
+
+```sh
+fontist repo setup NAME URL
+```
+
+E.g.
+
+```sh
+fontist repo setup acme https://example.com/acme/formulas.git
+# or
+fontist repo setup acme git@example.com:acme/formulas.git
+```
+
+Then you can just install fonts from this repo:
+
+```sh
+fontist install "private font"
+```
+
+There is no need in any additional command to be run, but if you add new
+formulas to your repo, you can fetch them with the `repo update` command:
+
+```sh
+fontist repo update acme
+```
+
+If there is a need to avoid using private formulas, the repo can be removed with:
+
+```sh
+fontist repo remove acme
+```
+
+### Private formulas
+
+Authorization of private archives in private formulas can be implemented with
+headers. Here is an example which works with Github releases:
+
+```yaml
+resources:
+  fonts.zip:
+    urls:
+    - url: https://example.com/repos/acme/formulas/releases/assets/38777461
+      headers:
+        Accept: application/octet-stream
+        Authorization: token ghp_1234567890abcdefghi
+```
+
+A token can be obtained on [this page](https://github.com/settings/tokens).
+It should have at least the `repo` scope.
+
 ### Auto-generate a formula
 
 A formula could be generated from a fonts archive. Just specify a URL to the
@@ -409,20 +473,21 @@ fontist create-formula https://www.latofonts.com/download/lato2ofl-zip/
 cp lato.yml ~/.fontist/formulas/Formulas/
 ```
 
+Though indexes are auto-generated now, maintainers should rebuild indexes
+in the main repo for backward compatibility with fontist prior to 1.9.x versions.
 A formula index should be rebuild, when a new formula is generated or an
 existing one changed:
 
 ```sh
-fontist rebuild-index
+fontist rebuild-index --main-repo
 ```
 
-Then, both the formula and the updated index should be commited and pushed to
+Then, both the formula and the updated indexes should be commited and pushed to
 the formula repository:
 
 ```sh
 cd ~/.fontist/formulas
-git add Formulas/lato.yml
-git add index.yml
+git add Formulas/lato.yml index.yml filename_index.yml
 git commit -m "Add Lato formula"
 ```
 
@@ -441,7 +506,7 @@ repository [formulas][fontist-formulas]:
 
 ```
 cd ~/.fontist/formulas
-git add Formulas/google
+git add Formulas/google index.yml filename_index.yml
 git commit -m "Google Fonts update"
 git push
 ```
@@ -454,8 +519,7 @@ can be updated with:
 ```sh
 fontist import-sil
 cd ~/.fontist/formulas
-git add Formulas/sil
-git add index.yml
+git add Formulas/sil index.yml filename_index.yml
 git commit -m "SIL fonts update"
 git push
 ```

data/fontist.gemspec

@@ -40,7 +40,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "nokogiri", "~> 1.0"
   spec.add_development_dependency "rake", "~> 13"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rubocop", "0.75.0"
+  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"

data/lib/fontist.rb

@@ -7,6 +7,7 @@ require "singleton"
 require "fontist/errors"
 require "fontist/version"
 
+require "fontist/repo"
 require "fontist/font"
 require "fontist/formula"
 require "fontist/system_font"
@@ -28,7 +29,11 @@ module Fontist
   end
 
   def self.fontist_path
-    Pathname.new(ENV["FONTIST_PATH"] || File.join(Dir.home, ".fontist"))
+    Pathname.new(ENV["FONTIST_PATH"] || default_fontist_path)
+  end
+
+  def self.default_fontist_path
+    Pathname.new(File.join(Dir.home, ".fontist"))
   end
 
   def self.fonts_path
@@ -47,6 +52,10 @@ module Fontist
     Fontist.formulas_repo_path.join("Formulas")
   end
 
+  def self.private_formulas_path
+    Fontist.formulas_path.join("private")
+  end
+
   def self.downloads_path
     Fontist.fontist_path.join("downloads")
   end
@@ -60,10 +69,23 @@ module Fontist
   end
 
   def self.formula_index_path
-    Fontist.formulas_repo_path.join("index.yml")
+    @formula_index_path || Fontist.formula_index_dir.join("formula_index.yml")
+  end
+
+  def self.formula_index_path=(path)
+    @formula_index_path = path
   end
 
   def self.formula_filename_index_path
-    Fontist.formulas_repo_path.join("filename_index.yml")
+    @formula_filename_index_path ||
+      Fontist.formula_index_dir.join("filename_index.yml")
+  end
+
+  def self.formula_filename_index_path=(path)
+    @formula_filename_index_path = path
+  end
+
+  def self.formula_index_dir
+    Fontist.fontist_path
   end
 end

data/lib/fontist/cli.rb

@@ -1,4 +1,5 @@
 require "thor"
+require "fontist/repo_cli"
 
 module Fontist
   class CLI < Thor
@@ -10,6 +11,9 @@ module Fontist
     STATUS_MANIFEST_COULD_NOT_BE_FOUND_ERROR = 5
     STATUS_MANIFEST_COULD_NOT_BE_READ_ERROR = 6
     STATUS_FONT_INDEX_CORRUPTED = 7
+    STATUS_REPO_NOT_FOUND = 8
+    STATUS_MAIN_REPO_NOT_FOUND = 9
+    STATUS_REPO_COULD_NOT_BE_UPDATED = 10
 
     ERROR_TO_STATUS = {
       Fontist::Errors::UnsupportedFontError => [STATUS_NON_SUPPORTED_FONT_ERROR],
@@ -20,6 +24,8 @@ module Fontist
       Fontist::Errors::ManifestCouldNotBeReadError => [STATUS_MANIFEST_COULD_NOT_BE_READ_ERROR,
                                                        "Manifest could not be read."],
       Fontist::Errors::FontIndexCorrupted => [STATUS_FONT_INDEX_CORRUPTED],
+      Fontist::Errors::RepoNotFoundError => [STATUS_REPO_NOT_FOUND],
+      Fontist::Errors::MainRepoNotFoundError => [STATUS_MAIN_REPO_NOT_FOUND],
     }.freeze
 
     def self.exit_on_failure?
@@ -78,8 +84,11 @@ module Fontist
     desc "update", "Update formulas"
     def update
       Formula.update_formulas_repo
-      Fontist.ui.say("Formulas have been successfully updated")
+      Fontist.ui.success("Formulas have been successfully updated.")
       success
+    rescue Fontist::Errors::RepoCouldNotBeUpdatedError => e
+      Fontist.ui.error(e.message)
+      STATUS_REPO_COULD_NOT_BE_UPDATED
     end
 
     desc "manifest-locations MANIFEST",
@@ -123,11 +132,21 @@ module Fontist
 
     desc "rebuild-index", "Rebuild formula index (used by formulas maintainers)"
     long_desc <<-LONGDESC
-      This index is pre-built and served with formulas, so there is no need
-      update it unless something changes in the formulas repo.
+      Index should be rebuilt when any formula changes.
+
+      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
-      Fontist::Index.rebuild
+      if options[:main_repo]
+        Fontist::Index.rebuild_for_main_repo
+      else
+        Fontist::Index.rebuild
+      end
+
       Fontist.ui.say("Formula index has been rebuilt.")
       STATUS_SUCCESS
     end
@@ -138,6 +157,9 @@ module Fontist
       Fontist::Import::SilImport.new.call
     end
 
+    desc "repo SUBCOMMAND ...ARGS", "Manage custom repositories"
+    subcommand "repo", Fontist::RepoCLI
+
     private
 
     def success

data/lib/fontist/errors.rb

@@ -3,17 +3,37 @@ module Fontist
     class GeneralError < StandardError; end
 
     class BinaryCallError < GeneralError; end
+
     class FontIndexCorrupted < GeneralError; end
+
     class FontNotFoundError < GeneralError; end
+
+    # for backward compatibility with metanorma,
+    # it depends on this exception to automatically download formulas
     class FormulaIndexNotFoundError < GeneralError; end
+
+    class MainRepoNotFoundError < FormulaIndexNotFoundError; end
+
     class InvalidResourceError < GeneralError; end
+
     class LicensingError < GeneralError; end
+
     class ManifestCouldNotBeFoundError < GeneralError; end
+
     class ManifestCouldNotBeReadError < GeneralError; end
+
     class MissingAttributeError < GeneralError; end
+
+    class RepoNotFoundError < GeneralError; end
+
+    class RepoCouldNotBeUpdatedError < GeneralError; end
+
     class TamperedFileError < GeneralError; end
+
     class TimeoutError < GeneralError; end
+
     class UnknownFontTypeError < GeneralError; end
+
     class UnknownArchiveError < GeneralError; end
 
     class FontError < GeneralError

data/lib/fontist/font.rb

@@ -203,9 +203,9 @@ module Fontist
     end
 
     def font_list
-      return unless formula
+      return if formulas.empty?
 
-      list_styles([formula])
+      list_styles(formulas)
     end
 
     def list_styles(formulas)

data/lib/fontist/font_installer.rb

@@ -54,11 +54,12 @@ module Fontist
     end
 
     def download_file(source)
-      url = source.urls.first
+      request = source.urls.first
+      url = request.respond_to?(:url) ? request.url : request
       Fontist.ui.say(%(Downloading font "#{@formula.key}" from #{url}))
 
       Fontist::Utils::Downloader.download(
-        url,
+        request,
         sha: source.sha256,
         file_size: source.file_size,
         progress_bar: !@no_progress

data/lib/fontist/formula.rb

@@ -1,17 +1,12 @@
 require "fontist/index"
 require "fontist/helpers"
+require "fontist/update"
 require "git"
 
 module Fontist
   class Formula
     def self.update_formulas_repo
-      if Dir.exist?(Fontist.formulas_repo_path)
-        Git.open(Fontist.formulas_repo_path).pull
-      else
-        Git.clone(Fontist.formulas_repo_url,
-                  Fontist.formulas_repo_path,
-                  depth: 1)
-      end
+      Update.call
     end
 
     def self.all

data/lib/fontist/index.rb

@@ -3,9 +3,37 @@ require_relative "indexes/filename_index"
 
 module Fontist
   class Index
+    def self.rebuild_for_main_repo
+      unless Dir.exist?(Fontist.private_formulas_path)
+        return do_rebuild_for_main_repo_with
+      end
+
+      Dir.mktmpdir do |dir|
+        tmp_private_path = File.join(dir, "private")
+        FileUtils.mv(Fontist.private_formulas_path, tmp_private_path)
+
+        do_rebuild_for_main_repo_with
+
+        FileUtils.mv(tmp_private_path, Fontist.private_formulas_path)
+      end
+    end
+
+    def self.do_rebuild_for_main_repo_with
+      Fontist.formula_index_path = Fontist.formulas_repo_path.join("index.yml")
+      Fontist.formula_filename_index_path =
+        Fontist.formulas_repo_path.join("filename_index.yml")
+
+      rebuild
+
+      Fontist.formula_index_path = nil
+      Fontist.formula_filename_index_path = nil
+    end
+
     def self.rebuild
       Fontist::Indexes::FontIndex.rebuild
       Fontist::Indexes::FilenameIndex.rebuild
+
+      reset_cache
     end
 
     def self.reset_cache

data/lib/fontist/indexes/base_index.rb

@@ -5,10 +5,14 @@ module Fontist
     class BaseIndex
       def self.from_yaml
         @from_yaml ||= begin
-          unless File.exist?(path)
-            raise Errors::FormulaIndexNotFoundError.new("Please fetch `#{path}` index with `fontist update`.")
+          unless Dir.exist?(Fontist.formulas_repo_path)
+            raise Errors::MainRepoNotFoundError.new(
+              "Please fetch formulas with `fontist update`.",
+            )
           end
 
+          rebuild unless File.exist?(path)
+
           data = YAML.load_file(path)
           new(data)
         end
@@ -63,6 +67,8 @@ module Fontist
       end
 
       def to_yaml
+        dir = File.dirname(self.class.path)
+        FileUtils.mkdir_p(dir) unless File.exist?(dir)
         File.write(self.class.path, YAML.dump(to_h))
       end
 

data/lib/fontist/repo.rb

@@ -0,0 +1,60 @@
+require "git"
+
+module Fontist
+  class Repo
+    class << self
+      def setup(name, url)
+        ensure_private_formulas_path_exists
+        fetch_repo(name, url)
+        Index.rebuild
+      end
+
+      def update(name)
+        path = repo_path(name)
+        unless Dir.exist?(path)
+          raise(Errors::RepoNotFoundError, "No such repo '#{name}'.")
+        end
+
+        Git.open(path).pull
+        Index.rebuild
+      end
+
+      def remove(name)
+        path = repo_path(name)
+        unless Dir.exist?(path)
+          raise(Errors::RepoNotFoundError, "No such repo '#{name}'.")
+        end
+
+        FileUtils.rm_r(path)
+        Index.rebuild
+      end
+
+      def list
+        Dir.glob(Fontist.private_formulas_path.join("*"))
+          .select { |path| File.directory?(path) }
+          .map { |path| File.basename(path) }
+      end
+
+      private
+
+      def ensure_private_formulas_path_exists
+        Fontist.private_formulas_path.tap do |path|
+          FileUtils.mkdir_p(path) unless Dir.exist?(path)
+        end
+      end
+
+      def fetch_repo(name, url)
+        path = repo_path(name)
+        if Dir.exist?(path)
+          Git.open(path).pull
+        else
+          Git.clone(url, path, depth: 1)
+        end
+      end
+
+      def repo_path(name)
+        Fontist.private_formulas_path.join(name)
+      end
+    end
+  end
+end

data/lib/fontist/repo_cli.rb

@@ -0,0 +1,51 @@
+module Fontist
+  class RepoCLI < Thor
+    desc "setup NAME URL",
+         "Setup a custom fontist repo named NAME for the repository at URL " \
+         "and fetches its formulas"
+    def setup(name, url)
+      Repo.setup(name, url)
+      Fontist.ui.success(
+        "Fontist repo '#{name}' from '#{url}' has been successfully set up.",
+      )
+      CLI::STATUS_SUCCESS
+    end
+
+    desc "update NAME", "Update formulas in a fontist repo named NAME"
+    def update(name)
+      Repo.update(name)
+      Fontist.ui.success(
+        "Fontist repo '#{name}' has been successfully updated.",
+      )
+      CLI::STATUS_SUCCESS
+    rescue Errors::RepoNotFoundError
+      handle_repo_not_found(name)
+    end
+
+    desc "remove NAME", "Remove fontist repo named NAME"
+    def remove(name)
+      Repo.remove(name)
+      Fontist.ui.success(
+        "Fontist repo '#{name}' has been successfully removed.",
+      )
+      CLI::STATUS_SUCCESS
+    rescue Errors::RepoNotFoundError
+      handle_repo_not_found(name)
+    end
+
+    desc "list", "List fontist repos"
+    def list
+      Repo.list.each do |name|
+        Fontist.ui.say(name)
+      end
+      CLI::STATUS_SUCCESS
+    end
+
+    private
+
+    def handle_repo_not_found(name)
+      Fontist.ui.error("Fontist repo '#{name}' is not found.")
+      CLI::STATUS_REPO_NOT_FOUND
+    end
+  end
+end

data/lib/fontist/update.rb

@@ -0,0 +1,78 @@
+module Fontist
+  class Update
+    BRANCH = "master".freeze
+
+    def self.call
+      new(BRANCH).call
+    end
+
+    def initialize(branch = "main")
+      @branch = branch
+    end
+
+    def call
+      update_main_repo
+      update_private_repos
+    ensure
+      rebuild_index
+    end
+
+    private
+
+    def update_main_repo
+      dir = File.dirname(Fontist.formulas_repo_path)
+      FileUtils.mkdir_p(dir) unless File.exist?(dir)
+
+      unless Dir.exist?(Fontist.formulas_repo_path)
+        return Git.clone(Fontist.formulas_repo_url,
+                         Fontist.formulas_repo_path,
+                         branch: @branch,
+                         depth: 1)
+      end
+
+      git = Git.open(Fontist.formulas_repo_path)
+      return git.pull("origin", @branch) if git.current_branch == @branch
+
+      git.config("remote.origin.fetch",
+                 "+refs/heads/#{@branch}:refs/remotes/origin/#{@branch}")
+      git.fetch
+      git.checkout(@branch)
+      git.pull("origin", @branch)
+    end
+
+    def update_private_repos
+      private_repos.each do |path|
+        update_repo(path)
+      end
+    end
+
+    def update_repo(path)
+      Git.open(path).pull
+    rescue Git::GitExecuteError => e
+      name = repo_name(path)
+      raise Errors::RepoCouldNotBeUpdatedError.new(<<~MSG.chomp)
+        Formulas repo '#{name}' could not be updated.
+        Please consider reinitializing it with:
+          fontist remove #{name}
+          fontist setup #{name} REPO_URL
+
+        Git error:
+        #{e.message}
+      MSG
+    end
+
+    def private_repos
+      Dir.glob(Fontist.private_formulas_path.join("*")).select do |path|
+        File.directory?(path)
+      end
+    end
+
+    def repo_name(path)
+      File.basename(path)
+    end
+
+    def rebuild_index
+      Index.rebuild
+    end
+  end
+end

data/lib/fontist/utils/downloader.rb

@@ -20,7 +20,7 @@ module Fontist
       end
 
       def download
-        file = @cache.fetch(@file) do
+        file = @cache.fetch(url) do
           download_file
         end
 
@@ -56,9 +56,11 @@ module Fontist
 
       def download_file
         file = Down.download(
-          @file,
+          url,
           open_timeout: 10,
           read_timeout: 10,
+          max_redirects: 10,
+          headers: headers,
           content_length_proc: ->(content_length) {
             @progress_bar.total = content_length if content_length
           },
@@ -73,6 +75,17 @@ module Fontist
       rescue Down::NotFound
         raise(Fontist::Errors::InvalidResourceError.new("Invalid URL: #{@file}"))
       end
+
+      def url
+        @file.respond_to?(:url) ? @file.url : @file
+      end
+
+      def headers
+        @file.respond_to?(:headers) &&
+          @file.headers &&
+          @file.headers.to_h.map { |k, v| [k.to_s, v] }.to_h || # rubocop:disable Style/HashTransformKeys, Metrics/LineLength
+          {}
+      end
     end
 
     class ProgressBar

data/lib/fontist/utils/locking.rb

@@ -11,6 +11,7 @@ module Fontist
         yield
       ensure
         f.flock(File::LOCK_UN)
+        f.close
       end
     end
   end

data/lib/fontist/version.rb

@@ -1,3 +1,3 @@
 module Fontist
-  VERSION = "1.8.13".freeze
+  VERSION = "1.9.3".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fontist
 version: !ruby/object:Gem::Version
-  version: 1.8.13
+  version: 1.9.3
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-13 00:00:00.000000000 Z
+date: 2021-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: down
@@ -184,14 +184,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.75.0
+        version: 1.5.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.75.0
+        version: 1.5.2
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
@@ -302,9 +302,12 @@ files:
 - lib/fontist/manifest.rb
 - lib/fontist/manifest/install.rb
 - lib/fontist/manifest/locations.rb
+- lib/fontist/repo.rb
+- lib/fontist/repo_cli.rb
 - lib/fontist/system.yml
 - lib/fontist/system_font.rb
 - lib/fontist/system_index.rb
+- lib/fontist/update.rb
 - lib/fontist/utils.rb
 - lib/fontist/utils/cache.rb
 - lib/fontist/utils/downloader.rb
@@ -337,8 +340,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: Install openly-licensed fonts on Windows, Linux and Mac!
 test_files: []