epos 0.9.0

data/README.md

@@ -0,0 +1,45 @@
+Epos
+====
+
+Epos, from the Greek ἔπος (“word”), is a Ruby gem that gives you access to the
+data files of the excellent
+[Houaiss dictionary](http://www.objetiva.com.br/livro_ficha.php?id=707).
+
+Please notice that you must
+[buy the dictionary](http://www.objetiva.com.br/livro_ficha.php?id=707) in order
+to use this gem.
+
+Features
+--------
+
+* Entries can be retrieved as HTML.
+* Both the main dictionary and the morpheme one are supported.
+* There's a parser for the structure used by entries.
+* There's a parser for the RTF-like format used by the text.
+* Characters are rendered correctly, even those in the etymology section or in
+  the pronunciation of foreign words.
+
+Example
+-------
+
+The following example looks up the word *épico* and saves it to a file:
+
+    require 'epos'
+    dict = Epos::Dictionary.new("/home/user/houaiss")
+    File.write("épico.html", dict.look_up("épico"))
+
+This is what it should look like:
+
+![épico](epico.png)
+
+Limitations
+-----------
+
+* No support for animal sounds, verb conjugation, etc.
+* No nice interface.
+
+Compatibility
+-------------
+
+I know it works with version 2009.6 (July 2013).  I don't know about any other
+version.

data/README.pt-br.md

@@ -0,0 +1,43 @@
+Epos
+====
+
+Epos, do grego ἔπος (“palavra”), é uma gem de Ruby que dá acesso aos arquivos de
+dados do excelente
+[dicionário Houaiss eletrônico da língua portuguesa](http://www.objetiva.com.br/livro_ficha.php?id=707).
+
+Note que você precisa
+[comprar o dicionário](http://www.objetiva.com.br/livro_ficha.php?id=707) para
+usar esta gem.
+
+Funcionalidades
+---------------
+
+* Os verbetes podem ser convertidos para HTML.
+* Há um analisador para a estrutura usada nos verbetes.
+* Há um analisador para o formato do texto, que é semelhante ao RTF.
+* Os caracteres aparecem corretamente, mesmo aqueles na parte de etimologia e na
+  pronúncia de palavras estrangeiras.
+
+Exemplo
+-------
+
+O seguinet exemplo busca a definição da palavra *épico* e a salva num arquivo:
+
+    require 'epos'
+    dict = Epos::Dictionary.new("/home/user/houaiss")
+    File.write("épico.html", dict.look_up("épico"))
+
+Deve gerar algo assim:
+
+![épico](epico.png)
+
+Limitações
+----------
+
+* Não há suporte às vozes de animais, à conjugação verbal, etc.
+* Não há uma interface amigável.
+
+Compatibilidade
+---------------
+
+Sei que funciona com a versão 2009.6 (Julho de 2013).  Não sei sobre as outras.

data/epos.gemspec

@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name        = 'epos'
+  s.version     = '0.9.0'
+  s.date        = '2014-09-05'
+  s.summary     = "Access to the Houaiss dictionary data files"
+  s.description = "Provides access to the Houaiss dictionary data files.  Entries can be exported as HTML."
+  s.authors     = ["Adiel Mittmann"]
+  s.email       = 'adiel@mittmann.net.br'
+  s.homepage    = 'https://github.com/adiel-mittmann/epos'
+  s.license     = 'GPL3'
+
+  s.files       = %w(LICENSE README.md README.pt-br.md epico.png epos.gemspec) +
+                  Dir["lib/**/*.rb"] +
+                  Dir["lib/**/*.slim"] +
+                  Dir["lib/**/*.css"] +
+                  Dir["examples/**/*.rb"]
+
+  s.add_dependency 'slim', '>= 2.0.0'
+end

data/examples/web.rb

@@ -0,0 +1,9 @@
+require 'epos'
+require 'sinatra'
+
+set :dict, Epos::Dictionary.new(ARGV[0] || ".")
+set :bind, '0.0.0.0'
+
+get "/:level/:word/" do
+  settings.dict.look_up(params[:word], level: params[:level].to_i, fragment: false)
+end

data/lib/epos/cp/f1.rb

@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+module Epos
+  class CodePage
+    F1_MAP = {
+      "¬"      => "-́",
+      "\u0096" => "—",
+      "\u0097" => "—",
+      "\u0086" => "✝",
+      "\u0093" => "“",
+      "\u0094" => "”",
+      "\u009c" => "œ", # A mistake, should be f6, e.g. "causeur".
+    }
+  end
+end

data/lib/epos/cp/f10.rb

@@ -0,0 +1,18 @@
+# -*- coding: utf-8 -*-
+module Epos
+  class CodePage
+    F10_MAP = {
+      "t" => "ṭ",
+      "h" => "ḥ",
+      "s" => "ṣ",
+      "H" => "Ḥ",
+      "d" => "ḍ",
+      "r" => "ṛ",
+      "S" => "Ṣ",
+      "n" => "ṇ",
+      "z" => "ẓ",
+      "m" => "ṃ",
+      "l" => "ḷ",
+    }
+  end
+end

data/lib/epos/cp/f11.rb

@@ -0,0 +1,51 @@
+# -*- coding: utf-8 -*-
+module Epos
+  class CodePage
+    F11_MAP = {
+      "®" => "→",
+      "¾" => "—",
+      "a" => "α",
+      "b" => "β",
+      "c" => "χ",
+      "d" => "δ",
+      "Ç" => "∩",
+      "D" => "Δ",
+      "e" => "ε",
+      "È" => "∪",
+      "f" => "φ",
+      "F" => "Φ",
+      "g" => "γ",
+      "G" => "Γ",
+      "h" => "η",
+      "i" => "ι",
+      "k" => "κ",
+      "l" => "λ",
+      "m" => "μ",
+      "Ñ" => "∇",
+      "o" => "ο",
+      "ò" => "ʃ",
+      "Ö" => "√",
+      "º" => "≡",
+      "p" => "π",
+      "q" => "θ",
+      "Q" => "Θ",
+      "r" => "ρ",
+      "s" => "σ",
+      "S" => "Σ",
+      "t" => "τ",
+      "u" => "υ",
+      "U" => "Υ",
+      "V" => "ζ", # "dzeta".  Houaiss shows "ς".
+      "w" => "ω",
+      "W" => "Ω",
+      "x" => "ξ",
+      "X" => "Ξ",
+      "y" => "ψ",
+      "Y" => "Ψ",
+      "." => ".",
+      "L" => "Λ",
+      "n" => "ν",
+      "P" => "Π",
+    }
+  end
+end

data/lib/epos/cp/f12.rb

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+module Epos
+  class CodePage
+    F12_MAP = {
+      "¿" => "♭",
+      "Æ" => "𝅘𝅥𝅲",
+      "x" => "𝅘𝅥𝅯",
+      "w" => "𝅝",
+      "r" => "𝅘𝅥𝅰",
+      "q" => "𝅘𝅥",
+      "k" => "♮",
+      "h" => "𝅗𝅥",
+      "e" => "𝅘𝅥𝅮",
+      "B" => "𝄡",
+      "?" => "𝄢",
+      "&" => "𝄞",
+    }
+  end
+end

data/lib/epos/cp/f13.rb

@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+module Epos
+  class CodePage
+    F13_MAP = {
+      "ì" => "ĭ",
+      "á" => "ā",
+      "í" => "ī",
+      "ó" => "ō",
+      "è" => "ĕ",
+      "ý" => "ȳ",
+      "ù" => "ŭ",
+      "é" => "ē",
+      "ú" => "ū",
+      "ò" => "ŏ",
+      "à" => "ă",
+      "ø" => "ø",
+      "u" => "u",
+      "i" => "i",
+    }
+  end
+end

data/lib/epos/cp/f16.rb

@@ -0,0 +1,8 @@
+# -*- coding: utf-8 -*-
+module Epos
+  class CodePage
+    F16_MAP = {
+      "D" => "⇆",
+    }
+  end
+end

data/lib/epos/cp/f2.rb

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+module Epos
+  class CodePage
+    F2_MAP = {
+      "Á"      => "Ā",
+      "Ó"      => "Ō",
+      "á"      => "ā",
+      "é"      => "ē",
+      "í"      => "ī",
+      "ó"      => "ō",
+      "ú"      => "ū",
+      "ý"      => "ȳ",
+      "à"      => "ă",
+      "è"      => "ĕ",
+      "ì"      => "ĭ",
+      "ò"      => "ŏ",
+      "ù"      => "ŭ",
+      "þ"      => "y̆",
+      "â"      => "ā́",
+      "ê"      => "ḗ",
+      "ô"      => "ṓ",
+      "î"      => "ī́",
+      "ë"      => "ẹ",
+      "ö"      => "ọ",
+      "ü"      => "ụ",
+      "k"      => "k",
+      "h"      => "h",
+      "d"      => "d",
+      "n"      => "n",
+      "o"      => "o",
+      "c"      => "c",
+      "e"      => "e",
+      "m"      => "m",
+      "i"      => "i",
+      "r"      => "r",
+      "l"      => "l",
+      "u"      => "u",
+      "s"      => "s",
+      "a"      => "a",
+      "i"      => "i",
+      "t"      => "t",
+      "g"      => "g",
+      "y"      => "y",
+      ">"      => ">",
+      "'"      => "'",
+      ","      => ",",
+      "-"      => "-",
+      " "      => " ",
+      ")"      => ")",
+      "\u0096" => "—",
+      "\u0097" => "—",
+      "¬"      => "-́",
+    }
+  end
+end

data/lib/epos/cp/f3.rb

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+module Epos
+  class CodePage
+    F3_MAP = {
+      "\u0096" => "-́",
+      "g"      => "ĝ",
+      "e"      => "ẽ",
+      "i"      => "ĩ",
+      "u"      => "ũ",
+      "¬"      => "-",
+      "-"      => "-",
+      "j"      => "j̈",
+      "s"      => "s",
+      "y"      => "ỹ",
+      " "      => " ",
+      "k"      => "ǩ",
+    }
+  end
+end

data/lib/epos/cp/f4.rb

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+module Epos
+  # "y" is used in two entries: "evonim-" and "mormir(o)-".  In both cases, it
+  # is shown as a "y" with something weird below.  In the first entry, it is
+  # used to represent the *short* "y" in "euonymus"; in the second, the *long*
+  # "y" in "mormyr".  So...
+  class CodePage
+    F4_MAP = {
+      "H" => "ʰ",
+      "N" => "ⁿ",
+      "T" => "ᵗ",
+      "S" => "ˢ",
+      "J" => "ʲ",
+      "ï" => "ï",
+      "D" => "ᵈ",
+      "y" => "y",
+    }
+  end
+end

data/lib/epos/cp/f6.rb

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+module Epos
+  class CodePage
+    F6_MAP = {
+      "«"      => "ə",
+      '"'      => "ɪ",
+      "E"      => "ɛ",
+      "S"      => "ʃ",
+      "\u0086" => "ɔ",
+      "A"      => "ɑ",
+      "N"      => "ŋ",
+      "Z"      => "ʒ",
+      "Ã"      => "ʌ",
+      "¡"      => "ɑ̃",
+      "Î"      => "ɜ",
+      "é"      => "ɛ̃",
+      "U"      => "ʊ",
+      "\u009c" => "œ",
+      "ø"      => "ɲ",
+      "Ö"      => "ʕ",
+      "ç"      => "ɥ",
+      "|"      => "ɫ",
+      "ö"      => "ɨ",
+      "¢"      => "ɔ̃",
+      "´"      => "ʎ",
+      "l"      => "ḷ",
+      "â"      => "a͡a",
+      "¸"      => "ɸ",
+      "D"      => "ð",
+      "\u008a" => "ș",
+      "t"      => "ț",
+    }
+  end
+end

data/lib/epos/cp/f7.rb

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+module Epos
+  class CodePage
+    F7_MAP = {
+      "r"      => "ɹ",
+      "e"      => "ẹ",
+      "·"      => "ẹ",
+      "\u0096" => "o̧",
+      "¢"      => "ɔ̃",
+      "m"      => "ɯ",
+      "¡"      => "ɑ̃",
+      "ø"      => "ɲ",
+      "«"      => "ə",
+      "w"      => "ẅ",
+      "M"      => ">", # "antilambda", but see http://en.wikipedia.org/wiki/Diple_(textual_symbol)
+      "A"      => "ɑ",
+    }
+  end
+end

data/lib/epos/cp/f8.rb

@@ -0,0 +1,29 @@
+# -*- coding: utf-8 -*-
+module Epos
+  class CodePage
+    # Characters in this page produce a line above some of the characters that
+    # precede them.  Their purpose is to indicate the pitch in Japanese words.
+    # Lowercase letters indicate that the pitch remains the same, uppercase that
+    # it drops.  The closer a letter is to the beginning of the alphabet, the
+    # shorter the line that it produces.
+    #
+    # The length of the line does not match well letter boundaries.  It's
+    # difficult to establish how many letters should be affected.
+    F8_MAP = {
+      "c" => "",
+      "d" => "",
+      "e" => "",
+      "f" => "",
+      "h" => "",
+      "j" => "",
+
+      "A" => "˺",
+      "C" => "˺",
+      "D" => "˺",
+      "E" => "˺",
+      "F" => "˺",
+      "G" => "˺",
+      "H" => "˺",
+    }
+  end
+end

data/lib/epos/cp/f9.rb

@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+module Epos
+  class CodePage
+    F9_MAP = {
+      "t" => "ṭ",
+      "H" => "Ḥ",
+      "s" => "ṣ",
+      "r" => "ṛ",
+      "h" => "ḥ",
+      "d" => "ḍ",
+      "n" => "ṇ",
+    }
+  end
+end

data/lib/epos/data-file.rb

@@ -0,0 +1,28 @@
+require 'epos/encoded-file.rb'
+
+module Epos
+
+  class DataFile
+
+    def initialize(path)
+      @file = EncodedFile.new(path)
+    end
+
+    def read_entry(pos)
+      @file.seek(pos + 1)
+      s = "*"
+      while !@file.eof?
+        t = @file.read(1024)
+        break if t == nil || t == ""
+        s << t
+        i = s.index("\n*")
+        if i
+          s = s[0..i]
+          break
+        end
+      end
+      return s
+    end
+
+  end
+end

data/lib/epos/dictionary.rb

@@ -0,0 +1,104 @@
+# -*- coding: utf-8 -*-
+require 'epos/indexed-data-file.rb'
+require 'epos/html-formatter.rb'
+require 'epos/entry-parser.rb'
+
+module Epos
+  class Dictionary
+
+    def initialize(path)
+      @idf1 = Epos::IndexedDataFile.new(File.join(path, "deah002.dhn"), File.join(path, "deah001.dhn"))
+      @idf2 = Epos::IndexedDataFile.new(File.join(path, "deah008.dhn"), File.join(path, "deah007.dhn"))
+
+      @fmt1 = Epos::HtmlFormatter.new(unmarked: false)
+      @fmt2 = Epos::HtmlFormatter.new(unmarked: true)
+
+      @entry_parser = Epos::EntryParser.new
+
+      @fuzzy = {}
+
+      (@idf1.keys + @idf2.keys).each do |key|
+        simple = simplify(key)
+        if @fuzzy.has_key?(simple)
+          @fuzzy[simple] << key
+        else
+          @fuzzy[simple] = [key]
+        end
+      end
+
+      @fuzzy.each_value do |value|
+        value.sort!.uniq!
+      end
+    end
+
+    def look_up(word, level: 1, fragment: false)
+      html        = ""
+      simple_word = simplify(word)
+      used        = {}
+
+      if level >= 0
+        html << look_up_and_format(word)
+        used[word] = true
+      end
+
+      if level >= 1
+        (@fuzzy[simple_word] || []).each do |actual|
+          if !used[actual]
+            html << look_up_and_format(actual)
+            used[actual] = true
+          end
+        end
+      end
+
+      if level >= 2
+        @fuzzy.each do |simple, words|
+          if simple.include?(simple_word)
+            words.each do |actual|
+              if !used[actual]
+                html << look_up_and_format(actual)
+                used[actual] = true
+              end
+            end
+          end
+        end
+      end
+
+      if !fragment
+        if html.length == 0
+          html = "<i>No results were found for your query.</i>"
+        end
+        html = %Q{
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset='utf-8'>
+    <title>Epos</title>
+    <style type='text/css'>#{self.style}</style>
+  </head>
+  <body>
+    #{html}
+  </body>
+</html>
+}
+      end
+
+      return html
+    end
+
+    def style
+      @fmt1.style
+    end
+
+    def look_up_and_format(word)
+      s = ""
+      s << @idf1.look_up(word).map{|text| @fmt1.format(@entry_parser.parse(text))}.join
+      s << @idf2.look_up(word).map{|text| @fmt2.format(@entry_parser.parse(text))}.join
+      return s
+    end
+
+    def simplify(s)
+      s.tr("áéíóúâêôãõàüçÁÉÍÓÚÂÊÔÃÕÀÜÇ", "aeiouaeoaoaucaeiouaeoaoauc").gsub(/[ -\\(\\)]/, "")
+    end
+
+  end
+end

data/lib/epos/encoded-file.rb

@@ -0,0 +1,38 @@
+module Epos
+  class EncodedFile
+
+    def initialize(path)
+      @io = File.open(path, "rb")
+    end
+
+    def read(length = nil)
+      self.decipher(@io.read(length)).encode("utf-8", "iso-8859-1")
+    end
+
+    def seek(pos)
+      @io.seek(pos)
+    end
+
+    def close
+      @io.close
+    end
+
+    def eof?
+      @io.eof?
+    end
+
+    def self.read(path, length = nil)
+      file = EncodedFile.new(path)
+      data = file.read(length)
+      file.close
+      return data
+    end
+
+    protected
+
+    def decipher(data)
+      data.bytes.map{|b| b = (b + 0x0b) % 255; b == 11 ? 10 : b}.pack("C*")
+    end
+
+  end
+end