fontist 1.3.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f45a43c4f700cd793576c4783b7098beea7d366c8aeb2654fcc5b6a38c986b0
-  data.tar.gz: 01ce25c4eae85e3fb20b7cdf0d106a04a2273e770a4261e937c344520a723651
+  metadata.gz: 4832b87f5d5535536b6f2f2e2761bf8ff8dbd82770703f93e201e2c7e81f496d
+  data.tar.gz: 32e720d4a33cb78a88bcdd8bf3b80bc24abec544d3dd755a459ae2a1a4a78d6b
 SHA512:
-  metadata.gz: 6aae04a73aa89e5a7919430cecf56a8da1361bbe7b4a40a5676abe1ca02cc011e95681b7520a2d0ec3f47dd793af48c462f9deb1377b2547ba5d5edbc8c864e4
-  data.tar.gz: 541d57da927636744955a5917ad39d57fe793bb37b0c31d167252da9efea8815c3675d2e998ed7ef585921415733e2b393de19f16be433d2ca62cfdbf0d00f02
+  metadata.gz: 6567b976d958bc852244e5080753eb1fc2e44f8231fe08f3cded4076d510c553565160cf83c108e2e6c309cce042393acf7e19ab34e5a851f4c879a7f9c642ae
+  data.tar.gz: 2bab58316fdc830954b93daa716deaac90912ee4906510fad27efba2c0323af8cdb9bade71d5a5f257461063576863b44e1bfc0b72f7cdde1839689acb497f95

data/.github/workflows/check_google.yml

@@ -0,0 +1,28 @@
+name: check_google
+
+on:
+  schedule:
+    - cron: '0 0 * * *'
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+
+      - name: Install otfinfo
+        run: sudo apt-get install lcdf-typetools
+
+      - name: Install bundler
+        run: gem install bundler
+
+      - name: Setup
+        run: bin/setup
+
+      - name: Check new fonts
+        run: TEST_ENV=CI bin/check_google

data/.github/workflows/macosx.yml

@@ -20,6 +20,9 @@ jobs:
         with:
           ruby-version: 2.6
 
+      - name: Install otfinfo
+        run: brew install lcdf-typetools
+
       - name: Install bundler
         run: gem install bundler
 

data/.github/workflows/ubuntu.yml

@@ -27,4 +27,4 @@ jobs:
         run: bin/setup
 
       - name: Run tests
-        run: TEST_ENV=CI bin/rspec
+        run: TEST_ENV=CI bin/rspec --tag ~dev

data/.github/workflows/windows.yml

@@ -29,4 +29,4 @@ jobs:
           bundle install --jobs 4 --retry 3
 
       - name: Run tests
-        run: bundle exec rspec --tag ~skip_in_windows
+        run: bundle exec rspec --tag ~skip_in_windows --tag ~dev

data/.gitignore

@@ -11,6 +11,12 @@ Gemfile.lock
 # fonts
 /spec/fixtures/fonts/*
 /spec/fixtures/fonts/DejaVuSerif.ttf
+/spec/fixtures/formulas/
+/spec/fixtures/*
+!/spec/fixtures/system.yml
 
 # rspec failure tracking
 .rspec_status
+
+# remote file cache
+.rubocop-*

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,22 @@
+inherit_from:
+  - 'https://raw.githubusercontent.com/fontist/oss-guides/master/ci/rubocop.yml'
+
+AllCops:
+  Exclude:
+    - 'lib/fontist/import/google/fonts_public.pb.rb'
+    - 'lib/fontist/formula_template.rb'
+
+Rails:
+  Enabled: false
+
+Metrics/LineLength:
+  Exclude:
+    - 'lib/fontist/formulas/**/*.rb'
+
+Layout/IndentFirstHashElement:
+  Exclude:
+    - 'lib/fontist/formulas/**/*.rb'
+
+Layout/IndentHeredoc:
+  Exclude:
+    - 'lib/fontist/formulas/**/*.rb'

data/README.md

@@ -26,6 +26,14 @@ Or install it yourself as:
 gem install fontist
 ```
 
+### Fetch formulas
+
+After installation please fetch formulas to your system:
+
+```sh
+fontist update
+```
+
 ## Usage
 
 ### Font
@@ -124,6 +132,182 @@ The return values are ` OpenStruct` object, so you can easily do any other
 operation you would do in any ruby object.
 
 
+### Manifest
+
+#### Locations
+
+Fontist lets find font locations from a YAML manifest of the following format:
+
+```yml
+Segoe UI:
+- Regular
+- Bold
+Roboto Mono:
+- Regular
+```
+
+Calling the following code returns a nested hash with font paths.
+
+```ruby
+Fontist::Manifest::Locations.call(manifest_path)
+```
+
+```ruby
+{"Segoe UI"=>
+  {"Regular"=>["/Users/user/.fontist/fonts/SEGOEUI.TTF"],
+   "Bold"=>["/Users/user/.fontist/fonts/SEGOEUIB.TTF"]},
+ "Roboto Mono"=>
+  {"Regular"=>[]}}
+```
+
+#### Install
+
+Fontist lets not only to get font locations but also to install fonts from the
+manifest:
+
+```ruby
+Fontist::Manifest::Install.call(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"]}}
+```
+
+### CLI
+
+These commands makes possible to operate with fonts via command line. The CLI
+properly supports exit status, so in a case of error it returns a status code
+higher or equal than 1.
+
+All searches are case-insensitive for ease of use.
+
+#### Install
+
+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.
+
+```
+$ fontist install "segoe ui"
+These fonts are found or installed:
+/Users/user/.fontist/fonts/SEGOEUI.TTF
+/Users/user/.fontist/fonts/SEGOEUIB.TTF
+/Users/user/.fontist/fonts/SEGOEUII.TTF
+/Users/user/.fontist/fonts/SEGOEUIZ.TTF
+```
+
+#### Uninstall
+
+Uninstalls any font supported by Fontist. Returns paths of an uninstalled font,
+or prints an error telling that the font isn't installed or could not be found
+in Fontist formulas. Aliased as `remove`.
+
+```
+$ fontist uninstall "segoe ui"
+These fonts are removed:
+/Users/user/.fontist/fonts/SEGOEUII.TTF
+/Users/user/.fontist/fonts/SEGOEUIZ.TTF
+/Users/user/.fontist/fonts/SEGOEUIB.TTF
+/Users/user/.fontist/fonts/SEGOEUI.TTF
+```
+
+#### Status
+
+Prints installed font paths grouped by formula and font.
+
+```
+$ fontist status "segoe ui"
+Fontist::Formulas::SegoeUIFont
+ Segoe UI
+  Regular (/Users/user/.fontist/fonts/SEGOEUI.TTF)
+  Bold (/Users/user/.fontist/fonts/SEGOEUIB.TTF)
+  Italic (/Users/user/.fontist/fonts/SEGOEUII.TTF)
+  Bold Italic (/Users/user/.fontist/fonts/SEGOEUIZ.TTF)
+```
+
+#### List
+
+Lists installation status of fonts supported by Fontist.
+
+```
+$ fontist list "segoe ui"
+Fontist::Formulas::SegoeUIFont
+ Segoe UI
+  Regular (installed)
+  Bold (installed)
+  Italic (installed)
+  Bold Italic (installed)
+```
+
+```
+$ fontist list "roboto mono"
+Fontist::Formulas::RobotoMonoFont
+ Roboto Mono
+  Regular (uninstalled)
+  Italic (uninstalled)
+```
+
+#### Locations from manifest
+
+Returns locations of fonts specified in a YAML file as an input.
+
+For example, if there is a file `manifest.yml`:
+
+```yml
+Segoe UI:
+- Regular
+- Bold
+Roboto Mono:
+- Regular
+```
+
+Then the command will return the following YAML output:
+
+```yml
+$ fontist manifest-locations manifest.yml
+---
+Segoe UI:
+  Regular:
+  - "/Users/user/.fontist/fonts/SEGOEUI.TTF"
+  Bold:
+  - "/Users/user/.fontist/fonts/SEGOEUIB.TTF"
+Roboto Mono:
+  Regular: []
+```
+
+Since Segoe UI is installed, but Roboto Mono is not.
+
+#### Install from manifest
+
+Install fonts from a YAML manifest:
+
+```yml
+$ fontist manifest-install --confirm-license manifest.yml
+---
+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"
+```
+
+#### Help
+
+List of all commands could be seen by:
+
+```
+fontist help
+```
+
 ## Development
 
 We are following Sandi Metz's Rules for this gem, you can read the
@@ -151,6 +335,44 @@ Run the test suite
 bin/rspec
 ```
 
+### Formulas storage
+
+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.
+
+### Auto-generate a formula
+
+A formula could be generated from a fonts archive. Just specify a URL to the
+archive:
+
+```sh
+fontist create-formula https://www.latofonts.com/download/lato2ofl-zip/
+cp lato.yml ~/.fontist/formulas/Formulas/
+cd ~/.fontist/formulas
+git add Formulas/lato.yml
+git commit -m "Add Lato formula"
+```
+
+### Google Import
+
+The library contains formulas for [Google Foonts][google-fonts]. A GHA workflow
+checks for fonts update every day. In case an update is found, it could be
+fetched to the library by:
+
+```
+bin/import_google
+```
+
+The script would update formulas which should be committed to a separate
+repository [formulas][fontist-formulas]:
+
+```
+cd ~/.fontist/formulas
+git add Formulas/google
+git commit -m "Google Fonts update"
+git push
+```
+
 ## Contributing
 
 First, thank you for contributing! We love pull requests from everyone. By
@@ -177,3 +399,5 @@ This gem is developed, maintained and funded by [Ribose Inc.][riboseinc]
 [issues]: https://github.com/fontist/fontist/issues
 [squash]: https://github.com/thoughtbot/guides/tree/master/protocol/git#write-a-feature
 [sandi-metz]: http://robots.thoughtbot.com/post/50655960596/sandi-metz-rules-for-developers
+[fontist-formulas]: https://github.com/fontist/formulas
+[google-fonts]: https://fonts.google.com

data/bin/check_google

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "fontist"
+require "fontist/import/google_check"
+
+Fontist::Import::GoogleCheck.new.call

data/bin/convert_formulas

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "fontist"
+require "fontist/import/convert_formulas"
+
+Fontist::Import::ConvertFormulas.new.call

data/bin/fontist

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "fontist"
+require "fontist/cli"
+
+status_code = Fontist::CLI.start(ARGV)
+exit status_code.is_a?(Integer) ? status_code : 1

data/bin/generate_otfinfo

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "fontist"
+require "fontist/import/otfinfo_generate"
+
+Fontist::Import::OtfinfoGenerate.new(ARGV[0]).call

data/bin/import_google

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "fontist"
+require "fontist/import/google_import"
+
+Fontist::Import::GoogleImport.new.call

data/fontist.gemspec

@@ -13,21 +13,35 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/fontist/fontist"
   spec.license       = "BSD-2-Clause"
 
+  spec.post_install_message = "Please run `fontist update` to fetch formulas"
+
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/fontist/fontist"
   spec.metadata["changelog_uri"] = "https://github.com/fontist/fontist"
 
   spec.require_paths = ["lib"]
-  spec.files         = `git ls-files`.split("\n")
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = ["fontist"]
   spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
 
   spec.add_runtime_dependency "down", "~> 5.0"
   spec.add_runtime_dependency "libmspack", "~> 0.1.0"
   spec.add_runtime_dependency "rubyzip", "~> 2.3.0"
+  spec.add_runtime_dependency "seven_zip_ruby", "~> 1.0"
+  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_development_dependency "extract_ttc", "~> 0.1"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "0.75.0"
+  spec.add_development_dependency "rubocop-rails"
+  spec.add_development_dependency "rubocop-performance"
+  spec.add_development_dependency "ruby-protocol-buffers", "~> 1.0"
 end

data/lib/fontist.rb

@@ -12,6 +12,8 @@ require "fontist/registry"
 require "fontist/formulas"
 require "fontist/formula"
 require "fontist/system_font"
+require "fontist/fontist_font"
+require "fontist/manifest"
 
 module Fontist
   def self.ui
@@ -34,19 +36,23 @@ module Fontist
     Fontist.fontist_path.join("fonts")
   end
 
+  def self.formulas_repo_path
+    Fontist.fontist_path.join("formulas")
+  end
+
+  def self.formulas_repo_url
+    "https://github.com/fontist/formulas.git"
+  end
+
   def self.formulas_path
-    Fontist.lib_path.join("fontist", "formulas")
+    Fontist.formulas_repo_path.join("Formulas")
   end
-end
 
-# Loading formulas
-#
-# The formula loading behavior is dynamic, so what we are actualy
-# doing here is looking for formulas in the `./fontist/formulas` directory
-# then require thos as we go.
-#
-# There is a caviat, since the `Dir` method depends on absoulate path
-# so moving this loading up or somewhere else might not always ensure
-# the fontist related path helpers.
-#
-Dir[Fontist.formulas_path.join("**.rb").to_s].sort.each { |file| require file }
+  def self.downloads_path
+    Fontist.fontist_path.join("downloads")
+  end
+
+  def self.system_file_path
+    Fontist.lib_path.join("fontist", "system.yml")
+  end
+end