fontist 1.9.0 → 1.11.1

data/README.md

@@ -399,16 +399,20 @@ 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.
 
-### Privare repos
+### 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 corresponding SSH key should be setup with ssh-agent in order to access this private repo.
+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.
 
-Private fontist repo can be set up with:
+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
@@ -418,15 +422,24 @@ 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"
 ```
 
-Later, to fetch changes the following command can be used:
+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 these formulas, the repo can be removed with:
+If there is a need to avoid using private formulas, the repo can be removed with:
 
 ```sh
 fontist repo remove acme
@@ -511,6 +524,18 @@ git commit -m "SIL fonts update"
 git push
 ```
 
+### Using with proxy
+
+`fontist` can read proxy settings from environemnt variables:
+
+* `HTTP_PROXY`
+* `SOCKS_PROXY`
+
+Also because `fontist` uses git under the hood, proxy must be configured in `~/.gitconfig` separately.
+Check [nice guide](https://gist.github.com/evantoli/f8c23a37eb3558ab8765) about how it can be configured for more details
+
+Also as for regular URL you can pass username and password, like `http://username:password@example.com/` for SOCKS it's similar
+
 ### Releasing
 
 Releasing is done automatically with GitHub Action. Just bump and tag with `gem-release`.

data/exe/fontist

@@ -3,5 +3,27 @@
 require "fontist"
 require "fontist/cli"
 
-status_code = Fontist::CLI.start(ARGV)
-exit status_code.is_a?(Integer) ? status_code : 1
+fontist_cli = proc {
+  status_code = Fontist::CLI.start(ARGV)
+  exit status_code.is_a?(Integer) ? status_code : 1
+}
+
+if ENV["SOCKS_PROXY"]
+  require "socksify"
+  require "uri"
+  begin
+    proxy = URI.parse(ENV["SOCKS_PROXY"])
+    if proxy.userinfo
+      user, pass = proxy.userinfo.split(":")
+      TCPSocket::socks_username = user
+      TCPSocket::socks_password = pass
+    end
+    Socksify::proxy(proxy.host, proxy.port, &fontist_cli)
+  rescue URI::InvalidURIError
+    warn "Value of ENV.SOCKS_PROXY=#{ENV['SOCKS_PROXY']} is invalid! Droping it"
+    ENV.delete("SOCKS_PROXY")
+    fontist_cli.call
+  end
+else
+  fontist_cli.call
+end

data/fontist.gemspec

@@ -44,4 +44,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rubocop-rails"
   spec.add_development_dependency "rubocop-performance"
   spec.add_development_dependency "ruby-protocol-buffers", "~> 1.0"
+
+  spec.add_runtime_dependency "socksify"
 end

data/lib/fontist.rb

@@ -11,7 +11,6 @@ require "fontist/repo"
 require "fontist/font"
 require "fontist/formula"
 require "fontist/system_font"
-require "fontist/fontist_font"
 require "fontist/manifest"
 require "fontist/helpers"
 
@@ -65,15 +64,32 @@ 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
-    @formula_index_path || Fontist.formula_index_dir.join("formula_index.yml")
+    Fontist.formula_index_dir.join("formula_index.default_family.yml")
   end
 
-  def self.formula_index_path=(path)
-    @formula_index_path = path
+  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
@@ -88,4 +104,12 @@ module Fontist
   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

@@ -13,6 +13,7 @@ module Fontist
     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],
@@ -31,6 +32,10 @@ module Fontist
       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"
@@ -38,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],
@@ -52,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"))
@@ -63,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?
 
@@ -73,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
@@ -82,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
@@ -101,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",
@@ -120,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")
@@ -137,6 +153,8 @@ module Fontist
                        desc: "Updates indexes in the main repo (for backward " \
                              "compatibility with versions prior to 1.9)"
     def rebuild_index
+      handle_class_options(options)
+
       if options[:main_repo]
         Fontist::Index.rebuild_for_main_repo
       else
@@ -149,6 +167,7 @@ module Fontist
 
     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
@@ -158,6 +177,10 @@ module Fontist
 
     private
 
+    def handle_class_options(options)
+      Fontist.preferred_family = options[:preferred_family]
+    end
+
     def success
       STATUS_SUCCESS
     end

data/lib/fontist/errors.rb

@@ -26,6 +26,8 @@ module Fontist
 
     class RepoNotFoundError < GeneralError; end
 
+    class RepoCouldNotBeUpdatedError < GeneralError; end
+
     class TamperedFileError < GeneralError; end
 
     class TimeoutError < GeneralError; end

data/lib/fontist/font.rb

@@ -166,7 +166,7 @@ module Fontist
     end
 
     def uninstall_font
-      paths = find_fontist_font
+      paths = find_fontist_paths
       return unless paths
 
       paths.each do |path|
@@ -176,8 +176,13 @@ module Fontist
       paths
     end
 
-    def find_fontist_font
-      Fontist::FontistFont.find(name)
+    def find_fontist_paths
+      fonts = Fontist::SystemIndex.fontist_index.find(name, nil)
+      return unless fonts
+
+      fonts.map do |font|
+        font[:path]
+      end
     end
 
     def installed_paths

data/lib/fontist/formula.rb

@@ -1,22 +1,12 @@
 require "fontist/index"
 require "fontist/helpers"
+require "fontist/update"
 require "git"
 
 module Fontist
   class Formula
     def self.update_formulas_repo
-      dir = File.dirname(Fontist.formulas_repo_path)
-      FileUtils.mkdir_p(dir) unless File.exist?(dir)
-
-      if Dir.exist?(Fontist.formulas_repo_path)
-        Git.open(Fontist.formulas_repo_path).pull
-      else
-        Git.clone(Fontist.formulas_repo_url,
-                  Fontist.formulas_repo_path,
-                  depth: 1)
-      end
-
-      Index.rebuild
+      Update.call
     end
 
     def self.all

data/lib/fontist/import/files/collection_file.rb

@@ -11,7 +11,7 @@ module Fontist
         def initialize(path)
           @path = path
           @fonts = read
-          @extension = "ttc"
+          @extension = detect_extension
         end
 
         def filename
@@ -46,6 +46,15 @@ module Fontist
             File.join(tmp_dir, filename)
           end
         end
+
+        def detect_extension
+          base_extension = "ttc"
+
+          file_extension = File.extname(File.basename(@path)).sub(/^\./, "")
+          return file_extension if file_extension.casecmp?(base_extension)
+
+          base_extension
+        end
       end
     end
   end

data/lib/fontist/import/formula_builder.rb

@@ -1,3 +1,4 @@
+require "shellwords"
 require_relative "text_helper"
 
 module Fontist
@@ -5,7 +6,7 @@ module Fontist
     class FormulaBuilder
       FORMULA_ATTRIBUTES = %i[name description homepage resources
                               font_collections fonts extract copyright
-                              license_url open_license].freeze
+                              license_url open_license command].freeze
 
       attr_accessor :archive,
                     :url,
@@ -49,7 +50,7 @@ module Fontist
       end
 
       def homepage
-        both_fonts.first.homepage
+        both_fonts.map(&:homepage).compact.first
       end
 
       def resources
@@ -129,7 +130,7 @@ module Fontist
 
         fonts = groups.map do |name, group|
           { name: name,
-            styles: group.map(&style_type) }
+            styles: styles_from_files(group, style_type) }
         end
 
         fonts.sort_by do |x|
@@ -137,16 +138,20 @@ module Fontist
         end
       end
 
+      def styles_from_files(files, style_type)
+        files.map(&style_type).sort_by { |x| x[:type] }
+      end
+
       def extract
         @extractor.operations
       end
 
       def copyright
-        both_fonts.first.copyright
+        both_fonts.map(&:copyright).compact.first
       end
 
       def license_url
-        both_fonts.first.license_url
+        both_fonts.map(&:license_url).compact.first
       end
 
       def open_license
@@ -161,6 +166,10 @@ module Fontist
 
         TextHelper.cleanup(@license_text)
       end
+
+      def command
+        Shellwords.shelljoin(ARGV)
+      end
     end
   end
 end

data/lib/fontist/import/google_import.rb

@@ -156,6 +156,10 @@ module Fontist
           h.merge!(family_name: style.family_name,
                    type: style.style,
                    full_name: style.full_name)
+          if style.preferred_family_name
+            h[:preferred_family_name] = style.preferred_family_name
+          end
+          h[:preferred_type] = style.preferred_style if style.preferred_style
           h.merge!(style.to_h.select do |k, _|
             %i(post_script_name version description copyright).include?(k)
           end.compact)

data/lib/fontist/import/otf/font_file.rb

@@ -10,7 +10,8 @@ module Fontist
           otfinfo: Otfinfo::OtfinfoRequirement.new,
         }.freeze
 
-        STYLE_ATTRIBUTES = %i[family_name type full_name post_script_name
+        STYLE_ATTRIBUTES = %i[family_name type preferred_family_name
+                              preferred_type full_name post_script_name
                               version description copyright font
                               source_font].freeze
 
@@ -35,11 +36,19 @@ module Fontist
         end
 
         def family_name
-          info["Preferred family"] || info["Family"]
+          info["Family"]
         end
 
         def type
-          info["Preferred subfamily"] || info["Subfamily"]
+          info["Subfamily"]
+        end
+
+        def preferred_family_name
+          info["Preferred family"]
+        end
+
+        def preferred_type
+          info["Preferred subfamily"]
         end
 
         def full_name
@@ -97,7 +106,11 @@ module Fontist
         end
 
         def detect_extension
-          Files::FontDetector.standard_extension(@path)
+          detected = Files::FontDetector.standard_extension(@path)
+          file_extension = File.extname(File.basename(@path)).sub(/^\./, "")
+          return file_extension if file_extension.casecmp?(detected)
+
+          detected
         end
       end
     end