treat 1.0.6 → 1.1.0

data/lib/treat/helpers/didyoumean.rb

@@ -0,0 +1,57 @@
+# Search the list to see if there are 
+# words similar to #name in the #list 
+# If yes, return a string saying 
+# "Did you mean ... ?" with the names.
+def did_you_mean?(list, name)
+  return '' # Fix
+  list = list.map { |e| e.to_s }
+  name = name.to_s
+  sugg = []
+  list.each do |element|
+    l = levenshtein(element,name)
+    if  l > 0 && l < 2
+      sugg << element
+    end
+  end
+  unless sugg.size == 0
+    if sugg.size == 1
+      msg += " Perhaps you meant '#{sugg[0]}' ?"
+    else
+      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 levensthein distance between 
+# two strings taking into account the costs 
+# of insertion, deletion, and substitution. 
+# Used by did_you_mean? to detect typos.
+def levenshtein(first, other, ins=1, del=1, sub=1)
+  return nil if first.nil? || other.nil?
+  dm = []
+  dm[0] = (0..first.length).collect { |i| i * ins}
+  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][j-1] + ins,
+        dm[i-1][j] + del
+      ].min
+    end
+  end
+  dm[other.length][first.length]
+end

data/lib/treat/helpers/escaping.rb

@@ -0,0 +1,15 @@
+# This is ugly, we should change it.
+EscapeChar = '^^'
+EscapedEscapeChar = '\^\^'
+ 
+def escape_floats!(s)
+  s.gsub!(/([0-9]+)\.([0-9]+)/) do
+    $1 + EscapeChar + $2
+  end
+end
+
+def unescape_floats!(s)
+  s.gsub!(/([0-9]+)#{EscapedEscapeChar}([0-9]+)/) do
+    $1 + '.' + $2
+  end
+end

data/lib/treat/helpers/formatting.rb

@@ -0,0 +1,41 @@
+# A cache to optimize camel casing.
+@@cc_cache = {}
+
+# A cache to optimize un camel casing.
+@@ucc_cache = {}
+
+# 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]
+
+  if Treat.core.acronyms.include?(phrase)
+    phrase = phrase.upcase
+  else
+    phrase.gsub!(/^[a-z]|_[a-z]/) { |a| a.upcase }
+    phrase.gsub!('_', '')
+  end
+  @@cc_cache[o_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]
+  if Treat.core.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
+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

data/lib/treat/helpers/platform.rb

@@ -0,0 +1,15 @@
+# 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
+
+# Set up the right NULL device.
+if detect_platform == :windows
+  NULL_DEVICE = 'NUL'
+else
+  NULL_DEVICE = '/dev/null'
+end

data/lib/treat/helpers/reflection.rb

@@ -0,0 +1,17 @@
+# 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].
+  gsub('block in ', '').intern
+end
+
+Object.module_eval do
+  # Unset a constant publicly.
+  def self.const_unset(const)
+    Object.instance_eval do 
+      remove_const(const)
+    end
+  end
+end

data/lib/treat/helpers/temporary.rb

@@ -0,0 +1,27 @@
+# Require file utilities for creating and
+# deleting temporary files.
+require 'fileutils'
+
+# Create a temporary file which is deleted
+# after execution of the block.
+def create_temp_file(ext, value = nil, &block)
+  fname = Treat.paths.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, which is
+# deleted after execution of the block.
+def create_temp_dir(&block)
+  dname = Treat.paths.tmp +
+  "#{Random.rand(10000000).to_s}"
+  Dir.mkdir(dname)
+  block.call(dname)
+ensure
+  FileUtils.rm_rf(dname)
+end

data/lib/treat/helpers/verbosity.rb

@@ -0,0 +1,19 @@
+# Runs a block of code without warnings.
+def silence_warnings(&block)
+  warn_level = $VERBOSE
+  $VERBOSE = nil
+  result = block.call
+  $VERBOSE = warn_level
+  result
+end
+
+# Runs a block of code while blocking stdout.
+def silence_stdout(log = '/dev/null')
+  unless Treat.core.verbosity.silence
+    yield; return
+  end
+  old = $stdout.dup
+  $stdout.reopen(File.new(log, 'w'))
+  yield
+  $stdout = old
+end

data/lib/treat/helpers.rb

@@ -0,0 +1,5 @@
+# Contains utility functions used by Treat.
+module Treat::Helpers
+  p = Treat.paths.lib + 'treat/helpers/*.rb'
+  Dir.glob(p).each { |f| require f }
+end

data/lib/treat/installer.rb

@@ -1,5 +1,4 @@
-# Installer is a dependency manager for languages.
-#
+# A dependency manager for Treat language plugins.
 # It can be called by using Treat.install(language).
 module Treat::Installer
 
@@ -7,15 +6,9 @@ module Treat::Installer
   silence_warnings do
     require 'rubygems/dependency_installer'
   end
-  require 'treat/downloader'
-  require 'treat/dependencies'
-
-  # Package managers for each platforms.
-  PackageManagers = {
-    :mac => 'port',
-    :linux => 'apt-get',
-    :windows => 'win-get'
-  }
+  
+  require 'treat/version'  
+  require 'schiphol'
 
   # Address of the server with the files.
   Server = 'www.louismullie.com'
@@ -29,66 +22,40 @@ module Treat::Installer
 
   # Absolute paths required for cp and mkdir.
   Paths = {
-    :tmp => File.absolute_path(Treat.tmp),
-    :bin => File.absolute_path(Treat.bin),
-    :models => File.absolute_path(Treat.models)
+    :tmp => File.absolute_path(Treat.paths.tmp),
+    :bin => File.absolute_path(Treat.paths.bin),
+    :models => File.absolute_path(Treat.paths.models)
   }
   
   # Install required dependencies and optional
   # dependencies for a specific language.
-  def self.install(language = :english)
+  def self.install(language = 'english')
     
     @@installer = Gem::DependencyInstaller.new
     
-    if language == :travis
+    if language == 'travis'
       install_travis; return
     end
     
-    lang_class = Treat::Languages.get(language.to_s)
     l = "#{language.to_s.capitalize} language"
 
-    puts
-    puts "Treat Installer, v. #{Treat::VERSION.to_s}\n"
-    puts
+    puts "\nTreat Installer, v. #{Treat::VERSION.to_s}\n\n"
     
     begin
 
-      title "Install language-independent gem dependencies."
-
-      case prompt(
-        "1 - Install all default language-independent dependencies\n" +
-        "2 - Select dependencies to install manually\n" +
-        "3 - Skip this step", ['1', '2', '3'])
-      when '1' then install_dependencies(false)
-      when '2' then install_dependencies(true)
-      when '3' then puts 'Skipping this step.'
-      end
-
-      title "Install gem dependencies for the #{l}.\n"
-
-      dflt = lang_class::RequiredDependencies
-      all = dflt + lang_class::OptionalDependencies
-      case prompt("1 - Install default dependencies.\n" +
-        "2 - Select dependencies to install manually.\n" +
-        "3 - Skip this step.", ['1', '2', '3'])
-      when '1' then install_language_dependencies(dflt, false)
-      when '2' then install_language_dependencies(all, true)
-      when '3' then puts 'Skipping this step.'
-      end
+      title "Installing core dependencies."
+      install_language_dependencies('agnostic')
       
-      Treat::Downloader.show_progress = true
+      title "Installing dependencies for the #{l}.\n"
+      install_language_dependencies(language)
       
       # If gem is installed only, download models.
       begin
         Gem::Specification.find_by_name('punkt-segmenter')
-        title "Downloading model for the Punkt segmenter for the #{l}."
-        # Need fix
-        download_punkt_models([language.to_s])
+        title "Downloading models for the Punkt segmenter for the #{l}."
+        download_punkt_models(language)
       rescue Gem::LoadError; end
-      
-      # Download reuters models always
-      download_reuters_models
-      
+
       # If stanford is installed, download models.
       begin
         Gem::Specification.find_by_name('stanford-core-nlp')
@@ -96,23 +63,7 @@ module Treat::Installer
         "model files for the the #{l}.\n\n"
         package = (language == :english) ? :english : :all
         download_stanford(package)
-      rescue Gem::LoadError
-        puts 'Stanford-core-nlp gem not installed.'
-        puts 'Skipping download of Stanford models.'
-      end
-
-      title "Install external binary libraries " +
-            "(requires port, apt-get or win-get).\n"
-      puts "Warning: this may take a long amount of time."
-
-      case prompt("1 - Select binaries to install manually.\n" +
-        "2 - Skip this step.", ['1', '2'])
-      when '1' then install_binaries
-      when '2' then puts 'Skipping this step.'
-      end
-
-      puts
-      puts "-----\nDone!"
+      rescue Gem::LoadError; end
 
     rescue Errno::EACCES => e
 
@@ -124,77 +75,32 @@ module Treat::Installer
 
   end
   
-  # Automated install for Travis CI.
+  # Minimal install for Travis CI.
   def self.install_travis
-    dep = (Treat::Languages::English::RequiredDependencies + 
-          Treat::Languages::English::OptionalDependencies)
-    install_dependencies(false)
-    install_language_dependencies(dep, false)
+    install_language_dependencies(:agnostic)
+    install_language_dependencies(:english)
     download_stanford(:minimal)
-    download_punkt_models([:english])
+    download_punkt_models(:english)
   end
   
-  def self.install_dependencies(optionally)
-
-    Treat::Dependencies::Gem.each do |d|
-      dep, ver, pur = *d
-      install_gem(dep, ver, pur, optionally)
-    end
-
-  end
-
-  def self.install_language_dependencies(dependencies, optionally)
 
+  def self.install_language_dependencies(language)
+    dependencies = Treat.languages[language].dependencies
     puts "No dependencies to install.\n" if dependencies.empty?
     dependencies.each do |dependency|
-      install_gem(dependency, nil, nil, optionally)
+      install_gem(dependency)
     end
-
-  end
-
-  def self.install_binaries
-
-    puts "Warning: this will require authentification."
-
-    p = detect_platform
-    man = PackageManagers[p]
-
-    if !man
-      puts "Cannot find a download manager "+
-      "for the #{p} platform.\n\n"
-    else
-      unless `hash #{man} 2>&1` == ''
-        puts "The '#{man}' command is required "+
-        "to install binaries on #{p}.\n\n"
-        man = nil
-      end
-    end
-
-    unless man
-      puts "Skipping installation of the "+
-      "following binaries:\n\n"
-      Binary.each do |binary, purpose|
-        puts "- #{binary} to #{purpose}"
-      end
-      return
-    end
-
-    Treat::Dependencies::Binary.each do |binary, purpose|
-      if prompt("install #{binary} to " +
-        "#{purpose} (y/n)", ['y', 'n']) == 'y'
-        `sudo #{man} install #{binary}`
-      end
-    end
-
   end
 
   def self.download_stanford(package = :minimal)
     
     f = StanfordPackages[package]
-    loc = Treat::Downloader.download(
-    'http', Server, 'treat', f, Treat.tmp)
+    url = "http://#{Server}/treat/#{f}"
+    loc = Schiphol.download(url, 
+      download_folder: Treat.paths.tmp
+    )
     puts "- Unzipping package ..."
-    dest = File.join(Treat.tmp, 'stanford')
+    dest = File.join(Treat.paths.tmp, 'stanford')
     unzip_stanford(loc, dest)
     
     model_dir = File.join(Paths[:models], 'stanford')
@@ -232,37 +138,26 @@ module Treat::Installer
     puts "- Cleaning up..."
     FileUtils.rm_rf(origin)
     
+    'Done.'
+    
   end
 
-  def self.download_punkt_models(languages)
-    languages.map! { |l| "#{l}.yaml" }
-    download_models 'punkt', languages
-  end
-  
-  def self.download_reuters_models
-    files = ["industry.xml", "region.xml", "topics.xml"]
-    download_models 'reuters', files
-  end
-
-  def self.download_models(directory, files)
-    
-    dest = "#{Treat.models}#{directory}/"
+  def self.download_punkt_models(language)
 
+    f = "#{language}.yaml"
+    dest = "#{Treat.paths.models}punkt/"
+    url = "http://#{Server}/treat/punkt/#{f}"
+    loc = Schiphol.download(url, 
+      download_folder: Treat.paths.tmp
+    )
     unless File.readable?(dest)
-      puts "- Creating directory models/#{directory} ..."
+      puts "- Creating directory models/punkt ..."
       FileUtils.mkdir_p(File.absolute_path(dest))
     end
 
+    puts "- Copying model file to models/punkt ..."
+    FileUtils.cp(loc, File.join(Paths[:models], 'punkt', f))
     
-    files.each do |file|
-      puts "- Downloading #{file} ..."
-      loc = Treat::Downloader.download(
-      'http', Server, "treat/#{directory}", file, Treat.tmp)
-      puts "- Copying file to models/#{directory} ..."
-      FileUtils.cp(loc, File.join(Paths[:models], directory, file))
-    end
-
- 
     puts "- Cleaning up..."
     FileUtils.rm_rf(Paths[:tmp] + Server)
 
@@ -282,25 +177,11 @@ module Treat::Installer
 
   # Install a dependency with a supplied purpose
   # but ask the user if she wishes to do so first.
-  def self.install_gem(dependency, version = nil, 
-                       purpose = nil, optionally = false)
-
-    install = false
+  def self.install_gem(dependency)
 
     begin
-      purpose = purpose ? " to #{purpose}" : ''
-      if optionally
-        if prompt("install #{dependency}#{purpose}", 
-          ['y', 'n']) == 'y'
-          install = true
-        end
-      else
-        puts "\n- Installing #{dependency}#{purpose}."
-        install = true
-      end
-      silence_warnings do 
-        @@installer.install(dependency, version)
-      end if install
+      puts "Installing #{dependency}...\n"
+      @@installer.install(dependency)
     rescue Exception => error
       raise
       puts "Couldn't install gem '#{dependency}' " +
@@ -325,4 +206,4 @@ module Treat::Installer
 
   end
 
-end
+end

data/lib/treat/loaders/linguistics.rb

@@ -1,34 +1,29 @@
-module Treat
+# A helper class to load a language class
+# registered with the Linguistics gem.
+class Treat::Loaders::Linguistics
 
-  module Loaders
-
-    # A helper class to load a language class
-    # registered with the Linguistics gem.
-    class Linguistics
-
-      silence_warnings { require 'linguistics' }
-      @@languages = {}
-
-      def self.load(language)
-        if @@languages[language]
-          return @@languages[language]
-        end
-        begin
-          l = language.to_s.upcase
-          silence_warnings do
-            @@languages[language] =
-            ::Linguistics.const_get(l)
-          end
-        rescue RuntimeError
-          raise "Ruby Linguistics does " +
-          "not have a module installed " +
-          "for the #{language} language."
-        end
+  silence_warnings do 
+    require 'linguistics'
+  end
+  
+  @@languages = {}
 
+  def self.load(language)
+    if @@languages[language]
+      return @@languages[language]
+    end
+    begin
+      l = language.to_s[0..1].upcase
+      silence_warnings do
+        @@languages[language] =
+        ::Linguistics.const_get(l)
       end
-
+    rescue RuntimeError
+      raise "Ruby Linguistics does " +
+      "not have a module installed " +
+      "for the #{language} language."
     end
 
   end
 
-end
+end

data/lib/treat/loaders/stanford.rb

@@ -1,45 +1,27 @@
-module Treat
-  
-  module Loaders
-
-    class Stanford
-
-      require 'stanford-core-nlp'
-
-      class << self
-        attr_accessor :jar_path
-        attr_accessor :model_path
-        attr_accessor :loaded
-      end
-
-      self.jar_path = Treat.bin + 'stanford/'
-      self.model_path = Treat.models + 'stanford/'
-      self.loaded = false
-
-      def self.load(language = nil)
-
-        return if self.loaded
-
-        language ||=
-        Treat::Languages.describe(
-        Treat.default_language)
-
-        StanfordCoreNLP.jar_path = self.jar_path
-        StanfordCoreNLP.model_path = self.model_path
-
-        StanfordCoreNLP.use(language)
-
-        StanfordCoreNLP.log_file =
-        NULL_DEVICE if Treat.silence
-
-        StanfordCoreNLP.bind
-
-        self.loaded = true
-
-      end
-
+# A helper class to load the 
+# Stanford Core NLP package.
+class Treat::Loaders::Stanford
+
+  require 'stanford-core-nlp'
+  @@loaded = false
+
+  def self.load(language = nil)
+    return if @@loaded
+    language ||= Treat.core.language.default
+    jar_path = Treat.libraries.
+    stanford.jar_path || Treat.paths.bin
+    models_path = Treat.libraries.
+    stanford.model_path || Treat.paths.models
+    StanfordCoreNLP.jar_path =
+    "#{jar_path}stanford/"
+    StanfordCoreNLP.model_path =
+    "#{models_path}stanford/"
+    StanfordCoreNLP.use(language)
+    if Treat.core.verbosity.silence
+      StanfordCoreNLP.log_file = NULL_DEVICE
     end
-    
+    StanfordCoreNLP.bind
+    @@loaded = true
   end
   
 end

data/lib/treat/loaders.rb

@@ -0,0 +1,10 @@
+# Contains classes to load external libraries.
+module Treat::Loaders
+  # Autoload all of the loaders.
+  def self.const_missing(const)
+    name = const.to_s.downcase
+    require Treat.paths.lib + 
+    "treat/loaders/#{name}.rb"
+    self.const_get(const)
+  end
+end