fontisan 0.1.0

data/lib/fontisan/models/font_info.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+
+module Fontisan
+  module Models
+    # FontInfo model represents comprehensive font metadata
+    # extracted from various font tables (name, head, OS/2, etc.)
+    #
+    # This model provides a unified interface for accessing font information
+    # and supports serialization to YAML and JSON formats through lutaml-model.
+    class FontInfo < Lutaml::Model::Serializable
+      attribute :font_format, :string
+      attribute :is_variable, Lutaml::Model::Type::Boolean
+      attribute :family_name, :string
+      attribute :subfamily_name, :string
+      attribute :full_name, :string
+      attribute :postscript_name, :string
+      attribute :postscript_cid_name, :string
+      attribute :preferred_family, :string
+      attribute :preferred_subfamily, :string
+      attribute :mac_font_menu_name, :string
+      attribute :version, :string
+      attribute :unique_id, :string
+      attribute :description, :string
+      attribute :designer, :string
+      attribute :designer_url, :string
+      attribute :manufacturer, :string
+      attribute :vendor_url, :string
+      attribute :vendor_id, :string
+      attribute :trademark, :string
+      attribute :copyright, :string
+      attribute :license_description, :string
+      attribute :license_url, :string
+      attribute :sample_text, :string
+      attribute :font_revision, :float
+      attribute :permissions, :string
+      attribute :units_per_em, :integer
+
+      json do
+        map "font_format", to: :font_format
+        map "is_variable", to: :is_variable
+        map "family_name", to: :family_name
+        map "subfamily_name", to: :subfamily_name
+        map "full_name", to: :full_name
+        map "postscript_name", to: :postscript_name
+        map "postscript_cid_name", to: :postscript_cid_name
+        map "preferred_family", to: :preferred_family
+        map "preferred_subfamily", to: :preferred_subfamily
+        map "mac_font_menu_name", to: :mac_font_menu_name
+        map "version", to: :version
+        map "unique_id", to: :unique_id
+        map "description", to: :description
+        map "designer", to: :designer
+        map "designer_url", to: :designer_url
+        map "manufacturer", to: :manufacturer
+        map "vendor_url", to: :vendor_url
+        map "vendor_id", to: :vendor_id
+        map "trademark", to: :trademark
+        map "copyright", to: :copyright
+        map "license_description", to: :license_description
+        map "license_url", to: :license_url
+        map "sample_text", to: :sample_text
+        map "font_revision", to: :font_revision
+        map "permissions", to: :permissions
+        map "units_per_em", to: :units_per_em
+      end
+
+      yaml do
+        map "font_format", to: :font_format
+        map "is_variable", to: :is_variable
+        map "family_name", to: :family_name
+        map "subfamily_name", to: :subfamily_name
+        map "full_name", to: :full_name
+        map "postscript_name", to: :postscript_name
+        map "postscript_cid_name", to: :postscript_cid_name
+        map "preferred_family", to: :preferred_family
+        map "preferred_subfamily", to: :preferred_subfamily
+        map "mac_font_menu_name", to: :mac_font_menu_name
+        map "version", to: :version
+        map "unique_id", to: :unique_id
+        map "description", to: :description
+        map "designer", to: :designer
+        map "designer_url", to: :designer_url
+        map "manufacturer", to: :manufacturer
+        map "vendor_url", to: :vendor_url
+        map "vendor_id", to: :vendor_id
+        map "trademark", to: :trademark
+        map "copyright", to: :copyright
+        map "license_description", to: :license_description
+        map "license_url", to: :license_url
+        map "sample_text", to: :sample_text
+        map "font_revision", to: :font_revision
+        map "permissions", to: :permissions
+        map "units_per_em", to: :units_per_em
+      end
+    end
+  end
+end

data/lib/fontisan/models/glyph_info.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+
+module Fontisan
+  module Models
+    # Model for glyph information
+    class GlyphInfo < Lutaml::Model::Serializable
+      attribute :glyph_count, :integer
+      attribute :glyph_names, :string, collection: true
+      attribute :source, :string
+
+      json do
+        map "glyph_count", to: :glyph_count
+        map "glyph_names", to: :glyph_names
+        map "source", to: :source
+      end
+
+      yaml do
+        map "glyph_count", to: :glyph_count
+        map "glyph_names", to: :glyph_names
+        map "source", to: :source
+      end
+    end
+  end
+end

data/lib/fontisan/models/optical_size_info.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+
+module Fontisan
+  module Models
+    # OpticalSizeInfo model represents optical size information from a font
+    #
+    # Optical size information indicates the design size range for which a font
+    # is optimized. This can come from the OS/2 table (version 5+) or from the
+    # GPOS 'size' feature.
+    class OpticalSizeInfo < Lutaml::Model::Serializable
+      attribute :has_optical_size, Lutaml::Model::Type::Boolean
+      attribute :source, :string
+      attribute :lower_point_size, :float
+      attribute :upper_point_size, :float
+
+      json do
+        map "has_optical_size", to: :has_optical_size
+        map "source", to: :source
+        map "lower_point_size", to: :lower_point_size
+        map "upper_point_size", to: :upper_point_size
+      end
+
+      yaml do
+        map "has_optical_size", to: :has_optical_size
+        map "source", to: :source
+        map "lower_point_size", to: :lower_point_size
+        map "upper_point_size", to: :upper_point_size
+      end
+    end
+  end
+end

data/lib/fontisan/models/scripts_info.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+
+module Fontisan
+  module Models
+    # Represents a single script record
+    class ScriptRecord < Lutaml::Model::Serializable
+      attribute :tag, :string
+      attribute :description, :string
+
+      json do
+        map "tag", to: :tag
+        map "description", to: :description
+      end
+
+      yaml do
+        map "tag", to: :tag
+        map "description", to: :description
+      end
+    end
+
+    # Represents scripts information from GSUB/GPOS tables
+    class ScriptsInfo < Lutaml::Model::Serializable
+      attribute :script_count, :integer
+      attribute :scripts, ScriptRecord, collection: true
+
+      json do
+        map "script_count", to: :script_count
+        map "scripts", to: :scripts
+      end
+
+      yaml do
+        map "script_count", to: :script_count
+        map "scripts", to: :scripts
+      end
+    end
+  end
+end

data/lib/fontisan/models/table_info.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+
+module Fontisan
+  module Models
+    # TableEntry represents a single table directory entry in a font file
+    #
+    # Each entry contains metadata about a font table including its tag,
+    # length, offset within the file, and checksum for validation.
+    class TableEntry < Lutaml::Model::Serializable
+      attribute :tag, :string
+      attribute :length, :integer
+      attribute :offset, :integer
+      attribute :checksum, :integer
+
+      json do
+        map "tag", to: :tag
+        map "length", to: :length
+        map "offset", to: :offset
+        map "checksum", to: :checksum
+      end
+
+      yaml do
+        map "tag", to: :tag
+        map "length", to: :length
+        map "offset", to: :offset
+        map "checksum", to: :checksum
+      end
+    end
+
+    # TableInfo represents the table directory information from a font file
+    #
+    # This model contains the SFNT version identifier, the number of tables,
+    # and a collection of TableEntry objects representing each table in the font.
+    # It supports serialization to YAML and JSON formats through lutaml-model.
+    class TableInfo < Lutaml::Model::Serializable
+      attribute :sfnt_version, :string
+      attribute :num_tables, :integer
+      attribute :tables, TableEntry, collection: true
+
+      json do
+        map "sfnt_version", to: :sfnt_version
+        map "num_tables", to: :num_tables
+        map "tables", to: :tables
+      end
+
+      yaml do
+        map "sfnt_version", to: :sfnt_version
+        map "num_tables", to: :num_tables
+        map "tables", to: :tables
+      end
+    end
+  end
+end

data/lib/fontisan/models/unicode_mappings.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+
+module Fontisan
+  module Models
+    # Model for a single Unicode to glyph mapping
+    class UnicodeMapping < Lutaml::Model::Serializable
+      attribute :codepoint, :string
+      attribute :glyph_index, :integer
+      attribute :glyph_name, :string
+
+      json do
+        map "codepoint", to: :codepoint
+        map "glyph_index", to: :glyph_index
+        map "glyph_name", to: :glyph_name
+      end
+
+      yaml do
+        map "codepoint", to: :codepoint
+        map "glyph_index", to: :glyph_index
+        map "glyph_name", to: :glyph_name
+      end
+    end
+
+    # Model for collection of Unicode mappings
+    class UnicodeMappings < Lutaml::Model::Serializable
+      attribute :count, :integer
+      attribute :mappings, UnicodeMapping, collection: true
+
+      json do
+        map "count", to: :count
+        map "mappings", to: :mappings
+      end
+
+      yaml do
+        map "count", to: :count
+        map "mappings", to: :mappings
+      end
+    end
+  end
+end

data/lib/fontisan/models/variable_font_info.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+
+module Fontisan
+  module Models
+    # AxisInfo model represents a single variation axis in a variable font
+    #
+    # Each axis defines a design dimension along which the font can vary,
+    # such as weight (wght), width (wdth), italic (ital), or slant (slnt).
+    class AxisInfo < Lutaml::Model::Serializable
+      attribute :tag, :string
+      attribute :name, :string
+      attribute :min_value, :float
+      attribute :default_value, :float
+      attribute :max_value, :float
+
+      json do
+        map "tag", to: :tag
+        map "name", to: :name
+        map "min_value", to: :min_value
+        map "default_value", to: :default_value
+        map "max_value", to: :max_value
+      end
+
+      yaml do
+        map "tag", to: :tag
+        map "name", to: :name
+        map "min_value", to: :min_value
+        map "default_value", to: :default_value
+        map "max_value", to: :max_value
+      end
+    end
+
+    # InstanceInfo model represents a named instance in a variable font
+    #
+    # Each instance defines a predefined combination of axis values,
+    # representing a named style/weight/width combination.
+    class InstanceInfo < Lutaml::Model::Serializable
+      attribute :name, :string
+      attribute :coordinates, :float, collection: true
+
+      json do
+        map "name", to: :name
+        map "coordinates", to: :coordinates
+      end
+
+      yaml do
+        map "name", to: :name
+        map "coordinates", to: :coordinates
+      end
+    end
+
+    # VariableFontInfo model represents comprehensive variable font metadata
+    #
+    # This model provides information about variation axes and named instances
+    # for variable fonts (OpenType Font Variations).
+    class VariableFontInfo < Lutaml::Model::Serializable
+      attribute :is_variable, Lutaml::Model::Type::Boolean
+      attribute :axis_count, :integer
+      attribute :instance_count, :integer
+      attribute :axes, AxisInfo, collection: true
+      attribute :instances, InstanceInfo, collection: true
+
+      json do
+        map "is_variable", to: :is_variable
+        map "axis_count", to: :axis_count
+        map "instance_count", to: :instance_count
+        map "axes", to: :axes
+        map "instances", to: :instances
+      end
+
+      yaml do
+        map "is_variable", to: :is_variable
+        map "axis_count", to: :axis_count
+        map "instance_count", to: :instance_count
+        map "axes", to: :axes
+        map "instances", to: :instances
+      end
+    end
+  end
+end

data/lib/fontisan/open_type_collection.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require "bindata"
+require_relative "constants"
+
+module Fontisan
+  # OpenType Collection domain object using BinData
+  #
+  # Represents a complete OpenType Collection file (OTC) using BinData's declarative
+  # DSL for binary structure definition. Parallel to TrueTypeCollection but for OpenType fonts.
+  #
+  # @example Reading and extracting fonts
+  #   File.open("fonts.otc", "rb") do |io|
+  #     otc = OpenTypeCollection.read(io)
+  #     puts otc.num_fonts  # => 4
+  #     fonts = otc.extract_fonts(io)  # => [OpenTypeFont, OpenTypeFont, ...]
+  #   end
+  class OpenTypeCollection < BinData::Record
+    endian :big
+
+    string :tag, length: 4, assert: "ttcf"
+    uint16 :major_version
+    uint16 :minor_version
+    uint32 :num_fonts
+    array :font_offsets, type: :uint32, initial_length: :num_fonts
+
+    # Read OpenType Collection from a file
+    #
+    # @param path [String] Path to the OTC file
+    # @return [OpenTypeCollection] A new instance
+    # @raise [ArgumentError] if path is nil or empty
+    # @raise [Errno::ENOENT] if file does not exist
+    # @raise [RuntimeError] if file format is invalid
+    def self.from_file(path)
+      if path.nil? || path.to_s.empty?
+        raise ArgumentError,
+              "path cannot be nil or empty"
+      end
+      raise Errno::ENOENT, "File not found: #{path}" unless File.exist?(path)
+
+      File.open(path, "rb") { |io| read(io) }
+    rescue BinData::ValidityError => e
+      raise "Invalid OTC file: #{e.message}"
+    rescue EOFError => e
+      raise "Invalid OTC file: unexpected end of file - #{e.message}"
+    end
+
+    # Extract fonts as OpenTypeFont objects
+    #
+    # Reads each font from the OTC file and returns them as OpenTypeFont objects.
+    #
+    # @param io [IO] Open file handle to read fonts from
+    # @return [Array<OpenTypeFont>] Array of font objects
+    def extract_fonts(io)
+      require_relative "open_type_font"
+
+      font_offsets.map do |offset|
+        OpenTypeFont.from_collection(io, offset)
+      end
+    end
+
+    # Get a single font from the collection
+    #
+    # @param index [Integer] Index of the font (0-based)
+    # @param io [IO] Open file handle
+    # @return [OpenTypeFont, nil] Font object or nil if index out of range
+    def font(index, io)
+      return nil if index >= num_fonts
+
+      require_relative "open_type_font"
+      OpenTypeFont.from_collection(io, font_offsets[index])
+    end
+
+    # Get font count
+    #
+    # @return [Integer] Number of fonts in collection
+    def font_count
+      num_fonts
+    end
+
+    # Validate format correctness
+    #
+    # @return [Boolean] true if the format is valid, false otherwise
+    def valid?
+      tag == Constants::TTC_TAG && num_fonts.positive? && font_offsets.length == num_fonts
+    rescue StandardError
+      false
+    end
+
+    # Get the OTC version as a single integer
+    #
+    # @return [Integer] Version number (e.g., 0x00010000 for version 1.0)
+    def version
+      (major_version << 16) | minor_version
+    end
+  end
+end