fontist 1.7.0 → 1.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4832b87f5d5535536b6f2f2e2761bf8ff8dbd82770703f93e201e2c7e81f496d
-  data.tar.gz: 32e720d4a33cb78a88bcdd8bf3b80bc24abec544d3dd755a459ae2a1a4a78d6b
+  metadata.gz: 1fea467133e3e6a8a287dd36a2a03790fb63859f983b0398f0f558de519a0a64
+  data.tar.gz: b8c717aef31834b5a9b3c3f903dacf0d267ddd85aa6f0a1eca34566a45b219bf
 SHA512:
-  metadata.gz: 6567b976d958bc852244e5080753eb1fc2e44f8231fe08f3cded4076d510c553565160cf83c108e2e6c309cce042393acf7e19ab34e5a851f4c879a7f9c642ae
-  data.tar.gz: 2bab58316fdc830954b93daa716deaac90912ee4906510fad27efba2c0323af8cdb9bade71d5a5f257461063576863b44e1bfc0b72f7cdde1839689acb497f95
+  metadata.gz: 20d44b20267db6f15f1b36be660f91690cef7c6f4b0653341231b3f18658ec0f88ea8225884b7b2ac1d06f3e8aa5be79aea600fed5be91513f43031a10b5de5b
+  data.tar.gz: 6138e6bed40c741f21c6d116f021aef9f6c7cca24506337fe681ba5e6c6e996c8e8e6a84e50103601231d6cab9f5cafc7b5527b418d65fbd6c1477c67ceda201

data/.github/workflows/release.yml

@@ -0,0 +1,38 @@
+name: release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  release:
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v1
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.6'
+
+      - run: bundle config set path 'vendor/bundle'
+
+      - run: bundle install --jobs 4 --retry 3
+
+      - run: bundle exec rspec --tag ~dev
+        env:
+          TEST_ENV: CI
+
+      - name: Publish to rubygems.org
+        env:
+          RUBYGEMS_API_KEY: ${{secrets.FONTIST_CI_RUBYGEMS_API_KEY}}
+        run: |
+          gem install gem-release
+          touch ~/.gem/credentials
+          cat > ~/.gem/credentials << EOF
+          ---
+          :rubygems_api_key: ${RUBYGEMS_API_KEY}
+          EOF
+          chmod 0600 ~/.gem/credentials
+          git status
+          gem release

data/.github/workflows/rspec.yml

@@ -0,0 +1,58 @@
+name: rspec
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+
+jobs:
+  build:
+    name: Test on Ruby ${{ matrix.ruby }} ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.6', '2.5', '2.4' ]
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
+        experimental: [ false ]
+        include:
+          - ruby: '2.7'
+            os: 'ubuntu-latest'
+            experimental: true
+          - ruby: '2.7'
+            os: 'windows-latest'
+            experimental: true
+          - ruby: '2.7'
+            os: 'macos-latest'
+            experimental: true
+
+    steps:
+      - uses: actions/checkout@master
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: bundle-${{ matrix.os }}-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}
+          restore-keys: bundle-${{ matrix.os }}-${{ matrix.ruby }}
+
+      - if: matrix.os == 'macos-latest'
+        run: brew install lcdf-typetools
+
+      - run: bundle config set path 'vendor/bundle'
+
+      - run: bundle install --jobs 4 --retry 3
+
+      - if: matrix.os == 'macos-latest'
+        run: bundle exec rspec
+        env:
+          TEST_ENV: CI
+
+      - if: matrix.os != 'macos-latest'
+        run: bundle exec rspec --tag ~dev
+        env:
+          TEST_ENV: CI

data/README.md

@@ -44,7 +44,7 @@ can we find a font in your system.
 
 #### Finding a font
 
-The `Fontist::Fontist.find` interface can be used a find a font in your system.
+The `Fontist::Font.find` interface can be used a find a font in your system.
 It will look into the operating system specific font directories, and also the
 fontist specific `~/.fontist` directory.
 
@@ -109,7 +109,7 @@ fonts in your system.
 #### Find formula fonts
 
 Normally, each font name can be associated with multiple styles or collection, for
-example the `Calibri` font might contains a `regular`, `bola` or `italic` styles
+example the `Calibri` font might contains a `regular`, `bold` or `italic` styles
 fonts and if you want a interface that can return the complete list then this is
 your friend. You can use it as following:
 
@@ -136,28 +136,29 @@ operation you would do in any ruby object.
 
 #### Locations
 
-Fontist lets find font locations from a YAML manifest of the following format:
+Fontist lets find font locations from a manifest of the following format:
 
-```yml
-Segoe UI:
-- Regular
-- Bold
-Roboto Mono:
-- Regular
+```ruby
+{"Segoe UI"=>["Regular", "Bold"],
+ "Roboto Mono"=>["Regular"]}
 ```
 
-Calling the following code returns a nested hash with font paths.
+Calling the following code returns a nested hash with font paths and names.
+Font name is useful to choose a specific font in a font collection file (TTC).
 
 ```ruby
-Fontist::Manifest::Locations.call(manifest_path)
+Fontist::Manifest::Locations.from_hash(manifest)
 ```
 
 ```ruby
-{"Segoe UI"=>
-  {"Regular"=>["/Users/user/.fontist/fonts/SEGOEUI.TTF"],
-   "Bold"=>["/Users/user/.fontist/fonts/SEGOEUIB.TTF"]},
- "Roboto Mono"=>
-  {"Regular"=>[]}}
+{"Segoe UI"=> {
+   "Regular"=>{"full_name"=>"Segoe UI",
+               "paths"=>["/Users/user/.fontist/fonts/SEGOEUI.TTF"]},
+   "Bold"=>{"full_name"=>"Segoe UI Bold",
+            "paths"=>["/Users/user/.fontist/fonts/SEGOEUIB.TTF"]}},
+ "Roboto Mono"=> {
+   "Regular"=>{"full_name"=>nil,
+               "paths"=>[]}}}
 ```
 
 #### Install
@@ -166,17 +167,41 @@ Fontist lets not only to get font locations but also to install fonts from the
 manifest:
 
 ```ruby
-Fontist::Manifest::Install.call(manifest, confirmation: "yes")
+Fontist::Manifest::Install.from_hash(manifest, confirmation: "yes")
 ```
 
 It will install fonts and return their locations:
 
 ```ruby
-{"Segoe UI"=>
-  {"Regular"=>["/Users/user/.fontist/fonts/SEGOEUI.TTF"],
-   "Bold"=>["/Users/user/.fontist/fonts/SEGOEUIB.TTF"]},
- "Roboto Mono"=>
-  {"Regular"=>["/Users/user/.fontist/fonts/RobotoMono-VariableFont_wght.ttf"]}}
+{"Segoe UI"=> {
+   "Regular"=>{"full_name"=>"Segoe UI",
+               "paths"=>["/Users/user/.fontist/fonts/SEGOEUI.TTF"]},
+   "Bold"=>{"full_name"=>"Segoe UI Bold",
+            "paths"=>["/Users/user/.fontist/fonts/SEGOEUIB.TTF"]}},
+ "Roboto Mono"=> {
+   "Regular"=>{"full_name"=>"Roboto Mono Regular",
+               "paths"=>["/Users/user/.fontist/fonts/RobotoMono-VariableFont_wght.ttf"]}}}
+```
+
+#### Support of YAML format
+
+Both commands support a YAML file as an input with a `from_file` method. For
+example, if there is a `manifest.yml` file containing:
+
+```yaml
+Segoe UI:
+- Regular
+- Bold
+Roboto Mono:
+- Regular
+```
+
+Then the following calls would return font names and paths, as from the
+`from_hash` method (see [Locations](#locations) and [Install](#install)).
+
+```ruby
+Fontist::Manifest::Locations.from_file("manifest.yml")
+Fontist::Manifest::Install.from_file("manifest.yml", confirmation: "yes")
 ```
 
 ### CLI
@@ -191,7 +216,8 @@ All searches are case-insensitive for ease of use.
 
 The `install` command is similar to the `Font.install` call. It first checks
 whether this font is already installed, and if not, then installs the font and
-returns its paths. Font or formula could be specified as a name.
+returns its paths. Only font name (not formula name, nor font filename) could
+be used as a parameter.
 
 ```
 $ fontist install "segoe ui"
@@ -223,7 +249,7 @@ Prints installed font paths grouped by formula and font.
 
 ```
 $ fontist status "segoe ui"
-Fontist::Formulas::SegoeUIFont
+segoe_ui
  Segoe UI
   Regular (/Users/user/.fontist/fonts/SEGOEUI.TTF)
   Bold (/Users/user/.fontist/fonts/SEGOEUIB.TTF)
@@ -237,7 +263,7 @@ Lists installation status of fonts supported by Fontist.
 
 ```
 $ fontist list "segoe ui"
-Fontist::Formulas::SegoeUIFont
+segoe_ui
  Segoe UI
   Regular (installed)
   Bold (installed)
@@ -247,7 +273,7 @@ Fontist::Formulas::SegoeUIFont
 
 ```
 $ fontist list "roboto mono"
-Fontist::Formulas::RobotoMonoFont
+google/roboto_mono
  Roboto Mono
   Regular (uninstalled)
   Italic (uninstalled)
@@ -274,11 +300,17 @@ $ fontist manifest-locations manifest.yml
 ---
 Segoe UI:
   Regular:
-  - "/Users/user/.fontist/fonts/SEGOEUI.TTF"
+    full_name: Segoe UI
+    paths:
+    - "/Users/user/.fontist/fonts/SEGOEUI.TTF"
   Bold:
-  - "/Users/user/.fontist/fonts/SEGOEUIB.TTF"
+    full_name: Segoe UI Bold
+    paths:
+    - "/Users/user/.fontist/fonts/SEGOEUIB.TTF"
 Roboto Mono:
-  Regular: []
+  Regular:
+    full_name:
+    paths: []
 ```
 
 Since Segoe UI is installed, but Roboto Mono is not.
@@ -292,12 +324,18 @@ $ fontist manifest-install --confirm-license manifest.yml
 ---
 Segoe UI:
   Regular:
-  - "/Users/user/.fontist/fonts/SEGOEUI.TTF"
+    full_name: Segoe UI
+    paths:
+    - "/Users/user/.fontist/fonts/SEGOEUI.TTF"
   Bold:
-  - "/Users/user/.fontist/fonts/SEGOEUIB.TTF"
+    full_name: Segoe UI Bold
+    paths:
+    - "/Users/user/.fontist/fonts/SEGOEUIB.TTF"
 Roboto Mono:
   Regular:
-  - "/Users/user/.fontist/fonts/RobotoMono-VariableFont_wght.ttf"
+    full_name: Roboto Mono Regular
+    paths:
+    - "/Users/user/.fontist/fonts/RobotoMono-VariableFont_wght.ttf"
 ```
 
 #### Help
@@ -308,6 +346,15 @@ List of all commands could be seen by:
 fontist help
 ```
 
+### Configuration
+
+By default Fontist uses the `~/.fontist` directory to store fonts and its
+files. It could be changed with the `FONTIST_PATH` environment variable.
+
+```sh
+FONTIST_PATH=~/.fontist_new fontist update
+```
+
 ## Development
 
 We are following Sandi Metz's Rules for this gem, you can read the
@@ -348,8 +395,22 @@ archive:
 ```sh
 fontist create-formula https://www.latofonts.com/download/lato2ofl-zip/
 cp lato.yml ~/.fontist/formulas/Formulas/
+```
+
+A formula index should be rebuild, when a new formula is generated or an
+existing one changed:
+
+```sh
+fontist rebuild-index
+```
+
+Then, both the formula and the updated index should be commited and pushed to
+the formula repository:
+
+```sh
 cd ~/.fontist/formulas
 git add Formulas/lato.yml
+git add index.yml
 git commit -m "Add Lato formula"
 ```
 
@@ -373,6 +434,36 @@ git commit -m "Google Fonts update"
 git push
 ```
 
+### Import of SIL fonts
+
+Fontist contains formulas of [SIL fonts](https://software.sil.org/fonts/). They
+can be updated with:
+
+```sh
+fontist import-sil
+cd ~/.fontist/formulas
+git add Formulas/sil
+git add index.yml
+git commit -m "SIL fonts update"
+git push
+```
+
+### Releasing
+
+Releasing is done automatically with GitHub Action. Just bump and tag with `gem-release`.
+
+For a patch release (0.0.x) use:
+
+```sh
+gem bump --version patch --tag --push
+```
+
+For a minor release (0.x.0) use:
+
+```sh
+gem bump --version minor --tag --push
+```
+
 ## Contributing
 
 First, thank you for contributing! We love pull requests from everyone. By

data/fontist.gemspec

@@ -21,9 +21,9 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ["lib"]
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+    f.match(%r{^(bin|test|spec|features)/})
   end
-  spec.bindir        = "bin"
+  spec.bindir        = "exe"
   spec.executables   = ["fontist"]
   spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
 
@@ -34,10 +34,13 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "ruby-ole", "~> 1.0"
   spec.add_runtime_dependency "thor", "~> 1.0.1"
   spec.add_runtime_dependency "git", "~> 1.0"
+  spec.add_runtime_dependency "ttfunk", "~> 1.0"
 
   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", "~> 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rubocop", "0.75.0"

data/lib/fontist.rb

@@ -8,12 +8,11 @@ require "fontist/errors"
 require "fontist/version"
 
 require "fontist/font"
-require "fontist/registry"
-require "fontist/formulas"
 require "fontist/formula"
 require "fontist/system_font"
 require "fontist/fontist_font"
 require "fontist/manifest"
+require "fontist/helpers"
 
 module Fontist
   def self.ui
@@ -29,7 +28,7 @@ module Fontist
   end
 
   def self.fontist_path
-    Pathname.new(Dir.home).join(".fontist")
+    Pathname.new(ENV["FONTIST_PATH"] || File.join(Dir.home, ".fontist"))
   end
 
   def self.fonts_path
@@ -55,4 +54,12 @@ module Fontist
   def self.system_file_path
     Fontist.lib_path.join("fontist", "system.yml")
   end
+
+  def self.system_index_path
+    Fontist.fontist_path.join("system_index.yml")
+  end
+
+  def self.formula_index_path
+    Fontist.formulas_repo_path.join("index.yml")
+  end
 end

data/lib/fontist/cli.rb

@@ -3,13 +3,28 @@ require "thor"
 module Fontist
   class CLI < Thor
     STATUS_SUCCESS = 0
-    STATUS_ERROR = 1
+    STATUS_UNKNOWN_ERROR = 1
+    STATUS_NON_SUPPORTED_FONT_ERROR = 2
+    STATUS_MISSING_FONT_ERROR = 3
+    STATUS_LICENSING_ERROR = 4
+    STATUS_MANIFEST_COULD_NOT_BE_FOUND_ERROR = 5
+    STATUS_MANIFEST_COULD_NOT_BE_READ_ERROR = 6
+
+    ERROR_TO_STATUS = {
+      Fontist::Errors::NonSupportedFontError => [STATUS_NON_SUPPORTED_FONT_ERROR],
+      Fontist::Errors::MissingFontError => [STATUS_MISSING_FONT_ERROR],
+      Fontist::Errors::LicensingError => [STATUS_LICENSING_ERROR],
+      Fontist::Errors::ManifestCouldNotBeFoundError => [STATUS_MANIFEST_COULD_NOT_BE_FOUND_ERROR,
+                                                        "Manifest could not be found."],
+      Fontist::Errors::ManifestCouldNotBeReadError => [STATUS_MANIFEST_COULD_NOT_BE_READ_ERROR,
+                                                       "Manifest could not be read."],
+    }.freeze
 
     def self.exit_on_failure?
       false
     end
 
-    desc "install FONT", "Install font by font or formula"
+    desc "install FONT", "Install font"
     option :force, type: :boolean, aliases: :f,
                    desc: "Install even if it's already installed in system"
     option :confirm_license, type: :boolean, desc: "Confirm license agreement"
@@ -19,9 +34,9 @@ module Fontist
         force: options[:force],
         confirmation: options[:confirm_license] ? "yes" : "no"
       )
-      STATUS_SUCCESS
-    rescue Fontist::Errors::NonSupportedFontError
-      could_not_find_font(font)
+      success
+    rescue Fontist::Errors::GeneralError => e
+      handle_error(e)
     end
 
     desc "uninstall/remove FONT", "Uninstall font by font or formula"
@@ -29,26 +44,21 @@ module Fontist
       fonts_paths = Fontist::Font.uninstall(font)
       Fontist.ui.success("These fonts are removed:")
       Fontist.ui.success(fonts_paths.join("\n"))
-      STATUS_SUCCESS
-    rescue Fontist::Errors::MissingFontError => e
-      Fontist.ui.error(e.message)
-      STATUS_ERROR
-    rescue Fontist::Errors::NonSupportedFontError
-      could_not_find_font(font)
+      success
+    rescue Fontist::Errors::GeneralError => e
+      handle_error(e)
     end
     map remove: :uninstall
 
     desc "status [FONT]", "Show status of FONT or all fonts in fontist"
     def status(font = nil)
       formulas = Fontist::Font.status(font)
-      return error("No font is installed.") if formulas.empty?
+      return error("No font is installed.", STATUS_MISSING_FONT_ERROR) if formulas.empty?
 
       print_formulas(formulas)
       success
-    rescue Fontist::Errors::MissingFontError => e
-      error(e.message)
-    rescue Fontist::Errors::NonSupportedFontError
-      could_not_find_font(font)
+    rescue Fontist::Errors::GeneralError => e
+      handle_error(e)
     end
 
     desc "list [FONT]", "List installation status of FONT or fonts in fontist"
@@ -56,43 +66,39 @@ module Fontist
       formulas = Fontist::Font.list(font)
       print_list(formulas)
       success
-    rescue Fontist::Errors::NonSupportedFontError
-      could_not_find_font(font)
+    rescue Fontist::Errors::GeneralError => e
+      handle_error(e)
     end
 
     desc "update", "Update formulas"
     def update
-      Formulas.fetch_formulas
+      Formula.update_formulas_repo
       Fontist.ui.say("Formulas have been successfully updated")
-      STATUS_SUCCESS
+      success
     end
 
     desc "manifest-locations MANIFEST",
          "Get locations of fonts from MANIFEST (yaml)"
     def manifest_locations(manifest)
-      paths = Fontist::Manifest::Locations.call(manifest)
+      paths = Fontist::Manifest::Locations.from_file(manifest)
       print_yaml(paths)
       success
-    rescue Fontist::Errors::ManifestCouldNotBeFoundError
-      error("Manifest could not be found.")
-    rescue Fontist::Errors::ManifestCouldNotBeReadError
-      error("Manifest could not be read.")
+    rescue Fontist::Errors::GeneralError => e
+      handle_error(e)
     end
 
     desc "manifest-install MANIFEST", "Install fonts from MANIFEST (yaml)"
     option :confirm_license, type: :boolean, desc: "Confirm license agreement"
     def manifest_install(manifest)
-      paths = Fontist::Manifest::Install.call(
+      paths = Fontist::Manifest::Install.from_file(
         manifest,
         confirmation: options[:confirm_license] ? "yes" : "no"
       )
 
       print_yaml(paths)
       success
-    rescue Fontist::Errors::ManifestCouldNotBeFoundError
-      error("Manifest could not be found.")
-    rescue Fontist::Errors::ManifestCouldNotBeReadError
-      error("Manifest could not be read.")
+    rescue Fontist::Errors::GeneralError => e
+      handle_error(e)
     end
 
     desc "create-formula URL", "Create a new formula with fonts from URL"
@@ -104,27 +110,42 @@ module Fontist
       require "fontist/import/create_formula"
       name = Fontist::Import::CreateFormula.new(url, options).call
       Fontist.ui.say("#{name} formula has been successfully created")
+      success
+    end
+
+    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.
+    LONGDESC
+    def rebuild_index
+      Fontist::Index.rebuild
+      Fontist.ui.say("Formula index has been rebuilt.")
       STATUS_SUCCESS
     end
 
+    desc "import-sil", "Import formulas from SIL"
+    def import_sil
+      require "fontist/import/sil_import"
+      Fontist::Import::SilImport.new.call
+    end
+
     private
 
     def success
       STATUS_SUCCESS
     end
 
-    def could_not_find_font(font)
-      error("Font '#{font}' not found locally nor available in the Fontist " \
-            "formula repository.\n" \
-            "Perhaps it is available at the latest Fontist formula " \
-            "repository.\n" \
-            "You can update the formula repository using the command " \
-            "`fontist update` and try again.")
+    def handle_error(exception)
+      status, message = ERROR_TO_STATUS[exception.class]
+      raise exception unless status
+
+      error(message || exception.message, status)
     end
 
-    def error(message)
+    def error(message, status)
       Fontist.ui.error(message)
-      STATUS_ERROR
+      status
     end
 
     def print_yaml(object)
@@ -133,7 +154,7 @@ module Fontist
 
     def print_formulas(formulas)
       formulas.each do |formula, fonts|
-        Fontist.ui.success(formula.installer)
+        Fontist.ui.success(formula.key)
 
         fonts.each do |font, styles|
           Fontist.ui.success(" #{font.name}")
@@ -148,7 +169,7 @@ module Fontist
     # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
     def print_list(formulas)
       formulas.each do |formula, fonts|
-        Fontist.ui.say(formula.installer)
+        Fontist.ui.say(formula.key)
 
         fonts.each do |font, styles|
           Fontist.ui.say(" #{font.name}")