scylla 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+end
+
+group :test do
+  gem "shoulda", ">= 0"
+  gem "mocha", "~> 0.9.12", :require => nil
+  gem "ruby-debug"
+end

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    columnize (0.3.4)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    linecache (0.46)
+      rbx-require-relative (> 0.0.4)
+    mocha (0.9.12)
+    rake (0.9.2)
+    rbx-require-relative (0.0.5)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  mocha (~> 0.9.12)
+  ruby-debug
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ashwin Hegde
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,19 @@
+= scylla
+
+Scylla is a language categorizing gem that allows you to guess the language of a given text. Scylla is a Ruby port of TextCat (http://www.let.rug.nl/~vannoord/TextCat) and is based on the text categorization algorithm presented in Cavnar, W. B. and J. M. Trenkle, ``N-Gram-Based Text Categorization'' In Proceedings of Third Annual Symposium on Document Analysis and Information Retrieval, Las Vegas, NV, UNLV Publications/Reprographics, pp. 161-175, 11-13 April 1994.
+
+== Contributing to scylla
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Ashwin Hegde. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), "lib")))
+
+require 'rubygems'
+require 'bundler'
+require 'scylla'
+require 'scylla/tasks'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "scylla"
+  gem.homepage = "http://github.com/hashwin/scylla"
+  gem.license = "MIT"
+  gem.summary = "Ruby port of Textcat language guesser"
+  gem.description = "Allows for text categorization by guessing the language of a given text using n-grams"
+  gem.email = "ahegde@zendesk.com"
+  gem.authors = ["Ashwin Hegde"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "scylla #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Scylla::Tasks.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/scylla/classifier.rb

@@ -0,0 +1,65 @@
+module Scylla
+  class Classifier
+    attr_accessor :limit, :dir, :ngrams, :threshold, :input
+
+    # limit    : Up to how many matching language results should be displayed
+    # ngrams   : The total number of ngrams that are stored for each language
+    # threshold: The threshold score for matches
+    def initialize(limit = 10, ngrams = 400, threshold = 1.05)
+      @limit = limit
+      @ngrams = ngrams
+      @threshold = threshold
+    end
+
+    # Classifies a string to a list of languages in order of best match
+    def classify_string(text)
+      @input = ""
+      text.each_line { |line| @input += line.strip }
+      classify
+    end
+
+    # Classifies a file to a list of languages in order of best match
+    def classify_file(path)
+      @input = ""
+      File.readlines(path).each { |line| @input += line.strip }
+      classify
+    end
+
+    # Classifies @input to a list of languages in order of best match
+    def classify
+      results = Hash.new
+      languages = Scylla::Loader.languages
+      if languages.empty?
+        p "No languages (.lm files) found. Please run rake scylla:train after placing your training texts in the source_texts directory."
+        return
+      end
+      sg = Scylla::Generator.new
+      unknown = sg.create_lm(@input)
+      languages.each_key do |key|
+        ngram = languages[key]
+        results[key] = get_score(unknown, ngram)
+      end
+      results = results.sort {|a,b| a[1]<=>b[1]}
+      a = results[0][1]
+      answers = [results.shift[0]]
+      while (!results.empty? and results[0][1] < (@threshold * a))
+        answers << results.shift[0]
+      end
+      return answers
+    end
+
+    # Gets the score of the text in question compared to a particular language
+    def get_score(unknown, ngram)
+      i, p = 0,0
+      while i < unknown.size
+        if (ngram[unknown[i]])
+          p += (ngram[unknown[i]]-i).abs
+        else
+          p += @ngrams
+        end
+        i += 1
+      end
+      return p
+    end
+  end
+end

data/lib/scylla/generator.rb

@@ -0,0 +1,73 @@
+module Scylla
+  class Generator
+    attr_accessor :dirtext, :dirlm, :minsize
+
+    # dirtext: The location of the source training text files
+    # minsize: The minimum size of the ngrams that you would like to store
+    def initialize(dirtext = DEFAULT_SOURCE_DIR, dirlm = DEFAULT_TARGET_DIR, minsize = 0, silent = false)
+      @dirtext = dirtext
+      @dirlm   = dirlm
+      @minsize = minsize
+    end
+
+    # This loads all the .txt files in the specified source training text folder  
+    # and creates language maps using ngram frequencies. The maps are stored in
+    # lib/scylla/lms as .lm files
+    def train
+      languages = Dir.glob("**/*.lm")
+      textpaths = Dir.glob(@dirtext + "/*.txt")
+      languages.each {|l| File.delete(l) }
+      textpaths.each do |path|
+        write_lm(path)
+      end
+    end
+
+    # Reads a single text file specified by a path and writes a .lm file in 
+    # lib/scylla/lms
+    def write_lm(path)
+      text = ""
+      File.open(path).each { |line| text += line.strip }
+      p "Creating language map for " + path
+      lm = create_lm(text, true)
+      lmname = File.join(@dirlm, File.basename(path, ".txt") + ".lm")
+      File.delete(lmname) if File.exists?(lmname)
+      File.open(lmname, 'w') do |f|
+        i = 0
+        lm.each do |freq|
+          break if i == 400
+          f.write(freq[0] + "\t" + freq[1].to_s + "\n")
+          i += 1
+        end
+      end
+    end
+
+    # This creates a language map for a given input string. 
+    # The frequencies boolean specifies whether or not the method should
+    # return the freqencies of the ngrams, or simply an array in sorted order
+    def create_lm(input, frequencies = false)
+      text = ""
+      input.each_line {|line| text += line.strip }
+      input = text
+      ngram = Hash.new
+      input.split(/[0-9\s]/).each do |word|
+        word = "_" + word + "_";
+        len = word.size
+        for i in 0..word.size
+          (1..5).each do |j|
+            ngram[word[i,j]] ||= 0
+            ngram[word[i,j]] += 1 if (len > (j - 1))
+          end
+          len = len - 1
+        end
+      end
+      ngram.each_key do |key|
+        ngram.delete(key) if key.size <= @minsize
+      end
+      ngram = ngram.sort {|a,b| b[1] <=> a[1]}
+      return ngram if frequencies
+      sorted = []
+      ngram.each {|key| sorted << key[0]}
+      return sorted
+    end
+  end
+end 

data/lib/scylla/loader.rb

@@ -0,0 +1,37 @@
+module Scylla
+  class Loader
+    # Loads all the language maps once into memory using the .lm files located
+    # in lib/scylla/lm
+    def self.load_language_maps
+      languages = Hash.new
+      Dir.glob("**/*.lm").each do |filepath|
+        language = File.basename(filepath, ".lm")
+        languages[language] = language_map(filepath)
+      end
+      return languages
+    end
+
+    # Returns a single language map from a specified .lm file
+    def self.language_map(path)
+      rank, ngram = 1, Hash.new
+      File.readlines(path).each do |line|
+        line = line.strip.split("\t").first
+        if(line =~ /^[^0-9\s]+/o)
+          ngram[line] = rank
+          rank += 1
+        end
+      end
+      return ngram
+    end
+
+    # Loads all maps from the .lm files, or loads them from memory if the 
+    # files have already been read and loaded. 
+    def self.languages
+      @languages ||= load_language_maps
+    end
+
+    def self.clear
+      @languages = nil
+    end
+  end
+end

data/lib/scylla/string.rb

@@ -0,0 +1,11 @@
+class String
+  def guess
+    sc = Scylla::Classifier.new
+    sc.classify_string(self)
+  end
+
+  def language
+    sc = Scylla::Classifier.new
+    sc.classify_string(self).first
+  end
+end

data/lib/scylla/tasks.rb

@@ -0,0 +1,20 @@
+require 'rake'
+require 'rake/tasklib'
+
+module Scylla
+  class Tasks < ::Rake::TaskLib
+    def initialize
+      define_training_task
+    end
+
+    def define_training_task
+      namespace :scylla do
+        desc "Trains Scylla in new languages"
+        task :train do
+          sg = Scylla::Generator.new
+          sg.train
+        end
+      end
+    end
+  end
+end

data/lib/scylla.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+module Scylla
+  DEFAULT_SOURCE_DIR = File.join(File.dirname(__FILE__), "..", "source_texts")
+  DEFAULT_TARGET_DIR = File.join(File.dirname(__FILE__), "scylla", "lms")
+end
+
+require 'scylla/classifier'
+require 'scylla/generator'
+require 'scylla/loader'
+require 'scylla/string'

data/scylla.gemspec

@@ -0,0 +1,117 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{scylla}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ashwin Hegde"]
+  s.date = %q{2011-08-25}
+  s.description = %q{Allows for text categorization by guessing the language of a given text using n-grams}
+  s.email = %q{ahegde@zendesk.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/scylla.rb",
+    "lib/scylla/classifier.rb",
+    "lib/scylla/generator.rb",
+    "lib/scylla/loader.rb",
+    "lib/scylla/string.rb",
+    "lib/scylla/tasks.rb",
+    "scylla.gemspec",
+    "source_texts/13375P33K.txt",
+    "source_texts/afrikaans.txt",
+    "source_texts/arabic.txt",
+    "source_texts/armenian.txt",
+    "source_texts/bulgarian.txt",
+    "source_texts/catalan.txt",
+    "source_texts/chinese.txt",
+    "source_texts/danish.txt",
+    "source_texts/english.txt",
+    "source_texts/esperanto.txt",
+    "source_texts/finnish.txt",
+    "source_texts/french.txt",
+    "source_texts/german.txt",
+    "source_texts/greek-iso8859-7.txt",
+    "source_texts/hebrew.txt",
+    "source_texts/hindi.txt",
+    "source_texts/hungarian.txt",
+    "source_texts/icelandic.txt",
+    "source_texts/indonesian.txt",
+    "source_texts/irish.txt",
+    "source_texts/italian.txt",
+    "source_texts/japanese.txt",
+    "source_texts/korean.txt",
+    "source_texts/latin.txt",
+    "source_texts/malay.txt",
+    "source_texts/marathi.txt",
+    "source_texts/mingo.txt",
+    "source_texts/nepali.txt",
+    "source_texts/norwegian.txt",
+    "source_texts/polish.txt",
+    "source_texts/portuguese.txt",
+    "source_texts/quechua.txt",
+    "source_texts/romanian.txt",
+    "source_texts/rumantsch.txt",
+    "source_texts/russian.txt",
+    "source_texts/sanskrit.txt",
+    "source_texts/scots_gaelic.txt",
+    "source_texts/serbian-ascii.txt",
+    "source_texts/slovak-ascii.txt",
+    "source_texts/slovenian-ascii.txt",
+    "source_texts/spanish.txt",
+    "source_texts/swahili.txt",
+    "source_texts/swedish.txt",
+    "source_texts/tagalog.txt",
+    "source_texts/tamil.txt",
+    "source_texts/thai.txt",
+    "source_texts/turkish.txt",
+    "source_texts/ukrainian-koi8_u.txt",
+    "source_texts/vietnamese.txt",
+    "source_texts/welsh.txt",
+    "source_texts/yiddish-utf.txt",
+    "test/classifier_test.rb",
+    "test/fixtures/source_texts/danish.txt",
+    "test/fixtures/source_texts/english.txt",
+    "test/fixtures/source_texts/french.txt",
+    "test/fixtures/source_texts/german.txt",
+    "test/fixtures/source_texts/spanish.txt",
+    "test/generator_test.rb",
+    "test/helper.rb",
+    "test/loader_test.rb",
+    "test/scylla_test.rb"
+  ]
+  s.homepage = %q{http://github.com/hashwin/scylla}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Ruby port of Textcat language guesser}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+    else
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    end
+  else
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+  end
+end
+