gullah 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73c8674a510b84d261ae0575c6d9b65109aea210b1b3bc0832a018ef572ee6b5
-  data.tar.gz: e5497a3d4e967fd3547496caf23728d03ce0f2f485bc97c53332713331027b9e
+  metadata.gz: cdb5fc63d2f73407d20cfc3fdb709f27e800a1b4c4b572243e46af970d2563c6
+  data.tar.gz: 4803e11f42479445bc125013777e797fe526f949e1d9620bea34a974f83fd3dc
 SHA512:
-  metadata.gz: b51e5eb27bec2a7d1554f332c5c71e26280ad76a704e07f7146e60cb60b59ef106c6e61bef1cb5c877889487cb51033a968a6d62575e429468486dbfb939c921
-  data.tar.gz: 0fdc0bc2d67ac9833f92ae9a6535e092ede3e5c95fde414604d685a0e0835f016fae11db1578dee251bf7947b0f861e6c428b81b2ae25a45b349bea50a808ebc
+  metadata.gz: 03ad7649f31e61e78cb7220809a13e68ce6e8bdc88c497b251c36c9c5a885688bb1fd075b8d0e31e8724ee4d697446ace38cce36381a9ef1f1a2ac5c5642d334
+  data.tar.gz: 0d86b4e95ef0f6390cac7a47bafc45ed45e68d3bedc0524b95dd82fc2140281da3db3a380a71814f0862ca94e3b05f21634f3975a2b38eb42719254debbd03e3

data/CHANGES.md

@@ -1,5 +1,8 @@
 # Change Log
 
+## 0.0.2 *2021-8-29*
+* still more improvements to documentation
+
 ## 0.0.1 *2021-8-29*
 * improvements to documentation
 

data/README.md

@@ -20,11 +20,11 @@ A simple, fault-tolerant bottom-up parser written in Ruby.
     rule :N, 'nouns'
     rule :A, 'adjectives'
 
-    leaf :determiners, /\b(the|a)\b/i
+    leaf :determiners, /\b(the|an?)\b/i
     leaf :nouns, /\b(cat|mat)\b/i
     leaf :prepositions, /\b(on|in|around|above|beside)\b/i
     leaf :verbs, /\b(sat|slept|moped)\b/
-    leaf :adjectives, /\b(big|small|hairy|bald)\b/i
+    leaf :adjectives, /\b(big|small|hairy|bald|fat)\b/i
 
     ignore :whatever, /[^\w\s]+/
   end
@@ -33,8 +33,8 @@ A simple, fault-tolerant bottom-up parser written in Ruby.
     parses = Cat.parse 'The fat cat sat on the mat.'
     assert_equal 1, parses.length, 'there is only one parse of this sentence'
     parse = parses.first
-    assert_equal 1, parse.nodes.reject(&:ignorable?).count, 'there is a root node for this parse'
-    root = parse.nodes.first
+    assert_equal 1, parse.roots.reject(&:ignorable?).length, 'there is a root node for this parse'
+    root = parse.roots.reject(&:ignorable?).first
     assert_equal :S, root.name, 'the root node is a sentence'
     verb = root.descendants.find { |d| d.name == :VP }&.descendants&.find { |d| d.name == :V }
     assert_equal 'sat', verb&.text, 'we have the expected verb'

data/lib/gullah/node.rb

@@ -7,6 +7,7 @@ module Gullah
     # The parent node of this node, if any.
     attr_reader :parent
 
+    # @private
     attr_reader :rule # :nodoc:
 
     ##
@@ -26,6 +27,7 @@ module Gullah
     # An alternative method for when a more telegraphic coding style is useful.
     alias atts attributes
 
+    # @private
     def initialize(parse, s, e, rule) # :nodoc:
       @rule = rule
       @leaf = rule.is_a?(Leaf) || trash?
@@ -100,6 +102,7 @@ module Gullah
     end
 
     # is this node some sort of boundary to further matching
+    # @private
     def traversible? # :nodoc:
       !(boundary? || trash? || error?)
     end
@@ -337,6 +340,7 @@ module Gullah
       root.descendants.select { |n| n.start >= self.end }
     end
 
+    # @private
     def clone # :nodoc:
       super.tap do |c|
         c._attributes = deep_clone(attributes)
@@ -416,13 +420,16 @@ module Gullah
     ## ADVISORILY PRIVATE
 
     # :stopdoc:
+    # @!visibility private
 
+    # @private
     def _summary=(str) # :nodoc:
       @summary = str
     end
 
     # used during parsing
     # make sure we don't have any repeated symbols in a unary branch
+    # @private
     def _loop_check?(seen = nil) # :nodoc:
       return true if seen == name
 
@@ -437,26 +444,32 @@ module Gullah
       @leaf ? false : children.first._loop_check?(seen)
     end
 
+    # @private
     def _attributes=(attributes) # :nodoc:
       @attributes = attributes
     end
 
+    # @private
     def _parent=(other) # :nodoc:
       @parent = other
     end
 
+    # @private
     def _children=(children) # :nodoc:
       @children = children
     end
 
+    # @private
     def _descendants(skip) # :nodoc:
       Descendants.new(self, skip)
     end
 
+    # @private
     def _ancestors(skip) # :nodoc:
       Ancestors.new(self, skip)
     end
 
+    # @private
     def _failed_test=(bool) # :nodoc:
       @failed_test = bool
     end

data/lib/gullah/version.rb

@@ -3,5 +3,5 @@
 module Gullah
   # This is an alpha release. Gullah has not yet been used in anything
   # other than unit tests.
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/test/parse_demo_test.rb

@@ -30,4 +30,39 @@ class ParseDemoTest < Minitest::Test
     assert_equal 8, parse.size
     assert_equal 'S[NP[D,_ws,N],_ws,VP[V]]', parse.summary
   end
+
+  class Cat
+    extend Gullah
+
+    rule :S, 'NP VP'
+    rule :NP, 'D NB'
+    rule :NB, 'A* N'
+    rule :VP, 'VP PP'
+    rule :VP, 'V'
+    rule :PP, 'P NP'
+    rule :P, 'prepositions'
+    rule :V, 'verbs'
+    rule :D, 'determiners'
+    rule :N, 'nouns'
+    rule :A, 'adjectives'
+
+    leaf :determiners, /\b(the|an?)\b/i
+    leaf :nouns, /\b(cat|mat)\b/i
+    leaf :prepositions, /\b(on|in|around|above|beside)\b/i
+    leaf :verbs, /\b(sat|slept|moped)\b/
+    leaf :adjectives, /\b(big|small|hairy|bald|fat)\b/i
+
+    ignore :whatever, /[^\w\s]+/
+  end
+
+  def test_cat
+    parses = Cat.parse 'The fat cat sat on the mat.'
+    assert_equal 1, parses.length, 'there is only one parse of this sentence'
+    parse = parses.first
+    assert_equal 1, parse.roots.reject(&:ignorable?).length, 'there is a root node for this parse'
+    root = parse.roots.reject(&:ignorable?).first
+    assert_equal :S, root.name, 'the root node is a sentence'
+    verb = root.descendants.find { |d| d.name == :VP }&.descendants&.find { |d| d.name == :V }
+    assert_equal 'sat', verb&.text, 'we have the expected verb'
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gullah
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - David F. Houghton