hierogloss 0.0.1 → 0.0.2

data/lib/hierogloss/metrics.rb

@@ -0,0 +1,47 @@
+# -*- coding: utf-8 -*-
+
+module Hierogloss
+  # :nodoc: Internal utilities for measuring hieroglyphs for layout
+  # purposes.
+  class Metrics
+    # The nominal size of a quadrat relative to Data::SIGN_SIZES.
+    QUADRAT_DATA_SIZE = 0.55
+
+    # The nominal size of a quadrat in our API units.
+    QUADRAT_SIZE = 12
+
+    # A conversion factor.
+    QUADRAT_CONV = QUADRAT_SIZE / QUADRAT_DATA_SIZE
+
+    class << self
+      def find(char)
+        size = Data::SIGN_SIZES[char]
+        new(conv(size[0]),conv(size[1]))
+      end
+      
+      protected
+
+      # Round things to reasonable sizes.  This is ad hoc and will require
+      # extensive adjustment.
+      def conv(x)
+        rounded = (x*QUADRAT_CONV).round
+        case rounded
+        when 1..4 then 3
+        when 5..7 then 6
+        when 8..9 then 9
+        when 10..14 then 12
+        else rounded
+        end
+      end
+    end
+
+    attr_reader :width, :height
+
+    def initialize(width, height)
+      @width = width
+      @height = height
+    end
+  end
+end
+
+require "hierogloss/metrics/data"

data/lib/hierogloss/version.rb

@@ -1,3 +1,3 @@
 module Hierogloss
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/hierogloss.rb

@@ -1,6 +1,8 @@
 require 'kramdown'
 require "hierogloss/version"
 require "hierogloss/dictionary"
+require "hierogloss/metrics"
+require "hierogloss/mdc"
 require "hierogloss/gloss"
 require "kramdown/parser/hierogloss"
 require "kramdown/converter/bbcode"

data/src/dump_metrics.rb

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+# Requires ttfunk 1.1 to operate, which conflicts with the
+# currently-released version of prawn.
+
+require "ttfunk"
+
+def metrics(file, codepoint)
+  glyph_id = file.cmap.unicode.first[codepoint]
+  return nil if glyph_id == 0
+  glyph = file.glyph_outlines.for(glyph_id)
+  [codepoint, glyph.x_max-glyph.x_min, glyph.y_max-glyph.y_min]
+end
+
+f = TTFunk::File.open(File.join(File.dirname(__FILE__), 'Gardiner.ttf'))
+
+metrics = (0x13000..0x1342F).map {|cp| metrics(f, cp) }.compact
+max_width = metrics.map {|m| m[1] }.max
+max_height = metrics.map {|m| m[2] }.max
+unit = 1.0*([max_width, max_height].max)
+
+print <<EOD
+# -*- coding: utf-8 -*-
+
+# :nodoc: This file is generated automatically using dump_metrics.rb.
+# It contains the relative width and height of each sign in the Gardiner.ttf
+# font for use in layout algorithms.
+module Hierogloss
+  class Metrics
+    module Data
+      SIGN_SIZES = {
+EOD
+
+metrics.each do |cp, w, h|
+  c = [cp].pack("U")
+  printf "\"%s\"=>[%0.2f,%0.2f],\n", c, w/unit, h/unit
+end
+
+print <<EOD
+      }
+    end
+  end
+end
+EOD

data/test/test_dictionary.rb

@@ -37,14 +37,7 @@ class TestDictionary < Minitest::Test
   end
 
   def test_should_provide_gardiner_signs_for_most_signs
-    assert_equal("A1", Hierogloss::Dictionary.gardiner("𓀀"))
-    assert_equal("D4", Hierogloss::Dictionary.gardiner("𓁹"))
-  end
-
-  def test_should_not_provide_gardiner_signs_for_uniliterals
-    # Let's not link these common characters.
-    "𓄿𓇋𓏭𓂝𓅱𓏲𓃀𓊪𓆑𓅓𓈖𓂋𓉔𓎛𓐍𓄡𓊃𓋴𓈙𓈎𓎡𓎼𓏏𓍿𓂧𓆓".each_char do |c|
-      assert_nil(Hierogloss::Dictionary.gardiner(c), "should not translate #{c}")
-    end
+    assert_equal("A1", Hierogloss::Dictionary.sign_to_gardiner("𓀀"))
+    assert_equal("D4", Hierogloss::Dictionary.sign_to_gardiner("𓁹"))
   end
 end

data/test/test_gloss.rb

@@ -6,7 +6,7 @@ class TestGloss < MiniTest::Test
 
   def setup
     input = <<EOD
-H: 𓊃𓀀𓏤 | 𓊃𓏏𓁐
+H: 𓊃:𓀀*𓏤 | z:t*B1
 L: s | s.t
 G: homme | femme
 T: l'homme et la femme
@@ -22,7 +22,9 @@ EOD
 
   def test_should_parse_gloss_into_appropriate_rows
     assert_equal(4, @gloss.rows.length)
-    assert_row(HieroglyphRow, ["𓊃𓀀𓏤", "𓊃𓏏𓁐"], @gloss.rows[0])
+    assert_row(HieroglyphRow, ["𓊃:𓀀*𓏤", "z:t*B1"], @gloss.rows[0])
+    assert_equal(["𓊃𓀀𓏤", "𓊃𓏏𓁐"],
+                 @gloss.rows[0].cells.map {|c| c.to_linear_hieroglyphs })
     assert_row(TransliterationRow, ["s", "s.t"], @gloss.rows[1])
     assert_row(Row, ["homme", "femme"], @gloss.rows[2])
 

data/test/test_mdc.rb

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+require 'minitest_helper'
+
+class TestCodage < MiniTest::Test
+  def assert_parse(expected, input)
+    assert_equal(expected, Hierogloss::MdC.parse(input).to_debug)
+  end
+
+  def test_should_parse_separated_signs
+    assert_parse(["i"], "i")
+    assert_parse(["i", "A2"], "i-A2")
+    assert_parse(["i", "A2"], "i A2")
+    assert_parse(["i", "A2"], "i  A2")
+    assert_parse(["i", "A2"], "i_A2")
+    assert_parse(["i", "A2"], "i__A2")
+    # A non-standard extension, but I rather like using a proper input
+    # method to type hieroglyphs.
+    assert_parse(["𓇋", "𓀁"], "𓇋𓀁")
+  end
+
+  def test_should_parse_stacked_signs
+    assert_parse([[:stack, "D", "d"], "n"], "D:d-n")
+    assert_parse([[:stack, "D", "d", "n"]], "D:d:n")
+    assert_parse([[:stack, "𓆓", "𓂧"], "𓈖"], "𓆓:𓂧𓈖")
+    assert_parse([[:stack, "𓆓", "𓂧", "𓈖"]], "𓆓:𓂧:𓈖")
+  end
+
+  def test_should_parse_juxtaposed_signs
+    assert_parse([[:stack, "𓇾", ["𓏤", "𓈇"]]], "𓇾:𓏤*𓈇")
+  end
+
+  def test_should_honor_parens
+    assert_parse([[:stack, ["p", [:stack, "t", "Z4"]], "pt"]], "p*(t:Z4):pt")
+  end
+
+  def assert_linear_hieroglyphs(expected, input)
+    assert_equal(expected, Hierogloss::MdC.parse(input).to_linear_hieroglyphs)
+  end
+
+  def test_should_convert_mdc_to_linear_hieroglyphs
+    assert_linear_hieroglyphs("𓆓𓂧𓈖", "𓆓:𓂧𓈖")
+    assert_linear_hieroglyphs("𓊪𓏏𓏭𓇯", "p*(t:Z4):pt")
+  end
+
+  def assert_mdc(expected, input)
+    assert_equal(expected, Hierogloss::MdC.parse(input).to_mdc)
+  end
+
+  def test_should_convert_mdc_to_mdc_string
+    assert_mdc("D:d-n", "𓆓:𓂧𓈖")
+    assert_mdc("p*(t:Z4):pt", "p*(t:Z4):pt")
+    # Compound signs are always placed in parens.
+    assert_mdc("(N33*N33:N33*N33)", "𓃌")
+  end
+end

data/test/test_metrics.rb

@@ -0,0 +1,29 @@
+# -*- coding: utf-8 -*-
+require 'minitest_helper'
+
+class TestMetrics < MiniTest::Test
+  # For our purposes, an ordinary quadrat is 12 units by 12 units, mostly
+  # because this allows us to use most small fractions (1/1 through 1/4)
+  # easily.
+  def assert_metrics(width, height, char)
+    m = Hierogloss::Metrics.find(char)
+    assert_equal width, m.width, "Expected width of #{char} to be #{width}"
+    assert_equal height, m.height, "Expected hieght of #{char} to be #{height}"
+  end
+
+  def test_signs_should_have_plausible_metrics
+    # These numbers are a bit arbitrary.  They're based on my
+    # interpretation of common hieroglyphic layouts and the sizes of the
+    # signs extracted from the Gardiner font.  The idea is that anything
+    # adding up to 12x12 should make a nice square quadrat without any
+    # further scaling.  The ultimate answer here, of course, is whatever
+    # looks good.
+    assert_metrics(9, 12, "𓀀")
+    assert_metrics(6, 12, "𓁐")
+    assert_metrics(3, 12, "𓋴")
+    assert_metrics(12, 3, "𓈖")
+    assert_metrics(12, 3, "𓆑")
+    assert_metrics(12, 6, "𓂧")
+    assert_metrics(12, 12, "𓆓")
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hierogloss
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Eric Kidd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-20 00:00:00.000000000 Z
+date: 2014-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -24,6 +24,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: parslet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: prawn
   requirement: !ruby/object:Gem::Requirement
@@ -115,16 +129,22 @@ files:
 - lib/hierogloss.rb
 - lib/hierogloss/dictionary.rb
 - lib/hierogloss/gloss.rb
+- lib/hierogloss/mdc.rb
+- lib/hierogloss/metrics.rb
+- lib/hierogloss/metrics/data.rb
 - lib/hierogloss/version.rb
 - lib/kramdown/converter/bbcode.rb
 - lib/kramdown/converter/htlal.rb
 - lib/kramdown/parser/hierogloss.rb
 - src/Gardiner.ttf
+- src/dump_metrics.rb
 - test/minitest_helper.rb
 - test/test_dictionary.rb
 - test/test_gloss.rb
 - test/test_hierogloss.rb
 - test/test_kramdown_extensions.rb
+- test/test_mdc.rb
+- test/test_metrics.rb
 homepage: https://github.com/emk/hierogloss
 licenses:
 - Public domain + other open source licenses
@@ -155,3 +175,5 @@ test_files:
 - test/test_gloss.rb
 - test/test_hierogloss.rb
 - test/test_kramdown_extensions.rb
+- test/test_mdc.rb
+- test/test_metrics.rb