fontist 1.19.0 → 1.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f726f1ac899163c9c7346d540f5bcaf831d522dd59f3e3afd5bed661560ea40
-  data.tar.gz: a94c77482bd16d9f751b2d3d713e13bf1aefd78703d7bba973c8d2649469035d
+  metadata.gz: b84dad2469698853e57c647d63890c7f054f888db3d7c53367e7c17ac3ca3951
+  data.tar.gz: ebc3c36071d189946c187af9c7a1e340ed703dc37b1eb40b821ce7557b4f2b3a
 SHA512:
-  metadata.gz: 9d0fbfe9abf98ee2b28b2cf7f1aa73d0d3003519345d2f68f684043fb462f5df26a19a662e005ff07eb882923e3becbd52c616254ab6a704423a08f7c4588797
-  data.tar.gz: 74dd96f8a564fbcfab6d6372e0729b4aab1c3e80d14fd358626e8beaec505acdeb21b3e4de1eb589a13c9a490c8f595dc1e3ca40fc9650ae24dc29e68234a214
+  metadata.gz: 3cb8a0632dde13a856ac227b3dfd6af2082fa9e4a4c27357e94664cfb3861b26ed16af5dd0891eb1542d3ec2ae4d82dbc8f57c8ae593f39610c071885f6e45d3
+  data.tar.gz: a792eceef4a821e48acce6ccb7d863a9fbc7602ac8197f488a927a1e1563947740ff4863a6162af004dbfcc40789433980ce31aed0b2a674d6b10d74009b3b7d

data/.github/workflows/deploy-pages.yml

@@ -0,0 +1,48 @@
+name: deploy-pages
+on:
+  push:
+    branches: "main"
+    paths-ignore:
+      - README.md
+      - CONTRIBUTING.md
+      - LICENSE
+      - .gitignore
+      - .github/**
+      - "!.github/workflows/deploy-pages.yml"
+  workflow_dispatch:
+concurrency:
+  group: ${{ github.workflow }}
+  cancel-in-progress: true
+jobs:
+  deploy-pages:
+    environment:
+      name: github-pages
+      url: ${{ steps.deploy-pages.outputs.page_url }}
+    permissions:
+      pages: write
+      id-token: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: latest
+          # Lockfile is in subfolder
+          # cache: npm
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ruby
+      - run: rdoc -x docs
+      - run: npm install
+        working-directory: docs
+      - id: configure-pages
+        uses: actions/configure-pages@v4
+      - run: npm run build
+        working-directory: docs
+        env:
+          BASE_PATH: ${{ steps.configure-pages.outputs.base_path }}/
+      - run: mv docs/.vitepress/dist _site
+      - run: mv doc _site/reference/api-ruby
+      - uses: actions/upload-pages-artifact@v3
+      - id: deploy-pages
+        uses: actions/deploy-pages@v4

data/.github/workflows/tebako-pack.yml

@@ -0,0 +1,61 @@
+name: tebako-pack
+
+on:
+  push:
+    tags: [ 'v*' ]
+  workflow_dispatch:
+
+concurrency:
+  group: '${{ github.workflow }}-${{ github.job }}-${{ github.head_ref || github.ref_name }}'
+  cancel-in-progress: true
+
+env:
+  # This is Ruby version that will be as a base for tebako package
+  # I.e.: fontist binary will be executed by this version of Ruby
+  PACKAGE_RUBY_VER: 3.2.3
+  # This is Ruby version that will be used to execute tebako itself
+  # It can be the same as PACKAGE_RUBY_VER but for whatever reason 3.1.4
+  # has better performance
+  TEBAKO_RUBY_VER: 3.1.4
+
+jobs:
+  pack:
+    name: Pack fontist
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      # macos-11 runner is deadly slow because brew is not supported on this version anymore
+      # so it is practically impossible to use it for tests anymore
+      matrix:
+        os: [ubuntu-20.04, macos-12]
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 1
+
+    - name: Setup Tebako
+      uses: tamatebako/tebako/.github/actions/setup-tebako@main
+      with:
+        cache: build
+        ruby_version: ${{ env.TEBAKO_RUBY_VER }}
+
+    - name: Pack Fontist
+      run: |
+        tebako press -R "$PACKAGE_RUBY_VER" --root="." --entry-point="fontist" --output="fontist"
+        if [ ${{ matrix.os }} -ne "macos-12" ]; then
+          strip fontist
+        fi
+        ./fontist help || echo "fontist help exits with status 1"
+        cp ./fontist ./fontist-${{ runner.os }}
+
+    - if: github.event_name != 'workflow_dispatch'
+      uses: softprops/action-gh-release@v1
+      with:
+        files: |
+          fontist-${{ runner.os }}
+
+    - if: github.event_name == 'workflow_dispatch'
+      uses: actions/upload-artifact@v4
+      with:
+        name: fontist-${{ matrix.os }}
+        path: fontist-${{ runner.os }}

data/LICENSE.txt

@@ -1,4 +1,4 @@
-D 2-Clause License
+BSD 2-Clause License
 
 Copyright (c) 2020, Ribose
 All rights reserved.
@@ -23,4 +23,3 @@ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-

data/README.adoc

@@ -123,7 +123,29 @@ Here, `courier_prime` is the filename of the formula located at the public
 Fontist Formula repository
 (https://github.com/fontist/formulas/blob/v3/Formulas/courier_prime.yml[`courier_prime.yml`]).
 
-NOTE: Specifying the formula's name or the font's filename is not supported.
+You can also specify the human-readable name of the formula. This name is
+derived from the filename, with underscores replaced by spaces. It's not
+case-sensitive, meaning you can use capital letters if you prefer.
+
+[source,sh]
+----
+$ fontist install --formula "Courier Prime"
+$ fontist install --formula "Google/Noto Sans"
+----
+
+Installation by the formula name supports suggestions in CLI when input is
+partial:
+
+[source,sh]
+----
+$ fontist install --formula 'noto s'
+Formula 'noto s' not found. Did you mean?
+[0] Google/Noto Sans
+[1] Google/Noto Serif
+Please type number or press ENTER to skip installation:
+----
+
+NOTE: Specifying the font's filename is not supported yet.
 
 If there are several formulas with a requested font, then `fontist` searches
 for the newest version of the font among formulas with size below a limit

data/docs/.gitignore

@@ -0,0 +1,136 @@
+# https://vitepress.dev/
+**/.vitepress/cache
+**/.vitepress/dist
+
+#region https://github.com/github/gitignore/blob/main/Node.gitignore
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+#endregion

data/docs/.vitepress/config.ts

@@ -0,0 +1,83 @@
+import { defineConfig } from "vitepress";
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  // https://vitepress.dev/guide/routing#generating-clean-url
+  cleanUrls: true,
+
+  title: "Fontist",
+  description:
+    "Fontist brings cross-platform font management to the command line for Windows, Linux, and macOS. Free and open source.",
+
+  // https://github.com/vuejs/vitepress/issues/3508
+  base: process.env.BASE_PATH,
+
+  // https://vitepress.dev/reference/default-theme-config
+  themeConfig: {
+    logo: "/logo.png",
+
+    nav: [
+      { text: "Home", link: "/" },
+      { text: "Guide", link: "/guide/" },
+      { text: "Reference", link: "/reference/" },
+      {
+        text: "Formulas",
+        link: "https://fontist.org/formulas/",
+        target: "_self",
+      },
+    ],
+
+    sidebar: {
+      "/guide/": [
+        {
+          text: "Guide",
+          items: [
+            { text: "Why Fontist?", link: "/guide/why" },
+            { text: "Getting started", link: "/guide/" },
+            { text: "Using Fontist in CI", link: "/guide/ci" },
+            { text: "Fontist with Fontconfig", link: "/guide/fontconfig" },
+            { text: "Using Fontist with a proxy", link: "/guide/proxy" },
+            {
+              text: "Create a new Fontist Formula",
+              link: "https://fontist.org/formulas/guide/create-formula",
+              target: "_self",
+            },
+          ],
+        },
+        {
+          text: "API",
+          items: [
+            { text: "Fontist Ruby library", link: "/guide/api-ruby" },
+            {
+              text: "Ruby API reference",
+              link: "https://fontist.org/fontist/reference/api-ruby/",
+              target: "_self",
+            },
+          ],
+        },
+      ],
+      "/reference/": [
+        {
+          text: "Reference",
+          items: [
+            { text: "Fontist CLI reference", link: "/reference/" },
+            {
+              text: "Ruby API reference",
+              link: "https://fontist.org/fontist/reference/api-ruby/",
+              target: "_self",
+            },
+          ],
+        },
+      ],
+    },
+
+    socialLinks: [
+      { icon: "github", link: "https://github.com/fontist/fontist" },
+    ],
+
+    footer: {
+      message: `Fontist is <a href="https://open.ribose.com/">riboseopen</a>`,
+      copyright: `Copyright &copy; 2023 Ribose Group Inc. All rights reserved.`,
+    },
+  },
+});

data/docs/guide/api-ruby.md

@@ -0,0 +1,190 @@
+# Fontist Ruby library
+
+In addition to the command-line interface, Fontist can be used as a Ruby library.
+
+## Fontist::Font
+
+The `Fontist::Font` is your go-to place to deal with any font using Fontist.
+
+This interface allows you to find a font or install a font.
+
+### Finding a font
+
+The `Fontist::Font.find` interface can be used to find a font in your system.
+
+It will look into the operating system specific font directories, and also the fontist specific `~/.fontist` directory.
+
+```ruby
+Fontist::Font.find(name)
+```
+
+- If Fontist finds a font, then it will return the paths.
+- Otherwise, it will either raise an unsupported font error, or trigger display of installation instructions for that specific font.
+
+### Install a font
+
+The `Fontist::Font.install` interface can be used to install any supported font.
+
+This interface first checks if you already have that font installed or not and if you do, then it will return the paths.
+
+If you don't have a font but that font is supported by Fontist, then it will download the font and copy it to `~/.fontist` directory and also return the paths.
+
+```ruby
+Fontist::Font.install(name, confirmation: "no")
+```
+
+If there are issues detected with the provided font, such as the font is not supported, those errors would be raised.
+
+### List all fonts
+
+The `Fontist::Font` interface exposes an interface to list all supported fonts.
+
+This might be useful if you want to know the name of the font or the available styles. You can do that by using:
+
+```ruby
+Fontist::Font.all
+```
+
+The return values are `OpenStruct` objects, so you can easily do any other operation you would do in any Ruby object.
+
+## Fontist::Formula
+
+The `fontist` gem internally uses the `Fontist::Formula` interface to find a registered formula or fonts supported by any formula. Unless you need to do anything with that, you shouldn't need to work with this interface directly. But if you do, then these are the public interfaces it offers.
+
+### Find a formula
+
+The `Fontist::Formula.find` interface allows you to find any of the registered formulas. This interface takes a font name as an argument and it looks through each of the registered formulas that offer this font installation. Usages:
+
+```ruby
+Fontist::Formula.find("Calibri")
+```
+
+This method will search and return a Fontist formula for the provided keyword which allows for further processing, such as license checks or proceeding with the installation of the font in your system.
+
+### List font styles supported by a formula
+
+Normally, each font name can be associated with multiple styles or collections, for example, the `Calibri` font might contain `regular`, `bold`, or `italic` styles fonts and if you want an interface that can return the complete list then this is your friend.
+
+You can use it as following:
+
+```ruby
+Fontist::Formula.find_fonts("Calibri")
+```
+
+### List all formulas
+
+The `Fontist::Formula` interface exposes an interface to list all registered font formulas. This might be useful if you want to know the name of the formula or what type of fonts can be installed using that formula. Usages:
+
+```ruby
+Fontist::Formula.all
+```
+
+The return values are `OpenStruct` objects, so you can easily do any other operation you would do in any Ruby object.
+
+## Fontist::Manifest
+
+### Global options
+
+Fontist can be switched to use the preferred family names. This format was used prior to v1.10.
+
+```ruby
+Fontist.preferred_family = true
+```
+
+### Fontist::Manifest::Locations
+
+Fontist lets you find font locations from a defined manifest Hash in the following format:
+
+```ruby
+{
+  "Segoe UI"=>["Regular", "Bold"],
+  "Roboto Mono"=>["Regular"]
+}
+```
+
+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)
+```
+
+```ruby
+{
+  "Segoe UI"=> {
+    "Regular"=>{
+      "full_name"=>"Segoe UI",
+      "paths"=>["/Users/user/.fontist/fonts/SEGOEUI.TTF"]
+    },
+    "Bold"=>{
+      "full_name"=>"Segoe UI Bold",
+      "paths"=>["/Users/user/.fontist/fonts/SEGOEUIB.TTF"]
+    }
+  },
+  "Roboto Mono"=> {
+    "Regular"=>{
+      "full_name"=>nil,
+      "paths"=>[]
+    }
+  }
+}
+```
+
+### 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")
+```
+
+It will install fonts and return their locations:
+
+```ruby
+{
+  "Segoe UI"=> {
+    "Regular"=>{
+      "full_name"=>"Segoe UI",
+      "paths"=>["/Users/user/.fontist/fonts/SEGOEUI.TTF"]},
+    "Bold"=>{
+      "full_name"=>"Segoe UI Bold",
+      "paths"=>["/Users/user/.fontist/fonts/SEGOEUIB.TTF"]
+    }
+  },
+  "Roboto Mono"=> {
+    "Regular"=>{
+      "full_name"=>"Roboto Mono Regular",
+      "paths"=>["/Users/user/.fontist/fonts/RobotoMono-VariableFont_wght.ttf"]
+    }
+  }
+}
+```
+
+### 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:
+
+```yaml
+---
+Segoe UI:
+  - Regular
+  - Bold
+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).
+
+```ruby
+Fontist::Manifest::Locations.from_file("manifest.yml")
+Fontist::Manifest::Install.from_file("manifest.yml", confirmation: "yes")
+```
+
+## Fontist::Fontconfig
+
+Fontist supports work with Fontconfig via the Ruby interface:
+
+```ruby
+Fontist::Fontconfig.update              # let detect fontist fonts
+Fontist::Fontconfig.remove              # disable detection
+Fontist::Fontconfig.remove(force: true) # do not fail if no config exists
+```

data/docs/guide/ci.md

@@ -0,0 +1,29 @@
+# Using Fontist in CI
+
+Fontist works well in CI environments too! You can just `gem install fontist` like normal to get up and running. Hoever, if you don't like waiting for it to compile the native Ruby extensions each time you `gem install fontist` then you might be interested in our premade custom CI helpers.
+
+```sh
+# This works on your PC and in CI! 🚀
+gem install fontist
+```
+
+ℹ Make sure your CI runner has an appropriate version of Ruby installed.
+
+## GitHub Actions
+
+If you want to use Fontist in GitHub Actions you can use the [fontist/setup](https://github.com/fontist/setup) action to automagically ✨ configure Fontist in the GitHub Actions environment. This lets you install fonts and use them in your CI process. Here's an example:
+
+```yml
+on: push
+jobs:
+  job:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: fontist/setup@v1
+      - run: fontist install "Fira Code"
+      - run: fontist install "Open Sans"
+      # Now you can use the installed fonts!
+```
+
+[📚 Read more on the fontist/setup GitHub page](https://github.com/fontist/setup)

data/docs/guide/fontconfig.md

@@ -0,0 +1,23 @@
+# Fontist with Fontconfig
+
+Fontconfig is software designed to provide fonts to other programs. It is typically used on Linux, but also available on macOS and Windows. Fontconfig is used by LibreOffice, GIMP, and many other programs.
+
+In order to find Fontist fonts, Fontconfig should be updated to include Fontist paths. This can be done with the `--update-fontconfig` option of `install`:
+
+```sh
+fontist install --update-fontconfig 'courier prime'
+```
+
+Or by calling a special command:
+
+```sh
+fontist fontconfig update
+```
+
+This will create a configuration file in `~/.config/fontconfig/conf.d/10-fontist.conf`.
+
+To remove it, please use:
+
+```sh
+fontist fontconfig remove
+```

data/docs/guide/index.md

@@ -0,0 +1,67 @@
+# Getting started
+
+The easiest way to get started with Fontist is to install the Fontist CLI. There's also a [fontist RubyGem package](/guide/api-ruby) that you can use from your Ruby code.
+
+```sh
+gem install fontist
+```
+
+💎 Don't have Ruby installed? You can [download Ruby from the official Ruby website](https://www.ruby-lang.org/en/downloads/).
+
+Now you're ready to start using Fontist to install fonts on your machine! 🤩
+
+```sh
+fontist install "Fira Code"
+fontist install "Open Sans"
+fontist install "Consolas"
+```
+
+<sup>👩‍⚖️ Some fonts may require you to accept license terms regarding their use.</sup>
+
+## Using a Fontist manifest
+
+Several fonts can be specified in a file, called "manifest", and installed together.
+
+First, prepare a file "manifest.yml":
+
+```yaml
+---
+Times New Roman:
+Arial:
+Courier New:
+---
+```
+
+Then run:
+
+```sh
+fontist manifest-install manifest.yml
+```
+
+```
+---
+Arial:
+  Regular:
+    full_name: Arial
+    paths:
+    - "/home/octocat/.fontist/fonts/Arial.ttf"
+  Bold Italic:
+    ...
+```
+
+💡 You can use `fontist manifest-locations` to get the installation paths of **only the fonts listed in the manifest file**.
+
+```sh
+fontist manifest-locations manifest.yml
+```
+
+```
+---
+Arial:
+  Regular:
+    full_name: Arial
+    paths:
+    - "/home/octocat/.fontist/fonts/Arial.ttf"
+  Bold Italic:
+    ...
+```