fontist 1.21.4 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfd5ec32758b1fac561e81c902c8a6be42fba0050802a65a1c856d01c4c28239
-  data.tar.gz: 7530a3efd9cb1921aa9c074a7dc09c343ffb281b2ebd294750fd8621f75c2d83
+  metadata.gz: 579975f05c71659ca72914f2e273dead08930e5943f230fbc4ad5029d19b5bad
+  data.tar.gz: c3529656ee99bbd27cd9b7c37025e79350c99ead6b5f222cb08773460b2e6feb
 SHA512:
-  metadata.gz: 32526e4bee6a47c6ac946acbbf1a831cf9b41b2c1f4ce0e9750ee60dfee06a4c9122bcd521b2f5612ab87d89d75dc13b18d35eed2c25fe8a57e8d1e31ab66738
-  data.tar.gz: 920c81e9380c7874cc91599161887709a897ae6b37ac21fcda8aa8285eb86b367f9eb4def36d26d96c3f7da891989da1aff4be5085219ecd71cceea594c35259
+  metadata.gz: 7cffa6efd591fc625aff86d71774ef70aff09b6c0fe9d5cb53f4ff0fff81a80fb76950701267ecfd8bea637a26e046a1ce698111226c8972049d86cd0110dd7a
+  data.tar.gz: 8e0386ba63208db999567979f733521ff11b64b745bfd492436012761335a6a406b0fc0104176e05cecb283c4bd3924504e7668ab388a2937fd1596f6bfe8fa4

data/.github/workflows/rake.yml

@@ -4,7 +4,11 @@ on:
   push:
     branches: [ main ]
     tags: [ 'v*' ]
+    paths-ignore:
+      - '**.adoc'
   pull_request:
+    paths-ignore:
+      - '**.adoc'
 
 concurrency:
   group: '${{ github.workflow }}-${{ github.job }}-${{ github.head_ref || github.ref_name }}'

data/Gemfile

@@ -2,3 +2,14 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in fontist.gemspec
 gemspec
+
+gem "pry"
+gem "bundler"
+gem "rake"
+gem "rspec"
+gem "rspec-benchmark"
+gem "rubocop"
+gem "rubocop-rails"
+gem "rubocop-performance"
+gem "vcr"
+gem "webmock"

data/README.adoc

@@ -4,7 +4,17 @@ image:https://github.com/fontist/fontist/actions/workflows/test-and-release.yml/
 image:https://img.shields.io/gem/v/fontist.svg["Gem Version", link="https://rubygems.org/gems/fontist"]
 image:https://img.shields.io/github/issues-pr-raw/fontist/fontist.svg["Pull Requests", link="https://github.com/fontist/fontist/pulls"]
 
-A simple library to find and download fonts for Windows, Linux and Mac.
+Fontist lets you find and download fonts for Windows, Linux and Mac.
+
+Fontist is designed to facilitate automated and unattended management of font
+installations on modern operating systems.
+
+Fontist provides a repository of open
+https://github.com/fontist/formulas[Fontist Formulas] that can be easily
+installed, and also supports private font formula repositories for private or
+licensed commercial fonts.
+
+Learn more (and find your font) at https://www.fontist.org[fontist.org].
 
 :toc:
 
@@ -468,8 +478,8 @@ styles. You can do that by using:
 Fontist::Font.all
 ----
 
-The return values are `OpenStruct` objects, so you can easily do any other
-operation you would do in any ruby object.
+The return values are model objects, so you can easily access their properties
+and perform operations on them.
 
 === `Fontist::Formula`
 
@@ -518,8 +528,8 @@ what type fonts can be installed using that formula. Usages:
 Fontist::Formula.all
 ----
 
-The return values are `OpenStruct` objects, so you can easily do any other
-operation you would do in any ruby object.
+The return values are model objects, so you can easily access their properties
+and perform operations on them.
 
 === `Fontist::Manifest`
 
@@ -534,7 +544,7 @@ Fontist.preferred_family = true
 ----
 
 [[fontist-locations]]
-==== `Fontist::Manifest::Locations`
+==== Locations
 
 Fontist lets you find font locations from a defined manifest Hash in the
 following format:
@@ -552,7 +562,7 @@ Font name is useful to choose a specific font in a font collection file (TTC).
 
 [source,ruby]
 ----
-Fontist::Manifest::Locations.from_hash(manifest)
+Fontist::Manifest.from_hash(manifest, locations: true)
 ----
 
 [source,ruby]
@@ -578,14 +588,14 @@ Fontist::Manifest::Locations.from_hash(manifest)
 ----
 
 [[fontist-install]]
-==== `Fontist::Manifest::Install`
+==== Install
 
 Fontist lets you not only to obtain font locations but also to install fonts
 from the manifest:
 
 [source,ruby]
 ----
-Fontist::Manifest::Install.from_hash(manifest, confirmation: "yes")
+manifest.install(confirmation: "yes")
 ----
 
 It will install fonts and return their locations:
@@ -631,8 +641,8 @@ Then the following calls would return font names and paths, as from the
 
 [source,ruby]
 ----
-Fontist::Manifest::Locations.from_file("manifest.yml")
-Fontist::Manifest::Install.from_file("manifest.yml", confirmation: "yes")
+manifest = Fontist::Manifest.from_file("manifest.yml")
+manifest.install(confirmation: "yes")
 ----
 
 === `Fontist::Fontconfig`
@@ -916,6 +926,62 @@ fontist create-formula https://www.latofonts.com/files/Lato2OFL.zip
 cp lato.yml ~/.fontist/formulas/Formulas/
 ----
 
+==== Options for `create-formula`
+
+The `create-formula` command supports several options to customize formula generation:
+
+`--name`::
+Specify a custom formula name instead of auto-detecting from fonts.
++
+[source,sh]
+----
+fontist create-formula https://example.com/fonts.zip --name "My Custom Fonts"
+----
+
+`--subdir`::
+Extract fonts only from a specific subdirectory within the archive.
+Uses `fnmatch` patterns.
++
+[source,sh]
+----
+fontist create-formula https://example.com/fonts.zip --subdir "fonts/otf"
+----
+
+`--file-pattern`::
+Filter font files by pattern. Uses `fnmatch` patterns.
++
+[source,sh]
+----
+fontist create-formula https://example.com/fonts.zip --file-pattern "*.otf"
+----
+
+`--name-prefix`::
+Add a prefix to all font family names in the generated formula. This is useful
+for distinguishing compatibility or replacement fonts from original proprietary
+fonts.
++
+[source,sh]
+----
+fontist create-formula https://dl.winehq.org/wine/source/10.x/wine-10.18.tar.xz \
+  --subdir fonts \
+  --file-pattern '*.ttf' \
+  --name-prefix 'Wine '
+----
++
+This will generate a formula where all fonts have names prefixed with `"Wine "`,
+such as "Wine Courier", "Wine Tahoma", "Wine Symbol", etc., making it clear
+these are Wine compatibility fonts rather than the original Microsoft fonts.
+
+`--mirror`::
+Specify mirror URLs for the font archive (can be used multiple times).
++
+[source,sh]
+----
+fontist create-formula https://example.com/fonts.zip \
+  --mirror https://mirror1.example.com/fonts.zip \
+  --mirror https://mirror2.example.com/fonts.zip
+----
+
 
 ==== Overriding font metadata in Fontist formulas
 

data/docs/guide/api-ruby.md

@@ -45,7 +45,7 @@ This might be useful if you want to know the name of the font or the available s
 Fontist::Font.all
 ```
 
-The return values are `OpenStruct` objects, so you can easily do any other operation you would do in any Ruby object.
+The return values are model objects, so you can easily access their properties and perform operations on them.
 
 ## Fontist::Formula
 
@@ -79,7 +79,7 @@ The `Fontist::Formula` interface exposes an interface to list all registered fon
 Fontist::Formula.all
 ```
 
-The return values are `OpenStruct` objects, so you can easily do any other operation you would do in any Ruby object.
+The return values are model objects, so you can easily access their properties and perform operations on them.
 
 ## Fontist::Manifest
 
@@ -91,7 +91,7 @@ Fontist can be switched to use the preferred family names. This format was used
 Fontist.preferred_family = true
 ```
 
-### Fontist::Manifest::Locations
+### Manifest from YAML file or Hash
 
 Fontist lets you find font locations from a defined manifest Hash in the following format:
 
@@ -105,7 +105,8 @@ Fontist lets you find font locations from a defined manifest Hash in the followi
 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.from_hash(manifest)
+Fontist::Manifest.from_yaml(manifest)
+Fontist::Manifest.from_hash(manifest)
 ```
 
 ```ruby
@@ -129,12 +130,10 @@ Fontist::Manifest::Locations.from_hash(manifest)
 }
 ```
 
-### Fontist::Manifest::Install
-
 Fontist lets you not only obtain font locations but also install fonts from the manifest:
 
 ```ruby
-Fontist::Manifest::Install.from_hash(manifest, confirmation: "yes")
+manifest.install(confirmation: "yes")
 ```
 
 It will install fonts and return their locations:
@@ -159,7 +158,7 @@ It will install fonts and return their locations:
 }
 ```
 
-### Support of YAML format
+#### 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:
 
@@ -172,11 +171,11 @@ Roboto Mono:
   - Regular
 ```
 
-Then the following calls would return font names and paths, as from the `from_hash` method (see Fontist::Manifest::Install and Fontist::Manifest::Locations).
+Then the following calls would return font names and paths, as from the `from_hash` method (see Fontist::Manifest).
 
 ```ruby
-Fontist::Manifest::Locations.from_file("manifest.yml")
-Fontist::Manifest::Install.from_file("manifest.yml", confirmation: "yes")
+manifest = Fontist::Manifest.from_file("manifest.yml")
+manifest.install(confirmation: "yes")
 ```
 
 ## Fontist::Fontconfig

data/fontist.gemspec

@@ -29,28 +29,18 @@ Gem::Specification.new do |spec|
   spec.executables   = ["fontist"]
   spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
 
-  spec.add_runtime_dependency "down", "~> 5.0"
-  spec.add_runtime_dependency "extract_ttc", "~> 0.1"
-  spec.add_runtime_dependency "fuzzy_match", "~> 2.1"
-  spec.add_runtime_dependency "json", "~> 2.0"
-  spec.add_runtime_dependency "nokogiri", "~> 1.0"
-  spec.add_runtime_dependency "mime-types", "~> 3.0"
-  spec.add_runtime_dependency "sys-uname", "~> 1.2"
-  spec.add_runtime_dependency "thor", "~> 1.2", ">= 1.2.1"
-  spec.add_runtime_dependency "git", "~> 1.0"
-  spec.add_runtime_dependency "ttfunk", "~> 1.6"
-  spec.add_runtime_dependency "plist", "~> 3.0"
-  spec.add_runtime_dependency "excavate", "~> 0.3", '>= 0.3.4'
-  spec.add_runtime_dependency "socksify", "~> 1.7"
-
-  spec.add_development_dependency "pry", "~> 0.14"
-  spec.add_development_dependency "bundler", "~> 2.3"
-  spec.add_development_dependency "rake", "~> 13"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rspec-benchmark", "~> 0.6"
-  spec.add_development_dependency "rubocop", "~> 1.22.1"
-  spec.add_development_dependency "rubocop-rails", "~> 2.9"
-  spec.add_development_dependency "rubocop-performance", "~> 1.10"
-  spec.add_development_dependency "vcr"
-  spec.add_development_dependency "webmock"
+  spec.add_dependency "down", "~> 5.0"
+  spec.add_dependency "extract_ttc", "~> 0.3.7"
+  spec.add_dependency "fuzzy_match", "~> 2.1"
+  spec.add_dependency "json", "~> 2.0"
+  spec.add_dependency "nokogiri", "~> 1.0"
+  spec.add_dependency "mime-types", "~> 3.0"
+  spec.add_dependency "sys-uname", "~> 1.2"
+  spec.add_dependency "thor", "~> 1.4"
+  spec.add_dependency "git", "~> 1.0"
+  spec.add_dependency "ttfunk", "~> 1.6"
+  spec.add_dependency "plist", "~> 3.0"
+  spec.add_dependency "excavate", "~> 0.3", '>= 0.3.8'
+  spec.add_dependency "socksify", "~> 1.7"
+  spec.add_dependency "lutaml-model", "~> 0.7"
 end