hierogloss 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0ddc0d217ce2338569073c4d5da2259a595b62b
-  data.tar.gz: a7f2c0564b348abcc6c864796ad69873896079a4
+  metadata.gz: 2217a6d05d499f86580c6cab5f2125b6d2a2be61
+  data.tar.gz: 1271a83c6216b0e156e4d0db70d7cff4161b5501
 SHA512:
-  metadata.gz: 740be2d088f038a3a2d5ab40fc898799890ccba066047d293124532a62043372c6eebe28f75f9f23c7ab3d238b498a1c40e3e018ba9cbe27ad3e82a734ef77af
-  data.tar.gz: 0faa6a5486c3b58c9ac54e6c65028534ffe42a9472dbd782452887d525c439dbda57f009bf450d33e445798209d79c689bcd712712fe714062490522983b324c
+  metadata.gz: 00e1516a717baec63b0b0b7f41916cd3082d3300db386123bdc79e622813fb316050de6cd43b642e356a6bd3f90b405fbfc17f7ac182d8b2c37235124d20c1ba
+  data.tar.gz: ba57a23e71dc632fe92fc63960270cda4d1dc555107a30c6e381e17ed2b38d5de40825fab1e3463b1df72c618c87bc5afc381f97f956c2f3601ce61d052fe8a3

data/README.md

@@ -12,7 +12,7 @@ write:
     This example is based on one in Allen's excellent [Middle Egyptian: An
     Introduction to the Language and Culture of Hieroglyphs][allen].
 
-    H: z:A1*Z1 | 𓊃:𓏏*𓁐 | 𓂋:𓏤-𓊪:𓅱
+    H: z:A1*Z1 | 𓊃:𓏏*𓁐 | 𓂋:𓏤-𓊪𓅱
     L: s | s.t | r-pw
     G: man | woman | whichever
     T: either [a] man or [a] woman
@@ -27,8 +27,9 @@ be presented in an appropriate font with Unicode characters.
 
 You can render this as HTML by running:
 
-    hierogloss example.md > example.html
+    hierogloss -i example.md > example.html
 
+The `-i` flag causes `hierogloss` to render the hieroglyphs as images.
 This will give you the following:
 
 > ![](examples/disjunction.png)

data/bin/hierogloss

@@ -3,7 +3,7 @@
 require 'optparse'
 require 'hierogloss'
 
-options = { format: 'html' }
+options = { format: 'html', images: false }
 
 OptionParser.new do |opts|
   opts.banner = "Usage: hierogloss [options] files..."
@@ -13,9 +13,15 @@ OptionParser.new do |opts|
           "  (defaults to html)") do |format|
     options[:format] = format
   end
+
+  opts.on("-i", "--[no-]images",
+          "Use inline images to render hieroglyphs",
+          "  (defaults to off)") do |images|
+    options[:images] = images
+  end
 end.parse!
 
-args = { input: 'hierogloss' }
+args = { input: 'hierogloss', use_images_for_signs: options[:images] }
 if options[:format] == 'html'
   args[:template] =
     File.join(File.dirname(__FILE__), '..', 'data', 'hierogloss.html.erb')

data/examples/disjunction.md

@@ -3,7 +3,7 @@
 This example is based on one in Allen's excellent [Middle Egyptian: An
 Introduction to the Language and Culture of Hieroglyphs][allen].
 
-H: z:A1*Z1 | 𓊃:𓏏*𓁐 | 𓂋:𓏤-𓊪:𓅱
+H: z:A1*Z1 | 𓊃:𓏏*𓁐 | 𓂋:𓏤-𓊪𓅱
 L: s | s.t | r-pw
 G: man | woman | whichever
 T: either [a] man or [a] woman

data/lib/hierogloss/gloss.rb

@@ -27,12 +27,12 @@ module Hierogloss
       nil
     end
 
-    def to_kramdown
+    def to_kramdown(options)
       attrs = attributes
       tr = Kramdown::Element.new(:tr, nil, attrs)
       cells.each do |c|
         td = Kramdown::Element.new(:td)
-        children = cell_to_kramdown(c)
+        children = cell_to_kramdown(c, options)
         if children.kind_of?(Array)
           td.children.concat(children)
         else
@@ -43,7 +43,7 @@ module Hierogloss
       tr
     end
 
-    def cell_to_kramdown(cell)
+    def cell_to_kramdown(cell, options)
       Kramdown::Element.new(:text, cell)
     end
 
@@ -71,13 +71,17 @@ module Hierogloss
       @cells ||= raw_cells.map {|c| Hierogloss::MdC.parse(c) }
     end
 
-    def cell_to_kramdown(cell)
-      cell.to_linear_hieroglyphs.chars.map do |c|
-        gardiner = Dictionary.sign_to_gardiner(c)
-        unless gardiner.nil? || UNLINKED[c]
-          search_link("Signe:#{gardiner}", c)
-        else
-          Kramdown::Element.new(:text, c)
+    def cell_to_kramdown(cell, options)
+      if options[:use_images_for_signs]
+        Kramdown::Element.new(:img, nil, 'src' => cell.to_mdc_image_url)
+      else
+        cell.to_linear_hieroglyphs.chars.map do |c|
+          gardiner = Dictionary.sign_to_gardiner(c)
+          unless gardiner.nil? || UNLINKED[c]
+            search_link("Signe:#{gardiner}", c)
+          else
+            Kramdown::Element.new(:text, c)
+          end
         end
       end
     end
@@ -107,7 +111,7 @@ module Hierogloss
       'hgls-l'
     end
 
-    def cell_to_kramdown(cell)
+    def cell_to_kramdown(cell, options)
       fancy = self.class.fancy(cell)
       search_link(Dictionary.headword(cell), fancy)
     end
@@ -129,7 +133,7 @@ module Hierogloss
       'hgls-t'
     end
 
-    def to_kramdown
+    def to_kramdown(options)
       em = Kramdown::Element.new(:em, nil)
       em.children << Kramdown::Element.new(:text, text)
       em
@@ -155,7 +159,7 @@ module Hierogloss
       end
     end
 
-    def to_kramdown
+    def to_kramdown(options={})
       result = []
       # Neither Kramdown nor BBCode support rowspans, so we'll just cheat
       # for now.
@@ -164,7 +168,7 @@ module Hierogloss
           rows.each do |r|
             class_attr = "hgls-gloss #{r.class_attr}"
             p = Kramdown::Element.new(:p, nil, 'class' => class_attr)
-            p.children << r.to_kramdown
+            p.children << r.to_kramdown(options)
             result << p
           end
         else
@@ -172,7 +176,7 @@ module Hierogloss
                                         alignment: [])
           tbody = Kramdown::Element.new(:tbody)
           table.children << tbody
-          rows.each {|r| tbody.children << r.to_kramdown }
+          rows.each {|r| tbody.children << r.to_kramdown(options) }
           result << table
         end
       end

data/lib/hierogloss/mdc.rb

@@ -4,6 +4,16 @@ module Hierogloss
   #:nodoc: Our parser for the Manuel de Codage format.
   module MdC
     class Block
+      protected
+
+      # This whole precedence business may need more test cases further work.
+      def maybe_parens(current, context, str)
+        if current < context
+          "(#{str})"
+        else
+          str
+        end
+      end
     end
 
     class Sign < Block
@@ -33,6 +43,27 @@ module Hierogloss
       end
     end
 
+    class Composed < Block
+      attr_reader :base, :composed
+
+      def initialize(base, composed)
+        @base = base
+        @composed = composed
+      end
+
+      def to_debug
+        [:composed, base.to_debug, composed.to_debug]
+      end
+
+      def to_linear_hieroglyphs
+        [base.to_linear_hieroglyphs, composed.to_linear_hieroglyphs]
+      end
+
+      def to_mdc(precedence)
+        maybe_parens(3, precedence, "#{base.to_mdc(3)}&#{composed.to_mdc(3)}")
+      end
+    end
+
     class Group < Block
       attr_reader :blocks
 
@@ -47,17 +78,6 @@ module Hierogloss
       def to_linear_hieroglyphs
         blocks.map {|b| b.to_linear_hieroglyphs }
       end
-
-      protected
-
-      # This whole precedence business may need more test cases further work.
-      def maybe_parens(current, context, str)
-        if current < context
-          "(#{str})"
-        else
-          str
-        end
-      end
     end
 
     class Sequence < Group
@@ -85,6 +105,11 @@ module Hierogloss
       def to_mdc
         blocks.map {|b| b.to_mdc(0) }.join("-")
       end
+
+      def to_mdc_image_url
+        esc = URI.escape(to_mdc, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+        "http://i.hierogloss.net/mdc/#{esc}.png"
+      end
     end
 
     class Parser < Parslet::Parser
@@ -97,12 +122,15 @@ module Hierogloss
       rule(:unicode_sign) { match('[\u{13000}-\u{1342F}]') }
       rule(:sign) { (alpha_sign | unicode_sign).as(:sign) >> space? }
 
+      # Signs with special composition behavior, as per JSesh.
+      rule(:composed) { sign.as(:base) >> str('&') >> atomic.as(:composed) }
+
       # Parenthesized blocks.
       rule(:parens) { str('(') >> space? >> sequence >> str(')') >> space? }
 
       # "Terminal" chunks in our expression grammar, which will match
       # an actual, concrete symbol in the first position.
-      rule(:atomic) { sign | parens }
+      rule(:atomic) { composed | sign | parens }
 
       # A list of items with separators between them.
       def separated(item, separator)
@@ -132,6 +160,9 @@ module Hierogloss
 
       rule(head: subtree(:head), rest: sequence(:rest)) { [head].concat(rest) }
       rule(sign: simple(:sign)) { Sign.new(sign.to_s) }
+      rule(base: simple(:base), composed: simple(:composed)) do
+        Composed.new(base, composed)
+      end
       rule(stack: subtree(:list)) {|d| lists_as(Stack, d[:list]) }
       rule(juxtaposed: subtree(:list)) {|d| lists_as(Sequence, d[:list]) }
     end

data/lib/hierogloss/version.rb

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

data/lib/kramdown/parser/hierogloss.rb

@@ -27,7 +27,8 @@ module Kramdown
       def parse_gloss
         start_line_number = @src.current_line_number
         data = @src.scan(self.class::GLOSS_MATCH)
-        @tree.children.concat(::Hierogloss::Gloss.new(data).to_kramdown)
+        elems = ::Hierogloss::Gloss.new(data).to_kramdown(@options)
+        @tree.children.concat(elems)
         true
       end
 

data/test/test_gloss.rb

@@ -42,4 +42,8 @@ EOD
     assert(kramdown.length > 0)
     kramdown.each {|k| assert_instance_of(Kramdown::Element, k) }
   end
+
+  def test_should_be_convertible_to_kramdown_with_images
+    kramdown = @gloss.to_kramdown(use_images_for_signs: true)
+  end
 end

data/test/test_mdc.rb

@@ -29,6 +29,10 @@ class TestCodage < MiniTest::Test
     assert_parse([[:stack, "𓇾", ["𓏤", "𓈇"]]], "𓇾:𓏤*𓈇")
   end
 
+  def test_should_parse_composed_signs
+    assert_parse([[:composed, "𓅱", "𓏏"]], "𓅱&𓏏")
+  end
+
   def test_should_honor_parens
     assert_parse([[:stack, ["p", [:stack, "t", "Z4"]], "pt"]], "p*(t:Z4):pt")
   end
@@ -40,6 +44,7 @@ class TestCodage < MiniTest::Test
   def test_should_convert_mdc_to_linear_hieroglyphs
     assert_linear_hieroglyphs("𓆓𓂧𓈖", "𓆓:𓂧𓈖")
     assert_linear_hieroglyphs("𓊪𓏏𓏭𓇯", "p*(t:Z4):pt")
+    assert_linear_hieroglyphs("𓅱𓏏", "𓅱&𓏏")
   end
 
   def assert_mdc(expected, input)
@@ -49,7 +54,17 @@ class TestCodage < MiniTest::Test
   def test_should_convert_mdc_to_mdc_string
     assert_mdc("D:d-n", "𓆓:𓂧𓈖")
     assert_mdc("p*(t:Z4):pt", "p*(t:Z4):pt")
+    assert_mdc("w&t", "𓅱&𓏏")
     # Compound signs are always placed in parens.
     assert_mdc("(N33*N33:N33*N33)", "𓃌")
   end
+
+  def assert_mdc_image_url(expected, input)
+    assert_equal(expected, Hierogloss::MdC.parse(input).to_mdc_image_url)
+  end
+
+  def test_should_convert_to_mdc_image_url
+    assert_mdc_image_url("http://i.hierogloss.net/mdc/p*(t%3AZ4)%3Apt.png",
+                         "p*(t:Z4):pt")
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hierogloss
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Eric Kidd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-21 00:00:00.000000000 Z
+date: 2014-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown