gullah 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c5345d281d3e785973c68f4c0bb05466f5563c45bce2d2e71871b0fcc5d3c4e
-  data.tar.gz: 7640864e5cdc6c5b788798e2364f8d72e6ff43b2eb30d57a6c7e32a549161e29
+  metadata.gz: 73c8674a510b84d261ae0575c6d9b65109aea210b1b3bc0832a018ef572ee6b5
+  data.tar.gz: e5497a3d4e967fd3547496caf23728d03ce0f2f485bc97c53332713331027b9e
 SHA512:
-  metadata.gz: 7e5eed3d8ea6bfcc00f5594b636fc74e98c14b1efc3af447c956a869c1137e00ea9e7f2d0804cbffd1c3923e92c58cc319c5e4b6934af7a44d558e461ebef20a
-  data.tar.gz: f47ca345b05f9ab747b1bd2cff6d85be1773979d98bb76e9d5d0ebcb3ada5e599d2cf3c1d8cf4006ab55fc29a6399ba600ec78949b11b5dd34d5890bee5363d1
+  metadata.gz: b51e5eb27bec2a7d1554f332c5c71e26280ad76a704e07f7146e60cb60b59ef106c6e61bef1cb5c877889487cb51033a968a6d62575e429468486dbfb939c921
+  data.tar.gz: 0fdc0bc2d67ac9833f92ae9a6535e092ede3e5c95fde414604d685a0e0835f016fae11db1578dee251bf7947b0f861e6c428b81b2ae25a45b349bea50a808ebc

data/.gitignore

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

data/.yardopts

@@ -0,0 +1 @@
+--no-private

data/CHANGES.md

@@ -0,0 +1,7 @@
+# Change Log
+
+## 0.0.1 *2021-8-29*
+* improvements to documentation
+
+## 0.0.0 *2021-8-28*
+* initial release

data/gullah.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   s.authors     = ['David F. Houghton']
   s.email       = 'dfhoughton@gmail.com'
   s.homepage    =
-    'https://rubygems.org/gems/gullah'
+    'https://github.com/dfhoughton/gullah'
   s.license = 'MIT'
   s.required_ruby_version = '>= 2.6'
   s.files                 = `git ls-files -z`.split("\x0")

data/lib/gullah/atom.rb

@@ -2,6 +2,7 @@
 
 module Gullah
   # a minimal rule fragment; this is where the actual matching occurs
+  # @private
   class Atom # :nodoc:
     attr_reader :seeking, :min_repeats, :max_repeats, :parent, :next, :literal
 

data/lib/gullah/boundary.rb

@@ -2,6 +2,7 @@
 
 module Gullah
   # a node just for trash
+  # @private
   class Boundary < Node # :nodoc:
     # is this node something that cannot be the child of another node?
     def boundary?

data/lib/gullah/hopper.rb

@@ -3,6 +3,7 @@
 module Gullah
   # a Hopper keeps completed parses, deleting inferior ones as better parses are found
   # this facilitates efficient memory use and parsing
+  # @private
   class Hopper # :nodoc:
     def initialize(filters, number_sought)
       dross = filters - %i[completion correctness size pending]

data/lib/gullah/iterator.rb

@@ -2,6 +2,7 @@
 
 module Gullah
   # for iterating over reductions of a given parse
+  # @private
   class Iterator # :nodoc:
     attr_reader :parse
 

data/lib/gullah/leaf.rb

@@ -2,6 +2,7 @@
 
 module Gullah
   # a rule used in string tokenization
+  # @private
   class Leaf # :nodoc:
     attr_reader :rx, :name, :ignorable, :boundary, :tests, :ancestor_tests, :preconditions
 

data/lib/gullah/node.rb

@@ -478,6 +478,7 @@ module Gullah
       end
     end
 
+    # @private
     class Ancestors
       include Enumerable
       def initialize(n, skip)
@@ -495,6 +496,7 @@ module Gullah
       end
     end
 
+    # @private
     class Descendants
       include Enumerable
       def initialize(n, skip)

data/lib/gullah/parse.rb

@@ -150,6 +150,7 @@ module Gullah
     ## ADVISORILY PRIVATE
 
     # :stopdoc:
+    # @!visibility private
 
     # for debugging
     def own_text
@@ -212,6 +213,7 @@ module Gullah
       @summary = str
     end
 
+    # @private
     class NodeIterator # :nodoc:
       include Enumerable
 

data/lib/gullah/picker.rb

@@ -3,6 +3,7 @@
 module Gullah
   # a Picker keeps a sorted set of iterators so we can always pick the iterator
   # most likely to lead quickly to a satisfactory parse
+  # @private
   class Picker # :nodoc:
     def initialize
       # a sorted list of the

data/lib/gullah/rule.rb

@@ -2,6 +2,7 @@
 
 module Gullah
   # a non-terminal grammatical rule
+  # @private
   class Rule # :nodoc:
     # name -- a symbol identifying the rule
     # body -- preserved for debugging

data/lib/gullah/segment.rb

@@ -3,6 +3,7 @@
 module Gullah
   # a segment handles the portion of a string between boundaries
   # or a boundary itself
+  # @private
   class Segment # :nodoc:
     attr_reader :start, :end, :done
     attr_accessor :continuations

data/lib/gullah/trash.rb

@@ -2,6 +2,7 @@
 
 module Gullah
   # a node just for trash
+  # @private
   class Trash < Node # :nodoc:
     # does this node represent a character sequence no leaf rule matched?
     def trash?

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.0'
+  VERSION = '0.0.1'
 end

data/lib/gullah.rb

@@ -582,6 +582,7 @@ module Gullah
     end
   end
 
+  # @private
   class LoopCheck
     def initialize(link)
       @seen = Set.new(link)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gullah
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - David F. Houghton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-28 00:00:00.000000000 Z
+date: 2021-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -88,6 +88,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".yardopts"
+- CHANGES.md
 - LICENSE
 - README.md
 - Rakefile
@@ -121,7 +123,7 @@ files:
 - test/precondition_test.rb
 - test/tests_per_subrule_test.rb
 - test/tree_walking_test.rb
-homepage: https://rubygems.org/gems/gullah
+homepage: https://github.com/dfhoughton/gullah
 licenses:
 - MIT
 metadata: {}