fontist 1.8.12 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1ece96735fa8114f5ce56d56217b20208e8c5dced1c8d0b4092094ebac4ec17
-  data.tar.gz: 30e6189789d580d5c6bd56aa12d02c91057a05a286ec513469c4897d193a2542
+  metadata.gz: d2ed5346597364ad2d6cf6d2ecdc575baee6590f164cd79888a85c7ae0a67ed5
+  data.tar.gz: f7378c2d93061211db416dfa4ce7e49450dfd50ec01618f79dedb483d1a258ee
 SHA512:
-  metadata.gz: 20044f9435f70398c851eca878a846dad762c065ace4de9efcd6b1c05a3b5c6e9ab1f6bef4aefdf6231db020f3d5cb4454c5a2e4cf4c1f151f19288890449b11
-  data.tar.gz: d93ca29eedc83eeb4fb60b574ae254b277eb210e2e1e8fbcad68ad6a15d86f3f2fe981f549444fdfb13f559221cd2bc03b73f0a00a89496f7a22482c6493afa3
+  metadata.gz: 30e8c3f17d17c275e1942a07c113feda490e426afa762e4a6c93a283a99f97010da04b4bd954c13e8cc2504211ad273b9aeb84b6af12232d46cd1d19b7c8b244
+  data.tar.gz: 6d8e216241908538339ecb0a06a92f0b31a590eef0ffe2e81bee78a97b18204f4fc4f2b70113a79ea1d87f6c815b125bfb58e6db500942c5d1019098bb3812a0

data/.github/workflows/metanorma.yml

@@ -0,0 +1,35 @@
+name: metanorma
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+
+jobs:
+  test:
+    name: Test on Ruby ${{ matrix.ruby }} ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.5', '2.6', '2.7', '3.0' ]
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
+        experimental: [ true ]
+    steps:
+      - uses: actions/checkout@master
+        with:
+          repository: metanorma/metanorma
+
+      - uses: actions/checkout@master
+        with:
+          path: "fontist"
+
+      - run: 'echo ''gem "fontist", path: "./fontist"'' > Gemfile.devel'
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - run: bundle exec rake

data/.github/workflows/rspec.yml

@@ -2,7 +2,7 @@ name: rspec
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
 
 jobs:
@@ -13,19 +13,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.4', '2.5', '2.6', '2.7' ]
+        ruby: [ '2.4', '2.5', '2.6', '2.7', '3.0' ]
         os: [ ubuntu-latest, windows-latest, macos-latest ]
         experimental: [ false ]
-        include:
-          - ruby: '3.0'
-            os: 'ubuntu-latest'
-            experimental: true
-          - ruby: '3.0'
-            os: 'windows-latest'
-            experimental: true
-          - ruby: '3.0'
-            os: 'macos-latest'
-            experimental: true
 
     steps:
       - uses: actions/checkout@master

data/README.md

@@ -34,6 +34,18 @@ After installation please fetch formulas to your system:
 fontist update
 ```
 
+### Dependencies
+
+Depends on
+[ffi-libarchive-binary](https://github.com/fontist/ffi-libarchive-binary) which
+has the following requirements:
+
+* zlib
+* Expat
+* OpenSSL (for Linux only)
+
+These dependencies are generally present on all systems.
+
 ## Usage
 
 ### Font
@@ -387,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
@@ -397,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"
 ```
 
@@ -429,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
 ```
@@ -442,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,10 +7,10 @@ require "singleton"
 require "fontist/errors"
 require "fontist/version"
 
+require "fontist/repo"
 require "fontist/font"
 require "fontist/formula"
 require "fontist/system_font"
-require "fontist/fontist_font"
 require "fontist/manifest"
 require "fontist/helpers"
 
@@ -28,7 +28,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 +51,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
@@ -56,14 +64,52 @@ module Fontist
   end
 
   def self.system_index_path
-    Fontist.fontist_path.join("system_index.yml")
+    Fontist.fontist_path.join("system_index.default_family.yml")
+  end
+
+  def self.system_preferred_family_index_path
+    Fontist.fontist_path.join("system_index.preferred_family.yml")
+  end
+
+  def self.fontist_index_path
+    Fontist.fontist_path.join("fontist_index.default_family.yml")
+  end
+
+  def self.fontist_preferred_family_index_path
+    Fontist.fontist_path.join("fontist_index.preferred_family.yml")
   end
 
   def self.formula_index_path
-    Fontist.formulas_repo_path.join("index.yml")
+    Fontist.formula_index_dir.join("formula_index.default_family.yml")
+  end
+
+  def self.formula_preferred_family_index_path
+    @formula_preferred_family_index_path ||
+      Fontist.formula_index_dir.join("formula_index.preferred_family.yml")
+  end
+
+  def self.formula_preferred_family_index_path=(path)
+    @formula_preferred_family_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
+
+  def self.preferred_family?
+    !!@preferred_family
+  end
+
+  def self.preferred_family=(bool)
+    @preferred_family = bool
   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,12 +24,18 @@ 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?
       false
     end
 
+    class_option :preferred_family,
+                 type: :boolean,
+                 desc: "Use Preferred Family when available"
+
     desc "install FONT", "Install font"
     option :force, type: :boolean, aliases: :f,
                    desc: "Install even if it's already installed in system"
@@ -33,6 +43,7 @@ module Fontist
     option :hide_licenses, type: :boolean, desc: "Hide license texts"
     option :no_progress, type: :boolean, desc: "Hide download progress"
     def install(font)
+      handle_class_options(options)
       Fontist::Font.install(
         font,
         force: options[:force],
@@ -47,6 +58,7 @@ module Fontist
 
     desc "uninstall/remove FONT", "Uninstall font by font or formula"
     def uninstall(font)
+      handle_class_options(options)
       fonts_paths = Fontist::Font.uninstall(font)
       Fontist.ui.success("These fonts are removed:")
       Fontist.ui.success(fonts_paths.join("\n"))
@@ -58,6 +70,7 @@ module Fontist
 
     desc "status [FONT]", "Show paths of FONT or all fonts"
     def status(font = nil)
+      handle_class_options(options)
       paths = Fontist::Font.status(font)
       return error("No font is installed.", STATUS_MISSING_FONT_ERROR) if paths.empty?
 
@@ -68,6 +81,7 @@ module Fontist
 
     desc "list [FONT]", "List installation status of FONT or fonts in fontist"
     def list(font = nil)
+      handle_class_options(options)
       formulas = Fontist::Font.list(font)
       print_list(formulas)
       success
@@ -77,14 +91,19 @@ module Fontist
 
     desc "update", "Update formulas"
     def update
+      handle_class_options(options)
       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",
          "Get locations of fonts from MANIFEST (yaml)"
     def manifest_locations(manifest)
+      handle_class_options(options)
       paths = Fontist::Manifest::Locations.from_file(manifest)
       print_yaml(paths)
       success
@@ -96,6 +115,7 @@ module Fontist
     option :accept_all_licenses, type: :boolean, aliases: "--confirm-license", desc: "Accept all license agreements"
     option :hide_licenses, type: :boolean, desc: "Hide license texts"
     def manifest_install(manifest)
+      handle_class_options(options)
       paths = Fontist::Manifest::Install.from_file(
         manifest,
         confirmation: options[:accept_all_licenses] ? "yes" : "no",
@@ -115,6 +135,7 @@ module Fontist
     option :subdir, desc: "Subdirectory to take fonts from, starting with the " \
       "root dir, e.g.: stixfonts-2.10/fonts/static_otf. May include `fnmatch` patterns."
     def create_formula(url)
+      handle_class_options(options)
       require "fontist/import/create_formula"
       name = Fontist::Import::CreateFormula.new(url, options).call
       Fontist.ui.say("#{name} formula has been successfully created")
@@ -123,23 +144,43 @@ 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
+      handle_class_options(options)
+
+      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
 
     desc "import-sil", "Import formulas from SIL"
     def import_sil
+      handle_class_options(options)
       require "fontist/import/sil_import"
       Fontist::Import::SilImport.new.call
     end
 
+    desc "repo SUBCOMMAND ...ARGS", "Manage custom repositories"
+    subcommand "repo", Fontist::RepoCLI
+
     private
 
+    def handle_class_options(options)
+      Fontist.preferred_family = options[:preferred_family]
+    end
+
     def success
       STATUS_SUCCESS
     end