zenlish 0.2.02 → 0.2.06

data/lib/zenlish/trie/base_trie_node.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Zenlish
+  module Trie
+    # Abstract class for representing nodes in the trie data structure.
+    class BaseTrieNode
+      # @return [Hash{String => TrieNode}] the successor nodes
+      attr_reader :succ
+
+      def initialize
+        @succ = {}
+      end
+
+      def include?(aKey)
+        succ.include?(aKey)
+      end
+
+      def add_succ(aKey, aNode)
+        succ[aKey] = aNode
+      end
+
+      def leaf?
+        succ.empty?
+      end
+    end # class
+  end # module
+end # module

data/lib/zenlish/trie/trie.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require_relative 'trie_root'
+require_relative 'trie_node'
+
+# https://raw.githubusercontent.com/first20hours/google-10000-english/master/20k.txt
+# https://raw.githubusercontent.com/dwyl/english-words/master/words_alpha.txt
+
+module Zenlish
+  module Trie
+    # A trie (aka prefix tree or digital tree) is a kind of search tree.
+    class Trie
+      #  @return [TrieRoot] The root node of the trie data structure
+      attr_reader :root
+
+      def initialize
+        @root = TrieRoot.new
+      end
+
+      def add(aWord, aValue)
+        append_node(root, aWord, 0, aValue)
+      end
+
+      def search(aWord)
+        search_node(root, aWord, 0)
+      end
+
+      private
+
+      def append_node(aNode, aText, anIndex, aValue)
+        key = aText[anIndex]
+        unless aNode.include?(key)
+          aNode.add_succ(key, TrieNode.new(key))
+        end
+        successor = aNode.succ[key]
+
+        if anIndex == aText.size - 1
+          current_value = successor.value
+          if current_value
+            if current_value.kind_of?(Array)
+              current_value << aValue
+            else
+             successor.value = [current_value, aValue]
+            end
+          else
+            successor.value = aValue
+          end
+        else
+          append_node(successor, aText, anIndex + 1, aValue)
+        end
+      end
+
+      def search_node(aNode, aText, anIndex)
+        key = aText[anIndex]
+        return nil unless aNode.include?(key)
+
+        successor = aNode.succ[key]
+        return successor if anIndex == aText.size - 1
+
+        search_node(successor, aText, anIndex + 1)
+      end
+=begin
+
+
+      def include?(word)
+        find_word(word) { |found, base| return found && base.word }
+      end
+
+      def add_word(word)
+        letters = word.chars
+        base    = @root
+
+        letters.each { |letter| base = add_character(letter, base.next) }
+
+        base.word = true
+      end
+
+      def find_word(word)
+        letters = word.chars
+        base    = @root
+
+        word_found =
+        letters.all? { |letter| base = find_character(letter, base.next) }
+
+        yield word_found, base if block_given?
+
+        base
+      end
+
+      def find_words_starting_with(prefix)
+        stack        = []
+        words        = []
+        prefix_stack = []
+
+        stack        << find_word(prefix)
+        prefix_stack << prefix.chars.take(prefix.size-1)
+
+        return [] unless stack.first
+
+        until stack.empty?
+          node = stack.pop
+
+          prefix_stack.pop and next if node == :guard_node
+
+          prefix_stack << node.value
+          stack        << :guard_node
+
+          words << prefix_stack.join if node.word
+
+          node.next.each { |n| stack << n }
+        end
+
+        words
+      end
+
+      private
+
+      def add_character(character, trie)
+        trie.find { |n| n.value == character } || add_node(character, trie)
+      end
+
+      def find_character(character, trie)
+        trie.find { |n| n.value == character }
+      end
+
+      def add_node(character, trie)
+        TrieNode.new(character).tap { |new_node| trie << new_node }
+      end
+=end
+    end # class
+  end # module
+end # module

data/lib/zenlish/trie/trie_node.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative 'base_trie_node'
+
+module Zenlish
+  module Trie
+    class TrieNode < BaseTrieNode
+      # @return [String] the matching character
+      attr_reader :key
+
+      # @return [Object, NilClass] Result when this character matches end-of-word.
+      attr_accessor :value
+
+      def initialize(aChar)
+        super()
+        @key = aChar
+        @value = nil
+      end
+    end # class
+  end # module
+end # module

data/lib/zenlish/trie/trie_root.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'base_trie_node'
+
+module Zenlish
+  module Trie
+    class TrieRoot < BaseTrieNode
+    end # class
+  end # module
+end # module

data/lib/zenlish/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Zenlish
-  VERSION = '0.2.02'.freeze
+  VERSION = '0.2.06'
 end

data/lib/zenlish/wclasses/adjective.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'word_class'
 
 module Zenlish
@@ -6,8 +8,9 @@ module Zenlish
     class Adjective < WordClass
       # @return [FalseClass] Indicates that an adjective may inflect.
       def invariable?
-        false
-      end    
+        # TODO: set to false once we introduce the degrees (basic, comparative, superlative)
+        true
+      end
     end # class
   end # module
 end # module

data/lib/zenlish/wclasses/adverb.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require_relative 'word_class'
 
 module Zenlish
   module WClasses
     # TODO: document
-    class Adverb < WordClass   
+    class Adverb < WordClass
     end # class
   end # module
 end # module

data/lib/zenlish/wclasses/adverb_maybe.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require_relative 'adverb'
 
 module Zenlish
   module WClasses
-    # The adverb maybe expresses uncertainty and is often placed in front 
+    # The adverb maybe expresses uncertainty and is often placed in front
     # of clauses.
     class AdverbMaybe < Adverb
     end # class

data/lib/zenlish/wclasses/adverb_not.rb

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

data/lib/zenlish/wclasses/all_word_classes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Load the WordClass class hierarchy
 # Algorithm: load the leaf classes from hierarchy
 
@@ -20,6 +22,7 @@ require_relative 'proper_noun'
 require_relative 'irregular_linking_verb'
 require_relative 'irregular_verb'
 require_relative 'irregular_verb_be'
+require_relative 'irregular_verb_can'
 require_relative 'irregular_verb_do'
 require_relative 'irregular_verb_have'
 require_relative 'irregular_verb_know'
@@ -32,7 +35,6 @@ require_relative 'indefinite_article'
 require_relative 'indefinite_pronoun'
 require_relative 'linking_adverb'
 require_relative 'modal_verb_can'
-require_relative 'modal_verb_could'
 require_relative 'personal_pronoun'
 require_relative 'possessive_determiner'
 require_relative 'preposition'
@@ -43,4 +45,4 @@ require_relative 'fronting_quantifier'
 require_relative 'regular_verb'
 require_relative 'regular_verb_want'
 require_relative 'relative_pronoun'
-require_relative 'subordinating_conjunction'
+require_relative 'subordinating_conjunction'

data/lib/zenlish/wclasses/article.rb

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

data/lib/zenlish/wclasses/auxiliary.rb

@@ -1,10 +1,13 @@
+# frozen_string_literal: true
+
 require_relative 'verb'
 
 module Zenlish
   module WClasses
-    # The verbs: be, have, do
+    # The verbs: be, have, do and the modal verbs can, could, may, must, shall,
+    #   should, will, would
     # As they are so important to the English language, they deserve
-    # their own class
+    # their own class(es)
     class Auxiliary < Verb
     end # class
   end # module

data/lib/zenlish/wclasses/auxiliary_be.rb

@@ -1,9 +1,42 @@
+# frozen_string_literal: true
+
 require_relative 'auxiliary'
 
 module Zenlish
   module WClasses
-    # TODO: document
     class AuxiliaryBe < Auxiliary
+      # rubocop: disable Layout/SpaceInsideArrayLiteralBrackets
+
+      private
+
+      def init_feature_defs
+        super
+        # Create standard feature definitions for modal verb can.
+        feature_def_dsl do
+          feature_def 'PARADIGM' => [identifier, 'Verb_be_inflection'] # 2nd item is default value
+        end
+      end
+
+      def init_paradigms
+        builder = Inflect::InflectionTableBuilder.new
+        table = builder.build('Verb_be_inflection') do
+          feature_heading 'PERSON'
+          feature_heading 'NUMBER'
+          feature_heading 'TIME'
+          #     PERSON               NUMBER             TIME
+          rule([equals(:first),      equals(:singular), equals(:present)        ], literal('am'))
+          rule([equals(:second),     equals(:singular), equals(:present)        ], literal('are'))
+          rule([equals(:third),      equals(:singular), equals(:present)        ], literal('is'))
+          rule([dont_care,           equals(:plural),   equals(:present)        ], literal('are'))
+          rule([dont_care,           dont_care,         equals(:progressive)    ], literal('being'))
+          rule([in?(:first, :third), equals(:singular), equals(:past_simple)    ], literal('was'))
+          rule([equals(:second),     equals(:singular), equals(:past_simple)    ], literal('were'))
+          rule([dont_care,           equals(:plural),   equals(:past_simple)    ], literal('were'))
+          rule([dont_care,           dont_care,         equals(:past_participle)], literal('been'))
+        end
+        add_paradigm(table)
+      end
+      # rubocop: enable Layout/SpaceInsideArrayLiteralBrackets
     end # class
   end # module
 end # module

data/lib/zenlish/wclasses/auxiliary_do.rb

@@ -1,9 +1,40 @@
+# frozen_string_literal: true
+
 require_relative 'auxiliary'
 
 module Zenlish
   module WClasses
     # TODO: document
     class AuxiliaryDo < Auxiliary
+      # rubocop: disable Layout/SpaceInsideArrayLiteralBrackets
+
+      private
+
+      def init_feature_defs
+        super
+        # Create standard feature definitions for modal verb can.
+        feature_def_dsl do
+          feature_def 'PARADIGM' => [identifier, 'Verb_do_inflection'] # 2nd item is default value
+        end
+      end
+
+      def init_paradigms
+        builder = Inflect::InflectionTableBuilder.new
+        table = builder.build('Verb_do_inflection') do
+          feature_heading 'PERSON'
+          feature_heading 'NUMBER'
+          feature_heading 'TIME'
+          #     PERSON              NUMBER             TIME
+          rule([not_equal(:third), equals(:singular), equals(:present)        ], literal('do'))
+          rule([equals(:third),    equals(:singular), equals(:present)        ], literal('does'))
+          rule([dont_care,         equals(:plural),   equals(:present)        ], literal('do'))
+          rule([dont_care,         dont_care,         equals(:progressive)    ], literal('doing'))
+          rule([dont_care,         dont_care,         equals(:past_simple)    ], literal('did'))
+          rule([dont_care,         dont_care,         equals(:past_participle)], literal('done'))
+        end
+        add_paradigm(table)
+      end
+      # rubocop: enable Layout/SpaceInsideArrayLiteralBrackets
     end # class
   end # module
 end # module

data/lib/zenlish/wclasses/cardinal.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'numeral'
 
 module Zenlish
@@ -6,4 +8,4 @@ module Zenlish
     class Cardinal < Numeral
     end # class
   end # module
-end # module
+end # module

data/lib/zenlish/wclasses/common_noun.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'noun'
 require_relative '../inflect/inflection_table_builder'
 

data/lib/zenlish/wclasses/comparative_particle.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require_relative 'word_class'
 
 module Zenlish
   module WClasses
-    # TODO: document 
+    # TODO: document
     # Example: 'as' in 'same ... as'
-    class ComparativeParticle < WordClass   
+    class ComparativeParticle < WordClass
     end # class
   end # module
-end # module
+end # module

data/lib/zenlish/wclasses/conjunction.rb

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

data/lib/zenlish/wclasses/conjunctive_pronoun.rb

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