treat 0.2.5 → 1.0.0

data/lib/treat/kernel.rb

@@ -2,20 +2,22 @@
 # easy access to utility functions used across
 # the library.
 module Kernel
+  
+  # Require file utilities for creating and
+  # deleting temporary files.
   require 'fileutils'
-  require 'tempfile'
+
   # A list of acronyms used in class names within
   # the program. These do not CamelCase; they
   # CAMELCase.
-  Acronyms = ['XML', 'HTML', 'YAML', 'UEA', 'LDA', 'PDF'].join('|')
+  Acronyms = %w[xml html txt odt abw doc yaml uea lda pdf ptb dot ai id3 svo]
+
   # A cache to optimize camel casing.
   @@cc_cache = {}
+
   # A cache to optimize un camel casing.
   @@ucc_cache = {}
-  # Returns the platform we are running on.
-  def platform
-    RUBY_PLATFORM.split("-")[1]
-  end
+
   # Runs a block of code without warnings.
   def silence_warnings(&block)
     warn_level = $VERBOSE
@@ -24,62 +26,85 @@ module Kernel
     $VERBOSE = warn_level
     result
   end
+
   # Runs a block of code while blocking stdout.
-  def silence_stdout(log = '/dev/null')
+  def silence_stdout(log = NULL_DEVICE)
+    unless Treat.silence
+      yield; return
+    end
     old = $stdout.dup
     $stdout.reopen(File.new(log, 'w'))
     yield
     $stdout = old
   end
+  
   # Create a temporary file which is deleted
   # after execution of the block.
   def create_temp_file(ext, value = nil, &block)
-    fname = "#{Treat.lib}/../tmp/#{Random.rand(10000000).to_s}.#{ext}"
-    File.open(fname, 'w') do |f| 
-      f.write(value) if value 
+    fname = Treat.tmp + 
+    "#{Random.rand(10000000).to_s}.#{ext}"
+    File.open(fname, 'w') do |f|
+      f.write(value) if value
       block.call(f.path)
     end
   ensure
     File.delete(fname)
   end
-  # Create a temporary directory.
+
+  # Create a temporary directory, which is
+  # deleted after execution of the block.
   def create_temp_dir(&block)
-    dname = "#{Treat.lib}/../tmp/#{Random.rand(10000000).to_s}"
+    dname = "#{Treat.lib}/../tmp/"+
+    "#{Random.rand(10000000).to_s}"
     Dir.mkdir(dname)
     block.call(dname)
   ensure
     FileUtils.rm_rf(dname)
   end
+
   # Convert un_camel_case to CamelCase.
   def camel_case(o_phrase)
     phrase = o_phrase.to_s.dup
     return @@cc_cache[o_phrase] if @@cc_cache[o_phrase]
-    phrase.gsub!(/#{Acronyms.downcase}[^a-z]*/) { |a| a.upcase }
-    phrase.gsub!(/^[a-z]|_[a-z]/) { |a| a.upcase }
-    phrase.gsub!('_', '')
+
+    if Acronyms.include?(phrase)
+      phrase = phrase.upcase
+    else
+      phrase.gsub!(/^[a-z]|_[a-z]/) { |a| a.upcase }
+      phrase.gsub!('_', '')
+    end
     @@cc_cache[o_phrase] = phrase
-    phrase
   end
+
   alias :cc :camel_case
+
   # Convert CamelCase to un_camel_case.
   def un_camel_case(o_phrase)
     phrase = o_phrase.to_s.dup
     return @@ucc_cache[o_phrase] if @@ucc_cache[o_phrase]
-    phrase.gsub!(/#{Acronyms}/) { |a| a.downcase.capitalize }
-    phrase.gsub!(/[A-Z]/) { |p| '_' + p.downcase  }
-    phrase = phrase[1..-1] if phrase[0] == '_'
+    if Acronyms.include?(phrase.downcase)
+      phrase = phrase.downcase
+    else
+      phrase.gsub!(/[A-Z]/) { |p| '_' + p.downcase  }
+      phrase = phrase[1..-1] if phrase[0] == '_'
+    end
     @@ucc_cache[o_phrase] = phrase
-    phrase
   end
+
   alias :ucc :un_camel_case
+
   # Retrieve the Class from a Module::Class.
   def class_name(n); n.to_s.split('::')[-1]; end
+
   alias :cl :class_name
+
   # Search the list to see if there are words similar to #name
-  # in the #list If yes, return a string saying "Did you mean 
+  # in the #list If yes, return a string saying "Did you mean
   # ... ?" with the names.
   def did_you_mean?(list, name)
-    msg = ''
+    return '' # Fix
+    list = list.map { |e| e.to_s }
+    name = name.to_s
     sugg = []
     list.each do |element|
       l = levenshtein(element,name)
@@ -91,22 +116,38 @@ module Kernel
       if sugg.size == 1
         msg += " Perhaps you meant '#{sugg[0]}' ?"
       else
-        sugg_quote = sugg[0..-2].map {|x| '\'' + x + '\''}
-        msg += " Perhaps you meant #{sugg_quote.join(', ')}," +
+        sugg_quote = sugg[0..-2].map do
+          |x| '\'' + x + '\''
+        end
+        msg += " Perhaps you meant " +
+        "#{sugg_quote.join(', ')}," +
         " or '#{sugg[-1]}' ?"
       end
     end
     msg
   end
+
   alias :dym? :did_you_mean?
+
   # Return the name of the method that called the method
   # that calls this method.
   def caller_method(n = 3)
     at = caller(n).first
     /^(.+?):(\d+)(?::in `(.*)')?/ =~ at
-    Regexp.last_match[3].intern
+    Regexp.last_match[3].gsub('block in ', '').intern
   end
+
   alias :cm :caller_method
+
+  # Detect the platform we're running on.
+  def detect_platform
+    p = RUBY_PLATFORM.downcase
+    return :mac if p.include?("darwin")
+    return :windows if p.include?("mswin")
+    return :linux if p.include?("linux")
+    return :unknown
+  end
+
   # Return the levensthein distance between two stringsm
   # taking into account the costs of insertion, deletion,
   # and substitution. Stolen from:
@@ -116,14 +157,16 @@ module Kernel
     return nil if first.nil? || other.nil?
     dm = []
     dm[0] = (0..first.length).collect { |i| i * ins}
-    fill = [0] * (first.length - 1)
+    fill = [0] * (first.length - 1).abs
     for i in 1..other.length
       dm[i] = [i * del, fill.flatten]
     end
     for i in 1..other.length
       for j in 1..first.length
         dm[i][j] = [
-          dm[i-1][j-1] + (first[i-1] == other[i-1] ? 0 : sub),
+          dm[i-1][j-1] +
+          (first[i-1] ==
+          other[i-1] ? 0 : sub),
           dm[i][j-1] + ins,
           dm[i-1][j] + del
         ].min
@@ -131,4 +174,39 @@ module Kernel
     end
     dm[other.length][first.length]
   end
+
+  if detect_platform == :windows
+    NULL_DEVICE = 'NUL'
+  else
+    NULL_DEVICE = '/dev/null'
+  end
+  
+  def debug(msg)
+    puts msg if Treat.debug
+  end
+  
+  def prompt(msg, valid_answers)
+    
+    msg = msg
+    n = msg.include?("\n") ? ":\n" : ''
+    q = msg.include?("\n") ? '' : '?'
+    
+    s = "\nPlease enter one of #{valid_answers.join(', ')}: "
+    puts "Do you want to #{n}#{msg}#{q} \n#{s}"
+    
+    begin
+      answer = STDIN.gets.strip
+      unless valid_answers.include?(answer)
+        puts "Invalid input."
+        puts s
+        raise Treat::InvalidInputException
+      end
+      puts
+      answer
+    rescue Treat::InvalidInputException
+      retry
+    end
+    
+  end
+
 end

data/lib/treat/languages.rb

@@ -1,98 +1,132 @@
-module Treat
-  # This module provides linguistic resources
-  # for the Treat library, including information
-  # about language codes, the functions available
-  # for each language, and the different tags used
-  # to markup that language.
-  module Languages
-    Dir["#{Treat.lib}/treat/languages/*.rb"].each { |file| require file }
-    ISO639_1 = 1
-    ISO639_2 = 2
-    # Describe a language code (ISO-639-1 or ISO-639-2)
-    # or its full text description in full French or English.
-    def self.describe(lang, desc_lang = :en)
-      raise "Must provide a non-nil language identifier to describe." if lang.nil?
-      lang = code(lang).to_s
-      if [:en, :eng, :english, :anglais].include?(desc_lang)
-        l = @@english_full.key(lang)
-      elsif [:fr, :fra, :french, :french].include?(desc_lang)
-        l = @@french_full.key(lang)
-      else
-        raise Treat::Exception,
-        "Unknown language to describe: #{desc_lang}."
-      end
-      not_found(lang) if l.nil?
-      l.intern
+# This module provides linguistic resources
+# for the Treat library, including information
+# about language codes, the functions available
+# for each language, and the different tags used
+# to markup that language.
+module Treat::Languages
+
+  def self.const_missing(const)
+    lang = const.to_s.downcase
+    f = File.join(File.dirname(__FILE__), "languages", lang)
+    unless File.readable?(f + '.rb')
+      raise Treat::Exception,
+      "Language #{lang} is not supported."
     end
-    # Raise an error message when a language code
-    # or description is not found and suggest
-    # possible misspellings.
-    def self.not_found(lang)
-      msg = "Language '#{lang}' does not exist."
-      all = @@iso639_2.keys + @@iso639_1.keys +
-      @@english_full.keys + @@french_full.keys
-      msg += did_you_mean?(all, lang)
-      raise Treat::Exception, msg
+    require f
+    const_get(const)
+  end
+
+  # Yield a lowercase symbol for each
+  # defined language.
+  def self.each
+    constants.each do |constant|
+      yield constant.to_s.downcase.intern
     end
-    # Return the class representing a language.
-    def self.get(lang)
-      const_get(Treat::Languages.describe(lang).to_s.capitalize)
+  end
+
+  # Identifier constants for language codes.
+  ISO639_1 = 1
+  ISO639_2 = 2
+
+  # Describe a language code (ISO-639-1 or ISO-639-2)
+  # or its full text description in full French or English.
+  def self.describe(lang, desc_lang = :en)
+    raise "Must provide a non-nil language "+
+    "identifier to describe." if lang.nil?
+    lang = code(lang).to_s
+    if [:en, :eng, :english, :anglais].
+      include?(desc_lang)
+      l = @@english_full.key(lang)
+    elsif [:fr, :fra, :french, :french].
+      include?(desc_lang)
+      l = @@french_full.key(lang)
+    else
+      raise Treat::Exception,
+      "Unknown language to describe: #{desc_lang}."
     end
-    # Find a language by ISO-639-1 or ISO-639-2 code
-    # or full name (in English or French) and return
-    # the ISO-639-1 or ISO-639-2 language code as a
-    # lowercase identifier.
-    def self.code(lang, rc = ISO639_2)
-      raise "Must provide a non-nil language identifier to describe." if lang.nil?
-      get_languages
-      lang = lang.to_s.downcase
-      if @@iso639_1.has_key?(lang)
-        return lang.intern if rc == ISO639_1
-        return @@iso639_1[lang].intern if rc == ISO639_2
-      elsif @@iso639_2.has_key?(lang)
-        return lang.intern if rc == ISO639_2
-        return @@iso639_2[lang].intern if rc == ISO639_1
-      elsif @@english_full.has_key?(lang)
-        return @@english_full[lang].intern if rc == ISO639_2
-        return @@iso639_2[@@english_full[lang]].intern if rc == ISO639_1
-      elsif @@french_full.has_key?(lang)
-        return @@french_full[lang].intern if rc == ISO639_2
-        return @@iso639_1[@@french_full[lang]].intern if rc == ISO639_2
-      else
-        not_found(lang)
-      end
+    not_found(lang) if l.nil?
+    l.intern
+  end
+
+  # Raise an error message when a language code
+  # or description is not found and suggest
+  # possible misspellings.
+  def self.not_found(lang)
+    msg = "Language '#{lang}' does not exist."
+    all = @@iso639_2.keys + @@iso639_1.keys +
+    @@english_full.keys + @@french_full.keys
+    msg += did_you_mean?(all, lang)
+    raise Treat::Exception, msg
+  end
+
+  # Return the class representing a language.
+  def self.get(lang)
+    lang = Treat::Languages.describe(lang).to_s
+    begin
+      const_get(lang.capitalize)
+    rescue
+      not_found(lang)
+    end
+  end
+
+  # Find a language by ISO-639-1 or ISO-639-2 code
+  # or full name (in English or French) and return
+  # the ISO-639-1 or ISO-639-2 language code as a
+  # lowercase identifier.
+  def self.code(lang, rc = ISO639_2)
+    raise "Must provide a non-nil language "+
+    "identifier to describe." if lang.nil?
+    get_languages
+    lang = lang.to_s.downcase
+    if @@iso639_1.has_key?(lang)
+      return lang.intern if rc == ISO639_2
+      return @@iso639_1[lang].intern if rc == ISO639_1
+    elsif @@iso639_2.has_key?(lang)
+      return lang.intern if rc == ISO639_2
+      return @@iso639_2[lang].intern if rc == ISO639_1
+    elsif @@english_full.has_key?(lang)
+      return @@english_full[lang].intern if rc == ISO639_2
+      return @@iso639_2[@@english_full[lang]].intern if rc == ISO639_1
+    elsif @@french_full.has_key?(lang)
+      return @@french_full[lang].intern if rc == ISO639_2
+      return @@iso639_2[@@french_full[lang]].intern if rc == ISO639_1
+    else
+      not_found(lang)
     end
-    @@loaded = false
-    # Get the languages from the dictionary.
-    def self.get_languages
-      return if @@loaded
-      @@iso639_1 = {}; @@iso639_2 = {};
-      @@english_full = {}; @@french_full = {}
-      languages = IO.readlines(Treat.lib + '/treat/languages/list.txt')
-      languages.each do |language|
-        iso639_2, iso639_1, english_desc, french_desc =
-        language.split(',')
-        @@iso639_1[iso639_1] = iso639_2
-        @@iso639_2[iso639_2] = iso639_1
-        unless english_desc.nil?
-          english_desc.strip.downcase.split('|').each do |l|
-            @@english_full[l.downcase.strip] = iso639_2
-          end
+
+  end
+
+  # Whether the language list has been loaded or not.
+  @@loaded = false
+
+  # Get the languages from the dictionary.
+  def self.get_languages
+    return if @@loaded
+    @@iso639_1 = {}; @@iso639_2 = {};
+    @@english_full = {}; @@french_full = {}
+    languages = IO.readlines(File.join(
+    File.dirname(__FILE__), "languages", "list.txt"))
+    languages.each do |language|
+      iso639_2, iso639_1, english_desc, french_desc =
+      language.split(',')
+      @@iso639_1[iso639_1] = iso639_2
+      @@iso639_2[iso639_2] = iso639_1
+      unless english_desc.nil?
+        english_desc.strip.downcase.split('|').each do |l|
+          @@english_full[l.downcase.strip] = iso639_2
         end
-        unless french_desc.nil?
-          french_desc.strip.downcase.split('|').each do |l|
-            @@french_full[l.downcase.strip] = iso639_2
-          end
+      end
+      unless french_desc.nil?
+        french_desc.strip.downcase.split('|').each do |l|
+          @@french_full[l.downcase.strip] = iso639_2
         end
       end
-      @@loaded = true
     end
-    # A list of all possible word categories.
-    WordCategories = [
-      :adjective, :adverb, :noun, :verb, :interjection,
-      :clitic, :coverb, :conjunction, :determiner, :particle,
-      :preposition, :pronoun, :number, :symbol, :punctuation,
-      :complementizer
-    ]
+    @@loaded = true
   end
+
+  # Get the language list.
+  get_languages
+
+
 end

data/lib/treat/languages/arabic.rb

@@ -1,16 +1,16 @@
-module Treat
-  module Languages
-    class Arabic
-      RequiredDependencies = []
-      OptionalDependencies = []
-      Extractors = {}
-      Inflectors = {}
-      Lexicalizers = {
-        :tag => [:stanford]
-      }
-      Processors = {
-        :parsers => [:stanford]
-      }
-    end
-  end
+class Treat::Languages::Arabic
+  
+  RequiredDependencies = []
+  OptionalDependencies = []
+  
+  Extractors = {}
+  Inflectors = {}
+  Lexicalizers = {
+    :tag => [:stanford]
+  }
+  Processors = {
+    :parsers => [:stanford]
+  }
+  Retrievers = {}
+  
 end