fontist 1.4.0 → 1.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02323a2a83176e79be999c101277ab2d777986b07185ca8d18bbd47c0bae88ec
-  data.tar.gz: c5909e4220f762be25a22fe776f4273ef2affa44b68c3f16d6d181b83cfcf287
+  metadata.gz: e024a76941056e06491654749b2a467dd1df4212752a3a98e8a9ee58755af281
+  data.tar.gz: d7caaade9c91008f4e0b91b157847d2de4dd26203d88c3558583549fec3bdb5a
 SHA512:
-  metadata.gz: 831d21fc0882000bf30003193d8b4bacf8bbe002c8d07bebb1b36ab05cf552cbd844f0ddd0998beb59bc059e54ed365f92e79020c673130a90b61d3db515a2d7
-  data.tar.gz: 88f6a870cda4177824d9c5499250e5a45a088afc269e185a942c71bd02ea4589539473e72445a13c38265e7de091a6ca95ffcbde37c4bed08c87c251a02f4cb8
+  metadata.gz: 8d68a69167a89f6aa143f972da95f5bb06d2831e7e243d6c3ef338d47cc924b5b59c9f0404fad95dbd09b5ed870a555fae6a22e043a7a2eaa564b89036ddebfc
+  data.tar.gz: 3497ef80333b61a6a3df80f2493b3442779de017965cffbcffa13fbeb11a056de4f4741121100c8c7b34bd118e8af1aa1deaccad92423d8b68aa4b3b33c05c5a

data/README.md

@@ -132,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
@@ -197,12 +373,6 @@ 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

data/bin/fontist

@@ -1,8 +1,7 @@
 #!/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
+exit status_code.is_a?(Integer) ? status_code : 1

data/fontist.gemspec

@@ -34,7 +34,9 @@ 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 "rake", "~> 12.3.3"

data/lib/fontist.rb

@@ -13,6 +13,7 @@ require "fontist/formulas"
 require "fontist/formula"
 require "fontist/system_font"
 require "fontist/fontist_font"
+require "fontist/manifest"
 
 module Fontist
   def self.ui
@@ -54,4 +55,8 @@ 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
 end

data/lib/fontist/cli.rb

@@ -5,15 +5,23 @@ module Fontist
     STATUS_SUCCESS = 0
     STATUS_ERROR = 1
 
+    def self.exit_on_failure?
+      false
+    end
+
     desc "install FONT", "Install font by font or formula"
+    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"
     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"))
+      Fontist::Font.install(
+        font,
+        force: options[:force],
+        confirmation: options[:confirm_license] ? "yes" : "no"
+      )
       STATUS_SUCCESS
     rescue Fontist::Errors::NonSupportedFontError
-      Fontist.ui.error("Could not find font '#{font}'.")
-      STATUS_ERROR
+      could_not_find_font(font)
     end
 
     desc "uninstall/remove FONT", "Uninstall font by font or formula"
@@ -26,8 +34,7 @@ module Fontist
       Fontist.ui.error(e.message)
       STATUS_ERROR
     rescue Fontist::Errors::NonSupportedFontError
-      Fontist.ui.error("Could not find font '#{font}'.")
-      STATUS_ERROR
+      could_not_find_font(font)
     end
     map remove: :uninstall
 
@@ -41,7 +48,7 @@ module Fontist
     rescue Fontist::Errors::MissingFontError => e
       error(e.message)
     rescue Fontist::Errors::NonSupportedFontError
-      error("Could not find font '#{font}'.")
+      could_not_find_font(font)
     end
 
     desc "list [FONT]", "List installation status of FONT or fonts in fontist"
@@ -50,7 +57,7 @@ module Fontist
       print_list(formulas)
       success
     rescue Fontist::Errors::NonSupportedFontError
-      error("Could not find font '#{font}'.")
+      could_not_find_font(font)
     end
 
     desc "update", "Update formulas"
@@ -60,9 +67,39 @@ module Fontist
       STATUS_SUCCESS
     end
 
+    desc "manifest-locations MANIFEST",
+         "Get locations of fonts from MANIFEST (yaml)"
+    def manifest_locations(manifest)
+      paths = Fontist::Manifest::Locations.call(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.")
+    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(
+        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.")
+    end
+
     desc "create-formula URL", "Create a new formula with fonts from URL"
     option :name, desc: "Example: Times New Roman"
     option :mirror, repeatable: true
+    option :subarchive, desc: "Subarchive to choose when there are several ones"
+    option :subdir, desc: "Subdirectory to take fonts from"
     def create_formula(url)
       require "fontist/import/create_formula"
       name = Fontist::Import::CreateFormula.new(url, options).call
@@ -76,11 +113,24 @@ module Fontist
       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.")
+    end
+
     def error(message)
       Fontist.ui.error(message)
       STATUS_ERROR
     end
 
+    def print_yaml(object)
+      Fontist.ui.say(YAML.dump(object))
+    end
+
     def print_formulas(formulas)
       formulas.each do |formula, fonts|
         Fontist.ui.success(formula.installer)

data/lib/fontist/errors.rb

@@ -7,7 +7,10 @@ module Fontist
     class InvalidResourceError < StandardError; end
     class TimeoutError < StandardError; end
     class MissingAttributeError < StandardError; end
+    class UnknownFontTypeError < StandardError; end
     class FontNotFoundError < StandardError; end
     class BinaryCallError < StandardError; end
+    class ManifestCouldNotBeReadError < StandardError; end
+    class ManifestCouldNotBeFoundError < StandardError; end
   end
 end

data/lib/fontist/font.rb

@@ -3,6 +3,7 @@ module Fontist
     def initialize(options = {})
       @name = options.fetch(:name, nil)
       @confirmation = options.fetch(:confirmation, "no")
+      @force = options.fetch(:force, false)
 
       check_or_create_fontist_path!
     end
@@ -15,8 +16,12 @@ module Fontist
       new(name: name).find
     end
 
-    def self.install(name, confirmation: "no")
-      new(name: name, confirmation: confirmation).install
+    def self.install(name, confirmation: "no", force: false)
+      new(name: name, confirmation: confirmation, force: force).install
+    end
+
+    def self.try_install(name, confirmation: "no")
+      new(name: name, confirmation: confirmation).try_install
     end
 
     def self.uninstall(name)
@@ -38,11 +43,15 @@ module Fontist
     end
 
     def install
-      find_system_font || download_font || raise(
+      (find_system_font unless @force) || download_font || raise(
         Fontist::Errors::NonSupportedFontError
       )
     end
 
+    def try_install
+      download_font
+    end
+
     def uninstall
       uninstall_font || downloadable_font || raise(
         Fontist::Errors::NonSupportedFontError
@@ -72,7 +81,16 @@ module Fontist
     attr_reader :name, :confirmation
 
     def find_system_font
-      Fontist::SystemFont.find(name)
+      paths = Fontist::SystemFont.find(name)
+      unless paths
+        Fontist.ui.say(%(Font "#{name}" not found locally.))
+        return
+      end
+
+      Fontist.ui.say("Fonts found at:")
+      paths.each do |path|
+        Fontist.ui.say("- #{path}")
+      end
     end
 
     def check_or_create_fontist_path!
@@ -104,7 +122,13 @@ module Fontist
     def download_font
       if formula
         check_and_confirm_required_license(formula)
-        font_installer(formula).fetch_font(name, confirmation: confirmation)
+        paths = font_installer(formula).fetch_font(name,
+                                                   confirmation: confirmation)
+
+        Fontist.ui.say("Fonts installed at:")
+        paths.each do |path|
+          Fontist.ui.say("- #{path}")
+        end
       end
     end
 
@@ -223,6 +247,5 @@ module Fontist
     def installed(style)
       path(style) ? true : false
     end
-
   end
 end