tipo 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Hugo Bastien
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# Tipo
+
+[![Code Climate](https://codeclimate.com/github/hugobast/tipo.png)](https://codeclimate.com/github/hugobast/tipo) [![Build Status](https://travis-ci.org/hugobast/tipo.png?branch=master)](https://travis-ci.org/hugobast/tipo)
+
+This is very early work but Tipo is meant to be a pure ruby OpenType and TrueType font format reader. Support for more tables and information to come.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tipo'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tipo
+
+## Usage
+
+Very narrow interface:
+
+```ruby
+info = Tipo.info 'path/to/font.{otf|ttf}'
+info.naming.font   # => "Font Name"
+info.naming.style  # => "Italic"
+
+info.substitution.feature_list.map do |feature|
+  feature.tag
+end.uniq           # => ['aalt', 'dlig', 'liga' ... ]
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/tipo.rb

@@ -0,0 +1,27 @@
+require "active_support/inflector"
+
+require "tipo/version"
+require "tipo/table"
+require "tipo/header"
+require "tipo/font"
+require "tipo/table"
+
+module Tipo
+  class Info
+    attr_reader :font, :header
+
+    def initialize file
+      @font = Font.new file
+      @header = Header.new font
+    end
+
+    def method_missing table, *args, &block
+      table = "tipo/table/#{table}".camelize.constantize
+      table.new @header, @font
+    end
+  end
+
+  def self.info file 
+    Info.new file
+  end
+end

data/lib/tipo/font.rb

@@ -0,0 +1,28 @@
+require 'forwardable'
+
+module Tipo
+  class Font
+    extend Forwardable
+    
+    def_delegators :@file, :seek, :tell
+
+    def initialize file
+      @file = File.open file, 'rb:ASCII-8BIT'
+    end
+
+    def encoding
+      @file.read(5).encoding
+    end
+
+    def chunk options
+      @file.seek options[:seek] if options[:seek]
+      @file.read options.fetch :bytes
+    end
+
+    def unpack options
+      tmpl = options.delete :tmpl
+      chunk(options).unpack tmpl
+    end
+  end
+end
+

data/lib/tipo/header.rb

@@ -0,0 +1,26 @@
+module Tipo
+  class Header
+    # full template 'a4n4'
+    OffsetTable = Struct.new :version, :tables_count
+
+    # full template 'a4N3'
+    TableRecord = Struct.new :tag, :checksum, :offset
+
+    attr_reader :font
+    
+    def initialize font 
+      @font = font 
+    end
+
+    def offset_table
+      OffsetTable.new *(font.unpack seek: 0, bytes: 12, tmpl: 'a4n')
+    end
+
+    def table_records
+      font.seek 13 
+      offset_table.tables_count.times.map do
+        TableRecord.new *(font.unpack bytes: 16, tmpl: 'a4N2')
+      end
+    end
+  end
+end

data/lib/tipo/table.rb

@@ -0,0 +1,4 @@
+require 'tipo/table/base'
+require 'tipo/table/substitution'
+require 'tipo/table/naming'
+

data/lib/tipo/table/base.rb

@@ -0,0 +1,28 @@
+module Tipo
+  module Table
+    class Base 
+      attr_reader :font_header, :font
+      attr_accessor :name
+
+      def initialize font_header, font
+        @font_header = font_header
+        @font = font
+      end
+
+      def offset 
+        seek_to_table @name 
+      end
+
+      private
+
+      def seek_to_table tag
+        font.seek find_table(tag).offset
+        font.tell
+      end
+
+      def find_table tag
+        font_header.table_records.select { |t| t.tag == tag }.first
+      end
+    end
+  end
+end

data/lib/tipo/table/naming.rb

@@ -0,0 +1,65 @@
+module Tipo
+  module Table
+    class Naming < Base 
+      # full template 'n3'
+      Header = Struct.new :format, :count, :storage_offset
+
+      # full template 'n6'
+      NameRecord = Struct.new(
+        :platform, :encoding, :language, :name, :length, :offset)
+
+      def initialize header, font
+        @name = 'name'
+        super
+      end
+
+      def header
+        Header.new *(font.unpack seek: offset, bytes: 6, tmpl: 'n3')
+      end
+
+      def storage_offset
+        header.storage_offset + offset
+      end
+
+      def naming_list 
+        header.count.times.map do
+          NameRecord.new *(font.unpack bytes: 12, tmpl: 'n6')
+        end
+      end
+
+      def record_at id
+        naming_list.select do |n|
+          n.name == id && n.platform == 1
+        end.first
+      end
+
+      def family_name
+        stringify_record record_at 1
+      end
+
+      def name
+        stringify_record record_at 4
+      end
+
+      def style
+        stringify_record record_at 2
+      end
+
+      private
+
+      def stringify_record record
+        # To handle both 16bit and 8bit strings 
+        # first convert to a ord array and build the string
+        #
+        # TODO: Verify platform and encoding ids and provide 
+        # the proper template for each
+        #
+        text = font.unpack(
+          seek: storage_offset + record.offset,
+          bytes: record.length,
+          tmpl: 'c*')
+        text.pack 'U*'
+      end
+    end
+  end
+end

data/lib/tipo/table/substitution.rb

@@ -0,0 +1,40 @@
+module Tipo
+  module Table
+    class Substitution < Base
+      # full template 'n5'
+      Header = Struct.new(
+        :version_left, :version_right, 
+        :script_offset, :feature_offset, :lookup_offset) do
+        def version
+          "#{version_left}.#{version_right}"
+        end
+      end
+
+      # full template 'a4n'
+      FeatureRecord = Struct.new :tag, :feature_offset
+
+      def initialize header, font
+        @name = "GSUB"
+        super
+      end
+      
+      def header
+        Header.new *(font.unpack seek: offset, bytes: 10, tmpl: 'n5')
+      end
+
+      def feature_list_offset
+        header.feature_offset + offset
+      end
+
+      def feature_list_count
+        font.unpack(seek: feature_list_offset, bytes: 2, tmpl: 'n').first 
+      end
+
+      def feature_list
+        feature_list_count.times.map do
+          FeatureRecord.new *(font.unpack bytes: 6, tmpl: 'a4n')
+        end
+      end
+    end
+  end
+end

data/lib/tipo/version.rb

@@ -0,0 +1,3 @@
+module Tipo
+  VERSION = "0.0.2"
+end

data/spec/tipo/font_spec.rb

@@ -0,0 +1,28 @@
+require 'tipo'
+
+include Tipo
+
+describe Font do
+  let(:font) { Font.new 'spec/fixtures/hobo.otf' }
+  it "reads a file as ascii-8bit" do
+    font.encoding.should eq Encoding::ASCII_8BIT
+  end
+
+  it "delegates seek and tell to the file" do
+    font.seek 3
+    font.tell.should eq 3
+  end
+
+  it "gets a chunk of data" do
+    font.chunk(bytes: 4).should eq "OTTO"
+  end
+
+  it "gets chunks in sucessions" do
+    font.chunk(bytes: 2).should eq "OT"
+    font.chunk(bytes: 2).should eq "TO"
+  end
+
+  it "can unpack a chunk with a template" do
+    font.unpack(seek: 0, bytes: 12, tmpl: 'a4n4').should eq ["OTTO", 13, 128, 3, 80]
+  end
+end

data/spec/tipo/header_spec.rb

@@ -0,0 +1,18 @@
+require 'tipo'
+
+include Tipo
+
+describe Header do
+  context "contains the information located in the header" do
+    let(:font) { Font.new 'spec/fixtures/hobo.otf' }
+    let(:header) { Header.new font }
+
+    it "reads the offset table" do
+      header.offset_table.version.should eq "OTTO"
+    end
+
+    it "reads the table record entries" do
+      header.table_records.first.tag.should eq "BASE"
+    end
+  end
+end

data/spec/tipo/table/base_spec.rb

@@ -0,0 +1,22 @@
+require 'tipo'
+
+include Tipo
+include Table
+
+describe Base do
+  let(:font) { Font.new 'spec/fixtures/hobo.otf' }
+  let(:header) { Header.new font }
+  let(:table) { Base.new header, font }
+
+  context "navigating" do
+    it "has a name" do
+      table.name = "GPOS"
+      table.name.should eq "GPOS"
+    end
+
+    it "has a start position" do
+      table.name = "GSUB"
+      table.offset.should eq 23376
+    end
+  end
+end

data/spec/tipo/table/naming_spec.rb

@@ -0,0 +1,38 @@
+require 'tipo'
+
+include Tipo
+include Table
+
+describe Naming do
+  let(:font) { Font.new 'spec/fixtures/hobo.otf' }
+  let(:header) { Header.new font }
+  let(:name) { Naming.new header, font }
+
+  context "sorta header information" do
+    it "has a format" do
+      name.header.format.should eq 0
+    end
+
+    it "has a count" do
+      name.header.count.should eq 24
+    end
+
+    it "has a string storage offset" do
+      name.header.storage_offset.should eq 294
+    end
+  end
+
+  context "name records" do
+    it "has a family name" do
+      name.family_name.should eq "Hobo Std"
+    end
+
+    it "has a style" do
+      name.style.should eq "Regular"
+    end
+
+    it "has a name" do
+      name.name.should eq "Hobo Std Medium"
+    end
+  end
+end

data/spec/tipo/table/substitution_spec.rb

@@ -0,0 +1,26 @@
+require 'tipo'
+
+include Tipo
+include Table
+
+describe Substitution do
+  let(:font) { Font.new 'spec/fixtures/hobo.otf' }
+  let(:header) { Header.new font }
+  let(:gsub) { Substitution.new header, font }
+
+  context "information" do
+    it "has a header" do
+      gsub.header.version.should eq "1.0" 
+    end
+
+    it "has a feature list count" do
+      gsub.feature_list_count.should eq 10
+    end
+
+    it "has a list of features" do
+      gsub.feature_list.map do |feature|
+        feature.tag 
+      end.uniq.should eq ["aalt", "frac", "liga", "ordn", "sups"]
+    end
+  end
+end

data/spec/tipo_spec.rb

@@ -0,0 +1,16 @@
+require 'tipo'
+
+include Tipo
+
+describe Info do
+  it "takes a file" do
+    info = Info.new 'spec/fixtures/hobo.otf'
+    info.font.class.should eq Font
+  end
+
+  it "return a naming table" do
+    info = Info.new 'spec/fixtures/hobo.otf'
+    info.naming.class.should eq Table::Naming
+    info.substitution.class.should eq Table::Substitution
+  end
+end

data/tipo.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tipo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tipo"
+  spec.version       = Tipo::VERSION
+  spec.authors       = ["Hugo Bastien"]
+  spec.email         = ["hugobast@gmail.com"]
+  spec.description   = %q{Pure Ruby OpenType font file reader}
+  spec.summary       = %q{Incomplete implementation: Reads header tables, GSUB table and name table}
+  spec.homepage      = "https://github.com/hugobast/tipo"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: tipo
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Hugo Bastien
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Pure Ruby OpenType font file reader
+email:
+- hugobast@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tipo.rb
+- lib/tipo/font.rb
+- lib/tipo/header.rb
+- lib/tipo/table.rb
+- lib/tipo/table/base.rb
+- lib/tipo/table/naming.rb
+- lib/tipo/table/substitution.rb
+- lib/tipo/version.rb
+- spec/fixtures/hobo.otf
+- spec/tipo/font_spec.rb
+- spec/tipo/header_spec.rb
+- spec/tipo/table/base_spec.rb
+- spec/tipo/table/naming_spec.rb
+- spec/tipo/table/substitution_spec.rb
+- spec/tipo_spec.rb
+- tipo.gemspec
+homepage: https://github.com/hugobast/tipo
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: ! 'Incomplete implementation: Reads header tables, GSUB table and name table'
+test_files:
+- spec/fixtures/hobo.otf
+- spec/tipo/font_spec.rb
+- spec/tipo/header_spec.rb
+- spec/tipo/table/base_spec.rb
+- spec/tipo/table/naming_spec.rb
+- spec/tipo/table/substitution_spec.rb
+- spec/tipo_spec.rb