rooted_tree 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f48a3504fb307daf09d507cd556d7b622d6e17d
-  data.tar.gz: 363432cb0d5a2b69f0f4f0980de16ec03451619b
+  metadata.gz: 4500aef4d9f3aaa7483ec8908d63c594d2b1f8c9
+  data.tar.gz: c45b17013a6aa680e023a86e8b927841d22259b8
 SHA512:
-  metadata.gz: 08d262553a452128cceedda189e57d7118184f253c5106696a9a5b98751392091717dbd8551670cb81c6743e08ecd9876442c3592f4ff1e6ea9b67e9a581d5ee
-  data.tar.gz: f1de5a0b40607102934aaea8ecbb94d98de13aed5a5805bfed6e2ff34d41121a4cb600cc8a1f05dbf88b4c6001432c54e75621dde560ac4e79937cdd5f2a55f4
+  metadata.gz: 88bbe928aa3515c11a0c11d150c17286ca38e4bf4e69331eb1c4e4847743262978fd59ce4e1d126f898ab252fe6214ee7b21cf93be94666e6aa563f53ad5c03f
+  data.tar.gz: 568e6025fb468c1f7477a6425c140e506564ba4b84500f92fce9dd8fb174f77cdaae98f5d725b5f12a07ccaee359392a01bb0f339a9db6fb5fb725c6c175604d

data/.gitignore

@@ -1,6 +1,5 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/

data/.rubocop.yml

@@ -0,0 +1,65 @@
+AllCops:
+  Exclude:
+    - 'vendor/**/*'
+    - 'tmp/**/*'
+  TargetRubyVersion: 2.4
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always
+
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
+Layout/ClassStructure:
+  Enabled: true
+  Categories:
+    module_inclusion:
+      - include
+      - prepend
+      - extend
+  ExpectedOrder:
+      - module_inclusion
+      - constants
+      - public_class_methods
+      - initializer
+      - instance_methods
+      - protected_methods
+      - private_methods
+
+Layout/IndentHeredoc:
+  EnforcedStyle: squiggly
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'test/**/*.rb'
+
+Lint/InterpolationCheck:
+  Exclude:
+    - 'test/**/*.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'test/**/*.rb'
+    - '*.gemspec'
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'test/**/*.rb'
+
+Metrics/ParameterLists:
+  CountKeywordArgs: false
+
+Naming/UncommunicativeMethodParamName:
+  AllowedNames:
+    - x
+    - y
+    - i
+    - p
+    - n
+    - r
+    - g
+    - b
+    - to
+    - '_'

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rooted_tree.gemspec

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    rooted_tree (0.3.4)
+      linked (~> 0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    docile (1.3.1)
+    jaro_winkler (1.5.1)
+    json (2.1.0)
+    linked (0.1.3)
+    minitest (5.9.0)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    redcarpet (3.4.0)
+    rubocop (0.58.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    unicode-display_width (1.4.0)
+    yard (0.9.15)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  redcarpet (~> 3.4)
+  rooted_tree!
+  rubocop (~> 0.52)
+  simplecov (~> 0.16)
+  yard (~> 0.9)
+
+BUNDLED WITH
+   1.16.3

data/README.md

@@ -1,13 +1,11 @@
-# RootedTree
+# 🌳 RootedTree
 
 [![Gem Version](https://badge.fury.io/rb/rooted_tree.png)](http://badge.fury.io/rb/rooted_tree)
 [![Build Status](https://travis-ci.org/seblindberg/ruby-rooted_tree.svg?branch=master)](https://travis-ci.org/seblindberg/ruby-rooted_tree)
-[![Coverage Status](https://coveralls.io/repos/github/seblindberg/ruby-rooted_tree/badge.svg?branch=master)](https://coveralls.io/github/seblindberg/ruby-rooted_tree?branch=master)
 [![Inline docs](http://inch-ci.org/github/seblindberg/ruby-rooted_tree.svg?branch=master)](http://inch-ci.org/github/seblindberg/ruby-rooted_tree)
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/rooted_tree/)
 
-A tree is a connected graph with no cycles. There, that is plenty of explanation. Please refer to https://en.wikipedia.org/wiki/Tree_structure for a more in depth description, but if you need one this library probably is not for you.
-
-This gem technically implements a _rooted, ordered tree_, but that name is a mouthful. It is ment to be used as a building block when working with any tree shaped data. For a brief recap of the terminology please see below.
+This gem implements a _rooted, ordered tree_, but that name is a bit of a mouthful. It is ment to be used as a building block when working with any tree shaped data. For a brief recap of the terminology please see below. Please refer to https://en.wikipedia.org/wiki/Tree_structure for a more in depth description.
 
            A     A is the root.
       ┌────┼──┐  B, C and D are all children of A.

data/Rakefile

@@ -1,10 +1,24 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+require 'yard'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
+  t.libs << 'test'
+  t.libs << 'lib'
   t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+RuboCop::RakeTask.new(:rubocop)
+
+YARD::Rake::YardocTask.new(:yard) do |t|
+  t.stats_options = %w[--list-undoc]
+  t.files = ['lib/**/*.rb', '-', 'CHANGELOG.md']
+end
+
+desc 'Generate Ruby documentation'
+task doc: %w[yard]
+
+task default: %w[test rubocop:auto_correct]

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "rooted_tree"
+require 'bundler/setup'
+require 'rooted_tree'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "rooted_tree"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/examples/filesystem_tree.rb

@@ -1,20 +1,18 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'rooted_tree'
 
-# FileSystemItem
-#
 # Maps the entries in the file system to `Node` objects via .map_to_path. The
 # Node#inspect method is then exploited in #display to show the resulting tree
 # structure. The name of each entry in the filesystem is stored in the value
 # field of the Node.
-
 class FileSystemItem < RootedTree::Node
   def display
-    inspect { |item| item.value }
+    inspect(&:value)
   end
-  
-  def self.map_to_path path = '.', root: new(path)
+
+  def self.map_to_path(path = '.', root: new(path))
     # Iterate over all of the files in the directory
     Dir[path + '/*'].each do |entry|
       # Create a new FileSystemItem for the entry
@@ -24,7 +22,7 @@ class FileSystemItem < RootedTree::Node
       # entry, if it is a directory
       map_to_path entry, root: item unless File.file? entry
     end
-    
+
     root
   end
 end

data/lib/rooted_tree/mutable.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module RootedTree
+  # This module contains methods for mutating a tree node.
+  module Mutable
+    # Insert a child between this node and the one after it.
+    #
+    # @raise [StructureException] if this node has no parent.
+    #
+    # @param  value [Object] the value of the new sibling.
+    # @return [self]
+    def append_sibling(value = nil)
+      raise StructureException, 'Root node can not have siblings' if root?
+
+      append value
+      self
+    end
+
+    # Insert a child between this node and the one before it.
+    #
+    # @raise [StructureException] if this node has no parent.
+    #
+    # @param  value [Object] the value of the new sibling.
+    # @return [self]
+    def prepend_sibling(value = nil)
+      raise StructureException, 'Root node can not have siblings' if root?
+
+      prepend value
+      self
+    end
+
+    # Insert a child after the last one.
+    #
+    # @param  value [Object] the value of the new sibling.
+    # @return [self]
+    def append_child(value = nil)
+      push value
+    end
+
+    # @see #append_child.
+    alias << append_child
+
+    # Insert a child before the first one.
+    #
+    # @param  value [Object] the value of the new sibling.
+    # @return [self]
+    def prepend_child(value = nil)
+      unshift value
+    end
+
+    # Extracts the node and its subtree from the larger structure.
+    #
+    # @return [self] the node will now be root.
+    def extract
+      return self if root?
+
+      method(:delete).super_method.call
+      self
+    end
+
+    # Removes the node from the tree.
+    #
+    # @return [Array<Node>] an array of the children to the deleted node, now
+    #   made roots.
+    def delete
+      extract.children.to_a.each(&:extract)
+    end
+  end
+end

data/lib/rooted_tree/node.rb

@@ -1,335 +1,111 @@
 # frozen_string_literal: true
 
-# Node
-#
-# Nodes are mutable by default, since creating anyting but simple leafs would
-# otherwise be imposible. Calling #freeze on a node makes the entire subtree
-# immutable. This is used by the Tree class which only operates on frozen node
-# structures.
-#
-# The following is an example of a rooted tree with maximum depth 2.
-#
-#       r         - r, a, b, c, and d are internal vertices
-#    +--+---+     - vertices e, f, g, h, i, and j are leaves
-#    a  b   c     - vertices g, h, and i are siblings
-#   +++ | +-+-+   - node a is an ancestor of j
-#   d e f g h i   - j is a descendant of a
-#   |
-#   j
-#
-# The terminology is mostly referenced from
-# http://www.cs.columbia.edu/~cs4203/files/GT-Lec4.pdf.
-
 module RootedTree
-  class Node
-    include Enumerable
-
-    attr_accessor :first_child, :last_child, :degree, :value
-    attr_writer :next, :prev, :parent
-
-    protected :next=, :prev=, :parent=, :first_child=, :last_child=, :degree=
-
-    alias arity degree
+  # rubocop:disable Metrics/ClassLength
+
+  # Nodes are mutable by default, since creating anyting but simple leafs would
+  # otherwise be imposible. Calling #freeze on a node makes the entire subtree
+  # immutable. This is used by the Tree class which only operates on frozen node
+  # structures.
+  #
+  # The following is an example of a rooted tree with maximum depth 2.
+  #
+  #       r         - r, a, b, c, and d are internal vertices
+  #    +--+---+     - vertices e, f, g, h, i, and j are leaves
+  #    a  b   c     - vertices g, h, and i are siblings
+  #   +++ | +-+-+   - node a is an ancestor of j
+  #   d e f g h i   - j is a descendant of a
+  #   |
+  #   j
+  #
+  # The terminology is mostly referenced from
+  # http://www.cs.columbia.edu/~cs4203/files/GT-Lec4.pdf.
+  class Node < Linked::Item
+    extend  Forwardable
+    include Linked::List
+    include Mutable
 
     # Creates a new node with the given object as its value, unless a Node is
     # passed, in which case it will be returned.
     #
-    # value - the object to be used as value for a new Node, or a Node object.
-    #
-    # Returns a Node object.
-
+    # @param  value [Object] the object to be used as value for a new Node, or a
+    #   Node object.
+    # @return [Node] a Node object.
     def self.[](value = nil)
       return value if value.is_a? self
       new value
     end
-    
-    # Create a new, unconnected Node object with an optional value. The value is
-    # owned by the Node instance and will be duped along with it.
-    #
-    # value - arbitrary object that is owned by the Node instance.
-
-    def initialize(value = nil)
-      @parent = nil
-      @next = nil
-      @prev = nil
-      @first_child = nil
-      @last_child = nil
-      @degree = 0
-      @value = value
-    end
-    
-    # When copying a node the child nodes are copied as well, along with the
-    # value.
-
-    def initialize_dup(source)
-      # Dup each child and link them to the new parent
-      duped_children = source.children.map do |child|
-        child.dup.tap { |n| n.parent = self }
-      end
-      
-      # Connect each child to its adjecent siblings
-      duped_children.each_cons(2) { |a, b| a.next, b.prev = b, a }
-
-      @parent = nil
-      @first_child = duped_children.first
-      @last_child = duped_children.last
-      @value = begin
-                 source.value.dup
-               rescue TypeError
-                 source.value
-               end
-               
-      super
-    end
-    
-    # Freezes the value as well as each of the children, outside of the normal
-    # behaviour.
-
-    def freeze
-      @value.freeze
-      children.each(&:freeze)
-      super
-    end
 
-    # Returns true if this node is a leaf. A leaf is a node with no children.
+    # @return [Integer] the number of children of the node.
+    alias degree count
 
-    def leaf?
-      @degree == 0
-    end
+    # @return [Integer] see #degree.
+    alias arity degree
 
-    # Returns true if the node is internal, which is equivalent to it having
-    # children.
+    # @return [Node] the first child.
+    alias first_child first
 
-    def internal?
-      !leaf?
-    end
+    # @return [Node] the last child.
+    alias last_child last
 
-    # Returns true if the node has no parent.
+    # @return [true] if this node has no children.
+    # @return [false] otherwise.
+    def_delegator :degree, :zero?, :leaf?
 
-    def root?
-      @parent.nil?
-    end
+    # @return [true] if the node has children.
+    # @return [false] otherwise.
+    def_delegator :degree, :positive?, :internal?
 
-    # Returns the root of the tree structure that the node is part of.
+    # @return [true] if the node has no parent.
+    # @return [false] otherwise.
+    def_delegator :list, :nil?, :root?
 
+    # @return [Node] the root of the tree structure that the node is part of.
     def root
       return self if root?
-
-      node = self
-      loop { node = node.parent }
-      node
-    end
-
-    # Returns true if this node is the first of its siblings.
-
-    def first?
-      @prev.nil?
-    end
-
-    # Returns true if this node is the last of its siblings.
-
-    def last?
-      @next.nil?
+      loop.reduce(self) { |node,| node.parent }
     end
 
-    # Returns the depth of the node within the tree
-
-    def depth
-      ancestors.count
-    end
+    # @return [Integer] the depth of the node within the tree.
+    def_delegator :ancestors, :count, :depth
 
     alias level depth
 
-    # Returns the maximum node depth under this node.
-
+    # @return [Integer] the maximum node depth under this node.
     def max_depth(offset = depth)
       return offset if leaf?
 
       children.map { |c| c.max_depth offset + 1 }.max
     end
 
-    # Returns the highest child count of the nodes in the subtree.
-
+    # @return [Integer] the highest child count of the nodes in the subtree.
     def max_degree
       children.map(&:degree).push(degree).max
     end
 
     # Calculate the size in vertecies of the subtree.
     #
-    # Returns the number of nodes under this node, including self.
-
+    # @return [Integer] the number of nodes under this node, including self.
     def size
       children.reduce(1) { |a, e| a + e.size }
     end
 
-    # Access the next sibling. Raises a StopIteration if this node is the last
-    # one.
-    #
-    # Returns the next sibling node.
-
-    def next
-      raise StopIteration if last?
-      @next
-    end
-    
-    # Dangerous accessor of the next sibling. Unlike the regular #next this
-    # method will return nil if this node is the last one.
-    #
-    # Returns the next sibling node or nil if this node is last.
-    
-    def next!
-      @next
-    end
-
-    # Access the previous sibling. Raises a StopIteration if this node is the
-    # first one.
-    #
-    # Returns the previous sibling node.
-
-    def prev
-      raise StopIteration if first?
-      @prev
-    end
-
-    alias previous prev
-    
-    # Dangerous accessor of the previous sibling. Unlike the regular #prev this
-    # method will return nil if this node is the first one.
-    
-    def prev!
-      @prev
-    end
-    
-    alias previous! prev!
-
     # Access the parent node. Raises a StopIteration if this node is the
     # root.
     #
-    # Returns the parent node.
-
+    # @raise [StopIteration] if this node is the root.
+    #
+    # @return [Node] the parent node.
     def parent
       raise StopIteration if root?
-      @parent
-    end
-
-    # Insert a child between this node and the one after it.
-    #
-    # Returns self.
-
-    def append_sibling(value = nil)
-      raise StructureException, 'Root node can not have siblings' if root?
-
-      node = self.class[value]
-      node.next = @next
-      node.prev = self
-      node.parent = @parent
-      @parent.degree += 1
-
-      if @next
-        @next.prev = node
-      else
-        @parent.last_child = node
-      end
-      @next = node
-    end
-
-    # Insert a child between this node and the one before it.
-    #
-    # Returns self.
-
-    def prepend_sibling(value = nil)
-      raise StructureException, 'Root node can not have siblings' if root?
-
-      node = self.class[value]
-      node.next = self
-      node.prev = @prev
-      node.parent = @parent
-      @parent.degree += 1
-
-      if @prev
-        @prev.next = node
-      else
-        @parent.first_child = node
-      end
-      @prev = node
-    end
-
-    private def add_child_to_leaf(value)
-      node = self.class[value]
-      @first_child = @last_child = node
-      node.next = node.prev = nil
-      @degree = 1
-      node.parent = self
-    end
-
-    # Insert a child after the last one.
-    #
-    # Returns self.
-
-    def append_child(value = nil)
-      if leaf?
-        add_child_to_leaf value
-      else
-        @last_child.append_sibling value
-      end
-      self
-    end
-
-    alias << append_child
-
-    # Insert a child before the first one.
-    #
-    # Returns self.
-
-    def prepend_child(value = nil)
-      if leaf?
-        add_child_to_leaf value
-      else
-        @first_child.prepend_sibling value
-      end
-    end
-
-    # Extracts the node and its subtree from the larger structure.
-    #
-    # Returns self, now made root.
-
-    def extract
-      return self if root?
-
-      if last?
-        parent.last_child = @prev
-      else
-        @next.prev = @prev
-      end
-
-      if first?
-        parent.first_child = @next
-      else
-        @prev.next = @next
-      end
-
-      @parent.degree -= 1
-      @prev = @next = @parent = nil
-      self
-    end
-
-    # Removes the node from the tree.
-    #
-    # Returns an array of the children to the deleted node, now made roots.
-
-    def delete
-      extract.children.to_a.each do |child|
-        child.parent = nil
-        child.next = child.prev = nil
-      end
+      list
     end
 
     # Iterates over the nodes above this in the tree hierarchy and yields them
     # to a block. If no block is given an enumerator is returned.
     #
-    # Returns an enumerator that will iterate over the parents of this node
-    # until the root is reached.
-
+    # @yield  [Node] each parent node.
+    # @return [Enumerator] if no block is given.
     def ancestors
       return to_enum(__callee__) unless block_given?
       node = self
@@ -346,59 +122,41 @@ module RootedTree
     # Note that the block will catch any StopIteration that is raised and
     # terminate early, returning the value of the exception.
     #
-    # rtl - reverses the iteration order if true.
-
-    def children(rtl: false)
-      return to_enum(__callee__, rtl: rtl) unless block_given?
-      return if leaf?
-
-      child, advance = if rtl
-                         [@last_child, :prev]
-                       else
-                         [@first_child, :next]
-                       end
-
-      loop do
-        yield child
-        child = child.send advance
-      end
+    # @param  rtl [true, false] reverses the iteration order if true.
+    # @return see #each_item
+    def children(rtl: false, &block)
+      rtl ? reverse_each_item(&block) : each_item(&block)
     end
 
     # Accessor method for any of the n children under this node. If called
     # without an argument and the node has anything but exactly one child an
     # exception will be raised.
     #
-    # n - the n:th child to be returned. If n is negative the indexing will be
-    #     reversed and the children counted from the last to the first.
-    #
-    # Returns the child at the n:th index.
-
-    def child(n = nil)
-      if n.nil?
-        if @degree != 1
-          raise ArgumentError, 'No argument given for node with degree != 1'
-        end
-        return @first_child
+    # @param index [Integer] the n:th child to be returned. If the index is
+    #   negative the indexing will be reversed and the children counted from the
+    #   last to the first.
+    # @return [Node] the child at the n:th index.
+    def child(index = nil)
+      unless index
+        raise ArgumentError, 'No index for node with degree != 1' if degree != 1
+        return first
       end
 
-      rtl = if n < 0
-              n = -1 - n
-              true
-            else
-              false
-            end
+      rtl, index = wrap_index index
 
-      raise RangeError, 'Child index out of range' if n >= @degree
+      raise RangeError, 'Child index out of range' if index >= degree
 
       children(rtl: rtl).each do |c|
-        break c if n == 0
-        n -= 1
+        break c if index.zero?
+        index -= 1
       end
     end
 
-    # Yields first to self and then to each child. If a block is not given an
-    # enumerator is returned.
+    alias [] child
 
+    # @yield  [Node] first self is yielded and then the children who in turn
+    #   yield their children.
+    # @return [Enumerator] if no block is given.
     def each(&block)
       return to_enum(__callee__) unless block_given?
       yield self
@@ -409,9 +167,7 @@ module RootedTree
     # node is placed at index zero of its own array, followed by an array of its
     # children. Leaf nodes are not wraped in arrays but inserted directly.
     #
-    # flatten - flattens the array if true.
-    #
-    # Example
+    # == Example
     #
     #     r
     #    / \
@@ -419,29 +175,28 @@ module RootedTree
     #   |
     #   c
     #
-    # Returns a nested array of nodes.
-
-    def to_a flatten: false
-      return super() if flatten
+    # @param  flatten [true, false] the array is flattened if true.
+    # @return [Array<Node, Array>] a nested array of nodes.
+    def to_a(flatten: false)
+      return each.to_a if flatten
       return self if leaf?
       [self, children.map(&:to_a)]
     end
 
     # Iterates over each of the leafs.
     #
-    # rtl - if true the iteration order is switched to right to left.
-
+    # @param rtl [true, false] if true the iteration order is switched to right
+    #   to left.
     def leafs(rtl: false, &block)
       return to_enum(__callee__, rtl: rtl) unless block_given?
       return yield self if leaf?
       children(rtl: rtl) { |v| v.leafs(rtl: rtl, &block) }
     end
 
-    # Iterates over each of the edges and yields the parent and the child. If no
-    # block is given an enumerator is returned.
+    # Iterates over each edge in the tree.
     #
-    # block - an optional block that will be yielded to, if given.
-
+    # @yield  [Array<Node>] each connected node pair.
+    # @return [Enumerator] if no block is given.
     def edges(&block)
       return to_enum(__callee__) unless block_given?
 
@@ -455,10 +210,8 @@ module RootedTree
     # created and returned. Note that if the any of the root nodes are not
     # frozen they will be modified, and as a result seize to be roots.
     #
-    # other - a Node-like object that responds true to #root?
-    #
-    # Returns a new root with the two nodes as children.
-
+    # @param  other [Node] a Node-like object that responds true to #root?
+    # @return [Node] a new root with the two nodes as children.
     def +(other)
       unless root? && other.root?
         raise StructureException, 'Only roots can be added'
@@ -473,8 +226,9 @@ module RootedTree
 
     # Compare one node (sub)structure with another.
     #
-    # Returns true if the two vertecies form identical subtrees
-
+    # @param  other [Object]
+    # @return [true] if the two vertecies form identical subtrees.
+    # @reutrn [false] otherwise.
     def ==(other)
       return false unless other.is_a? self.class
       return false unless degree == other.degree
@@ -483,36 +237,19 @@ module RootedTree
       children.to_a == other.children.to_a
     end
 
-    # Visalizes the tree structure in a style very similar to the cli tool tree.
-    # An example of the output can be seen below. Note that the output string
-    # contains unicode characters.
-    #
-    #   Node:0x3ffd64c22abc
-    #   |--Node:0x3ffd64c1fd30
-    #   |  |--Node:0x3ffd64c1f86c
-    #   |  +--Node:0x3ffd64c1f63c
-    #   +--Node:0x3ffd64c1f40c
-    #
-    # By passing `as_array: true` the method will instead return an array
-    # containing each of the output lines. The method also accepts a block
-    # which, if given, will be yielded to once for every node, and the output
-    # will be used as node labels instead of the default identifier.
-
-    def inspect(as_array: false, &block)
-      unless block_given?
-        block = proc { |v| format '%s:0x%0x', v.class.name, v.object_id }
-      end
-
-      res = [block.call(self)]
+    private
 
-      children do |child|
-        lines = child.inspect(as_array: true, &block).each
-        res << ((child.last? ? '└─╴' : '├─╴') + lines.next)
-        prep = child.last? ? '   ' : '│  '
-        loop { res << (prep + lines.next) }
+    def wrap_index(index)
+      if index.negative?
+        [true, -1 - index]
+      else
+        [false, index]
       end
-
-      as_array ? res : res.join("\n")
     end
+
+    protected :first, :last, :each_item
+    private :push, :unshift, :list, :count
   end
+
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/rooted_tree/tree.rb

@@ -1,54 +1,36 @@
 # frozen_string_literal: true
 
-# Tree
-#
-# Include this module in any object that responds to #root with a Node
-# structure. The mixin provides some methods for describing the tree as well as
-# direct access to some of the iteration methods in Node.
-
 module RootedTree
+  # Include this module in any object that responds to #root with a Node
+  # structure. The mixin provides some methods for describing the tree as well
+  # as direct access to some of the iteration methods in Node.
   module Tree
-    
+    extend Forwardable
+
     # Freezes the node structure that is part of the tree.
-    
     def freeze
       root.freeze
       super
     end
-    
-    # Returns the maximum degree (highest number of children) in the tree.
 
-    def degree
-      root.max_degree
-    end
+    # Returns the maximum degree (highest number of children) in the tree.
+    def_delegator :root, :max_degree, :degree
 
     # Returns the maximum depth of the tree.
-
-    def depth
-      root.max_depth
-    end
+    def_delegator :root, :max_depth, :depth
 
     # Iterates over each node in the tree. When given a block it will be yielded
     # to once for each node. If no block is given an enumerator is returned.
-
-    def each_node(&block)
-      root.each(&block)
-    end
+    def_delegator :root, :each, :each_node
 
     # Iterates over each leaf in the tree. When given a block it will be yielded
     # to once for leaf node. If no block is given an enumerator is returned.
-
-    def each_leaf(&block)
-      root.leafs(&block)
-    end
+    def_delegator :root, :leafs, :each_leaf
 
     # Iterates over each edge in the tree. An edge is composed of the parent
     # node and the child, always in that order. When given a block it will be
     # yielded to once for each node. If no block is given an enumerator is
     # returned.
-
-    def each_edge(&block)
-      root.edges(&block)
-    end
+    def_delegator :root, :edges, :each_edge
   end
 end

data/lib/rooted_tree/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module RootedTree
-  VERSION = '0.3.3'
+  # @return [String] the semantic version number of the library.
+  VERSION = '0.3.4'
 end

data/lib/rooted_tree.rb

@@ -1,9 +1,16 @@
 # frozen_string_literal: true
 
+require 'forwardable'
+require 'linked'
+
 require 'rooted_tree/version'
+require 'rooted_tree/mutable'
 require 'rooted_tree/node'
 require 'rooted_tree/tree'
 
+# A basic implementation of a tree data structure.
 module RootedTree
   class StructureException < StandardError; end
+
+  private_constant :Mutable
 end

data/rooted_tree.gemspec

@@ -1,26 +1,38 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'rooted_tree/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "rooted_tree"
+  spec.name          = 'rooted_tree'
   spec.version       = RootedTree::VERSION
-  spec.authors       = ["Sebastian Lindberg"]
-  spec.email         = ["seb.lindberg@gmail.com"]
+  spec.authors       = ['Sebastian Lindberg']
+  spec.email         = ['seb.lindberg@gmail.com']
+
+  spec.summary       = 'A basic implementation of a tree data structure.'
+  spec.description   = 'This gem implements a rooted, ordered tree, with a ' \
+                       'focus on easy iteration over nodes and access to ' \
+                       'basic tree properties.'
+  spec.homepage      = 'https://github.com/seblindberg/ruby-rooted_tree'
+  spec.license       = 'MIT'
 
-  spec.summary       = %q{A basic implementation of a tree data structure.}
-  spec.description   = %q{This gem implements a rooted, ordered tree, with a focus on easy iteration over nodes and access to basic tree properties.}
-  spec.homepage      = "https://github.com/seblindberg/ruby-rooted_tree"
-  spec.license       = "MIT"
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0")
+                     .reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'linked', '~> 0.1.1'
 
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "coveralls", "~> 0.8"
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'redcarpet', '~> 3.4'
+  spec.add_development_dependency 'rubocop', '~> 0.52'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
+  spec.add_development_dependency 'yard', '~> 0.9'
 end

metadata

@@ -1,29 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: rooted_tree
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Sebastian Lindberg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-03 00:00:00.000000000 Z
+date: 2018-07-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: linked
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -39,33 +67,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
 description: This gem implements a rooted, ordered tree, with a focus on easy iteration
   over nodes and access to basic tree properties.
 email:
@@ -75,8 +131,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -84,6 +142,7 @@ files:
 - bin/setup
 - examples/filesystem_tree.rb
 - lib/rooted_tree.rb
+- lib/rooted_tree/mutable.rb
 - lib/rooted_tree/node.rb
 - lib/rooted_tree/tree.rb
 - lib/rooted_tree/version.rb
@@ -108,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: A basic implementation of a tree data structure.