fontist 2.1.4 → 2.1.6

data/docs/guide/platforms/windows.md

@@ -0,0 +1,220 @@
+---
+title: Windows Platform Guide
+---
+
+# Windows Platform Guide
+
+Fontist provides comprehensive Windows platform support, allowing installation and management of fonts on Windows 7 and later.
+
+## Windows Font Management
+
+Windows font management differs from Unix systems in several key ways:
+
+| Difference | Description |
+|------------|-------------|
+| Path separator | Uses backslash (`\`) instead of forward slash (`/`) |
+| Font locations | Registry-based and directory-based locations |
+| File locking | Stricter file locking during operations |
+| Permissions | Case-insensitive but case-preserving filesystem |
+
+---
+
+## Windows Font Locations
+
+Fontist supports three installation locations on Windows:
+
+### System Fonts
+
+| Property | Value |
+|----------|-------|
+| Location | `C:\Windows\Fonts` |
+| Requires Admin | Yes |
+| Available To | All users |
+
+### User Fonts
+
+| Property | Value |
+|----------|-------|
+| Location | `%LOCALAPPDATA%\Microsoft\Windows\Fonts` |
+| Requires Admin | No |
+| Available To | Current user only |
+| Windows Version | Windows 10+ |
+
+### Fontist Library
+
+| Property | Value |
+|----------|-------|
+| Location | `%USERPROFILE%\.fontist\fonts` |
+| Requires Admin | No |
+| Available To | Current user only |
+| Default | Yes |
+
+Fontist creates a `fontist` subdirectory within user and system font directories to avoid cluttering the main font directory.
+
+---
+
+## Installation Examples
+
+### Install to Fontist Library (Default)
+
+```powershell
+# No administrator privileges required
+fontist install "Roboto"
+```
+
+### Install to User Fonts Directory
+
+```powershell
+# No administrator privileges required (Windows 10+)
+fontist install "Roboto" --location=user
+```
+
+### Install to System Fonts Directory
+
+```powershell
+# Run as Administrator
+fontist install "Roboto" --location=system
+```
+
+---
+
+## Windows-Specific Considerations
+
+### File Locking
+
+Windows uses stricter file locking than Unix systems. Fontist handles this with automatic retry logic when encountering locked files during cleanup operations.
+
+If you encounter file locking issues:
+1. Close applications that might be using the font
+2. Retry the operation
+3. Use Task Manager to identify processes locking the file
+
+### Path Handling
+
+Fontist automatically handles Windows path separators and drive letters. Font paths are returned in Windows-native format:
+
+```
+C:\Users\user\.fontist\fonts\font.ttf
+```
+
+### Registry Integration
+
+While Windows historically used registry-based font registration, modern Windows (10+) supports directory-based fonts. Fontist uses directory-based installation for maximum compatibility and ease of management.
+
+### Administrator Privileges
+
+| Operation | Admin Required |
+|-----------|----------------|
+| Install to `fontist` location | No |
+| Install to `user` location | No |
+| Install to `system` location | Yes |
+| Uninstall from system fonts | Yes |
+
+---
+
+## Platform Compatibility
+
+| Windows Version | Support Status | Notes |
+|-----------------|----------------|-------|
+| Windows 11 | ✅ Fully Supported | All features available |
+| Windows 10 | ✅ Fully Supported | User font directory available |
+| Windows 8/8.1 | ✅ Supported | System and fontist locations only |
+| Windows 7 | ⚠️ Limited Support | System and fontist locations only |
+
+::: warning Windows 7 Support
+Extended support for Windows 7 ended January 14, 2020. Fontist is tested on Windows 10 and later. Earlier versions may work but are not actively tested.
+:::
+
+---
+
+## Ruby Installation on Windows
+
+### Prerequisites
+
+1. **RubyInstaller with DevKit** - Required for native gem extensions
+2. **MSYS2** - Required for building native extensions
+3. **Git for Windows** - Required for `fontist update` and `fontist repo` commands
+
+### Installation Steps
+
+1. Download [RubyInstaller](https://rubyinstaller.org/downloads/) (select "Ruby+Devkit" version)
+
+2. Run the installer and check "Add Ruby executables to your PATH"
+
+3. After installation, run MSYS2 setup:
+   ```powershell
+   ridk install
+   ```
+   Select option 3 (MSYS2 and MINGW development toolchain) when prompted.
+
+4. Install [Git for Windows](https://git-scm.com/download/win)
+
+5. Install Fontist:
+   ```powershell
+   gem install fontist
+   ```
+
+---
+
+## Troubleshooting
+
+### Native Extension Errors
+
+If you see errors about failed compilations:
+
+```powershell
+# Ensure MSYS2 is properly installed
+ridk install
+
+# Reinstall the gem with verbose output
+gem install fontist --verbose
+```
+
+### Permission Errors
+
+If you get permission errors:
+
+```powershell
+# Option 1: Install to user directory
+fontist install "Roboto" --location=user
+
+# Option 2: Run as Administrator for system fonts
+# Right-click PowerShell → "Run as administrator"
+fontist install "Roboto" --location=system
+```
+
+### Path Too Long Errors
+
+Windows has a 260 character path limit by default. If you encounter path issues:
+
+1. Enable long paths in Windows (requires admin):
+   ```powershell
+   # Run as Administrator
+   New-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem" `
+     -Name "LongPathsEnabled" -Value 1 -PropertyType DWORD -Force
+   ```
+
+2. Or use a shorter installation path via environment variable:
+   ```powershell
+   $env:FONTIST_PATH = "C:\f"
+   fontist install "Roboto"
+   ```
+
+---
+
+## Environment Variables
+
+| Variable | Description | Example |
+|----------|-------------|---------|
+| `FONTIST_PATH` | Base directory for Fontist data | `C:\fontist` |
+| `FONTIST_INSTALL_LOCATION` | Default install location | `user` |
+| `FONTIST_USER_FONTS_PATH` | Custom user fonts path | `C:\Users\me\Fonts` |
+| `FONTIST_SYSTEM_FONTS_PATH` | Custom system fonts path | `C:\Windows\Fonts` |
+
+---
+
+## See Also
+
+- [Installation Guide](/guide/installation) - General installation instructions
+- [Install Command](/cli/install) - CLI reference for install
+- [How Fontist Works](/guide/how-it-works) - Architecture overview

data/fontist.gemspec

@@ -36,7 +36,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "git", "> 1.0"
   spec.add_dependency "json", "~> 2.0"
   spec.add_dependency "lutaml-model", "~> 0.7"
-  spec.add_dependency "lutaml-xsd", "~> 1.0"
   spec.add_dependency "marcel", "~> 1.0"
   spec.add_dependency "nokogiri", "~> 1.0"
   spec.add_dependency "octokit", "~> 4.0"

data/lib/fontist/cache/manager.rb

@@ -1,5 +1,3 @@
-require_relative "store"
-
 module Fontist
   module Cache
     # Central cache manager for font index caching operations

data/lib/fontist/cache.rb

@@ -0,0 +1,6 @@
+module Fontist
+  module Cache
+    autoload :Store, "#{__dir__}/cache/store"
+    autoload :Manager, "#{__dir__}/cache/manager"
+  end
+end

data/lib/fontist/cli/thor_ext.rb

@@ -1,5 +1,3 @@
-require "fontist/utils/ui"
-
 module Fontist
   module ThorExt
     # Sources:

data/lib/fontist/cli.rb

@@ -1,13 +1,6 @@
 require "thor"
 require_relative "cli/class_options"
 require_relative "cli/thor_ext"
-require_relative "repo_cli"
-require_relative "cache_cli"
-require_relative "import_cli"
-require_relative "fontconfig_cli"
-require_relative "config_cli"
-require_relative "index_cli"
-require_relative "manifest_cli"
 
 module Fontist
   class CLI < Thor
@@ -248,7 +241,6 @@ module Fontist
                                "e.g. 'Wine ' for compatibility fonts"
     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")
       success
@@ -271,7 +263,6 @@ module Fontist
     desc "macos-catalogs", "List available macOS font catalogs"
     def macos_catalogs
       handle_class_options(options)
-      require_relative "macos/catalog/catalog_manager"
 
       catalogs = Fontist::Macos::Catalog::CatalogManager.available_catalogs
 

data/lib/fontist/collection_file.rb

@@ -1,5 +1,4 @@
 require "fontisan"
-require_relative "errors"
 
 module Fontist
   class CollectionFile
@@ -18,8 +17,6 @@ module Fontist
       def build_collection(path)
         # Validate collection by checking it can be loaded
         # This uses fontisan's collection validation infrastructure
-        require "fontisan"
-
         # First check if it's a valid collection file
         unless Fontisan::FontLoader.collection?(path)
           raise Errors::FontFileError,

data/lib/fontist/font.rb

@@ -1,9 +1,3 @@
-require "fontist/font_installer"
-require "fontist/font_path"
-require "fontist/formula_picker"
-require "fontist/fontconfig"
-require "fontist/formula_suggestion"
-
 module Fontist
   class Font
     def initialize(options = {})

data/lib/fontist/font_collection.rb

@@ -1,5 +1,4 @@
 require "lutaml/model"
-require_relative "font_model"
 
 module Fontist
   class FontCollection < Lutaml::Model::Serializable

data/lib/fontist/font_file.rb

@@ -1,6 +1,5 @@
 require "fontisan"
 require "tempfile"
-require_relative "errors"
 
 module Fontist
   class FontFile

data/lib/fontist/font_installer.rb

@@ -1,9 +1,4 @@
-require "fontist/utils"
 require "excavate"
-require_relative "resources/archive_resource"
-require_relative "resources/google_resource"
-require_relative "resources/apple_cdn_resource"
-require_relative "install_location"
 
 module Fontist
   class FontInstaller

data/lib/fontist/font_model.rb

@@ -1,5 +1,4 @@
 require "lutaml/model"
-require_relative "font_style"
 
 module Fontist
   class FontModel < Lutaml::Model::Serializable

data/lib/fontist/font_path.rb

@@ -1,5 +1,3 @@
-require "fontist/indexes/filename_index"
-
 module Fontist
   class FontPath
     def initialize(path)

data/lib/fontist/formula.rb

@@ -1,19 +1,7 @@
 require "lutaml/model"
-require_relative "font_model"
-require_relative "font_collection"
-require_relative "extract"
-require_relative "index"
-require_relative "helpers"
-require_relative "update"
-require_relative "import_source"
-require_relative "macos_import_source"
-require_relative "google_import_source"
-require_relative "sil_import_source"
 require "git"
 
 module Fontist
-  require "lutaml/model"
-
   class Resource < Lutaml::Model::Serializable
     attribute :name, :string
     attribute :source, :string
@@ -280,7 +268,6 @@ module Fontist
         # Check if framework exists for this macOS version
         framework = Utils::System.catalog_version_for_macos
         if framework.nil?
-          require_relative "macos_framework_metadata"
           raise Errors::UnsupportedMacOSVersionError.new(
             current_macos,
             MacosFrameworkMetadata.metadata,

data/lib/fontist/formula_picker.rb

@@ -1,5 +1,3 @@
-require "fontist/style_version"
-
 module Fontist
   class FormulaPicker
     def initialize(font_name, size_limit:, version:, smallest:, newest:)

data/lib/fontist/google_import_source.rb

@@ -1,5 +1,3 @@
-require_relative "import_source"
-
 module Fontist
   # Import source for Google Fonts
   #

data/lib/fontist/import/convert_formulas.rb

@@ -1,5 +1,3 @@
-require_relative "formula_serializer"
-
 module Fontist
   module Import
     class ConvertFormulas

data/lib/fontist/import/create_formula.rb

@@ -1,7 +1,3 @@
-require "fontist/import"
-require_relative "recursive_extraction"
-require_relative "formula_builder"
-
 module Fontist
   module Import
     class CreateFormula

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

@@ -1,5 +1,4 @@
 require "fontisan"
-require_relative "../otf/font_file"
 
 module Fontist
   module Import

data/lib/fontist/import/files.rb

@@ -0,0 +1,8 @@
+module Fontist
+  module Import
+    module Files
+      autoload :CollectionFile, "#{__dir__}/files/collection_file"
+      autoload :FontDetector, "#{__dir__}/files/font_detector"
+    end
+  end
+end

data/lib/fontist/import/font_metadata_extractor.rb

@@ -1,5 +1,4 @@
 require "fontisan"
-require_relative "models/font_metadata"
 
 module Fontist
   module Import

data/lib/fontist/import/formula_builder.rb

@@ -1,10 +1,4 @@
 require "shellwords"
-require_relative "text_helper"
-require_relative "helpers/hash_helper"
-require_relative "recursive_extraction"
-require_relative "../macos_import_source"
-require_relative "../google_import_source"
-require_relative "../sil_import_source"
 
 module Fontist
   module Import

data/lib/fontist/import/google/api.rb

@@ -1,12 +1,3 @@
-require_relative "models/axis"
-require_relative "models/font_variant"
-require_relative "models/font_family"
-require_relative "data_sources/base"
-require_relative "data_sources/ttf"
-require_relative "data_sources/vf"
-require_relative "data_sources/woff2"
-require_relative "font_database"
-
 module Fontist
   module Import
     module Google

data/lib/fontist/import/google/data_sources/base.rb

@@ -1,7 +1,6 @@
 require "net/http"
 require "json"
 require "uri"
-require_relative "../models/font_family"
 
 module Fontist
   module Import

data/lib/fontist/import/google/data_sources/github.rb

@@ -1,7 +1,4 @@
 require "unibuf"
-require_relative "../metadata_adapter"
-require_relative "../../otf/font_file"
-require_relative "../models/font_family"
 require "pathname"
 
 module Fontist

data/lib/fontist/import/google/data_sources/ttf.rb

@@ -1,5 +1,3 @@
-require_relative "base"
-
 module Fontist
   module Import
     module Google

data/lib/fontist/import/google/data_sources/vf.rb

@@ -1,5 +1,3 @@
-require_relative "base"
-
 module Fontist
   module Import
     module Google

data/lib/fontist/import/google/data_sources/woff2.rb

@@ -1,5 +1,3 @@
-require_relative "base"
-
 module Fontist
   module Import
     module Google

data/lib/fontist/import/google/data_sources.rb

@@ -0,0 +1,13 @@
+module Fontist
+  module Import
+    module Google
+      module DataSources
+        autoload :Base, "#{__dir__}/data_sources/base"
+        autoload :Github, "#{__dir__}/data_sources/github"
+        autoload :Ttf, "#{__dir__}/data_sources/ttf"
+        autoload :Vf, "#{__dir__}/data_sources/vf"
+        autoload :Woff2, "#{__dir__}/data_sources/woff2"
+      end
+    end
+  end
+end

data/lib/fontist/import/google/font_database.rb

@@ -1,12 +1,3 @@
-require_relative "models/font_family"
-require_relative "models/axis"
-require_relative "data_sources/ttf"
-require_relative "data_sources/vf"
-require_relative "data_sources/woff2"
-require_relative "data_sources/github"
-require_relative "../font_metadata_extractor"
-require_relative "../../utils/downloader"
-require_relative "../../google_import_source"
 require "yaml"
 require "fileutils"
 
@@ -404,7 +395,6 @@ github_data: nil, version: 4, source_path: nil)
           path = File.join(output_dir, filename)
 
           # Use HashHelper to convert keys to strings (preserves import_source object)
-          require_relative "../helpers/hash_helper"
           formula_with_string_keys = Helpers::HashHelper.stringify_keys(formula_hash)
 
           File.write(path, YAML.dump(formula_with_string_keys))

data/lib/fontist/import/google/metadata_adapter.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "unibuf"
-require_relative "models/metadata"
 
 module Fontist
   module Import

data/lib/fontist/import/google/models/font_family.rb

@@ -1,5 +1,4 @@
 require "lutaml/model"
-require_relative "axis"
 
 module Fontist
   module Import

data/lib/fontist/import/google/models/metadata.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
 require "lutaml/model"
-require_relative "font_file_metadata"
-require_relative "axis_metadata"
-require_relative "source_metadata"
+require "unibuf"
 
 module Fontist
   module Import
@@ -74,9 +72,6 @@ module Fontist
           # @return [Metadata] parsed metadata object
           # @raise [ParseError] if file cannot be parsed
           def self.from_file(file_path)
-            require "unibuf"
-            require_relative "../metadata_adapter"
-
             unibuf_message = Unibuf.parse_textproto_file(file_path)
             MetadataAdapter.adapt(unibuf_message)
           end
@@ -87,9 +82,6 @@ module Fontist
           # @return [Metadata] parsed metadata object
           # @raise [ParseError] if content cannot be parsed
           def self.from_content(content)
-            require "unibuf"
-            require_relative "../metadata_adapter"
-
             unibuf_message = Unibuf.parse_textproto(content)
             MetadataAdapter.adapt(unibuf_message)
           end

data/lib/fontist/import/google/models/source_metadata.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "lutaml/model"
-require_relative "file_metadata"
 
 module Fontist
   module Import

data/lib/fontist/import/google/models.rb

@@ -0,0 +1,16 @@
+module Fontist
+  module Import
+    module Google
+      module Models
+        autoload :Axis, "#{__dir__}/models/axis"
+        autoload :AxisMetadata, "#{__dir__}/models/axis_metadata"
+        autoload :FileMetadata, "#{__dir__}/models/file_metadata"
+        autoload :FontFamily, "#{__dir__}/models/font_family"
+        autoload :FontFileMetadata, "#{__dir__}/models/font_file_metadata"
+        autoload :FontVariant, "#{__dir__}/models/font_variant"
+        autoload :Metadata, "#{__dir__}/models/metadata"
+        autoload :SourceMetadata, "#{__dir__}/models/source_metadata"
+      end
+    end
+  end
+end

data/lib/fontist/import/google.rb

@@ -1,6 +1,13 @@
 module Fontist
   module Import
     module Google
+      autoload :Api, "#{__dir__}/google/api"
+      autoload :DataSources, "#{__dir__}/google/data_sources"
+      autoload :FontDatabase, "#{__dir__}/google/font_database"
+      autoload :MetadataAdapter, "#{__dir__}/google/metadata_adapter"
+      autoload :MetadataParser, "#{__dir__}/google/metadata_parser"
+      autoload :Models, "#{__dir__}/google/models"
+
       DEFAULT_MAX_COUNT = 100
 
       def self.metadata_name(path)
@@ -35,5 +42,3 @@ module Fontist
     end
   end
 end
-
-require_relative "google/api"

data/lib/fontist/import/google_fonts_importer.rb

@@ -1,11 +1,6 @@
 require "fileutils"
 require "yaml"
 require "paint"
-require_relative "../import"
-require_relative "../formula"
-require_relative "google/font_database"
-require_relative "google/api"
-require_relative "import_display"
 
 module Fontist
   module Import

data/lib/fontist/import/google_import.rb

@@ -5,10 +5,6 @@
 # @deprecated Use {Fontist::Import::GoogleImporter} instead
 # @see Fontist::Import::GoogleImporter
 
-require_relative "google"
-require_relative "google/api"
-require_relative "google/create_google_formula"
-
 module Fontist
   module Import
     # Legacy Google Fonts import class
@@ -57,10 +53,7 @@ module Fontist
       # @return [Boolean] true if new importer is available and should be used
       def use_new_importer?
         # Check if new importer is available
-        require_relative "google_importer"
-        true
-      rescue LoadError
-        false
+        defined?(Fontist::Import::GoogleImporter)
       end
 
       # Delegates to new GoogleImporter

data/lib/fontist/import/helpers.rb

@@ -0,0 +1,8 @@
+module Fontist
+  module Import
+    module Helpers
+      autoload :HashHelper, "#{__dir__}/helpers/hash_helper"
+      autoload :SystemHelper, "#{__dir__}/helpers/system_helper"
+    end
+  end
+end