gullah 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73c8674a510b84d261ae0575c6d9b65109aea210b1b3bc0832a018ef572ee6b5
-  data.tar.gz: e5497a3d4e967fd3547496caf23728d03ce0f2f485bc97c53332713331027b9e
+  metadata.gz: 8aa15a5c7da0a8578bc3462d2342205dbba603f316384bebd2a500c8e15cb3f1
+  data.tar.gz: 0e16604686a51b37e14ae5272e218702b317b3a6447e159ccf8b0e685f176780
 SHA512:
-  metadata.gz: b51e5eb27bec2a7d1554f332c5c71e26280ad76a704e07f7146e60cb60b59ef106c6e61bef1cb5c877889487cb51033a968a6d62575e429468486dbfb939c921
-  data.tar.gz: 0fdc0bc2d67ac9833f92ae9a6535e092ede3e5c95fde414604d685a0e0835f016fae11db1578dee251bf7947b0f861e6c428b81b2ae25a45b349bea50a808ebc
+  metadata.gz: 3ccb50387a8a3fb97cb4cf2ea4bb01946c6e300bda78b1af10aa83d8c0ff22c74de8551bc5dbb96ffec6ba0410a2946f8a24e946abe63a5076713f1d62dbfa12
+  data.tar.gz: c1916ff70ac408e8b870c2af1d7cdeb5036778b6876bf277e15ec9a9f2eb65e6c55e51ddb8d526ec99550e6bf508014e239aac532b1759f1c054b57de191bf8a

data/.gitignore

@@ -1,2 +1,3 @@
 doc/*
 .yardoc/*
+.byebug_history

data/CHANGES.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 0.0.3 *2023-11-24*
+* a few optimizations
+
+## 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'
@@ -85,3 +85,7 @@ Another possibility, if I have sufficient spare time and am sufficiently ambitio
 # Acknowledgements
 
 I would like to thank my family and co-workers for tolerating me saying "Gullah" much more often than any of them expected.
+
+# Dedication
+
+I dedicate this gem to my son Jude, a.k.a [TurkeyMcMac](https://github.com/TurkeyMcMac). He was a better programmer than I will ever be and was only getting better. More importantly, he was a kind, funny, thoughtful person. I miss him every day. I love you, Jude.

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/parse.rb

@@ -81,14 +81,14 @@ module Gullah
     # and the ancestor node where the test was run as erroneous,
     # so they will increase the +incorrectness_count+ by 2.
     def incorrectness_count
-      @incorrectness_count ||= roots.select(&:failed?).count
+      @incorrectness_count ||= roots.count(&:failed?)
     end
 
     ##
     # The count of nodes which have some structure test which was never
     # successfully run.
     def pending_count
-      @pending_count ||= roots.select(&:pending_tests?).count
+      @pending_count ||= roots.count(&:pending_tests?)
     end
 
     ##
@@ -122,7 +122,7 @@ module Gullah
     #
     #   parses = Grammar.parse "this grammar uses the usual whitespace rule"
     #
-    #   parses.first.nodes.select { |n| n.name == :_ws }.count  # => 6
+    #   parses.first.nodes.count { |n| n.name == :_ws }  # => 6
     def nodes
       NodeIterator.new self
     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.3'
 end

data/test/basic_test.rb

@@ -43,7 +43,7 @@ class BasicTest < Minitest::Test
     parses.each do |p|
       assert_equal 1, p.roots.length, 'parse has a root node'
       root = p.roots.first
-      assert_equal 2, root.subtree.select(&:nonterminal?).count, 'parse has 2 nonterminal nodes'
+      assert_equal 2, root.subtree.count(&:nonterminal?), 'parse has 2 nonterminal nodes'
       assert root.subtree.select(&:nonterminal?).each do |_n|
         assert_equal 2, b.children.length, 'nonterminal nodes each have 2 children'
       end
@@ -96,10 +96,10 @@ class BasicTest < Minitest::Test
     parse = parses.first
     assert_equal 8, parse.roots.length, 'there are 8 nodes in the parse'
     assert parse.roots.all?(&:leaf?), 'all nodes are leaf nodes'
-    assert_equal 3, parse.roots.select { |n| n.name == :ws }.count, 'there are 3 whitespace nodes'
-    assert_equal 3, parse.roots.select(&:ignorable?).count, 'there are 3 ignorable nodes'
-    assert_equal 4, parse.roots.select { |n| n.name == :word }.count, 'there are 4 word nodes'
-    assert_equal 1, parse.roots.select(&:trash?).count, 'there is 1 trash node'
+    assert_equal 3, parse.roots.count { |n| n.name == :ws }, 'there are 3 whitespace nodes'
+    assert_equal 3, parse.roots.count(&:ignorable?), 'there are 3 ignorable nodes'
+    assert_equal 4, parse.roots.count { |n| n.name == :word }, 'there are 4 word nodes'
+    assert_equal 1, parse.roots.count(&:trash?), 'there is 1 trash node'
     last_node = parse.roots.last
     assert last_node.trash?, 'the last node is the trash node'
   end
@@ -156,9 +156,9 @@ class BasicTest < Minitest::Test
     assert_equal 1, parse.roots.reject(&:ignorable?).count, 'there is a root node for this parse'
     root = parse.roots.first
     assert_equal :s, root.name, 'found expected root'
-    assert_equal 2, root.subtree.select { |n| n.name == :thing }.count, 'two things'
-    assert_equal 1, root.subtree.select { |n| n.name == :word }.count, 'one word'
-    assert_equal 1, root.subtree.select { |n| n.name == :integer }.count, 'one integer'
+    assert_equal 2, root.subtree.count { |n| n.name == :thing }, 'two things'
+    assert_equal 1, root.subtree.count { |n| n.name == :word }, 'one word'
+    assert_equal 1, root.subtree.count { |n| n.name == :integer }, 'one integer'
   end
 
   class SubRulesWithTest
@@ -185,8 +185,8 @@ class BasicTest < Minitest::Test
     things = root.subtree.select { |n| n.name == :thing }
     assert_equal 2, things.count, 'two things'
     assert things.all? { |n| n.attributes[:satisfied].include?(%i[foo etc]) }, 'passing tests stuff in extra bits'
-    assert_equal 1, root.subtree.select { |n| n.name == :word }.count, 'one word'
-    assert_equal 1, root.subtree.select { |n| n.name == :integer }.count, 'one integer'
+    assert_equal 1, root.subtree.count { |n| n.name == :word }, 'one word'
+    assert_equal 1, root.subtree.count { |n| n.name == :integer }, 'one integer'
   end
 
   class SubRulesWithAncestorTest
@@ -218,8 +218,8 @@ class BasicTest < Minitest::Test
       assert thing.attributes[:satisfied_descendant].include?([:foo, root.position]),
              'descendant is marked when ancestor test passes'
     end
-    assert_equal 1, root.subtree.select { |n| n.name == :word }.count, 'one word'
-    assert_equal 1, root.subtree.select { |n| n.name == :integer }.count, 'one integer'
+    assert_equal 1, root.subtree.count { |n| n.name == :word }, 'one word'
+    assert_equal 1, root.subtree.count { |n| n.name == :integer }, 'one integer'
   end
 
   class LeftAncestor

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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gullah
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - David F. Houghton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-29 00:00:00.000000000 Z
+date: 2023-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -142,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.4.15
 signing_key:
 specification_version: 4
 summary: A bottom up parser generator