RubyGems - tediparse - Versions diffs - 2.0.0 - Mend

tediparse 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (176) hide show

checksums.yaml +7 -0
data/CHANGELOG.md +319 -0
data/LICENSE +26 -0
data/README.md +308 -0
data/Rakefile +33 -0
data/bin/tediparse +102 -0
data/doc/Defining.md +97 -0
data/doc/Generating-Grammars.md +241 -0
data/doc/Generating.md +332 -0
data/doc/Navigating.md +670 -0
data/doc/Parsing.md +133 -0
data/doc/README.md +51 -0
data/doc/Serializing.md +100 -0
data/doc/Tokenizing.md +136 -0
data/doc/Validating.md +140 -0
data/lib/ruby/array.rb +226 -0
data/lib/ruby/blank.rb +52 -0
data/lib/ruby/exception.rb +14 -0
data/lib/ruby/hash.rb +14 -0
data/lib/ruby/module.rb +60 -0
data/lib/ruby/object.rb +56 -0
data/lib/ruby/string.rb +89 -0
data/lib/ruby/to_d.rb +82 -0
data/lib/ruby/to_date.rb +26 -0
data/lib/ruby/to_time.rb +21 -0
data/lib/ruby/try.rb +46 -0
data/lib/stupidedi/builder.rb +6 -0
data/lib/stupidedi/color.rb +94 -0
data/lib/stupidedi/config/code_list_config.rb +45 -0
data/lib/stupidedi/config/functional_group_config.rb +72 -0
data/lib/stupidedi/config/interchange_config.rb +86 -0
data/lib/stupidedi/config/transaction_set_config.rb +73 -0
data/lib/stupidedi/config.rb +100 -0
data/lib/stupidedi/either.rb +286 -0
data/lib/stupidedi/exceptions/invalid_element_error.rb +7 -0
data/lib/stupidedi/exceptions/invalid_schema_error.rb +7 -0
data/lib/stupidedi/exceptions/missing_grammar_error.rb +50 -0
data/lib/stupidedi/exceptions/output_error.rb +7 -0
data/lib/stupidedi/exceptions/parse_error.rb +7 -0
data/lib/stupidedi/exceptions/stupidedi_error.rb +7 -0
data/lib/stupidedi/exceptions/tokenize_error.rb +7 -0
data/lib/stupidedi/exceptions/zipper_error.rb +7 -0
data/lib/stupidedi/exceptions.rb +13 -0
data/lib/stupidedi/inspect.rb +26 -0
data/lib/stupidedi/interchanges/element_types/separator_val.rb +79 -0
data/lib/stupidedi/interchanges/element_types/special_val.rb +48 -0
data/lib/stupidedi/interchanges/element_types.rb +11 -0
data/lib/stupidedi/interchanges.rb +21 -0
data/lib/stupidedi/parser/builder_dsl.rb +292 -0
data/lib/stupidedi/parser/constraint_table.rb +566 -0
data/lib/stupidedi/parser/generation.rb +147 -0
data/lib/stupidedi/parser/identifier_stack.rb +248 -0
data/lib/stupidedi/parser/instruction.rb +112 -0
data/lib/stupidedi/parser/instruction_table.rb +222 -0
data/lib/stupidedi/parser/navigation.rb +786 -0
data/lib/stupidedi/parser/state_machine.rb +62 -0
data/lib/stupidedi/parser/states/abstract_state.rb +385 -0
data/lib/stupidedi/parser/states/failure_state.rb +69 -0
data/lib/stupidedi/parser/states/functional_group_state.rb +101 -0
data/lib/stupidedi/parser/states/initial_state.rb +62 -0
data/lib/stupidedi/parser/states/interchange_state.rb +96 -0
data/lib/stupidedi/parser/states/loop_state.rb +74 -0
data/lib/stupidedi/parser/states/table_state.rb +90 -0
data/lib/stupidedi/parser/states/transaction_set_state.rb +120 -0
data/lib/stupidedi/parser/states/transmission_state.rb +59 -0
data/lib/stupidedi/parser/tokenization.rb +195 -0
data/lib/stupidedi/parser.rb +32 -0
data/lib/stupidedi/reader/input/abstract_input.rb +137 -0
data/lib/stupidedi/reader/input/delegated_input.rb +112 -0
data/lib/stupidedi/reader/input/file_input.rb +157 -0
data/lib/stupidedi/reader/input.rb +31 -0
data/lib/stupidedi/reader/position.rb +78 -0
data/lib/stupidedi/reader/result.rb +172 -0
data/lib/stupidedi/reader/segment_dict.rb +176 -0
data/lib/stupidedi/reader/separators.rb +90 -0
data/lib/stupidedi/reader/stream_reader.rb +173 -0
data/lib/stupidedi/reader/token_reader.rb +465 -0
data/lib/stupidedi/reader/tokens/component_element_tok.rb +71 -0
data/lib/stupidedi/reader/tokens/composite_element_tok.rb +85 -0
data/lib/stupidedi/reader/tokens/repeated_element_tok.rb +74 -0
data/lib/stupidedi/reader/tokens/segment_tok.rb +74 -0
data/lib/stupidedi/reader/tokens/simple_element_tok.rb +76 -0
data/lib/stupidedi/reader.rb +121 -0
data/lib/stupidedi/schema/abstract_def.rb +76 -0
data/lib/stupidedi/schema/abstract_element_def.rb +35 -0
data/lib/stupidedi/schema/abstract_element_use.rb +47 -0
data/lib/stupidedi/schema/abstract_use.rb +79 -0
data/lib/stupidedi/schema/code_list.rb +99 -0
data/lib/stupidedi/schema/component_element_use.rb +76 -0
data/lib/stupidedi/schema/composite_element_def.rb +103 -0
data/lib/stupidedi/schema/composite_element_use.rb +78 -0
data/lib/stupidedi/schema/element_req.rb +57 -0
data/lib/stupidedi/schema/functional_group_def.rb +124 -0
data/lib/stupidedi/schema/generation/definition_generator.rb +139 -0
data/lib/stupidedi/schema/generation/element_generator.rb +221 -0
data/lib/stupidedi/schema/generation/flat_file_reader.rb +551 -0
data/lib/stupidedi/schema/generation/functional_group_generator.rb +64 -0
data/lib/stupidedi/schema/generation/interchange_generator.rb +145 -0
data/lib/stupidedi/schema/generation/master_loader_generator.rb +121 -0
data/lib/stupidedi/schema/generation/models.rb +85 -0
data/lib/stupidedi/schema/generation/module_loader_generator.rb +64 -0
data/lib/stupidedi/schema/generation/registration_generator.rb +230 -0
data/lib/stupidedi/schema/generation/runner.rb +161 -0
data/lib/stupidedi/schema/generation/segment_generator.rb +130 -0
data/lib/stupidedi/schema/generation/support.rb +78 -0
data/lib/stupidedi/schema/generation/support_modules_generator.rb +126 -0
data/lib/stupidedi/schema/generation/version_modules.rb +35 -0
data/lib/stupidedi/schema/generation.rb +94 -0
data/lib/stupidedi/schema/interchange_def.rb +103 -0
data/lib/stupidedi/schema/loop_def.rb +156 -0
data/lib/stupidedi/schema/repeat_count.rb +86 -0
data/lib/stupidedi/schema/segment_def.rb +122 -0
data/lib/stupidedi/schema/segment_req.rb +46 -0
data/lib/stupidedi/schema/segment_use.rb +99 -0
data/lib/stupidedi/schema/simple_element_def.rb +51 -0
data/lib/stupidedi/schema/simple_element_use.rb +83 -0
data/lib/stupidedi/schema/syntax_note.rb +52 -0
data/lib/stupidedi/schema/table_def.rb +178 -0
data/lib/stupidedi/schema/transaction_set_def.rb +125 -0
data/lib/stupidedi/schema.rb +30 -0
data/lib/stupidedi/sets.rb +42 -0
data/lib/stupidedi/transaction_sets/builder/dsl.rb +192 -0
data/lib/stupidedi/transaction_sets/builder.rb +188 -0
data/lib/stupidedi/transaction_sets/common/implementations/element_reqs.rb +37 -0
data/lib/stupidedi/transaction_sets/common/implementations/segment_reqs.rb +31 -0
data/lib/stupidedi/transaction_sets/common/implementations.rb +11 -0
data/lib/stupidedi/transaction_sets/common.rb +8 -0
data/lib/stupidedi/transaction_sets/validation/ambiguity.rb +395 -0
data/lib/stupidedi/transaction_sets/validation/implementation.rb +12 -0
data/lib/stupidedi/transaction_sets/validation.rb +9 -0
data/lib/stupidedi/transaction_sets.rb +25 -0
data/lib/stupidedi/values/abstract_element_val.rb +19 -0
data/lib/stupidedi/values/abstract_val.rb +133 -0
data/lib/stupidedi/values/composite_element_val.rb +102 -0
data/lib/stupidedi/values/functional_group_val.rb +105 -0
data/lib/stupidedi/values/interchange_val.rb +102 -0
data/lib/stupidedi/values/invalid_envelope_val.rb +61 -0
data/lib/stupidedi/values/invalid_segment_val.rb +89 -0
data/lib/stupidedi/values/loop_val.rb +73 -0
data/lib/stupidedi/values/repeated_element_val.rb +113 -0
data/lib/stupidedi/values/segment_val.rb +105 -0
data/lib/stupidedi/values/segment_val_group.rb +20 -0
data/lib/stupidedi/values/simple_element_val.rb +80 -0
data/lib/stupidedi/values/table_val.rb +69 -0
data/lib/stupidedi/values/transaction_set_val.rb +69 -0
data/lib/stupidedi/values/transmission_val.rb +56 -0
data/lib/stupidedi/values.rb +22 -0
data/lib/stupidedi/version.rb +4 -0
data/lib/stupidedi/versions/common/element_reqs.rb +13 -0
data/lib/stupidedi/versions/common/element_types/an.rb +386 -0
data/lib/stupidedi/versions/common/element_types/dt.rb +572 -0
data/lib/stupidedi/versions/common/element_types/id.rb +304 -0
data/lib/stupidedi/versions/common/element_types/nn.rb +312 -0
data/lib/stupidedi/versions/common/element_types/operators.rb +128 -0
data/lib/stupidedi/versions/common/element_types/r.rb +342 -0
data/lib/stupidedi/versions/common/element_types/simple_element.rb +73 -0
data/lib/stupidedi/versions/common/element_types/tm.rb +347 -0
data/lib/stupidedi/versions/common/element_types.rb +29 -0
data/lib/stupidedi/versions/common/segment_reqs.rb +15 -0
data/lib/stupidedi/versions/common/syntax_notes.rb +172 -0
data/lib/stupidedi/versions/common.rb +11 -0
data/lib/stupidedi/versions.rb +25 -0
data/lib/stupidedi/writer/claredi.rb +178 -0
data/lib/stupidedi/writer/default.rb +119 -0
data/lib/stupidedi/writer.rb +7 -0
data/lib/stupidedi/zipper/abstract_cursor.rb +351 -0
data/lib/stupidedi/zipper/dangling_cursor.rb +103 -0
data/lib/stupidedi/zipper/edited_cursor.rb +157 -0
data/lib/stupidedi/zipper/memoized_cursor.rb +133 -0
data/lib/stupidedi/zipper/path.rb +132 -0
data/lib/stupidedi/zipper/root_cursor.rb +120 -0
data/lib/stupidedi/zipper/stack_cursor.rb +107 -0
data/lib/stupidedi/zipper.rb +45 -0
data/lib/stupidedi.rb +69 -0
data/lib/tediparse.rb +1 -0
metadata +249 -0

data/lib/stupidedi/writer/claredi.rb ADDED Viewed

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+module Stupidedi
+  using Refinements
+  module Writer
+    class Claredi
+      def initialize(node)
+        @node = node
+      end
+      # @return [String]
+      def write(out = StringIO.new)
+        out << %Q(<html lang="en"><head>)
+        out << %Q(<meta charset="iso-8859-1">)
+        out << style
+        out << js
+        out << "</head><body>"
+        build(@node, out)
+        out << "</body></html>"
+        out
+      end
+    private
+      def js
+        <<-JS
+        <script type="text/javascript">
+          function toggle() {
+            var trim = document.getElementsByClassName("trim");
+            for (var k = 0; k < trim.length; k ++)
+              trim[k].classList.toggle("hide");
+          }
+        </script>
+        JS
+      end
+      # @return [String]
+      def style
+        <<-CSS
+        <style>
+          body { font-size: 0.75em; }
+          .interchange, .functionalgr, .table, .loop > .label {
+            font-weight: bold;
+            font-family: Optima, Trebuchet, sans-serif;
+          }
+          .interchange, .functionalgr, .transaction {
+            margin-left:   1em;
+          }
+          .transaction {
+            margin-top:    1.5em;
+            margin-bottom: 1em;
+          }
+          .transaction > .label {
+            font-weight: bold;
+            font-size: 1.5em;
+          }
+          .table, .loop {
+            margin-top:    0.5em;
+            margin-bottom: 0.5em;
+            margin-left:   0.5em;
+          }
+          .table { margin-left: 1em; margin-bottom: 2em; }
+          .table        > .label/*
+          .interchange  > .label,
+          .functionalgr > .label*/ {
+            font-size:     1.25em;
+            border-bottom: 3px solid black;
+            margin-top:    1em;
+            margin-bottom: 0.5em;
+          }
+          .loop { border: 1px solid grey; border-right: 0; }
+          .loop > .label { padding: 3px; background-color: #ddd; }
+          .loop > .segment { margin: 3px 0 3px 6px; }
+          .segment {
+            font-weight: normal;
+            font-family: 'Andale Mono', Monospace, monospace;
+          }
+          .segment .label:first-child { font-weight: bold; }
+          .trim { color: #bbb; display: inline; }
+          .hide { display: none; }
+          #form {
+            display:          block;
+            padding:          3px;
+            border:           1px solid #ccc;
+            margin:           3px 3px 30px 3px;
+            font-family:      Optima, Trebuchet, sans-serif;
+            background-color: #eee;
+          }
+        </style>
+        CSS
+      end
+      # @return [void]
+      def build(node, out)
+        if node.element?
+          if node.composite?
+            tmp = StringIO.new
+            node.children.each{|e| build(e, tmp) }
+            tmp.string.gsub!(%r{^(<span [^>]+>):}, "\\1*")
+            tmp.string.gsub!(%r{((?:<span [^<]+>:?</span>)+)$}, %Q(<em class="trim hide">\\1</em>))
+            out << tmp.string
+          elsif node.component?
+            out << %Q(<span class="label" title="#{node.definition.name}">:#{node.to_x12}</span>)
+          elsif node.repeated?
+            tmp = StringIO.new
+            node.children.each{|e| build(e, tmp) }
+            tmp.string.gsub!("*", "^")
+            out << tmp.string
+          else
+            out << %Q(<span class="label" title="#{node.definition.name}">*#{node.to_x12}</span>)
+          end
+        elsif node.segment?
+          out << %Q(<div class="segment"><span class="label" title="#{node.definition.name}">)
+          out << node.definition.id
+          out << "</span>"
+          tmp  = StringIO.new
+          node.children.each{|e| build(e, tmp) }
+          tmp.string.gsub!(%r{((?:<span [^>]+>\*</span>)+)$}, %Q(<div class="trim hide">\\1</div>))
+          out << "#{tmp.string}~</div>\n"
+        elsif node.loop?
+          if m = /^(\d\w+)(?: [:-])? (.+)$/.match(node.definition.id)
+            id   = m.captures[0]
+            name = m.captures[1]
+            name = name.split(/\s+/).map(&:capitalize).join(" ")
+            out << %Q(<div class="loop"><div class="label">#{name} (#{id})</div>\n)
+          else
+            out << %Q(<div class="loop"><div class="label">#{node.definition.id}</div>\n)
+          end
+          node.children.each{|c| build(c, out) }
+          out << "</div>\n"
+        elsif node.table?
+          out << %Q(<div class="table"><div class="label">#{node.definition.id}</div>\n)
+          node.children.each{|c| build(c, out) }
+          out << "</div>\n"
+        elsif node.transaction_set?
+          out << %Q(<div class="transaction"><div class="label">Transaction Set #{node.definition.id}</div>\n)
+          node.children.each{|c| build(c, out) }
+          out << "</div>\n"
+        elsif node.functional_group?
+          out << %Q(<div class="functionalgr">)
+        # out << %Q(<div class="label">Functional Group (#{node.definition.id})</div>\n)
+          node.children.each{|c| build(c, out) }
+          out << "</div>\n"
+        elsif node.interchange?
+          out << %Q(<div class="interchange">)
+        # out << %Q(<div class="label">Interchange (#{node.definition.id})</div>\n)
+          node.children.each{|c| build(c, out) }
+          out << "</div>\n"
+        elsif node.transmission?
+          out << %Q(<label id="form"><input type="checkbox" id="hide" onchange="toggle()" checked/> Hide empty suffixes</label>)
+          out << %Q(<div class="transmission">\n)
+          node.children.each{|c| build(c, out) }
+          out << "</div>\n"
+        end
+      end
+    end
+  end
+end

data/lib/stupidedi/writer/default.rb ADDED Viewed

@@ -0,0 +1,119 @@
+module Stupidedi
+  using Refinements
+  module Writer
+    class Default
+      # @return [Reader::Separators]
+      attr_reader :separators
+      def initialize(zipper, separators = Reader::Separators.empty)
+        @zipper, @separators =
+          zipper, separators
+      end
+      # @return out
+      def write(out = "")
+        unless @zipper.node.transmission? or @zipper.node.interchange?
+          common  = @separators.characters & @zipper.node.characters
+          message = common.to_a.map(&:inspect).join(", ")
+          if common.present?
+            raise Exceptions::OutputError,
+              "separator characters #{message} occur as data"
+          end
+        end
+        out.tap { recurse(@zipper.node, @separators, out) }
+      end
+    private
+      def recurse(value, separators, out)
+        return if value.invalid?
+        if value.segment?
+          segment(value, separators, out)
+        else
+          if value.interchange?
+            unless separators.merge(value.separators) == separators
+              common  = separators.characters & value.characters
+              message = common.to_a.map(&:inspect).join(", ")
+              if common.present?
+                raise Exceptions::OutputError,
+                  "separator characters #{message} occur as data"
+              end
+              # Change ISA11 and ISA16
+              value = value.replace_separators(separators)
+            end
+            separators = value.separators
+            raise Exceptions::OutputError,
+              "separators.segment cannot be blank" if separators.segment.blank?
+            raise Exceptions::OutputError,
+              "separators.element cannot be blank" if separators.element.blank?
+          end
+          value.children.each{|c| recurse(c, separators, out) }
+        end
+      end
+      def segment(s, separators, out)
+        # It's likely annoying for the user to need to check for at least
+        # one non-blank element before generating a segment. Instead, we
+        # can check that after the segment was generated and supress any
+        # empty segments here.
+        return if s.empty?
+        out << s.id.to_s
+        # Trailing empty elements (including component elements) can be omitted,
+        # so "NM1*XX*1:2::::*****~" should be abbreviated to "NM1*XX*1:2~".
+        elements = s.children.
+          reverse.drop_while(&:empty?).reverse  # Remove the trailing empties
+        elements.each do |e|
+          out << separators.element
+          element(e, separators, out)
+        end
+        out << separators.segment
+      end
+      def element(e, separators, out)
+        if e.simple?
+          out << e.to_x12
+        elsif e.composite?
+          components = e.children.
+            reverse.drop_while(&:empty?).reverse
+          unless components.empty?
+            out << components.head.to_x12
+          end
+          components.tail.each do |c|
+            out << separators.component
+            out << c.to_x12
+          end
+        elsif e.repeated?
+          occurrences = e.children.
+            reverse.drop_while(&:empty?).reverse
+          unless occurrences.empty?
+            element(occurrences.head, separators, out)
+          end
+          occurrences.tail.each do |o|
+            out << separators.repetition
+            element(o, separators, out)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stupidedi/writer.rb ADDED Viewed

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+module Stupidedi
+  module Writer
+    autoload :Claredi,  "stupidedi/writer/claredi"
+    autoload :Default,  "stupidedi/writer/default"
+  end
+end

data/lib/stupidedi/zipper/abstract_cursor.rb ADDED Viewed

@@ -0,0 +1,351 @@
+# frozen_string_literal: true
+module Stupidedi
+  using Refinements
+  module Zipper
+    class AbstractCursor
+      # @return [#leaf?, #children, #copy]
+      abstract :node
+      # @return [AbstractPath]
+      abstract :path
+      # @group Querying the Tree Location
+      #########################################################################
+      # (see AbstractPath#depth)
+      def depth
+        path.depth
+      end
+      # (see AbstractPath#first?)
+      def first?
+        path.first?
+      end
+      # (see AbstractPath#last?)
+      def last?
+        path.last?
+      end
+      # True if the node has no children
+      abstract :leaf?
+      # True if the node has no parent
+      abstract :root?
+      # Returns nodes between this zipper and the other, including `self.node`
+      # and `other.node` as end points. When this and the other zipper point to
+      # the same node within the tree, a single node is returned. Otherwise, the
+      # nodes are returned in order according to a left-to-right depth-first
+      # pre-order traversal.
+      #
+      # @note This method assumes `other` is a zipper for the same tree as the
+      #   tree wrapped by `this`. In general, there is no way to know if that is
+      #   or isn't the case, without comparing the entire tree. If this method
+      #   is called on two different trees, the results are undefined.
+      #
+      # @return [Array]
+      def between(other)
+        # Collect ancestors of self, sorted oldest first (deepest last). This
+        # forms a boundary of nodes, which is called a "spine" below
+        zipper = self
+        lspine = [self]
+        until zipper.root?
+          zipper = zipper.up
+          lspine.unshift(zipper)
+        end
+        # Collect ancestors of self, sorted oldest first (deepest last). This
+        # forms a list of boundary nodes, which is called a "spine" below
+        zipper = other
+        rspine = [other]
+        until zipper.root?
+          zipper = zipper.up
+          rspine.unshift(zipper)
+        end
+        # Now we have two spines, both beginning with the root node. We remove
+        # the prefix common to both spines.
+        while a = lspine.first and b = rspine.first
+          if a.path == b.path
+            lspine.shift
+            rspine.shift
+          else
+            break
+          end
+        end
+        if lspine.empty?
+          # The other node is a child of self's node, and rspine contains all
+          # the nodes along the path between the two nodes, not including the
+          # self node.
+          return node.cons(rspine.map(&:node))
+        elsif rspine.empty?
+          # Self's node is a child of other's node, and lspine contains all
+          # the nodes along the path between the two nodes, not including the
+          # other node
+          return other.node.cons(lspine.map(&:node))
+        elsif lspine.head.path.position > rspine.head.path.position
+          # The first elements of lspine and rspine are siblings that share a
+          # common parent. Arrange them such that lspine is on the left, and
+          # so rspine is on the right
+          lspine, rspine = rspine, lspine
+        end
+        between = []
+        # Starting at the bottom of the left spine working upward, accumulate
+        # all the nodes to the right of the spine. Remember this is contained
+        # within the subtree under lspine.head
+        lspine.each{|z| between << z.node }
+        lspine.tail.reverse.each do |zipper1|
+          until zipper1.last?
+            zipper1 = zipper1.next
+            between.concat(zipper1.flatten)
+          end
+        end
+        # For the sibling nodes directly between (not including) lspine.head
+        # and rspine.head, we can accumulate the entire subtrees.
+        count  = rspine.head.path.position - lspine.head.path.position - 1
+        zipper = lspine.head
+        count.times do
+          zipper = zipper.next
+          between.concat(zipper.flatten)
+        end
+        between << rspine.head.node
+        rspine.tail.each do |zipper_|
+          count  = zipper_.path.position
+          zipper_ = zipper_.first
+          # We have to do a bit more work to traverse the siblings in left-to-
+          # right order, because `zipper_` is now the left spine. We start on
+          # the first sibling and move left a fixed number of times
+          count.times do
+            between.concat(zipper_.flatten)
+            zipper_ = zipper_.next
+          end
+          # Now zipper_ is along the left spine. We don't expand it here, but the
+          # next item in rspine is the next child along the left spine
+          between << zipper_.node
+        end
+        between
+      end
+      # Flattens the subtree into an Array of nodes. The nodes are arranged
+      # according to a depth-first left-to-right preorder traversal.
+      #
+      # @return [Array]
+      def flatten
+        nodes = []
+        queue = [node]
+        while node = queue.shift
+          nodes << node
+          queue.unshift(*node.children) unless node.leaf?
+        end
+        nodes
+      end
+      # @group Traversing the Tree
+      #########################################################################
+      # Navigate to the first child node
+      #
+      # @return [MemoizedCursor]
+      def down
+        @__down ||= begin
+          if leaf?
+            raise Exceptions::ZipperError,
+              "cannot descend into leaf node"
+          end
+          head, *tail = @node.children
+          MemoizedCursor.new(head,
+            Hole.new([], @path, tail), self)
+        end
+      end
+      # Navigate to the first child node, or if there are no children,
+      # create a placeholder where the first child node will be placed
+      #
+      # @return [AbstractCursor]
+      def dangle
+        if node.leaf?
+          raise Exceptions::ZipperError,
+            "cannot descend into leaf node"
+        end
+        if leaf?
+          DanglingCursor.new(self)
+        else
+          down
+        end
+      end
+      # Navigate to the `nth` child node
+      #
+      # @return [AbstractCursor]
+      def child(n)
+        if n < 0
+          raise Exceptions::ZipperError,
+            "child index cannot be negative"
+        end
+        cursor = down
+        until n.zero?
+          cursor = cursor.next
+          n -= 1
+        end
+        cursor
+      end
+      # Returns a list of cursors, one pointing to each child node.
+      #
+      # @return [Array<MemoizedCursor>]
+      def children
+        children = []
+        unless leaf?
+          zipper    = down
+          children << zipper
+          until zipper.last?
+            zipper    = zipper.next
+            children << zipper
+          end
+        end
+        children
+      end
+      # Recursively descend to each node's `nth` child
+      #
+      # @return [AbstractCursor]
+      def descendant(n, *ns)
+        cursor = self
+        n.cons(ns).each do |n_|
+          cursor = cursor.child(n_)
+        end
+        cursor
+      end
+      # Navigate to the parent node
+      #
+      # @return [AbstractCursor]
+      abstract :up
+      # Navigate to the next (rightward) sibling node
+      #
+      # @return [AbstractCursor]
+      abstract :next
+      # Navigate to the previous (leftward) sibling node
+      #
+      # @return [AbstractCursor]
+      abstract :prev
+      # Navigate to the first (leftmost) sibling node
+      #
+      # @return [AbstractCursor]
+      abstract :first
+      # Navigate to the last (rightmost) sibling node
+      #
+      # @return [AbstractCursor]
+      abstract :last
+      # Navigate to the root node
+      #
+      # @return [RootCursor]
+      def root
+        cursor = self
+        cursor = cursor.up until cursor.root?
+        cursor
+      end
+      # @group Editing the Tree
+      #########################################################################
+      # Insert a new sibling node after (to the right of) the current node,
+      # and navigate to the new sibling node
+      #
+      # @return [EditedCursor]
+      abstract :append, :args => %w(sibling)
+      # Insert a new sibling node before (to the left of) the current node,
+      # and navigate to the new sibling node
+      #
+      # @return [EditedCursor]
+      abstract :prepend, :args => %w(sibling)
+      # (see #append)
+      def insert_right(sibling)
+        append(sibling)
+      end
+      # (see #prepend)
+      def insert_left(sibling)
+        prepend(sibling)
+      end
+      # Insert a new child node before (to the left of) any existing children
+      # nodes and navigate to the new child node
+      #
+      # @return [EditedCursor]
+      def prepend_child(child)
+        if node.leaf?
+          raise Exceptions::ZipperError,
+            "cannot add child to leaf node"
+        end
+        EditedCursor.new(child,
+          Hole.new([], path, node.children), self)
+      end
+      # Insert a new child node after (to the right of) any existing children
+      # nodes and navigate to the new child node
+      #
+      # @return [EditedCursor]
+      def append_child(child)
+        if node.leaf?
+          raise Exceptions::ZipperError,
+            "cannot add child to leaf node"
+        end
+        EditedCursor.new(child,
+          Hole.new(node.children.reverse, path, []), self)
+      end
+      # Replace the current node with the given node
+      #
+      # @return [AbstractCursor]
+      abstract :replace, :args => %w(node)
+      # Remove the current node, and navigate to the next (rightward) node if
+      # one exists. Otherwise, navigate to the previous (leftward) node if one
+      # exists. Otherwise, create a placeholder where the next sibling node will
+      # be created.
+      #
+      # @return [EditedCursor]
+      abstract :delete
+      # @endgroup
+      #########################################################################
+    end
+  end
+end