extract_ttc 0.3.6 → 0.3.7

data/lib/extract_ttc.rb

@@ -1,6 +1,28 @@
-require "extract_ttc/version"
-require "ffi"
-require "tempfile"
+# frozen_string_literal: true
+
+require_relative "extract_ttc/version"
+require_relative "extract_ttc/constants"
+require_relative "extract_ttc/configuration"
+
+# Domain objects (binary data objects)
+require_relative "extract_ttc/true_type_collection"
+require_relative "extract_ttc/true_type_font"
+
+# Model classes (value objects)
+require_relative "extract_ttc/models/extraction_result"
+require_relative "extract_ttc/models/validation_result"
+
+# Utility classes
+require_relative "extract_ttc/utilities/checksum_calculator"
+require_relative "extract_ttc/utilities/output_path_generator"
+
+# Command classes
+require_relative "extract_ttc/commands/extract"
+require_relative "extract_ttc/commands/list"
+require_relative "extract_ttc/commands/info"
+
+# Conditionally load CLI if Thor is available
+require_relative "extract_ttc/cli" if defined?(Thor)
 
 module ExtractTtc
   class Error < StandardError; end
@@ -13,67 +35,73 @@ module ExtractTtc
 
   class UnknownResultError < Error; end
 
-  extend FFI::Library
-  # NOTE: ffi doesn't support bundles out of box https://github.com/ffi/ffi/issues/42#issuecomment-750031554
-  # NOTE: rake-compiler doesn't support dylib generation https://github.com/rake-compiler/rake-compiler/issues/183
-  macos_binary = "stripttc.bundle"
-  lib_name = if File.exist?(File.join(File.dirname(__FILE__), macos_binary))
-               macos_binary
-             else
-               "stripttc.so"
-             end
-  ffi_lib File.join(File.dirname(__FILE__), lib_name)
-  attach_function :handlefile, [:string], :int
-
-  def self.extract(path)
-    stdout, stderr, code = capture3 do
-      handlefile(path)
+  # Extract all fonts from a TTC file
+  #
+  # This is the main public API for the gem. It extracts all fonts from
+  # a TrueType Collection (TTC) file and writes them as separate TTF files.
+  #
+  # Uses the object-oriented architecture where domain objects
+  # (TrueTypeCollection, TrueTypeFont) encapsulate their own persistence logic.
+  #
+  # @param path [String] Path to the input TTC file
+  # @param output_dir [String, nil] Optional output directory
+  # @param config [Configuration, nil] Optional configuration object
+  # @return [Array<String>] Array of output file paths
+  #
+  # @raise [ReadFileError] If the input file cannot be read
+  # @raise [InvalidFileError] If the file is not a valid TTC file
+  # @raise [WriteFileError] If output files cannot be written
+  #
+  # @example Extract fonts to current directory
+  #   ExtractTtc.extract("Helvetica.ttc")
+  #   # => ["Helvetica_00.ttf", "Helvetica_01.ttf", ...]
+  #
+  # @example Extract fonts to specific directory
+  #   ExtractTtc.extract("Helvetica.ttc", output_dir: "/tmp/fonts")
+  def self.extract(path, output_dir: nil, config: nil)
+    ensure_output_directory_exists(output_dir)
+
+    File.open(path, "rb") do |file|
+      ttc = TrueTypeCollection.read(file)
+      fonts = ttc.extract_fonts(file)
+
+      fonts.map.with_index do |font, index|
+        output_path = Utilities::OutputPathGenerator.generate(
+          path, index, output_dir: output_dir || config&.output_directory
+        )
+        font.to_file(output_path)
+        output_path
+      end
     end
-
-    return handle_error(code, stderr) unless code.zero?
-
-    fetch_filenames(stdout)
+  rescue Errno::ENOENT
+    raise ReadFileError, "Could not open file: #{path}"
+  rescue Errno::EACCES => e
+    raise WriteFileError, "Failed to open output file: #{e.message}"
+  rescue IOError, RuntimeError, StandardError => e
+    raise invalid_file?(e) ? invalid_file_error : write_file_error(e)
   end
 
-  def self.handle_error(code, stderr)
-    case code
-    when -1
-      raise ReadFileError, stderr
-    when -2
-      raise InvalidFileError, stderr
-    when -3
-      raise WriteFileError, stderr
-    else
-      raise UnknownResultError, "Return code: #{code}"
-    end
+  # Check if error indicates invalid/corrupted TTC file
+  def self.invalid_file?(error)
+    error.message.match?(/end of file|expected|Invalid TTC/i)
   end
 
-  def self.capture3
-    stderr = status = nil
-
-    stdout = capture_stream($stdout) do
-      stderr = capture_stream($stderr) do
-        status = yield
-      end
-    end
+  def self.invalid_file_error
+    InvalidFileError.new("File does not look like a ttc file")
+  end
 
-    [stdout, stderr, status]
+  def self.write_file_error(error)
+    WriteFileError.new("Failed to open output file: #{error.message}")
   end
 
-  def self.capture_stream(stream_io)
-    origin_stream = stream_io.dup
+  def self.ensure_output_directory_exists(output_dir)
+    return unless output_dir
+    return if File.directory?(output_dir)
 
-    Tempfile.open("captured_stream") do |captured_stream|
-      stream_io.reopen(captured_stream)
-      yield
-      captured_stream.rewind
-      return captured_stream.read
-    end
-  ensure
-    stream_io.reopen(origin_stream)
+    require "fileutils"
+    FileUtils.mkdir_p(output_dir)
   end
 
-  def self.fetch_filenames(stdout)
-    stdout.split("=>").last.split
-  end
+  private_class_method :invalid_file?, :invalid_file_error,
+                       :write_file_error, :ensure_output_directory_exists
 end

data/sig/extract_ttc/configuration.rbs

@@ -0,0 +1,19 @@
+module ExtractTtc
+  class Configuration
+    attr_accessor output_directory: String
+
+    attr_accessor overwrite_existing: bool
+
+    attr_accessor validate_checksums: bool
+
+    attr_accessor verbose: bool
+
+    def initialize: (?output_directory: String, ?overwrite_existing: bool, ?validate_checksums: bool, ?verbose: bool) -> void
+
+    def self.default: () -> Configuration
+
+    def merge: (Hash[Symbol, untyped] options) -> Configuration
+
+    def to_h: () -> Hash[Symbol, String | bool]
+  end
+end

data/sig/extract_ttc/constants.rbs

@@ -0,0 +1,17 @@
+module ExtractTtc
+  module Constants
+    TTC_TAG: String
+
+    TTC_VERSION_1: Integer
+
+    TTC_VERSION_2: Integer
+
+    HEAD_TAG: String
+
+    CHECKSUM_ADJUSTMENT_MAGIC: Integer
+
+    SUPPORTED_VERSIONS: Array[Integer]
+
+    TABLE_ALIGNMENT: Integer
+  end
+end

data/sig/extract_ttc/models/extraction_result.rbs

@@ -0,0 +1,19 @@
+module ExtractTtc
+  module Models
+    class ExtractionResult
+      attr_reader output_files: Array[String]
+
+      attr_reader success: bool
+
+      attr_reader errors: Array[String]
+
+      def initialize: (?output_files: Array[String], ?success: bool, ?errors: Array[String]) -> void
+
+      def success?: () -> bool
+
+      def failure?: () -> bool
+
+      def add_error: (String message) -> ExtractionResult
+    end
+  end
+end

data/sig/extract_ttc/models/font_data.rbs

@@ -0,0 +1,17 @@
+module ExtractTtc
+  module Models
+    class FontData
+      attr_reader offset_table: TrueTypeFontOffsetTable
+
+      attr_reader table_directory: Array[TableDirectoryEntry]
+
+      attr_reader table_data: Hash[String, String]
+
+      def initialize: (offset_table: TrueTypeFontOffsetTable, table_directory: Array[TableDirectoryEntry], table_data: Hash[String, String]) -> void
+
+      def head_table_entry: () -> TableDirectoryEntry?
+
+      def table_by_tag: (String tag) -> TableDirectoryEntry?
+    end
+  end
+end

data/sig/extract_ttc/models/table_directory_entry.rbs

@@ -0,0 +1,15 @@
+module ExtractTtc
+  module Models
+    class TableDirectoryEntry
+      attr_reader tag: String
+
+      attr_reader checksum: Integer
+
+      attr_reader offset: Integer
+
+      attr_reader length: Integer
+
+      def initialize: (tag: String, checksum: Integer, offset: Integer, length: Integer) -> void
+    end
+  end
+end

data/sig/extract_ttc/models/true_type_collection_header.rbs

@@ -0,0 +1,15 @@
+module ExtractTtc
+  module Models
+    class TrueTypeCollectionHeader
+      attr_reader tag: String
+
+      attr_reader version: Integer
+
+      attr_reader num_fonts: Integer
+
+      attr_reader font_offsets: Array[Integer]
+
+      def initialize: (tag: String, version: Integer, num_fonts: Integer, font_offsets: Array[Integer]) -> void
+    end
+  end
+end

data/sig/extract_ttc/models/true_type_font_offset_table.rbs

@@ -0,0 +1,17 @@
+module ExtractTtc
+  module Models
+    class TrueTypeFontOffsetTable
+      attr_reader sfnt_version: Integer
+
+      attr_reader num_tables: Integer
+
+      attr_reader search_range: Integer
+
+      attr_reader entry_selector: Integer
+
+      attr_reader range_shift: Integer
+
+      def initialize: (sfnt_version: Integer, num_tables: Integer, search_range: Integer, entry_selector: Integer, range_shift: Integer) -> void
+    end
+  end
+end

data/sig/extract_ttc/models/validation_result.rbs

@@ -0,0 +1,17 @@
+module ExtractTtc
+  module Models
+    class ValidationResult
+      attr_reader valid: bool
+
+      attr_reader errors: Array[String]
+
+      def initialize: (?valid: bool, ?errors: Array[String]) -> void
+
+      def valid?: () -> bool
+
+      def invalid?: () -> bool
+
+      def add_error: (String message) -> ValidationResult
+    end
+  end
+end

data/sig/extract_ttc/utilities/checksum_calculator.rbs

@@ -0,0 +1,13 @@
+module ExtractTtc
+  module Utilities
+    class ChecksumCalculator
+      def self.calculate_file_checksum: (String file_path) -> Integer
+
+      def self.calculate_adjustment: (Integer file_checksum) -> Integer
+
+      private
+
+      def self.calculate_checksum_from_io: (IO io) -> Integer
+    end
+  end
+end

data/sig/extract_ttc/utilities/output_path_generator.rbs

@@ -0,0 +1,11 @@
+module ExtractTtc
+  module Utilities
+    class OutputPathGenerator
+      DEFAULT_INDEX_FORMAT: String
+
+      def self.generate: (String input_path, Integer font_index, ?output_dir: String?) -> String
+
+      def self.generate_with_format: (String input_path, Integer font_index, String index_format, ?output_dir: String?) -> String
+    end
+  end
+end

data/sig/extract_ttc/validators/true_type_collection_validator.rbs

@@ -0,0 +1,9 @@
+module ExtractTtc
+  module Validators
+    class TrueTypeCollectionValidator
+      def self.validate_header: (Models::TrueTypeCollectionHeader ttc_header) -> Models::ValidationResult
+
+      def self.validate_font_data: (Models::FontData font_data) -> Models::ValidationResult
+    end
+  end
+end

data/sig/extract_ttc.rbs

@@ -0,0 +1,20 @@
+module ExtractTtc
+  VERSION: String
+
+  class Error < StandardError
+  end
+
+  class ReadFileError < Error
+  end
+
+  class InvalidFileError < Error
+  end
+
+  class WriteFileError < Error
+  end
+
+  class UnknownResultError < Error
+  end
+
+  def self.extract: (String path, ?output_dir: String?, ?config: Configuration?) -> Array[String]
+end

metadata

@@ -1,85 +1,101 @@
 --- !ruby/object:Gem::Specification
 name: extract_ttc
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.7
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-27 00:00:00.000000000 Z
+date: 2025-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: bindata
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.3.22
+        version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.3.22
+        version: '2.5'
 - !ruby/object:Gem::Dependency
-  name: ffi
+  name: paint
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13'
+        version: '1.4'
 description: Extract font collection to separate font files
 email:
 - operations@ribose.com
-executables: []
-extensions:
-- ext/stripttc/extconf.rb
+executables:
+- extract_ttc
+extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - Gemfile
 - LICENSE.adoc
 - README.adoc
 - Rakefile
-- ext/stripttc/LICENSE
-- ext/stripttc/dummy.c
-- ext/stripttc/extconf.rb
-- ext/stripttc/stripttc.c
+- exe/extract_ttc
 - extract_ttc.gemspec
 - lib/extract_ttc.rb
+- lib/extract_ttc/cli.rb
+- lib/extract_ttc/commands/extract.rb
+- lib/extract_ttc/commands/info.rb
+- lib/extract_ttc/commands/list.rb
+- lib/extract_ttc/configuration.rb
+- lib/extract_ttc/constants.rb
+- lib/extract_ttc/models/extraction_result.rb
+- lib/extract_ttc/models/validation_result.rb
+- lib/extract_ttc/true_type_collection.rb
+- lib/extract_ttc/true_type_font.rb
+- lib/extract_ttc/utilities/checksum_calculator.rb
+- lib/extract_ttc/utilities/output_path_generator.rb
 - lib/extract_ttc/version.rb
+- sig/extract_ttc.rbs
+- sig/extract_ttc/configuration.rbs
+- sig/extract_ttc/constants.rbs
+- sig/extract_ttc/models/extraction_result.rbs
+- sig/extract_ttc/models/font_data.rbs
+- sig/extract_ttc/models/table_directory_entry.rbs
+- sig/extract_ttc/models/true_type_collection_header.rbs
+- sig/extract_ttc/models/true_type_font_offset_table.rbs
+- sig/extract_ttc/models/validation_result.rbs
+- sig/extract_ttc/utilities/checksum_calculator.rbs
+- sig/extract_ttc/utilities/output_path_generator.rbs
+- sig/extract_ttc/validators/true_type_collection_validator.rbs
 homepage: https://github.com/fontist/extract_ttc
 licenses:
 - BSD-3-Clause
@@ -88,7 +104,7 @@ metadata:
   source_code_uri: https://github.com/fontist/extract_ttc
   changelog_uri: https://github.com/fontist/extract_ttc
   rubygems_mfa_required: 'false'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -103,8 +119,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Extract TTC file to TTF files
 test_files: []

data/ext/stripttc/LICENSE

@@ -1,31 +0,0 @@
-BSD 3-Clause License for stripttc.c
-
-Copyright (c) George Williams and FontForge authors. All rights reserved.
-https://github.com/fontforge/fontforge/blob/master/AUTHORS
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions
-are met:
-
-Redistributions of source code must retain the above copyright
-notice, this list of conditions and the following disclaimer.
-
-Redistributions in binary form must reproduce the above copyright
-notice, this list of conditions and the following disclaimer in the
-documentation and/or other materials provided with the distribution.
-
-The name of the author may not be used to endorse or promote
-products derived from this software without specific prior written
-permission.
-
-THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS
-OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
-DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
-GOODS OR 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/ext/stripttc/dummy.c

@@ -1,2 +0,0 @@
-// to keep linker happy
-void Init_stripttc() {}

data/ext/stripttc/extconf.rb

@@ -1,5 +0,0 @@
-require "rbconfig"
-require "mkmf"
-create_makefile "stripttc"
-m = File.read("Makefile").gsub("--no-as-needed", "--as-needed")
-File.write("Makefile", m)