hierogloss 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1c7226840e4b86ba6e423abc777be7d2e052192
-  data.tar.gz: 7d147b77e33083bd3906d88c954c48634f5619ee
+  metadata.gz: 013868a650a3464e07c17bcca8f37bcba3e52974
+  data.tar.gz: a02e8d67a85df5dcfedc9ae87447bf6604ed3587
 SHA512:
-  metadata.gz: 5da667b94a99bc656432c66c26e8cf576689ce4c56673ecbc4a1ab39f6d3fef5ada0da69aa2f8171174c9b9e09f4c714343d3316ffbdff359933e56855689a22
-  data.tar.gz: 77a1887d0318f9e4b88a86b3744fe5715bdf25856dc3de4595d16bc204d822d365db77f14814d6fd89bb6b67c144c2930445a1df582247cbe383122ad277be4d
+  metadata.gz: 9a362073542fa41bad251c4f0d38e9310b051fc617615036f9448d68e55a6855e0dd27e2e9c6d2489d7f0987245c07453775083c395817d23e8498d863b5801d
+  data.tar.gz: e17841bf61cb0b4b77680c498a6f93169a670246604b593b84b6b26a1ed3ec61b2edf5da8ca1aca437ebc7919cc138d088a8b0c892fa744b1ae23ed8ed36f52b

data/bin/hierogloss

@@ -3,12 +3,12 @@
 require 'optparse'
 require 'hierogloss'
 
-options = { format: 'html', images: false }
+options = { format: 'html', images: false, translit: :jy_unicode }
 
 OptionParser.new do |opts|
   opts.banner = "Usage: hierogloss [options] files..."
 
-  opts.on("-f", "--format [FORMAT]",
+  opts.on("-f", "--format FORMAT",
           "Output format (html, bbcode, htlal)",
           "  (defaults to html)") do |format|
     options[:format] = format
@@ -19,9 +19,19 @@ OptionParser.new do |opts|
           "  (defaults to off)") do |images|
     options[:images] = images
   end
+
+  opts.on("-t", "--translit TRANSLIT",
+          "Output transliteration convention (jy_unicode, mdc)",
+          "  (defaults to jy_unicode)") do |translit|
+    options[:translit] = translit.to_sym
+  end
 end.parse!
 
-args = { input: 'hierogloss', use_images_for_signs: options[:images] }
+args = {
+  input: 'hierogloss',
+  use_images_for_signs: options[:images],
+  transliteration: options[:translit]
+}
 if options[:format] == 'html'
   args[:template] =
     File.join(File.dirname(__FILE__), '..', 'data', 'hierogloss.html.erb')

data/lib/hierogloss/gloss.rb

@@ -88,30 +88,12 @@ module Hierogloss
 
   #:nodoc:
   class TransliterationRow < Row
-    JR_TRANSLITERATION = {
-      "A" => "ꜣ",
-      "i" => "j",
-      "a" => "ꜥ",
-      "H" => "ḥ",
-      "x" => "ḫ",
-      "X" => "ẖ",
-      "S" => "š",
-      "q" => "ḳ",
-      "K" => "ḳ",
-      "T" => "ṯ",
-      "D" => "ḏ"
-    }
-
-    def self.fancy(tl)
-      tl.chars.map {|c| JR_TRANSLITERATION[c] || c }.join
-    end
-
     def class_attr
       'hgls-l'
     end
 
     def cell_to_kramdown(cell, options)
-      fancy = self.class.fancy(cell)
+      fancy = Hierogloss::Transliteration.render(cell, options[:transliteration])
       search_link(Dictionary.headword(cell), fancy)
     end
   end

data/lib/hierogloss/transliteration.rb

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+module Hierogloss
+  # :nodoc: Transliteration utilities.
+  module Transliteration
+    STYLES = {
+      # Output as raw MdC.  Useful when the user isn't expected to have any
+      # fonts.
+      mdc: {},
+
+      # This is widely used in places like Allen, Loprieno and Thesaurus
+      # Linguae Aegyptiae.
+      jy_unicode: {
+        "A" => "ꜣ",
+        "i" => "j",
+        "a" => "ꜥ",
+        "H" => "ḥ",
+        "x" => "ḫ",
+        "X" => "ẖ",
+        "S" => "š",
+        "q" => "ḳ",
+        "K" => "ḳ",
+        "T" => "ṯ",
+        "D" => "ḏ"
+      }
+    }
+
+    # Convert from MDC to another transliteration style.  Defaults to
+    # :jy_unicode.
+    def self.render(mdc, style=nil)
+      style ||=:jy_unicode
+      conv = STYLES[style]
+      raise "Unknown transliteration style: #{style}" unless conv
+      mdc.chars.map {|c| conv[c] || c }.join
+    end
+  end
+end

data/lib/hierogloss/version.rb

@@ -1,3 +1,3 @@
 module Hierogloss
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/hierogloss.rb

@@ -3,6 +3,7 @@ require "hierogloss/version"
 require "hierogloss/dictionary"
 require "hierogloss/metrics"
 require "hierogloss/mdc"
+require "hierogloss/transliteration"
 require "hierogloss/gloss"
 require "kramdown/parser/hierogloss"
 require "kramdown/converter/bbcode"

data/lib/kramdown/parser/hierogloss.rb

@@ -15,8 +15,9 @@ module Kramdown
         @src.pos += @src.matched_size
         mdc = @src.matched[1..-2]
         em = Element.new(:em, nil, 'class' => 'hgls-l')
-        em.children <<
-          Element.new(:text, ::Hierogloss::TransliterationRow.fancy(mdc))
+        rendered =
+          ::Hierogloss::Transliteration.render(mdc, @options[:transliteration])
+        em.children << Element.new(:text, rendered)
         @tree.children << em
       end
       define_parser(:translit, TRANSLIT_START, '{')

data/test/test_transliteration.rb

@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+require 'minitest_helper'
+
+class TestTransliteration < MiniTest::Test
+  def assert_renders(output, input, type)
+    assert_equal output, Hierogloss::Transliteration.render(input, type)
+  end
+
+  def test_should_render_common_tranliterations
+    assert_renders "biA.t y", "biA.t y", :mdc
+    assert_renders "bjꜣ.t y", "biA.t y", :jy_unicode
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hierogloss
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Eric Kidd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-23 00:00:00.000000000 Z
+date: 2014-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -132,6 +132,7 @@ files:
 - lib/hierogloss/mdc.rb
 - lib/hierogloss/metrics.rb
 - lib/hierogloss/metrics/data.rb
+- lib/hierogloss/transliteration.rb
 - lib/hierogloss/version.rb
 - lib/kramdown/converter/bbcode.rb
 - lib/kramdown/converter/htlal.rb
@@ -145,6 +146,7 @@ files:
 - test/test_kramdown_extensions.rb
 - test/test_mdc.rb
 - test/test_metrics.rb
+- test/test_transliteration.rb
 homepage: https://github.com/emk/hierogloss
 licenses:
 - Public domain + other open source licenses
@@ -177,3 +179,4 @@ test_files:
 - test/test_kramdown_extensions.rb
 - test/test_mdc.rb
 - test/test_metrics.rb
+- test/test_transliteration.rb