krill 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e1b96731044a7c541b3d51a6367f3d47ee930ae
-  data.tar.gz: 3e8a31bb07ec43044890fe0402f2cf54d0cf646d
+  metadata.gz: 263d05f0b3e34007af5a65efed3386497244294e
+  data.tar.gz: 5607a0d4c668dd9cda6d736e78c50986eb108c23
 SHA512:
-  metadata.gz: d919a34509bc1a8b5b4707b76376948799337ba0f5c40df47882fa4b2b8de5dfa9a1b87161fd0d2fda7a09777abbbf8837d200e153ad6db548476ed8e7dfeaa5
-  data.tar.gz: 417e6a38abf3e71ea0f8fd0b6384db5a4f5d55d9dd37cbef4c6a7954777e04a8748d120da5c003d68e095d269578ac045a031cbdc9ef4fca6286155c81400e27
+  metadata.gz: 5dff75341afc874c3694154ccee79ff844c1dd27af1143486850bb256d1095a097d67092ad2252d21892c6e9787e7cfd5e54d0519d7a1841130979f7409bc571
+  data.tar.gz: 72c902daa932736530e97c5ff755a4345dc93807241da37cc6c41492544cc55c4f927820f8d1a9293a3bf6060344dd28c9deec94464b8b93bbabd3835e89993a

data/.rspec

@@ -0,0 +1 @@
+--color

data/README.md

@@ -37,5 +37,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
+The gem is available as open source under the terms of the [GPLv3](https://opensource.org/licenses/GPL-3.0).

data/Rakefile

@@ -1,10 +1,10 @@
 require "bundler/gem_tasks"
-require "rake/testtask"
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList['test/**/*_test.rb']
-end
+require "rspec/core/rake_task"
+
+task default: [:spec]
 
-task :default => :test
+desc "Run all rspec files"
+RSpec::Core::RakeTask.new("spec") do |c|
+  c.rspec_opts = "-t ~unresolved"
+end

data/krill.gemspec

@@ -22,5 +22,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "ttfunk"
+  spec.add_development_dependency "pry"
 end

data/lib/krill.rb

@@ -1,5 +1,25 @@
 require "krill/version"
+require "krill/text_box"
+require "krill/wrapped_text"
+require "krill/formatter"
 
 module Krill
-  # Your code goes here...
+
+  def self.wrap_text(runs, width:, leading:)
+    box = Krill::TextBox.new(runs, width: width, leading: leading, height: Float::INFINITY)
+    box.render
+    Krill::WrappedText.new(box)
+  end
+
+  CannotFit = Class.new(StandardError)
+
+  # No-Break Space
+  NBSP = " ".freeze
+
+  # Zero Width Space (indicate word boundaries without a space)
+  ZWSP = [8203].pack("U").freeze
+
+  # Soft Hyphen (invisible, except when causing a line break)
+  SHY = "­".freeze
+
 end

data/lib/krill/afm.rb

@@ -0,0 +1,174 @@
+module Krill
+  AFM = Struct.new(:filename) do
+    attr_reader :name, :family, :ascender, :descender, :line_gap,:character_widths, :kernings
+
+    def self.open(filename)
+      new filename
+    end
+
+    def initialize(filename)
+      super
+
+      data = parse(filename)
+
+      @character_widths = data.fetch(:character_widths)
+      @kernings = data.fetch(:kernings)
+      attributes = data.fetch(:attributes)
+
+      bbox = attributes['fontbbox'].split(/\s+/).map { |e| Integer(e) }
+      line_height = Float(bbox[3] - bbox[1]) / 1000.0
+
+      @name = attributes['fontname']
+      @family = attributes['familyname']
+      @ascender = attributes['ascender'].to_i / 1000.0
+      @descender = attributes['descender'].to_i / 1000.0
+      @line_gap = line_height - (ascender - descender)
+    end
+
+    def bold?
+      name["Bold"].present?
+    end
+
+    def italic?
+      name["Italic"].present?
+    end
+
+    def unicode?
+      false
+    end
+
+
+  private
+
+    def parse(filename)
+      character_widths = {}
+      kernings = {}
+      attributes = {}
+      section = []
+
+      File.foreach(filename) do |line|
+        case line
+        when /^Start(\w+)/
+          section.push Regexp.last_match(1)
+          next
+        when /^End(\w+)/
+          section.pop
+          next
+        end
+
+        case section
+        when %w{FontMetrics CharMetrics}
+          next unless line =~ /^CH?\s/
+
+          name = line[/\bN\s+(\.?\w+)\s*;/, 1]
+          char = WinAnsi.to_utf8(name)
+          character_widths[char] = line[/\bWX\s+(\d+)\s*;/, 1].to_i / 1000.0
+
+        when %w{FontMetrics KernData KernPairs}
+          next unless line =~ /^KPX\s+(\.?\w+)\s+(\.?\w+)\s+(-?\d+)/
+
+          pair = [WinAnsi.to_utf8(Regexp.last_match(1)), WinAnsi.to_utf8(Regexp.last_match(2))].join
+          kerning = Regexp.last_match(3).to_i / 1000.0
+          kernings[pair] = kerning unless kerning.zero?
+
+        when %w{FontMetrics KernData TrackKern}, %w{FontMetrics Composites}
+          next
+
+        else
+          line =~ /(^\w+)\s+(.*)/
+          key = Regexp.last_match(1).to_s.downcase
+          value = Regexp.last_match(2)
+          attributes[key] = attributes[key] ? Array(attributes[key]) << value : value
+
+        end
+      end
+
+      character_widths.freeze
+      kernings.freeze
+      attributes.freeze
+      { character_widths: character_widths, kernings: kernings, attributes: attributes }.freeze
+    end
+
+
+    class WinAnsi
+      def self.to_utf8(char)
+        CHARACTERS.index(char)&.chr(Encoding::UTF_8)
+      end
+
+      CHARACTERS = %w{
+        .notdef .notdef .notdef .notdef
+        .notdef .notdef .notdef .notdef
+        .notdef .notdef .notdef .notdef
+        .notdef .notdef .notdef .notdef
+        .notdef .notdef .notdef .notdef
+        .notdef .notdef .notdef .notdef
+        .notdef .notdef .notdef .notdef
+        .notdef .notdef .notdef .notdef
+
+        space exclam quotedbl numbersign
+        dollar percent ampersand quotesingle
+        parenleft parenright asterisk plus
+        comma hyphen period slash
+        zero one two three
+        four five six seven
+        eight nine colon semicolon
+        less equal greater question
+
+        at A B C
+        D E F G
+        H I J K
+        L M N O
+        P Q R S
+        T U V W
+        X Y Z bracketleft
+        backslash bracketright asciicircum underscore
+
+        grave a b c
+        d e f g
+        h i j k
+        l m n o
+        p q r s
+        t u v w
+        x y z braceleft
+        bar braceright asciitilde .notdef
+
+        Euro .notdef quotesinglbase florin
+        quotedblbase ellipsis dagger daggerdbl
+        circumflex perthousand Scaron guilsinglleft
+        OE .notdef Zcaron .notdef
+        .notdef quoteleft quoteright quotedblleft
+        quotedblright bullet endash emdash
+        tilde trademark scaron guilsinglright
+        oe .notdef zcaron ydieresis
+
+        space exclamdown cent sterling
+        currency yen brokenbar section
+        dieresis copyright ordfeminine guillemotleft
+        logicalnot hyphen registered macron
+        degree plusminus twosuperior threesuperior
+        acute mu paragraph periodcentered
+        cedilla onesuperior ordmasculine guillemotright
+        onequarter onehalf threequarters questiondown
+
+        Agrave Aacute Acircumflex Atilde
+        Adieresis Aring AE Ccedilla
+        Egrave Eacute Ecircumflex Edieresis
+        Igrave Iacute Icircumflex Idieresis
+        Eth Ntilde Ograve Oacute
+        Ocircumflex Otilde Odieresis multiply
+        Oslash Ugrave Uacute Ucircumflex
+        Udieresis Yacute Thorn germandbls
+
+        agrave aacute acircumflex atilde
+        adieresis aring ae ccedilla
+        egrave eacute ecircumflex edieresis
+        igrave iacute icircumflex idieresis
+        eth ntilde ograve oacute
+        ocircumflex otilde odieresis divide
+        oslash ugrave uacute ucircumflex
+        udieresis yacute thorn ydieresis
+      }.freeze
+    end
+
+  end
+end

data/lib/krill/arranger.rb

@@ -0,0 +1,182 @@
+require "krill/fragment"
+
+module Krill
+  class Arranger
+    attr_reader :max_line_height
+    attr_reader :max_descender
+    attr_reader :max_ascender
+    attr_reader :finalized
+    attr_accessor :consumed
+
+    # The following present only for testing purposes
+    attr_reader :unconsumed
+    attr_reader :fragments
+    attr_reader :current_format_state
+
+    def initialize(options={})
+      @fragments = []
+      @unconsumed = []
+      @kerning = options[:kerning]
+    end
+
+    def current_formatter
+      current_format_state.fetch(:font)
+    end
+
+    def space_count
+      fail "Lines must be finalized before calling #space_count" unless finalized
+
+      @fragments.inject(0) do |sum, fragment|
+        sum + fragment.space_count
+      end
+    end
+
+    def line_width
+      fail "Lines must be finalized before calling #line_width" unless finalized
+
+      @fragments.inject(0) do |sum, fragment|
+        sum + fragment.width
+      end
+    end
+
+    def line
+      fail "Lines must be finalized before calling #line" unless finalized
+
+      @fragments.collect do |fragment|
+        fragment.text.dup.force_encoding(::Encoding::UTF_8)
+      end.join
+    end
+
+    def finalize_line
+      @finalized = true
+
+      omit_trailing_whitespace_from_line_width
+      @fragments = []
+      @consumed.each do |hash|
+        text = hash[:text]
+        format_state = hash.dup
+        format_state.delete(:text)
+        fragment = Krill::Fragment.new(text, format_state)
+        @fragments << fragment
+        set_fragment_measurements(fragment)
+        set_line_measurement_maximums(fragment)
+      end
+    end
+
+    def format_array=(array)
+      initialize_line
+      @unconsumed = []
+      array.each do |hash|
+        binding.pry unless hash.is_a?(Hash)
+        hash[:text].scan(/[^\n]+|\n/) do |line|
+          @unconsumed << hash.merge(text: line)
+        end
+      end
+    end
+
+    def initialize_line
+      @finalized = false
+      @max_line_height = 0
+      @max_descender = 0
+      @max_ascender = 0
+
+      @consumed = []
+      @fragments = []
+    end
+
+    def finished?
+      @unconsumed.none?
+    end
+
+    def next_string
+      fail "Lines must not be finalized when calling #next_string" if finalized
+
+      next_unconsumed_hash = @unconsumed.shift
+
+      if next_unconsumed_hash
+        @consumed << next_unconsumed_hash.dup
+        @current_format_state = next_unconsumed_hash.dup
+        @current_format_state.delete(:text)
+
+        next_unconsumed_hash[:text]
+      end
+    end
+
+    def preview_next_string
+      next_unconsumed_hash = @unconsumed.first
+      next_unconsumed_hash[:text] if next_unconsumed_hash
+    end
+
+    def update_last_string(printed, unprinted, normalized_soft_hyphen = nil)
+      return if printed.nil?
+
+      if printed.empty?
+        @consumed.pop
+      else
+        @consumed.last[:text] = printed
+        @consumed.last[:normalized_soft_hyphen] = normalized_soft_hyphen if normalized_soft_hyphen
+      end
+
+      @unconsumed.unshift(@current_format_state.merge(text: unprinted)) unless unprinted.empty?
+
+      load_previous_format_state if printed.empty?
+    end
+
+    def retrieve_fragment
+      fail "Lines must be finalized before fragments can be retrieved" unless finalized
+
+      @fragments.shift
+    end
+
+    def repack_unretrieved
+      new_unconsumed = []
+      while fragment = retrieve_fragment
+        fragment.include_trailing_white_space!
+        new_unconsumed << fragment.format_state.merge(:text => fragment.text)
+      end
+      @unconsumed = new_unconsumed.concat(@unconsumed)
+    end
+
+  private
+
+    def load_previous_format_state
+      if @consumed.empty?
+        @current_format_state = {}
+      else
+        hash = @consumed.last
+        @current_format_state = hash.dup
+        @current_format_state.delete(:text)
+      end
+    end
+
+    def omit_trailing_whitespace_from_line_width
+      @consumed.reverse_each do |hash|
+        if hash[:text] == "\n"
+          break
+        elsif hash[:text].strip.empty? && @consumed.length > 1
+          # this entire fragment is trailing white space
+          hash[:exclude_trailing_white_space] = true
+        else
+          # this fragment contains the first non-white space we have
+          # encountered since the end of the line
+          hash[:exclude_trailing_white_space] = true
+          break
+        end
+      end
+    end
+
+    def set_fragment_measurements(fragment)
+      fragment.width = fragment.formatter.width_of(fragment.text, kerning: @kerning)
+      fragment.line_height = fragment.formatter.height
+      fragment.descender = fragment.formatter.descender
+      fragment.ascender = fragment.formatter.ascender
+    end
+
+    def set_line_measurement_maximums(fragment)
+      @max_line_height = [defined?(@max_line_height) && @max_line_height, fragment.line_height].compact.max
+      @max_descender = [defined?(@max_descender) && @max_descender, fragment.descender].compact.max
+      @max_ascender = [defined?(@max_ascender) && @max_ascender, fragment.ascender].compact.max
+    end
+
+  end
+end

data/lib/krill/formatter.rb

@@ -0,0 +1,108 @@
+module Krill
+  Formatter = Struct.new(:font, :size, :character_spacing) do
+
+    def initialize(font, size, character_spacing: 0)
+      super font, size, character_spacing
+    end
+
+    def name
+      font.name
+    end
+
+    def family
+      font.family
+    end
+
+
+    def width_of(string, kerning: true)
+      length = compute_width_of(string, kerning: kerning)
+      length + (character_spacing * character_count(string))
+    end
+
+    # NOTE: +string+ must be UTF8-encoded.
+    def compute_width_of(string, kerning: true)
+      if kerning
+        kern(string).inject(0) do |s, r|
+          if r.is_a?(Numeric)
+            s - r
+          else
+            r.inject(s) { |s2, u| s2 + font.character_widths.fetch(u, 0) }
+          end
+        end * size
+      else
+        string.chars.inject(0) do |sum, char|
+          sum + font.character_widths.fetch(char, 0.0)
+        end * size
+      end
+    end
+
+
+    def ascender
+      font.ascender * size
+    end
+
+    def descender
+      -font.descender * size
+    end
+
+    def line_gap
+      font.line_gap * size
+    end
+
+    def height
+      normalized_height * size
+    end
+
+
+    def superscript?
+      false # <-- TODO
+    end
+
+    def subscript?
+      false # <-- TODO
+    end
+
+
+    def unicode?
+      true
+    end
+
+    def normalize_encoding(text)
+      text.encode(::Encoding::UTF_8)
+    end
+
+
+  private
+
+    def normalized_height
+      @normalized_height ||= font.ascender - font.descender + font.line_gap
+    end
+
+    # Returns the number of characters in +str+ (a UTF-8-encoded string).
+    def character_count(str)
+      str.length
+    end
+
+    # +string+ must be UTF8-encoded.
+    #
+    # Returns an array. If an element is a numeric, it represents the
+    # kern amount to inject at that position. Otherwise, the element
+    # is an array of UTF-16 characters.
+    def kern(string)
+      a = []
+
+      string.each_char do |char|
+        if a.empty?
+          a << [char]
+        elsif (kern = font.kernings["#{a.last.last}#{char}"])
+          a << -kern << [char]
+        else
+          a.last << char
+        end
+      end
+
+      a
+    end
+
+  end
+end