fontist 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f45a43c4f700cd793576c4783b7098beea7d366c8aeb2654fcc5b6a38c986b0
-  data.tar.gz: 01ce25c4eae85e3fb20b7cdf0d106a04a2273e770a4261e937c344520a723651
+  metadata.gz: 02323a2a83176e79be999c101277ab2d777986b07185ca8d18bbd47c0bae88ec
+  data.tar.gz: c5909e4220f762be25a22fe776f4273ef2affa44b68c3f16d6d181b83cfcf287
 SHA512:
-  metadata.gz: 6aae04a73aa89e5a7919430cecf56a8da1361bbe7b4a40a5676abe1ca02cc011e95681b7520a2d0ec3f47dd793af48c462f9deb1377b2547ba5d5edbc8c864e4
-  data.tar.gz: 541d57da927636744955a5917ad39d57fe793bb37b0c31d167252da9efea8815c3675d2e998ed7ef585921415733e2b393de19f16be433d2ca62cfdbf0d00f02
+  metadata.gz: 831d21fc0882000bf30003193d8b4bacf8bbe002c8d07bebb1b36ab05cf552cbd844f0ddd0998beb59bc059e54ed365f92e79020c673130a90b61d3db515a2d7
+  data.tar.gz: 88f6a870cda4177824d9c5499250e5a45a088afc269e185a942c71bd02ea4589539473e72445a13c38265e7de091a6ca95ffcbde37c4bed08c87c251a02f4cb8

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
@@ -151,6 +159,50 @@ 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
+```
+
+### TTC extraction
+
+The stripttc script is used for extraction of TTC files. It's taken from the
+https://github.com/DavidBarts/getfonts repository, and placed in the bin/
+directory.
+
 ## Contributing
 
 First, thank you for contributing! We love pull requests from everyone. By
@@ -177,3 +229,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,8 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fontist"
+require "fontist/cli"
+
+status_code = Fontist::CLI.start(ARGV)
+exit status_code.is_a?(Integer) ? status_code : 0

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,34 @@ 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 "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,7 @@ require "fontist/registry"
 require "fontist/formulas"
 require "fontist/formula"
 require "fontist/system_font"
+require "fontist/fontist_font"
 
 module Fontist
   def self.ui
@@ -34,19 +35,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

data/lib/fontist/cli.rb

@@ -0,0 +1,118 @@
+require "thor"
+
+module Fontist
+  class CLI < Thor
+    STATUS_SUCCESS = 0
+    STATUS_ERROR = 1
+
+    desc "install FONT", "Install font by font or formula"
+    def install(font)
+      fonts_paths = Fontist::Font.install(font)
+      Fontist.ui.success("These fonts are found or installed:")
+      Fontist.ui.success(fonts_paths.join("\n"))
+      STATUS_SUCCESS
+    rescue Fontist::Errors::NonSupportedFontError
+      Fontist.ui.error("Could not find font '#{font}'.")
+      STATUS_ERROR
+    end
+
+    desc "uninstall/remove FONT", "Uninstall font by font or formula"
+    def uninstall(font)
+      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
+      Fontist.ui.error("Could not find font '#{font}'.")
+      STATUS_ERROR
+    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?
+
+      print_formulas(formulas)
+      success
+    rescue Fontist::Errors::MissingFontError => e
+      error(e.message)
+    rescue Fontist::Errors::NonSupportedFontError
+      error("Could not find font '#{font}'.")
+    end
+
+    desc "list [FONT]", "List installation status of FONT or fonts in fontist"
+    def list(font = nil)
+      formulas = Fontist::Font.list(font)
+      print_list(formulas)
+      success
+    rescue Fontist::Errors::NonSupportedFontError
+      error("Could not find font '#{font}'.")
+    end
+
+    desc "update", "Update formulas"
+    def update
+      Formulas.fetch_formulas
+      Fontist.ui.say("Formulas have been successfully updated")
+      STATUS_SUCCESS
+    end
+
+    desc "create-formula URL", "Create a new formula with fonts from URL"
+    option :name, desc: "Example: Times New Roman"
+    option :mirror, repeatable: true
+    def create_formula(url)
+      require "fontist/import/create_formula"
+      name = Fontist::Import::CreateFormula.new(url, options).call
+      Fontist.ui.say("#{name} formula has been successfully created")
+      STATUS_SUCCESS
+    end
+
+    private
+
+    def success
+      STATUS_SUCCESS
+    end
+
+    def error(message)
+      Fontist.ui.error(message)
+      STATUS_ERROR
+    end
+
+    def print_formulas(formulas)
+      formulas.each do |formula, fonts|
+        Fontist.ui.success(formula.installer)
+
+        fonts.each do |font, styles|
+          Fontist.ui.success(" #{font.name}")
+
+          styles.each do |style, path|
+            Fontist.ui.success("  #{style.type} (#{path})")
+          end
+        end
+      end
+    end
+
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def print_list(formulas)
+      formulas.each do |formula, fonts|
+        Fontist.ui.say(formula.installer)
+
+        fonts.each do |font, styles|
+          Fontist.ui.say(" #{font.name}")
+
+          styles.each do |style, installed|
+            if installed
+              Fontist.ui.success("  #{style.type} (installed)")
+            else
+              Fontist.ui.error("  #{style.type} (uninstalled)")
+            end
+          end
+        end
+      end
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+  end
+end

data/lib/fontist/errors.rb

@@ -6,5 +6,8 @@ module Fontist
     class TamperedFileError < StandardError; end
     class InvalidResourceError < StandardError; end
     class TimeoutError < StandardError; end
+    class MissingAttributeError < StandardError; end
+    class FontNotFoundError < StandardError; end
+    class BinaryCallError < StandardError; end
   end
 end

data/lib/fontist/font.rb

@@ -19,6 +19,18 @@ module Fontist
       new(name: name, confirmation: confirmation).install
     end
 
+    def self.uninstall(name)
+      new(name: name).uninstall
+    end
+
+    def self.status(name)
+      new(name: name).status
+    end
+
+    def self.list(name)
+      new(name: name).list
+    end
+
     def find
       find_system_font || downloadable_font || raise(
         Fontist::Errors::NonSupportedFontError
@@ -31,6 +43,26 @@ module Fontist
       )
     end
 
+    def uninstall
+      uninstall_font || downloadable_font || raise(
+        Fontist::Errors::NonSupportedFontError
+      )
+    end
+
+    def status
+      return installed_statuses unless @name
+
+      font_status || downloadable_font || raise(
+        Fontist::Errors::NonSupportedFontError
+      )
+    end
+
+    def list
+      return all_list unless @name
+
+      font_list || raise(Fontist::Errors::NonSupportedFontError)
+    end
+
     def all
       Fontist::Formula.all.to_h.map { |_name, formula| formula.fonts }.flatten
     end
@@ -62,8 +94,8 @@ module Fontist
       if formula
         raise(
           Fontist::Errors::MissingFontError,
-"#{name}"          "Fonts are missing, please run " \
-          "Fontist::Font.install('#{name}', confirmation: 'yes') to " \
+          "#{name} fonts are missing, please run " \
+          "`fontist install '#{name}'` to " \
           "download the font."
         )
       end
@@ -109,5 +141,88 @@ module Fontist
         FONT LICENSE END ("#{name}")
       MSG
     end
+
+    def uninstall_font
+      paths = find_fontist_font
+      return unless paths
+
+      paths.each do |path|
+        File.delete(path)
+      end
+
+      paths
+    end
+
+    def find_fontist_font
+      Fontist::FontistFont.find(name)
+    end
+
+    def installed_statuses
+      installed_styles(all_formulas)
+    end
+
+    def all_formulas
+      Fontist::Formula.all.to_h.values
+    end
+
+    def font_status
+      return unless formula
+
+      statuses = installed_styles([formula])
+      statuses.empty? ? nil : statuses
+    end
+
+    def installed_styles(formulas)
+      filter_blank(formulas) do |formula|
+        filter_blank(formula.fonts) do |font|
+          filter_blank(font.styles) do |style|
+            path(style)
+          end
+        end
+      end
+    end
+
+    def filter_blank(elements)
+      elements.map { |e| [e, yield(e)] }
+        .to_h
+        .reject { |_k, v| v.nil? || v.empty? }
+    end
+
+    def path(style)
+      font_paths.grep(/#{style.font}/i).first
+    end
+
+    def font_paths
+      @font_paths ||= Dir.glob(Fontist.fonts_path.join("**"))
+    end
+
+    def all_list
+      list_styles(all_formulas)
+    end
+
+    def font_list
+      return unless formula
+
+      list_styles([formula])
+    end
+
+    def list_styles(formulas)
+      map_to_hash(formulas) do |formula|
+        map_to_hash(formula.fonts) do |font|
+          map_to_hash(font.styles) do |style|
+            installed(style)
+          end
+        end
+      end
+    end
+
+    def map_to_hash(elements)
+      elements.map { |e| [e, yield(e)] }.to_h
+    end
+
+    def installed(style)
+      path(style) ? true : false
+    end
+
   end
 end