jido 0.1.0

data/.document

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

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "lib/jido/data"]
+	path = lib/jido/data
+	url = git@github.com:hans/jido-data.git

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem 'nokogiri', '>= 1.4.4'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,22 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    nokogiri (1.4.4)
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  nokogiri (>= 1.4.4)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Hans Engel
+
+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,21 @@
+= Jido
+
+Jido is a really fast, really simple dynamic verb conjugation library.
+
+    jido = Jido.load 'fr'
+    jido.conjugate 'être'
+
+== Contributing to Jido
+ 
+* 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 Hans Engel. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'bundler'
+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 = "jido"
+  gem.homepage = "http://github.com/hans/jido"
+  gem.license = "MIT"
+  gem.summary = %Q{Painless verb conjugation}
+  gem.description = %Q{Painless verb conjugation}
+  gem.email = "engel@engel.uk.to"
+  gem.authors = ["Hans Engel"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+  gem.add_runtime_dependency 'nokogiri', '>= 1.4.4'
+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
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << '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 = "jido #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/jido.rb

@@ -0,0 +1,8 @@
+require 'jido/conjugator'
+
+module Jido
+  # Convenience method for Jido::Conjugator.load
+  def Jido.load lang, options = {}
+    Jido::Conjugator.new lang, options
+  end
+end

data/lib/jido/conjugator.rb

@@ -0,0 +1,192 @@
+require 'rubygems'
+require 'nokogiri'
+
+module Jido
+  class Conjugator
+    attr_reader :lang
+    
+    # Accepted options:
+    #   
+    def initialize lang, options = {}
+      @lang = lang
+      
+      data_file_path = File.join(File.dirname(__FILE__), 'data', lang + '.xml')
+      data_file = nil
+      
+      begin
+        data_file = open data_file_path, 'r'
+      rescue IOError
+        raise "There was an error loading the data file for the given language."
+      end
+      
+      @data = Nokogiri.XML data_file, nil, 'UTF-8'
+      data_file.close
+    end
+    
+    # Get the possible verb form IDs for any conjugated verb.
+    #   Jido.load('fr').forms     # => ['PRS', 'PCOMP', 'IMP', ...]
+    def forms
+      if @forms.nil?
+        @forms = []
+        @data.xpath('/verbs/meta/forms/form').each do |form|
+          @forms << form.text
+        end
+      end
+      
+      @forms
+    end
+    
+    def fallbacks
+      if @fallbacks.nil?
+        @fallbacks = []
+        @data.xpath('/verbs/meta/fallbacks/fallback').each do |fallback|
+          @fallbacks << {:regex => fallback['regex'], :ref => fallback['ref']}
+        end
+      end
+      
+      @fallbacks
+    end
+    
+    def paradigms
+      if @paradigms.nil?
+        @paradigms = []
+        @data.xpath('/verbs/meta/paradigms/paradigm').each do |paradigm|
+          @paradigms << {:person => paradigm['person'], :quant => paradigm['quant']}
+        end
+      end
+      
+      @paradigms
+    end
+    
+    def conjugate verb
+      @current_el = @data.at_xpath "/verbs/verb[@word='#{verb}']"
+      @current_el = get_fallback_for_verb(verb) if @current_el.nil?
+      return false if @current_el.nil?
+      
+      ret = {}
+      @current_el_parents = [] # array of parents of the element, sorted by priority - parents earlier in the array will be picked over later ones
+      store_parents @current_el # populate the parents array = @current_el['inherit'].nil? ? nil : @data.at_xpath("/verbs/verbset[@id='#{@current_el['inherit']}']")
+      
+      group = nil; group_search = nil
+      forms.each do |form|
+        p form
+        ret[form] = {}
+        
+        group_search = "group[@id='#{form}']"
+        group = search_current_el group_search
+        
+        # grab modifier elements and extract their values
+        group_prepend_el = group.at_xpath('prepend'); group_append_el = group.at_xpath('append'); group_mod_el = group.at_xpath('mod'); group_endlength_el = group.at_xpath('endlength')
+        group_prepend = group_prepend_el.nil? ? nil : group_prepend_el.text
+        group_append = group_append_el.nil? ? nil : group_append_el.text
+        group_mod = group_mod_el.nil? ? nil : {:match => group_mod_el['match'], :search => group_mod_el['search'], :replace => group_mod_el['replace']}
+        group_endlength = group_endlength_el.nil? ? nil : group_endlength_el.text.to_i
+        
+        pdgmgroup = nil; pdgmgroup_search = nil
+        paradigm = nil; paradigm_search = nil
+        paradigms.each do |paradigm|
+          p paradigm
+          pdgmgroup_search = "group[@id='#{form}']/pdgmgroup[@id='#{paradigm[:person]}']"
+          pdgmgroup = search_current_el pdgmgroup_search
+          
+          # skip this paradigm group if the "ignore" attribute is set
+          next unless pdgmgroup['ignore'].nil?
+          
+          # grab modifier elements and extract their values
+          # if unset, try to inherit from parent group
+          pdgmgroup_prepend_el = pdgmgroup.at_xpath('prepend'); pdgmgroup_append_el = pdgmgroup.at_xpath('append'); pdgmgroup_mod_el = pdgmgroup.at_xpath('mod'); pdgmgroup_endlength_el = pdgmgroup.at_xpath('endlength')
+          pdgmgroup_prepend = pdgmgroup_prepend_el.nil? ? group_prepend : pdgmgroup_prepend_el.text
+          pdgmgroup_append = pdgmgroup_append_el.nil? ? group_append : pdgmgroup_append_el.text
+          pdgmgroup_mod = pdgmgroup_mod_el.nil? ? group_mod : {:match => pdgmgroup_mod_el['match'], :search => pdgmgroup_mod_el['search'], :replace => pdgmgroup_mod_el['replace']}
+          pdgmgroup_endlength = pdgmgroup_endlength_el.nil? ? group_endlength : pdgmgroup_endlength_el.text.to_i
+          
+          paradigm_search = "group[@id='#{form}']/pdgmgroup[@id='#{paradigm[:person]}']/paradigm[@id='#{paradigm[:quant]}']"
+          paradigm_el = search_current_el paradigm_search
+          
+          # skip this paradigm if the "ignore" attribute is set
+          next unless paradigm_el['ignore'].nil?
+          
+          # grab modifier elements and extract their values
+          # if unset, try to inherit from parent paradigm group
+          paradigm_prepend_el = paradigm_el.at_xpath('prepend'); paradigm_append_el = paradigm_el.at_xpath('append'); paradigm_mod_el = paradigm_el.at_xpath('mod'); paradigm_endlength_el = paradigm_el.at_xpath('endlength')
+          prepend = paradigm_prepend_el.nil? ? pdgmgroup_prepend : paradigm_prepend_el.text
+          append = paradigm_append_el.nil? ? pdgmgroup_append : paradigm_append_el.text
+          mod = paradigm_mod_el.nil? ? pdgmgroup_mod : {:match => paradigm_mod_el['match'], :search => paradigm_mod_el['search'], :replace => paradigm_mod_el['replace']}
+          
+          endlength = paradigm_endlength_el.nil? ? pdgmgroup_endlength : paradigm_endlength_el.text.to_i
+          endlength = 0 if endlength.nil? or endlength < 0
+          
+          # make a copy of verb to run the modifiers on
+          modded_verb = verb
+          
+          # chop n chars from the end of the string, based on the <endlength> modifier
+          modded_verb = modded_verb[0 ... ( modded_verb.length - endlength )] unless endlength.nil?
+          
+          # <mod> modifier (regex replacement)
+          unless mod.nil?
+            case mod[:match]
+            when 'first' then modded_verb.sub!(mod[:search], mod[:replace])
+            when 'all' then modded_verb.gsub!(mod[:search], mod[:replace])
+            end
+          end
+          
+          # <append> and <prepend> modifiers
+          modded_verb = ( prepend.nil? ? '' : prepend ) + modded_verb + ( append.nil? ? '' : append )
+          ret[form][paradigm[:person] + paradigm[:quant]] = modded_verb
+        end
+      end
+      
+      @current_el = nil
+      @current_el_inheritor = nil
+      
+      ret
+    end
+    
+    # Find all parents of a given verb / verbset, and store them in @current_el_parents
+    # (if a verb / verbset #1 inherits a verb / verbset #2, then #2 is the parent of #1)
+    # 
+    # Structure note: verbs are "final" objects. Verbs cannot be inherited; they are always at the bottom of a hierarchy.
+    # Verbsets can inherit / be inherited by other verbsets, and verbs can inherit verbsets.
+    # In other words.. verb = final class, verb set = abstract class
+    # 
+    # Yay recursion :)
+    def store_parents el
+      return if el['inherit'].nil?
+      
+      inherited_el = @data.at_xpath "/verbs/verbset[@id='#{el['inherit']}']"
+      @current_el_parents << inherited_el
+      store_parents inherited_el
+    end
+    
+    # Search each parent of some verb for a given element.
+    # Used for rule inheritance.
+    def search_current_el xpath
+      # try to find the rule in the current verb
+      desired_el = @current_el.at_xpath xpath
+      return desired_el unless desired_el.nil?
+      
+      # check all the verb's parents, walking up the hierarchy
+      @current_el_parents.each do |parent|
+        desired_el = parent.at_xpath xpath
+        return desired_el unless desired_el.nil?
+      end
+      
+      nil
+    end
+    
+    def get_fallback_for_verb verb
+      fallbacks.each do |fallback|
+        if verb.match fallback[:regex]
+          ret = @data.at_xpath "/verbs/verbset[@id='#{fallback[:ref]}']"
+          return ret
+        end
+      end
+      
+      false
+    end
+    
+    def inspect
+      "<Conjugator @lang => '#{@lang}'>"
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'bundler'
+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 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'jido'
+
+class Test::Unit::TestCase
+end
+
+class Hash
+  def diff other
+    self.keys.inject({}) do |memo, key|
+      unless self[key] == other[key]
+        memo[key] = [self[key], other[key]]
+      end
+      memo
+    end
+  end
+end

data/test/test_jido.rb

@@ -0,0 +1,106 @@
+# coding: utf-8
+
+require 'helper'
+
+class TestJido < Test::Unit::TestCase
+  should "prepare verb forms" do
+    jido = Jido.load 'fr'
+    assert_not_nil jido
+    
+    assert_equal 'fr', jido.lang
+    assert_equal ['prs', 'pcomp', 'imp', 'plu', 'futsimp', 'futant', 'passimp', 'pstant', 'subprs', 'subpst', 'subimp', 'subplu', 'cprs', 'cpst', 'cpst2', 'impprs', 'imppst'], jido.forms
+  end
+
+  should "conjugate some verbs correctly" do
+    jido = Jido.load 'fr'
+    assert_not_nil jido
+    
+    conj1 = jido.conjugate 'être'
+    assert_equal conj1, {
+    #p jido.conjugate('être').diff({
+      'prs' => { # present
+        '1sg' => 'suis',          '1pl' => 'sommes',
+        '2sg' => 'es',            '2pl' => 'êtes',
+        '3sg' => 'est',           '3pl' => 'sont'
+      },
+      'pcomp' => { # passé composé
+        '1sg' => 'ai été',        '1pl' => 'avons été',
+        '2sg' => 'as été',        '2pl' => 'avez été',
+        '3sg' => 'a été',         '3pl' => 'ont été'
+      },
+      'imp' => { # imperfect
+        '1sg' => 'étais',         '1pl' => 'étions',
+        '2sg' => 'étais',         '2pl' => 'étiez',
+        '3sg' => 'était',         '3pl' => 'étaient'
+      },
+      'plu' => { # pluperfect
+        '1sg' => 'avais été',     '1pl' => 'avions été',
+        '2sg' => 'avais été',     '2pl' => 'aviez été',
+        '3sg' => 'avait été',     '3pl' => 'avaient été'
+      },
+      'futsimp' => { # future
+        '1sg' => 'serai',         '1pl' => 'serons',
+        '2sg' => 'seras',         '2pl' => 'serez',
+        '3sg' => 'sera',          '3pl' => 'seront'
+      },
+      'futant' => { # future perfect
+        '1sg' => 'aurai été',     '1pl' => 'aurons été',
+        '2sg' => 'auras été',     '2pl' => 'aurez été',
+        '3sg' => 'aura été',      '3pl' => 'auront été'
+      },
+      'passimp' => { # simple past
+        '1sg' => 'fus',           '1pl' => 'fûmes',
+        '2sg' => 'fus',           '2pl' => 'fûtes',
+        '3sg' => 'fut',           '3pl' => 'furent'
+      },
+      'pstant' => { # past anterior
+        '1sg' => 'eus été',       '1pl' => 'eûmes été',
+        '2sg' => 'eus été',       '2pl' => 'eûtes été',
+        '3sg' => 'eut été',       '3pl' => 'eurent été'
+      },
+      'subprs' => { # subjunctive present
+        '1sg' => 'sois',          '1pl' => 'soyons',
+        '2sg' => 'sois',          '2pl' => 'soyez',
+        '3sg' => 'soit',          '3pl' => 'soient'
+      },
+      'subpst' => { # subjunctive past
+        '1sg' => 'aie été',       '1pl' => 'ayons été',
+        '2sg' => 'aies été',      '2pl' => 'ayez été',
+        '3sg' => 'ait été',       '3pl' => 'aient été'
+      },
+      'subimp' => { # subjunctive imperfect
+        '1sg' => 'fusse',         '1pl' => 'fussions',
+        '2sg' => 'fusses',        '2pl' => 'fussiez',
+        '3sg' => 'fût',           '3pl' => 'fussent'
+      },
+      'subplu' => { # subjunctive pluperfect
+        '1sg' => 'eusse été',     '1pl' => 'eussions été',
+        '2sg' => 'eusses été',    '2pl' => 'eussiez été',
+        '3sg' => 'eût été',       '3pl' => 'eussent été'
+      },
+      'cprs' => { # conditional present
+        '1sg' => 'serais',        '1pl' => 'serions',
+        '2sg' => 'serais',        '2pl' => 'seriez',
+        '3sg' => 'serait',        '3pl' => 'seraient'
+      },
+      'cpst' => { # conditional past
+        '1sg' => 'aurais été',    '1pl' => 'aurions été',
+        '2sg' => 'aurais été',    '2pl' => 'auriez été',
+        '3sg' => 'aurait été',    '3pl' => 'auraient été'
+      },
+      'cpst2' => { # conditional past II
+        '1sg' => 'eusse été',     '1pl' => 'eussions été',
+        '2sg' => 'eusses été',    '2pl' => 'eussiez été',
+        '3sg' => 'eût été',       '3pl' => 'eussent été'
+      },
+      'impprs' => { # imperative present
+                                  '1pl' => 'soyons !',
+        '2sg' => 'sois !',        '2pl' => 'soyez !'
+      },
+      'imppst' => { # imperative past
+                                  '1pl' => 'ayons été',
+        '2sg' => 'aie été',       '2pl' => 'ayez été'
+      }
+    }
+  end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification 
+name: jido
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Hans Engel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-16 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *id006
+description: Painless verb conjugation
+email: engel@engel.uk.to
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .gitmodules
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/jido.rb
+- lib/jido/conjugator.rb
+- test/helper.rb
+- test/test_jido.rb
+has_rdoc: true
+homepage: http://github.com/hans/jido
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 2407338913370765643
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Painless verb conjugation
+test_files: 
+- test/helper.rb
+- test/test_jido.rb