zenlish 0.2.05 → 0.2.07

data/lib/zenlish/inflect/formal_argument.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Zenlish
   module Inflect
     class FormalArgument
       attr_reader :index
-      
+
       def initialize(anIndex)
         @index = anIndex
       end

data/lib/zenlish/inflect/function_call.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'atomic_o_expression'
 
 module Zenlish
@@ -6,6 +8,7 @@ module Zenlish
       attr_reader :mth_name
 
       def initialize(aMethodName)
+        super()
         @mth_name = aMethodName
       end
 
@@ -14,4 +17,4 @@ module Zenlish
       end
     end # class
   end # module
-end # module
+end # module

data/lib/zenlish/inflect/heading.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../feature/feature'
 require_relative '../feature/feature_def'
 

data/lib/zenlish/inflect/inflection_rule.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Zenlish
   module Inflect
     # An inflection rule has two-parts:

data/lib/zenlish/inflect/inflection_table.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module Zenlish
   module Inflect
@@ -28,6 +29,7 @@ module Zenlish
         end
         err_msg = "Table has #{headings.size} headings, instead of #{constraints.size}"
         raise StandardError, err_msg if constraints.size != headings.size
+
         actuals = []
         headings.each_with_index do |hd, idx|
           if constraints[idx]
@@ -50,7 +52,7 @@ module Zenlish
       def all_inflections(aLexeme)
         constraints = Array.new(headings.size) { |_i| nil }
         heading_matches = []
-        headings.each_with_index do |hd, idx|
+        headings.each_with_index do |hd, _idx|
           heading_matches << hd.all_matches(aLexeme)
         end
         w_forms = nil
@@ -60,8 +62,8 @@ module Zenlish
             inflect(aLexeme, [item])
           end
         else
-          vector_1 = heading_matches.shift
-          all_combos = vector_1.product(*heading_matches)
+          vector1 = heading_matches.shift
+          all_combos = vector1.product(*heading_matches)
           w_forms = all_combos.map do |combination|
             inflect(aLexeme, combination)
           end
@@ -71,4 +73,4 @@ module Zenlish
       end
     end # class
   end # module
-end # module
+end # module

data/lib/zenlish/inflect/inflection_table_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'feature_heading'
 require_relative 'method_heading'
 require_relative 'formal_argument'
@@ -13,19 +15,19 @@ require_relative 'substitution'
 require_relative 'inflection_rule'
 require_relative 'inflection_table'
 
-        # DecisionTable: Common_form
-        # | NUMBER   | .base_form      | Common_form                |
-        # | singular | X               | base_form                  |
-        # | plural   | ~ /[^aeiouy]y$/ | sub(base_form, /y$/, "ies")|
-        # | plural   | X               | base_form + "s"            |
-        # build('Common_form') do
-        #   feature_heading 'NUMBER'
-        #   method_heading  'base_form'
-        #       | NUMBER          | base_form             | Common_form               |
-        #   rule [equals(:singular), dont_care             ], col('base_form')
-        #   rule [equals(:plural)  , matches(/[^aeiouy]y$/)], sub(col('base_form'), /y$/, 'ies')
-        #   rule [equals(:plural)  , dont_care             ], concat(col('base_form'), 's')
-        # end
+# DecisionTable: Common_form
+# | NUMBER   | .base_form      | Common_form                |
+# | singular | X               | base_form                  |
+# | plural   | ~ /[^aeiouy]y$/ | sub(base_form, /y$/, "ies")|
+# | plural   | X               | base_form + "s"            |
+# build('Common_form') do
+#   feature_heading 'NUMBER'
+#   method_heading  'base_form'
+#       | NUMBER          | base_form              | Common_form               |
+#   rule [equals(:singular), dont_care             ], col('base_form')
+#   rule [equals(:plural)  , matches(/[^aeiouy]y$/)], sub(col('base_form'), /y$/, 'ies')
+#   rule [equals(:plural)  , dont_care             ], concat(col('base_form'), 's')
+# end
 
 module Zenlish
   module Inflect
@@ -50,20 +52,20 @@ module Zenlish
       def feature_heading(aFeatureName)
         hd = FeatureHeading.new(aFeatureName)
         headings << hd
-        table.add_heading(hd) if table
+        table&.add_heading(hd)
       end
 
       def method_heading(aMethodName)
         hd = MethodHeading.new(aMethodName)
         headings << hd
-        table.add_heading(hd) if table
+        table&.add_heading(hd)
       end
 
       def rule(conditions, consequent)
         @conds = []
         rl = InflectionRule.new(conditions.dup, consequent)
         rules << rl
-        table.add_rule(rl) if table
+        table&.add_rule(rl)
 
         rl
       end
@@ -107,6 +109,7 @@ module Zenlish
         col_index = headings.find_index { |hd| hd.label == aColName }
         err_msg = "Cannot find heading named '#{aColName}'."
         raise StandardError, err_msg if col_index.nil?
+
         formal = FormalArgument.new(col_index)
         InputAsIs.new(formal)
       end
@@ -132,7 +135,7 @@ module Zenlish
 
       private
 
-      def reset()
+      def reset
         @table = nil
         @headings = []
         @conds = []
@@ -144,4 +147,4 @@ module Zenlish
       # end
     end # class
   end # module
-end # module
+end # module

data/lib/zenlish/inflect/input_asis.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'atomic_o_expression'
 
 module Zenlish
@@ -6,6 +8,7 @@ module Zenlish
       attr_reader :formal
 
       def initialize(anArgument)
+        super()
         @formal = anArgument
       end
 

data/lib/zenlish/inflect/input_expression.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Zenlish
   module Inflect
     class InputExpression
       def success?(_lexeme, _heading_values)
         raise NotImplementedError, 'Method must be implemented in subclass(es).'
-      end    
+      end
     end # class
   end # module
-end # module
+end # module

data/lib/zenlish/inflect/literal_asis.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'atomic_o_expression'
 
 module Zenlish
@@ -6,6 +8,7 @@ module Zenlish
       attr_reader :text
 
       def initialize(aLiteralValue)
+        super()
         @text = aLiteralValue
       end
 
@@ -14,4 +17,4 @@ module Zenlish
       end
     end # class
   end # module
-end # module
+end # module

data/lib/zenlish/inflect/matches_pattern.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'unary_input_expression'
 
 module Zenlish

data/lib/zenlish/inflect/membership.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'unary_input_expression'
 
 module Zenlish

data/lib/zenlish/inflect/method_heading.rb

@@ -1,20 +1,17 @@
+# frozen_string_literal: true
+
 require_relative 'heading'
 
 module Zenlish
   module Inflect
     class MethodHeading < Heading
-
-      def initialize(aLabel)
-        super(aLabel)
-      end
-      
       def evaluate_for(aFeatureBearer)
         aFeatureBearer.send(label)
       end
 
       def all_matches(aFeatureBearer)
         [evaluate_for(aFeatureBearer)]
-      end      
+      end
     end # class
   end # module
 end # module

data/lib/zenlish/inflect/not_equals_literal.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'unary_input_expression'
 
 module Zenlish

data/lib/zenlish/inflect/nullary_input_expression.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'input_expression'
 
 module Zenlish
@@ -5,4 +7,4 @@ module Zenlish
     class NullaryInputExpression < InputExpression
     end # class
   end # module
-end # module
+end # module

data/lib/zenlish/inflect/output_expression.rb

@@ -1,6 +1,12 @@
+# frozen_string_literal: true
+
 module Zenlish
   module Inflect
+    # rubocop: disable Lint/EmptyClass
+
     class OutputExpression
     end # class
+
+    # rubocop: enable Lint/EmptyClass
   end # module
 end # module

data/lib/zenlish/inflect/substitution.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'literal_asis'
 require_relative 'composite_o_expression'
 
@@ -62,4 +64,4 @@ module Zenlish
       end
     end # class
   end # module
-end # module
+end # module

data/lib/zenlish/inflect/unary_input_expression.rb

@@ -1,11 +1,14 @@
+# frozen_string_literal: true
+
 require_relative 'input_expression'
 
 module Zenlish
   module Inflect
     class UnaryInputExpression < InputExpression
       attr_reader :argument
-      
+
       def initialize(anArgument)
+        super()
         @argument = anArgument
       end
     end # class

data/lib/zenlish/inflect/unconditionally_true.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'nullary_input_expression'
 
 module Zenlish
@@ -5,7 +7,7 @@ module Zenlish
     class UnconditionallyTrue < NullaryInputExpression
       def success?(_headings, _lexeme, _heading_values)
         true
-      end     
+      end
     end # class
   end # module
-end # module
+end # module

data/lib/zenlish/lang/dictionary.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 unless defined?(Zenlish::Lang::Dictionary)
   require_relative '../feature/feature_struct_def_bearer'
   module Zenlish
@@ -9,7 +11,7 @@ unless defined?(Zenlish::Lang::Dictionary)
       sandbox = Object.new
       sandbox.extend(Zenlish::Lex::EmptyLexiconFactory)
       Dictionary = sandbox.create_empty_lexicon
-      self.extend(Feature::FeatureStructDefBearer)
+      extend(Feature::FeatureStructDefBearer)
 
       # @param aLemma [String] is the canonical form, dictionary form,
       #   or citation form of a headword.
@@ -18,6 +20,7 @@ unless defined?(Zenlish::Lang::Dictionary)
         entry = Zenlish::Lex::LexicalEntry.new(aLemma)
         wclass = Dictionary.name2terminal[aWClassName]
         raise StandardError, "Undefined word class for '#{aLemma}'" unless wclass
+
         lexeme = Zenlish::Lex::Lexeme.new(wclass, entry, aFeatureHash)
         lexeme.instance_exec(&aBlock) if block_given?
         lexeme.freeze
@@ -90,17 +93,17 @@ unless defined?(Zenlish::Lang::Dictionary)
       end
       add_entry('here', 'Adverb')
       # example: ...from here (works as a pronoun of a place)
-      add_entry('here', 'CommonNoun', {'NUMBER' => enumeration(:singular),
-        'PARADIGM' => [identifier, 'Singular_only']})
+      add_entry('here', 'CommonNoun', { 'NUMBER' => enumeration(:singular),
+        'PARADIGM' => [identifier, 'Singular_only'] })
       add_entry('I', 'PersonalPronoun', { 'PERSON' => enumeration(:first),
         'GENDER' => enumeration(:feminine, :masculine) })
       add_entry('if', 'SubordinatingConjunction')
       add_entry('in', 'Preposition')
       add_entry('inside', 'Preposition')
       add_entry('it', 'PersonalPronoun', { 'PERSON' => enumeration(:third),
-        'PARADIGM' => [identifier, 'ppn_3rd_paradigm']})
+        'PARADIGM' => [identifier, 'ppn_3rd_paradigm'] })
       add_entry('its', 'PossessiveDeterminer', { 'PERSON' => enumeration(:third),
-        'PARADIGM' => [identifier, 'possdet_3rd_paradigm']})
+        'PARADIGM' => [identifier, 'possdet_3rd_paradigm'] })
       add_entry('kind', 'CommonNoun')
       add_entry('know', 'IrregularVerbKnow') do
         forms past_simple: 'knew', past_participle: 'known'
@@ -120,13 +123,13 @@ unless defined?(Zenlish::Lang::Dictionary)
       add_entry('more', 'Adverb')
       add_entry('move', 'RegularVerb')
       add_entry('much', 'Adverb')
-      add_entry('my', 'PossessiveDeterminer',{ 'PERSON' => enumeration(:first),
-        'GENDER' => enumeration(:feminine, :masculine)})
+      add_entry('my', 'PossessiveDeterminer', { 'PERSON' => enumeration(:first),
+        'GENDER' => enumeration(:feminine, :masculine) })
       add_entry('near', 'Preposition')
       add_entry('near to', 'Preposition')
       add_entry('now', 'Adverb')
-      add_entry('now', 'CommonNoun', {'NUMBER' => enumeration(:singular),
-        'PARADIGM' => [identifier, 'Singular_only']})
+      add_entry('now', 'CommonNoun', { 'NUMBER' => enumeration(:singular),
+        'PARADIGM' => [identifier, 'Singular_only'] })
       add_entry('not', 'AdverbNot')
       add_entry('of', 'PrepositionOf')
       add_entry('on', 'Preposition')
@@ -136,10 +139,10 @@ unless defined?(Zenlish::Lang::Dictionary)
       add_entry('or', 'Coordinator')
       add_entry('other', 'Adjective')
       add_entry('part', 'CommonNoun')
-      add_entry('people', 'CommonNoun', {'NUMBER' => enumeration(:plural),
-        'PARADIGM' => [identifier, 'Plural_only']})
-      add_entry('person', 'CommonNoun', {'NUMBER' => enumeration(:singular),
-        'PARADIGM' => [identifier, 'Singular_only']})
+      add_entry('people', 'CommonNoun', { 'NUMBER' => enumeration(:plural),
+        'PARADIGM' => [identifier, 'Plural_only'] })
+      add_entry('person', 'CommonNoun', { 'NUMBER' => enumeration(:singular),
+        'PARADIGM' => [identifier, 'Singular_only'] })
       add_entry('place', 'CommonNoun')
       add_entry('same', 'Adjective')
       add_entry('same', 'Pronoun')
@@ -188,10 +191,10 @@ unless defined?(Zenlish::Lang::Dictionary)
       add_entry('word', 'CommonNoun')
       add_entry('you', 'PersonalPronoun', { 'PERSON' => enumeration(:second),
             'GENDER' => enumeration(:feminine, :masculine),
-            'PARADIGM' => [identifier, 'ppn_2nd_paradigm']})
+            'PARADIGM' => [identifier, 'ppn_2nd_paradigm'] })
       add_entry('your', 'PossessiveDeterminer', { 'PERSON' => enumeration(:second),
         'GENDER' => enumeration(:feminine, :masculine),
-        'PARADIGM' => [identifier, 'possdet_2nd_paradigm']})
+        'PARADIGM' => [identifier, 'possdet_2nd_paradigm'] })
 
       # Punctuation signs...
       add_entry(':', 'Colon')
@@ -200,4 +203,4 @@ unless defined?(Zenlish::Lang::Dictionary)
       add_entry('"', 'Quote')
     end # module
   end # module
-end # defined?
+end # defined?

data/lib/zenlish/lang/lemmatizer.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative '../trie/trie'
+
+module Zenlish
+  module Lang
+    class Lemmatizer
+      # @return [Trie:Trie] Trie (aka prefix tree) with all word forms from dictionary.
+      attr_reader :trie
+
+      def initialize(aLexicon)
+        @trie = Trie::Trie.new
+        initialize_trie(aLexicon)
+      end
+
+      def lemmatize(aWordForm, _hints = nil)
+        node = trie.search(aWordForm)
+        node&.value
+      end
+
+      private
+
+      def initialize_trie(aLexicon)
+        aLexicon.entries.each do |ent|
+          citation_form = ent.lemma
+          ent.lexemes.each do |lxm|
+            if lxm.wclass.kind_of?(Zenlish::WClasses::WordClass)
+              if lxm.wclass.invariable?
+                trie.add(citation_form, lxm)
+              else
+                w_forms = lxm.all_inflections
+                w_forms.each { |form| trie.add(form, lxm) }
+              end
+            end
+          end
+        end
+      end
+    end # class
+  end # module
+end # module

data/lib/zenlish/lang/zenlish_grammar.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Grammar for a simple subset of English language
 # It is called Zenlish
 
@@ -6,7 +8,7 @@ require_relative 'dictionary'
 
 ########################################
 # Define a grammar for a highly English-like language
-builder = Rley::Syntax::GrammarBuilder.new do
+builder = Rley::grammar_builder do
   add_terminals(*Zenlish::Lang::Dictionary.terminals)
 
   rule 'zenlish' => 'prose'
@@ -19,7 +21,7 @@ builder = Rley::Syntax::GrammarBuilder.new do
   #################
   # Simple sentence
   #################
-  rule 'simple_sentence' =>  'front_adverb simple_sentence'
+  rule 'simple_sentence' => 'front_adverb simple_sentence'
   rule 'front_adverb' => 'AdverbMaybe'
   rule 'front_adverb' => 'Adverb'
   rule 'simple_sentence' => 'declarative_simple_sentence'
@@ -107,7 +109,7 @@ builder = Rley::Syntax::GrammarBuilder.new do
   rule 'comparative_start' => 'ComparativeParticle'
   rule 'conjunctive_prefix' => 'ConjunctivePronoun noun_phrase verb_phrase'
   rule 'identifying_clause' => 'RelativePronoun tense_verb_phrase'
-  rule 'relative_clause_opt' =>  'relative_clause'
+  rule 'relative_clause_opt' => 'relative_clause'
   rule 'relative_clause_opt' => []
   rule 'relative_clause' => 'RelativePronoun tense_phrase'
   # Sentence 3-Bxa 'Lisa sees a living thing that is very big.
@@ -294,7 +296,7 @@ builder = Rley::Syntax::GrammarBuilder.new do
   # complementation by a verb: gerund -ing form...
   rule 'preposition_object' => 'noun_phrase_opt lexical_verb post_head_vp'
   # preposition_object => "a gerund (a verb form ending in "-ing") that acts as a noun # Example: He beat Lee without overly trying.
-  rule 'preposition_object' => 'conjunctive_prefix'		# It's obvious from _what he said_.
+  rule 'preposition_object' => 'conjunctive_prefix'	# It's obvious from _what he said_.
   rule 'preposition_object' => []
 
   ######################

data/lib/zenlish/lex/empty_lexicon_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../wclasses/all_word_classes'
 require_relative 'lexicon'
 
@@ -7,7 +9,7 @@ module Zenlish
       # Factory method. Helps in creating an "empty" lexicon.
       # It just contains the word classes of Zenlish but no headwords.
       # @return [Lexicon] the created lexicon object
-      def create_empty_lexicon()
+      def create_empty_lexicon
         lexicon = Lexicon.new
 
         add_word_classes(lexicon)
@@ -73,7 +75,6 @@ module Zenlish
       def add_wclass(aLexicon, aClass)
         aLexicon.add_terminal(aClass.new.freeze)
       end
-
     end # module
   end # module
 end # module

data/lib/zenlish/lex/lexeme.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../feature/feature_struct_def_bearer'
 module Zenlish
   module Lex
@@ -20,7 +22,7 @@ module Zenlish
         anEntry.add_lexeme(self)
         if aWClass.kind_of?(WClasses::WordClass)
           unless wclass.extension.nil?
-            self.extend(wclass.extension)
+            extend(wclass.extension)
             init_extension(self)
           end
           p_struct = aWClass.kind_of?(WClasses::WordClass) ? aWClass.struct : nil
@@ -41,11 +43,11 @@ module Zenlish
         table = paradigm
         table.inflect(self, constraints)
       end
-      
+
       def all_inflections
         table = paradigm
         table.all_inflections(self)
-      end      
+      end
 
       # @return [String] the base (dictionary) form.
       def lemma
@@ -62,4 +64,4 @@ module Zenlish
       alias base_form lemma
     end # class
   end # module
-end # module
+end # module

data/lib/zenlish/lex/lexical_entry.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 module Zenlish
   module Lex
     # TODO: document
     class LexicalEntry
-      #@return [String] the lemma (dictionary) form of a word.
+      # @return [String] the lemma (dictionary) form of a word.
       attr_reader :lemma
 
       # @return [Array<Lexeme, Rley::Syntax::Terminal>]
       attr_reader :lexemes
 
-      # @param theLemma [String] lemma (= citation form), a word form used 
+      # @param theLemma [String] lemma (= citation form), a word form used
       #   conventionnaly to represent a lexeme.
       # @param aLexeme [Lexeme, NilClass] the lexeme to link with lexical entry.
       def initialize(theLemma, aLexeme = nil)
@@ -17,10 +19,10 @@ module Zenlish
         add_lexeme(aLexeme)
       end
 
-      # @param aLexeme [Lexeme, NilClass] the lexeme to link with lexical entry.      
+      # @param aLexeme [Lexeme, NilClass] the lexeme to link with lexical entry.
       def add_lexeme(aLexeme)
         lexemes << aLexeme if aLexeme
       end
     end # class
   end # module
-end # module
+end # module

data/lib/zenlish/lex/lexicon.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Zenlish
   module Lex
     # A lexicon is a collection of lexical entries.
@@ -5,7 +7,7 @@ module Zenlish
     class Lexicon
       # @return [Array<Lex::LexicalEntry>] entries in the lexicon
       attr_reader :entries
-      
+
       # @return [Hash{String => Lex::LexicalEntry}] the lexical entry for the given lemma.
       attr_reader :lemma2entry
 
@@ -23,7 +25,7 @@ module Zenlish
       end
 
       # @param aLemma[String] retrieve the lexeme form the given "head word".
-      # @param aWordClass [WordClasses::WordClass, NilClass] the word class of 
+      # @param aWordClass [WordClasses::WordClass, NilClass] the word class of
       #   the lexeme.
       # @return [Lex::Lexeme]
       def get_lexeme(aLemma, aWordClass = nil)
@@ -83,7 +85,6 @@ module Zenlish
           aHash[aKey] = aValue
         end
       end
-
     end # class
   end # module
 end # module

data/lib/zenlish/lex/literal.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rley'
 
 module Zenlish
@@ -7,7 +9,7 @@ module Zenlish
       attr_reader :zlexeme
 
       # initialize(theLexeme, aTerminal, aPosition) ⇒ Token
-      # @param literalText [String] the portion of input text that represents 
+      # @param literalText [String] the portion of input text that represents
       #   an occurence of the lexeme.
       # @param aLexeme [Lex::Lexeme] the lexeme matched by the literal text.
       # @param aPosition [Integer] the position of the literal in the input.