odin 0.0.4

data/.gitignore

@@ -0,0 +1,19 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT
+doc/*
+*.gem
+.bundle

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.8.7@odin --create

data/.travis.yml

@@ -0,0 +1,2 @@
+rvm:
+  - 1.8.7

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in odin.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    odin (0.0.1)
+      activesupport (~> 2.0.1)
+      english (~> 0.1)
+      facets (~> 2.2.1)
+      linguistics (~> 1.0.8)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (2.0.5)
+    english (0.6.3)
+      language
+    facets (2.2.1)
+    language (0.6.0)
+    linguistics (1.0.9)
+    rake (0.8.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  odin!
+  rake (~> 0.8.7)

data/HISTORY.md

@@ -0,0 +1,102 @@
+Just for historical perspective, these are the original modification times (GitHub seems to be eating them :( ).
+
+    -rw-r--r--  1 ben  staff  3579 Jan  9  2008 LICENSE
+    -rw-r--r--  1 ben  staff   283 Dec 20  2007 README
+    -rw-r--r--  1 ben  staff   702 Oct  4 20:41 README.md
+    -rw-r--r--  1 ben  staff  1841 Dec 11  2007 Rakefile
+    -rw-r--r--@ 1 ben  staff   834 Jan 11  2008 check_grammar.rb
+    
+    app:
+    total 0
+    drwxr-xr-x  3 ben  staff  102 Oct  4 20:42 controllers/
+    
+    app/controllers:
+    total 8
+    -rw-r--r--@ 1 ben  staff  1375 Dec 11  2007 grammar_checker.rb
+    
+    images:
+    total 376
+    -rw-r--r--@ 1 ben  staff   3683 Dec 28  2007 atn_diagram.graffle
+    -rw-r--r--@ 1 ben  staff  73395 Jan  9  2008 atn_diagram.pdf
+    -rw-r--r--  1 ben  staff   1498 Oct  4 20:41 odin-ff6.gif
+    
+    lang:
+    total 24
+    drwxr-xr-x  11 ben  staff    374 Oct  4 20:42 en/
+    -rw-r--r--@  1 ben  staff  11141 Dec 11  2007 iso639.rb
+    
+    lang/en:
+    total 184
+    -rw-r--r--  1 ben  staff   4585 Dec 11  2007 adjectives.rb
+    -rw-r--r--@ 1 ben  staff   1931 Dec 11  2007 atn.rb
+    -rw-r--r--  1 ben  staff   5272 Dec 14  2007 closed_class_words.rb
+    -rw-r--r--@ 1 ben  staff  47385 Dec 11  2007 data.rb
+    -rw-r--r--@ 1 ben  staff   3110 Dec 11  2007 noun_inflections.rb
+    -rw-r--r--@ 1 ben  staff   6078 Dec 11  2007 noun_inflector_test_cases.rb
+    -rw-r--r--@ 1 ben  staff    377 Dec 14  2007 pronoun_inflector_test_cases.rb
+    -rw-r--r--@ 1 ben  staff   6724 Dec 11  2007 verbs.rb
+    
+    lib:
+    total 152
+    -rw-r--r--@ 1 ben  staff    329 Jan  8  2008 array.rb
+    -rw-r--r--@ 1 ben  staff   2032 Jan  9  2008 atn.rb
+    -rw-r--r--@ 1 ben  staff   4209 Dec 28  2007 augmented_transition_network.rb
+    -rw-r--r--@ 1 ben  staff    845 Dec 10  2007 dumper.rb
+    -rw-r--r--  1 ben  staff  10250 Dec 14  2007 noun_inflector.rb
+    -rw-r--r--@ 1 ben  staff  13565 Dec 14  2007 parts_of_speech.rb
+    -rw-r--r--@ 1 ben  staff    361 Dec 10  2007 star.rb
+    -rw-r--r--@ 1 ben  staff   2412 Dec 11  2007 string.rb
+    -rw-r--r--@ 1 ben  staff   2166 Dec 11  2007 string_bracketing.rb
+    -rw-r--r--  1 ben  staff   1813 Dec 11  2007 word.rb
+    -rw-r--r--  1 ben  staff  11074 Dec 11  2007 word_net.rb
+    
+    simple_atn:
+    total 80
+    -rw-r--r--  1 ben  staff  2198 Oct  4 20:52 README.md
+    -rw-r--r--  1 ben  staff   158 Dec 15  2007 Rakefile
+    -rw-r--r--  1 ben  staff   329 Jan  8  2008 array.rb
+    -rw-r--r--@ 1 ben  staff  4209 Dec 28  2007 augmented_transition_network.rb
+    -rw-r--r--@ 1 ben  staff  4432 Jan 11  2008 augmented_transition_network_test.rb
+    -rw-r--r--@ 1 ben  staff  5986 Jan  9  2008 english.rb
+    -rw-r--r--  1 ben  staff   847 Dec 15  2007 string.rb
+    
+    test:
+    total 8
+    drwxr-xr-x  11 ben  staff   374 Oct  4 20:43 fixtures/
+    drwxr-xr-x   4 ben  staff   136 Oct  4 20:43 functional/
+    drwxr-xr-x   4 ben  staff   136 Oct  4 20:44 integration/
+    -rw-r--r--   1 ben  staff  3029 Dec 10  2007 test_helper.rb
+    drwxr-xr-x  10 ben  staff   340 Oct  4 20:44 unit/
+    
+    test/fixtures:
+    total 336
+    -rwxrwxrwx  1 ben  staff  148490 Dec 11  2007 alice.txt
+    -rw-r--r--  1 ben  staff    1546 Dec 11  2007 art.txt
+    -rw-r--r--  1 ben  staff    1809 Dec 10  2007 both.txt
+    -rw-r--r--  1 ben  staff       0 Dec 10  2007 existing.txt
+    -rw-r--r--  1 ben  staff       0 Dec 10  2007 existing.txt.checked.html
+    -rw-r--r--  1 ben  staff      53 Dec 10  2007 grammar_checker.css
+    -rw-r--r--  1 ben  staff    1311 Dec 10  2007 grammatical.txt
+    -rw-r--r--  1 ben  staff     496 Dec 10  2007 ungrammatical.txt
+    
+    test/functional:
+    total 8
+    -rw-r--r--  1 ben  staff  1772 Dec 11  2007 grammar_checker_test.rb
+    
+    test/integration:
+    total 0
+    drwxr-xr-x  3 ben  staff  102 Oct  4 20:44 en/
+    
+    test/integration/en:
+    total 8
+    -rw-r--r--  1 ben  staff  782 Dec 11  2007 word_and_noun_inflector_test.rb
+    
+    test/unit:
+    total 88
+    -rw-r--r--  1 ben  staff  11996 Jan  9  2008 atn_test.rb
+    -rw-r--r--  1 ben  staff   8799 Dec 14  2007 noun_inflector_test.rb
+    -rw-r--r--  1 ben  staff    483 Dec 14  2007 pronoun_inflector_test.rb
+    -rw-r--r--  1 ben  staff    513 Dec 10  2007 star_test.rb
+    -rw-r--r--  1 ben  staff   1603 Dec 11  2007 string_bracketing_test_module.rb
+    -rw-r--r--  1 ben  staff   3566 Dec 11  2007 string_test.rb
+    -rw-r--r--  1 ben  staff    344 Dec 14  2007 word_test.rb

data/LICENSE.md

@@ -0,0 +1,10 @@
+The MIT License
+===============
+
+Copyright (c) 2007-2011 Benjamin Oakes
+
+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.md

@@ -0,0 +1,46 @@
+Odin
+====
+
+![Odin Esper from Final Fantasy VI](https://github.com/benjaminoakes/odin/raw/master/images/odin-ff6.gif)
+
+![Still Maintained?](http://stillmaintained.com/benjaminoakes/odin.png)
+![Build Status](http://travis-ci.org/benjaminoakes/odin.png)
+
+Odin is an **ATN** (Augmented Transition Network) based parser for natural languages with basic part of speech tagging and word-sense disambiguation. Currently, the only supported language is English, but other languages can be added.
+
+If interested, please become a watcher.
+
+Usage
+-----
+
+    ruby check_grammar.rb file_name
+
+Output is saved to `file_name.checked.html`.  There are some test files in "test/fixtures/".
+
+History
+-------
+
+This is based on a project I made for a Computational Linguistics course at the University of Iowa (taught by now-retired [Professor Oden][oden], hence the name) back in 2007.  It's not the earliest "serious" Ruby code I've written, but it's pretty close.
+
+  [oden]: http://cs.uiowa.edu/~oden
+
+Contributing
+------------
+
+I'm not actively developing Odin right now, but if you have a use for it and you'd like to be a maintainer, please let me know.
+
+You can run unit and functional tests with `rake test`.
+
+Resources
+---------
+
+The design of the `AugmentedTransitionNetwork` class was inspired by Paul Graham's implementation in Lisp.  For details on his implementation, please see the full text of his book [_On Lisp_][onlisp] (pages 309 - 320).
+
+Also, there's a diagram of the ATN being used in `images/atn_diagram.pdf`.
+
+  [onlisp]: http://www.paulgraham.com/onlisptext.html
+
+License
+-------
+
+Please see the `LICENSE.md` file.

data/Rakefile

@@ -0,0 +1,69 @@
+require 'rubygems'
+require 'bundler'
+require 'find'
+
+Bundler::GemHelper.install_tasks
+
+# TODO switch to using "import"
+def require_files(directory)
+  Find.find(directory) do |file_name|
+    if file_name.match(/.*\.rb$/)
+      require file_name
+    end
+  end
+end
+
+# The names of the tasks here are modeled after those in Rails
+
+# TODO add the descriptions back in.  (Removed because they make it so that I have to choose a
+# task when running the Rakefile via TextMate.)
+
+task :default => :pre_commit
+# desc "The task performed by the pre-commit hook in the Subversion repository."
+task :pre_commit => "test" #[:validate_syntax, :unit_test]
+task :test => ["test:units", "test:integration", "test:functionals"] # TODO a better way?
+
+namespace "test" do
+  # desc "Run the unit tests in 'test/unit/*_test.rb'"
+  task :units do
+    require 'rake/runtest'
+    # Add all the dependencies
+    require_files("lib")
+    Rake.run_tests "test/unit/*_test.rb"
+  end
+  
+  # desc "Run the integration tests in 'test/integration/*_test.rb'"
+  task :integration do
+    require 'rake/runtest'
+    # Add all the dependencies
+    require_files("lib")
+    Rake.run_tests "test/integration/*_test.rb"
+    Rake.run_tests "test/integration/*/*_test.rb"
+  end
+  
+  # desc "Run the unit tests in 'test/functional/*_test.rb'"
+  task :functionals do
+    require 'rake/runtest'
+    # Add all the dependencies
+    require_files("lib")
+    require_files("app")
+    Rake.run_tests "test/functional/*_test.rb"
+  end
+end
+
+# TODO
+# desc "Validate the syntax of all files."
+# task :validate_syntax do
+#   puts '--------------------------------------------'
+#   puts 'Syntax Errors:'
+#   # TODO use "ruby -wc" recursively on all Ruby files
+#   puts '--------------------------------------------'
+# end
+#
+# namespace "doc" do
+# TODO
+# desc "Generate documentation via rdoc"
+  # task :odin do
+  #  # TODO generate documentation with rdoc
+  # end
+# end

data/app/controllers/grammar_checker.rb

@@ -0,0 +1,51 @@
+# word.rb MUST be required before string.rb
+require File.dirname(__FILE__) + '/../../lib/word.rb'
+require File.dirname(__FILE__) + '/../../lib/string.rb'
+require File.dirname(__FILE__)/'..'/'..'/'lib'/'star.rb'
+require File.dirname(__FILE__)/'..'/'..'/'lib'/'atn.rb'
+
+class GrammarChecker
+  @@suffix = "checked.html"
+  
+  def self.suffix
+    @@suffix
+  end
+  
+  def self.check(file_name)
+    @in_file_name = file_name
+    @out_file_name = "#{@in_file_name}.#{@@suffix}"
+    
+    check_file_name
+    
+    File.open(@in_file_name, "r") do |in_file|
+      File.open(@out_file_name, "w") do |out_file|
+        
+        out_file.puts '<link rel="stylesheet" href="grammar_checker.css" type="text/css" media="screen" />'
+        
+        while (line = in_file.gets)
+          checked = line.check_grammar do |sentence|
+            "<span class=\"ungrammatical\">#{sentence}</span>"
+            # "<ungrammatical message=\"\" suggestion=\"\">#{sentence}</ungrammatical>"
+          end
+          
+          out_file.puts(checked)
+        end
+      end
+    end
+  end
+  
+  private
+    def self.check_file_name
+      if @in_file_name.nil?
+        raise ArgumentError.new("Nil file name supplied")
+      end
+      
+      if File.exists?(@out_file_name)
+        raise Errno::EEXIST
+      end
+      
+      if File.directory?(@in_file_name)
+        raise Errno::EISDIR
+      end
+    end
+end

data/check_grammar.rb

@@ -0,0 +1,24 @@
+require 'app/controllers/grammar_checker.rb'
+
+begin
+  GrammarChecker.check(ARGV[0])
+  puts "Output saved to '#{ARGV[0]}.#{GrammarChecker.suffix}'"
+rescue ArgumentError => e
+  puts "Usage: ruby check_grammar.rb file_name"
+  puts "Output saved to file_name.#{GrammarChecker.suffix}"
+# TODO find a way to avoid using Errno::* because of readability issues
+rescue Errno::EEXIST => e # Output file exists
+  print "There is already output saved for the file you're checking.  Overwrite? (y/n) "
+  response = $stdin.gets.chomp # without $stdin, Ruby will read the file supplied to to the script
+  
+  if "y" != response
+    exit!
+  else
+    File.delete("#{ARGV[0]}.#{GrammarChecker.suffix}")
+    retry
+  end
+rescue Errno::ENOENT => e # No such file or directory
+  puts e.message
+rescue Errno::EISDIR => e # Is a directory
+  puts e.message
+end

data/configure

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+# Configure build environment.
+#
+# @author Benjamin Oakes <hello@benjaminoakes.com>
+
+echo "[$0] starting"
+# gem install bundler --version '~> 1.0.21' --no-rdoc --no-ri
+bundle install
+echo "[$0] finished"

data/lang/en/adjectives.rb

@@ -0,0 +1,388 @@
+# A basic list.
+# From http://www.paulnoll.com/Books/Clear-English/English-adjectives-1.html
+# and http://www.keepandshare.com/doc/view.php?u=12894
+# and some others Ben included
+
+module CachedAdjectives
+  @@Adjectives = %w{
+    abundant
+    adorable
+    adventurous
+    afraid
+    aggressive
+    agreeable
+    alert
+    alive
+    amused
+    ancient
+    angry
+    annoyed
+    annoying
+    anxious
+    arrogant
+    ashamed
+    attractive
+    average
+    awful
+    bad
+    beautiful
+    better
+    bewildered
+    big
+    bitter
+    black
+    blonde
+    bloody
+    blue
+    blue-eyed
+    blushing
+    boiling
+    bored
+    brainy
+    brave
+    breakable
+    breezy
+    brief
+    bright
+    broad
+    broken
+    bumpy
+    busy
+    calm
+    careful
+    cautious
+    charming
+    cheerful
+    chilly
+    chubby
+    clean
+    clear
+    clever
+    cloudy
+    clumsy
+    cold
+    colorful
+    colossal
+    combative
+    comfortable
+    concerned
+    condemned
+    confused
+    cooing
+    cool
+    cooperative
+    courageous
+    crazy
+    crazy,
+    creepy
+    crooked
+    crowded
+    cruel
+    cuddly
+    curious
+    curly
+    curved
+    cute
+    damaged
+    damp
+    dangerous
+    dark
+    dead
+    deafening
+    deep
+    defeated
+    defiant
+    delicious
+    delightful
+    depressed
+    determined
+    different
+    difficult
+    dirty
+    disgusted
+    distinct
+    disturbed
+    dizzy
+    doubtful
+    drab
+    dry
+    dull
+    dusty
+    eager
+    early
+    easy
+    elated
+    elegant
+    embarrassed
+    empty
+    enchanting
+    encouraging
+    energetic
+    enthusiastic
+    envious
+    evil
+    excited
+    expensive
+    exuberant
+    faint
+    fair
+    faithful
+    famous
+    fancy
+    fantastic
+    fast
+    fat
+    few
+    fierce
+    filthy
+    fine
+    flaky
+    flat
+    flipped-out
+    fluffy
+    fluttering
+    foolish
+    fragile
+    frail
+    frantic
+    freezing
+    fresh
+    friendly
+    frightened
+    funny
+    fuzzy
+    gentle
+    giant
+    gifted
+    gigantic
+    glamorous
+    gleaming
+    glorious
+    good
+    gorgeous
+    graceful
+    greasy
+    great
+    grieving
+    grotesque
+    grubby
+    grumpy
+    handsome
+    happy
+    hard
+    harsh
+    healthy
+    heavy
+    helpful
+    helpless
+    high
+    high-pitched
+    hilarious
+    hissing
+    hollow
+    homeless
+    homely
+    horrible
+    hot
+    huge
+    hungry
+    hurt
+    hushed
+    husky
+    icy
+    ill
+    immense
+    important
+    impossible
+    inexpensive
+    innocent
+    inquisitive
+    itchy
+    jealous
+    jittery
+    jolly
+    joyous
+    juicy
+    kind
+    large
+    late
+    lazy
+    light
+    little
+    lively
+    lonely
+    long
+    loose
+    loud
+    lovely
+    low
+    lucky
+    magnificent
+    mammoth
+    many
+    massive
+    melodic
+    melted
+    miniature
+    misty
+    moaning
+    modern
+    motionless
+    muddy
+    mushy
+    mute
+    mysterious
+    narrow
+    nasty
+    naughty
+    nervous
+    nice
+    noisy
+    numerous
+    nutritious
+    nutty
+    obedient
+    obnoxious
+    odd
+    old
+    old-fashioned
+    open
+    outrageous
+    outstanding
+    panicky
+    perfect
+    petite
+    plain
+    plastic
+    pleasant
+    poised
+    poor
+    powerful
+    precious
+    pretty
+    prickly
+    proud
+    puny
+    purring
+    puzzled
+    quaint
+    quick
+    quiet
+    rainy
+    rapid
+    raspy
+    real
+    relieved
+    repulsive
+    resonant
+    rich
+    ripe
+    rotten
+    rough
+    round
+    salty
+    scary
+    scattered
+    scrawny
+    screeching
+    selfish
+    shaggy
+    shaky
+    shallow
+    sharp
+    shiny
+    shivering
+    short
+    shrill
+    shy
+    silent
+    silky
+    silly
+    skinny
+    sleepy
+    slimy
+    slippery
+    slow
+    small
+    smiling
+    smoggy
+    smooth
+    soft
+    solid
+    sore
+    sour
+    sparkling
+    spicy
+    splendid
+    spotless
+    square
+    squealing
+    stale
+    steady
+    steep
+    sticky
+    stormy
+    straight
+    strange
+    strong
+    stupid
+    substantial
+    successful
+    super
+    sweet
+    swift
+    talented
+    tall
+    tame
+    tart
+    tasteless
+    tasty
+    teeny
+    teeny-tiny
+    tender
+    tense
+    terrible
+    testy
+    thankful
+    thirsty
+    thoughtful
+    thoughtless
+    thundering
+    tight
+    tiny
+    tired
+    tough
+    troubled
+    ugliest
+    ugly
+    uneven
+    uninterested
+    unsightly
+    unusual
+    upset
+    uptight
+    vast
+    victorious
+    vivacious
+    voiceless
+    wandering
+    warm
+    weak
+    weary
+    wet
+    whispering
+    wicked
+    wide
+    wide-eyed
+    wild
+    witty
+    wonderful
+    wooden
+    worried
+    wrong
+    young
+    yummy
+    zany
+    zealous
+  }
+end