myasorubka 0.1

data/lib/myasorubka/msd.rb

@@ -0,0 +1,218 @@
+# encoding: utf-8
+
+# MSD is a morphosyntactic descriptor model.
+#
+# This representation, with the concrete applications which
+# display and exemplify the attributes and values and provide
+# their internal constraints and relationships, makes the proposal
+# self-explanatory. Other groups can easily test the
+# specifications on their language, simply by following the method of
+# the applications. The possibility of incorporating idiosyncratic
+# classes and distinctions after the common core features makes the
+# proposal relatively adaptable and flexible, without compromising
+# compatibility.
+#
+# MSD implementation and documentation are based on MULTEXT-East
+# Morphosyntactic Specifications, Version 4:
+# http://nl.ijs.si/ME/V4/msd/html/msd.html
+#
+# You may use Myasorubka::MSD either as parser and generator.
+#
+# ```ruby
+# msd = Myasorubka::MSD.new(Myasorubka::MSD::Russian)
+# msd[:pos] = :noun
+# msd[:type] = :common
+# msd[:number] = :plural
+# msd[:case] = :locative
+# msd.to_s # => "Nc-pl"
+# ```
+#
+# ```ruby
+# msd = Myasorubka::MSD.new(Myasorubka::MSD::Russian, 'Vmps-snpfel')
+# msd[:pos] # => :verb
+# msd[:tense] # => :past
+# msd[:person] # => nil
+# msd.grammemes # => {:type=>:main, :vform=>:participle, ...}
+# ```
+#
+class Myasorubka::MSD
+  # Empty descriptor character.
+  #
+  EMPTY_DESCRIPTOR = '-'
+
+  # An exception that is raised when Myasorubka::MSD unable to
+  # operate with given morphosyntactic descriptor. Mostly
+  # this problem is caused by inappropriate language selection
+  # or just typos.
+  #
+  class InvalidDescriptor < RuntimeError; end
+
+  attr_reader :pos, :grammemes, :language
+
+  # Creates a new morphosyntactic descriptor model instance.
+  # Please specify a `language` module with defined
+  # `CATEGORIES`.
+  #
+  # Optionally, you can parse MSD string that is passed as
+  # `msd` argument.
+  #
+  # @param language [Myasorubka::MSD::Language] a language to use.
+  # @param msd [String] a String to initialize new MSD.
+  #
+  def initialize(language, msd = '')
+    @language, @pos, @grammemes = language, nil, {}
+
+    unless language.const_defined? 'CATEGORIES'
+      raise ArgumentError,
+        'given language has no morphosyntactic descriptions'
+    end
+
+    parse! msd if msd && !msd.empty?
+  end
+
+  # Retrieves the morphosyntactic descriptor corresponding
+  # to the `key` object. If not, returns `nil`.
+  #
+  # @param key [Symbol] a key to look at.
+  # @return [Symbol] a value of `key`.
+  #
+  def [] key
+    return pos if :pos == key
+    grammemes[key]
+  end
+
+  # Assignes the morphosyntactic descriptor given by
+  # `value` with the key given by `key` object.
+  #
+  # @param key [Symbol] a key to be set.
+  # @param value [Symbol] a value to be assigned.
+  # @return [Symbol] the assigned value.
+  #
+  def []= key, value
+    return @pos = value if :pos == key
+    grammemes[key] = value
+  end
+
+  # @private
+  def inspect
+    '#<%s msd=%s>' % [language.name, to_s.inspect]
+  end
+
+  # @private
+  def <=> other
+    to_s <=> other.to_s
+  end
+
+  # @private
+  def == other
+    to_s == other.to_s
+  end
+
+  # Generates Regexp from the MSD that is useful to perform
+  # database queries.
+  #
+  # ```ruby
+  # msd = Myasorubka::MSD.new(Myasorubka::MSD::Russian, 'Vm')
+  # r = msd.to_regexp # => /^Vm.*$/
+  # 'Vmp' =~ r # 0
+  # 'Nc-pl' =~ r # nil
+  # ```
+  #
+  # @return [Regexp] the correspondent regular expression.
+  #
+  def to_regexp
+    Regexp.new([
+      '^',
+      self.to_s.gsub(EMPTY_DESCRIPTOR, '.'),
+      '.*',
+      '$'
+    ].join)
+  end
+
+  # Merges grammemes that are stored in `hash` into the
+  # MSD grammemes.
+  #
+  # @param hash [Hash<Symbol, Symbol>] a hash to be processed.
+  # @return [MSD] self.
+  #
+  def merge! hash
+    hash.each do |key, value|
+      self[key.to_sym] = value.to_sym
+    end
+
+    self
+  end
+
+  # @private
+  def to_s
+    return '' unless pos
+
+    unless category = language::CATEGORIES[pos]
+      raise InvalidDescriptor, "category is nil"
+    end
+
+    msd = [category[:code]]
+
+    attrs = category[:attrs]
+    grammemes.each do |attr_name, value|
+      next unless value
+
+      attr_index = attrs.index { |name, *values| name == attr_name }
+      unless attr_index
+        raise InvalidDescriptor, "no such attribute: '#{attr_name}' " \
+                                 "of category '#{pos}'"
+      end
+
+      attr_name, values = attrs[attr_index]
+
+      unless attr_value = values[value]
+        raise InvalidDescriptor, "no such value: '#{value}'' " \
+                                 "for attribute '#{attr_name}' " \
+                                 "of category '#{pos}'"
+      end
+
+      msd[attr_index + 1] = attr_value
+    end
+
+    msd.map { |e| e || EMPTY_DESCRIPTOR }.join
+  end
+
+  # Validates the MSD instance.
+  #
+  # @return [true, false] validation state of the MSD instance.
+  #
+  def valid?
+    !!to_s
+  rescue InvalidDescriptor
+    false
+  end
+
+  protected
+  # @private
+  def parse! msd_line
+    msd = msd_line.chars.to_a
+
+    category_code = msd.shift
+
+    @pos, category = language::CATEGORIES.find do |name, category|
+      category[:code] == category_code
+    end
+
+    raise InvalidDescriptor, msd_line unless @pos
+
+    attrs = category[:attrs]
+
+    msd.each_with_index do |value_code, i|
+      attr_name, values = attrs[i]
+      raise InvalidDescriptor, msd_line unless attr_name
+
+      next if :blank == attr_name
+      next if EMPTY_DESCRIPTOR == value_code
+
+      attribute = values.find { |name, code| code == value_code }
+      raise InvalidDescriptor, msd_line unless attribute
+
+      self[attr_name] = attribute.first
+    end
+  end
+end

data/lib/myasorubka/msd/english.rb

@@ -0,0 +1,263 @@
+# encoding: utf-8
+
+# English Specifications by Nancy Ide, Greg Priest-Dorman,
+# Tomaž Erjavec, Tamas Varadi.
+#
+# http://nl.ijs.si/ME/V4/msd/html/msd-en.html
+#
+# This specification was translated into the Ruby language
+# by [Dmitry Ustalov](http://eveel.ru).
+#
+module Myasorubka::MSD::English
+  # English Noun.
+  #
+  NOUN = {
+    code: 'N',
+    attrs: [
+      [ :type, {
+        common: 'c',
+        proper: 'p'
+      } ],
+      [ :gender, {
+        masculine: 'm',
+        feminine: 'f',
+        neuter: 'n'
+      } ],
+      [ :number, {
+        singular: 's',
+        plural: 'p'
+      } ]
+    ]
+  }
+
+  # English Verb.
+  #
+  VERB = {
+    code: 'V',
+    attrs: [
+      [ :type, {
+        main: 'm',
+        auxiliary: 'a',
+        modal: 'o',
+        base: 'b'
+      } ],
+      [ :vform, {
+        indicative: 'i',
+        conditional: 'c',
+        infinitive: 'n',
+        participle: 'p'
+      } ],
+      [ :tense, {
+        present: 'p',
+        past: 's'
+      } ],
+      [ :person, {
+        first: '1',
+        second: '2',
+        third: '3'
+      } ],
+      [ :number, {
+        singular: 's',
+        plural: 'p'
+      } ]
+    ]
+  }
+
+  # English Adjective.
+  #
+  ADJECTIVE = {
+    code: 'A',
+    attrs: [
+      [ :type, {
+        qualificative: 'f'
+      } ],
+      [ :degree, {
+        positive: 'p',
+        comparative: 'c',
+        superlative: 's'
+      } ]
+    ]
+  }
+
+  # English Pronoun.
+  #
+  PRONOUN = {
+    code: 'P',
+    attrs: [
+      [ :type, {
+        personal: 'p',
+        possessive: 's',
+        interrogative: 'q',
+        relative: 'r',
+        reflexive: 'x',
+        general: 'g',
+        ex_there: 't'
+      } ],
+      [ :person, {
+        first: '1',
+        second: '2',
+        third: '3'
+      } ],
+      [ :gender, {
+        masculine: 'm',
+        feminine: 'f',
+        neuter: 'n'
+      } ],
+      [ :number, {
+        singular: 's',
+        plural: 'p'
+      } ],
+      [ :case, {
+        nominative: 'n',
+        accusative: 'a'
+      } ],
+      [ :owner_number, {
+        singular: 's',
+        plural: 'p'
+      } ],
+      [ :owner_gender, {
+        masculine: 'm',
+        feminine: 'f'
+      } ],
+      [ :wh_type, {
+        relative: 'r',
+        question: 'q'
+      } ],
+    ]
+  }
+
+  # English Determiner.
+  #
+  DETERMINER = {
+    code: 'D',
+    attrs: [
+      [ :type, {
+        demonstrative: 'd',
+        indefinite: 'i',
+        possessive: 's',
+        general: 'g'
+      } ],
+      [ :person, {
+        first: '1',
+        second: '2',
+        third: '3'
+      } ],
+      [ :number, {
+        singular: 's',
+        plural: 'p'
+      } ],
+      [ :owner_number, {
+        singular: 's',
+        plural: 'p'
+      } ],
+      [ :owner_gender, {
+        masculine: 'm',
+        feminine: 'f',
+        neuter: 'n'
+      } ],
+      [ :wh_type, {
+        relative: 'r',
+        question: 'q'
+      } ]
+    ]
+  }
+
+  # English Adverb.
+  #
+  ADVERB = {
+    code: 'R',
+    attrs: [
+      [ :type, {
+        modifier: 'm',
+        specifier: 's'
+      } ],
+      [ :degree, {
+        positive: 'p',
+        comparative: 'c',
+        superlative: 's'
+      } ],
+      [ :wh_type, {
+        relative: 'r',
+        question: 'q'
+      } ]
+    ]
+  }
+
+  # English Adposition.
+  #
+  ADPOSITION = {
+    code: 'S',
+    attrs: [
+      [ :type, {
+        preposition: 'p',
+        postposition: 't'
+      } ]
+    ]
+  }
+
+  # English Conjunction.
+  #
+  CONJUNCTION = {
+    code: 'C',
+    attrs: [
+      [ :type, {
+        coordinating: 'c',
+        subordinating: 's'
+      } ],
+      [ :coord_type, {
+        initial: 'i',
+        non_initial: 'n'
+      } ],
+    ]
+  }
+
+  # English Numeral.
+  #
+  NUMERAL = {
+    code: 'M',
+    attrs: [
+      [ :type, {
+        cardinal: 'c',
+        ordinal: 'o'
+      } ],
+    ]
+  }
+
+  # English Interjection.
+  #
+  INTERJECTION = {
+    code: 'I',
+    attrs: []
+  }
+
+  # English Abbreviation.
+  #
+  ABBREVIATION = {
+    code: 'Y',
+    attrs: []
+  }
+
+  # English Residual.
+  #
+  RESIDUAL = {
+    code: 'X',
+    attrs: []
+  }
+
+  # Actual part-of-speech mapping.
+  #
+  CATEGORIES = {
+    noun: NOUN,
+    verb: VERB,
+    adjective: ADJECTIVE,
+    pronoun: PRONOUN,
+    determiner: DETERMINER,
+    adverb: ADVERB,
+    adposition: ADPOSITION,
+    conjunction: CONJUNCTION,
+    numeral: NUMERAL,
+    interjection: INTERJECTION,
+    abbreviation: ABBREVIATION,
+    residual: RESIDUAL
+  }
+end