rooted_tree 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf70759dc7a2bf845496a1eb2291a91a4a60e5e2
-  data.tar.gz: 6e7365e5d05e9f8daa1b34e5c726f0d2d8865d1b
+  metadata.gz: 22a5b2a13278deccce0118fecd19ba5d65e39a4c
+  data.tar.gz: f2de5a5dba41d23f396e325889f9ed2dd6d468af
 SHA512:
-  metadata.gz: 10622361191c35e83775a11d129245eaebc2ce0b69f970e24195dd20bba065784a53a29295446c733d7bd3179b74302a29fe83fd5da6b48fbcfd8c573310db86
-  data.tar.gz: 1e9c114ae888537459a66f2c7b1f27212c2d20160c35a9e84c7a111916c14d20f6042feb585e6430e18cce600a79b0177b7cb0f932e59b26c6f020f8d3ef25f7
+  metadata.gz: 492a612d75f800c8e3ab638beb1c7bc9f352125eb29ceff47bf2a38855b12bbbb4675846dd52a4813877baf5402da1f39a6b53880c2c9adf9083621c50122dc7
+  data.tar.gz: cd0a3ef730dca13e6d083bdf44ed0b834a973121dff0ca05369fd355f8c6b30a9be1fd957dc5b9e60dd5b0ba1395964fe63122e0914a4593441b791c6b4b87f3

data/README.md

@@ -53,22 +53,15 @@ The gem is primarily ment to be extended by other classes. The following example
 
 ```ruby
 class FileSystemItem < RootedTree::Node
-  attr_reader :name
-
-  def initialize name
-    super()
-    @name = name
-  end
-
   def display
-    inspect { |item| item.name }
+    inspect { |item| item.value }
   end
 
   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
-      item = new File.basename entry
+      item = new File.basename(entry)
       root << item
       # Continue to map the files and directories under
       # entry, if it is a directory

data/examples/filesystem_tree.rb

@@ -6,25 +6,19 @@ require 'rooted_tree'
 #
 # 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.
+# structure. The name of each entry in the filesystem is stored in the value
+# field of the Node.
 
 class FileSystemItem < RootedTree::Node
-  attr_reader :name
-  
-  def initialize name
-    super()
-    @name = name
-  end
-  
   def display
-    inspect { |item| item.name }
+    inspect { |item| item.value }
   end
   
   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
-      item = new File.basename entry
+      item = new File.basename(entry)
       root << item
       # Continue to map the files and directories under
       # entry, if it is a directory

data/lib/rooted_tree/node.rb

@@ -23,21 +23,27 @@
 module RootedTree
   class Node
     include Enumerable
-    
-    attr_accessor :first_child, :last_child, :degree
+
+    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
 
-    def initialize
+    def self.[](value = nil)
+      return value if value.is_a? self
+      self.new value
+    end
+
+    def initialize value = nil
       @parent = nil
       @next = nil
       @prev = nil
       @first_child = nil
       @last_child = nil
       @degree = 0
+      @value = value
     end
 
     def initialize_copy(*)
@@ -48,9 +54,10 @@ module RootedTree
       @first_child = duped_children.first
       @last_child = duped_children.last
     end
-    
+
     def freeze
       super
+      @value.freeze
       children.each(&:freeze)
     end
 
@@ -85,7 +92,7 @@ module RootedTree
 
     def root
       return self if root?
-      
+
       node = self
       loop { node = node.parent }
       node
@@ -116,15 +123,15 @@ module RootedTree
     end
 
     alias level depth
-    
+
     # Max Depth
     #
     # Returns the maximum node depth under this node.
-    
-    def max_depth offset = depth
+
+    def max_depth(offset = depth)
       return offset if leaf?
-      
-      children.map {|c| c.max_depth offset + 1 }.max
+
+      children.map { |c| c.max_depth offset + 1 }.max
     end
 
     # Max Degree
@@ -179,14 +186,15 @@ module RootedTree
     #
     # Insert a child between this node and the one after it.
 
-    def append_sibling(node)
+    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
@@ -199,14 +207,15 @@ module RootedTree
     #
     # Insert a child between this node and the one before it.
 
-    def prepend_sibling(node)
+    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
@@ -214,41 +223,42 @@ module RootedTree
       end
       @prev = node
     end
-    
-    private def add_child_to_leaf(child)
-      @first_child = @last_child = child
-      child.next = child.prev = nil
+
+    private def add_child_to_leaf(value)
+      node = self.class[value]
+      @first_child = @last_child = node
+      node.next = node.prev = nil
       @degree = 1
-      child.parent = self
+      node.parent = self
     end
 
     # Append Child
     #
     # Insert a child after the last one.
 
-    def append_child(child)
+    def append_child(value = nil)
       if leaf?
-        add_child_to_leaf child
+        add_child_to_leaf value
       else
-        @last_child.append_sibling child
+        @last_child.append_sibling value
       end
       self
     end
 
+    alias << append_child
+
     # Prepend Child
     #
     # Insert a child before the first one.
 
-    def prepend_child(child)
+    def prepend_child(value = nil)
       if leaf?
-        add_child_to_leaf child
+        add_child_to_leaf value
       else
-        @first_child.prepend_sibling child
+        @first_child.prepend_sibling value
       end
     end
 
-    alias << append_child
-
     # Extract
     #
     # Extracts the node and its subtree from the larger structure.
@@ -303,7 +313,8 @@ module RootedTree
     # Children
     #
     # Yields to each of the node children. The default order is left-to-right,
-    # but by passing rtl: true the order can be reversed. If a block is not given an enumerator is returned.
+    # but by passing rtl: true the order can be reversed. If a block is not
+    # given an enumerator is returned.
     #
     # Note that the block will catch any StopIteration that is raised and
     # terminate early, returning the value of the exception.
@@ -324,6 +335,33 @@ module RootedTree
       end
     end
 
+    # Child
+    #
+    # Accessor method for any of the n children under this node.
+
+    def child(n = nil)
+      if n.nil?
+        if @degree != 1
+          raise ArgumentError, 'No argument given for node with degree != 1'
+        end
+        return @first_child
+      end
+
+      rtl = if n < 0
+              n = -1 - n
+              true
+            else
+              false
+            end
+
+      raise RangeError, 'Child index out of range' if n >= @degree
+
+      children(rtl: rtl).each do |c|
+        break c if n == 0
+        n -= 1
+      end
+    end
+
     # Each
     #
     # Yields first to self and then to each child. If a block is not given an
@@ -382,37 +420,37 @@ module RootedTree
 
       children.to_a == other.children.to_a
     end
-    
+
     # Tree!
     #
     # Wraps the entire tree in a Tree object. The operation will freeze the node
     # structure, making it immutable. If this node is a child the root will be
     # found and passed to Tree.new.
-    
+
     def tree!
       Tree.new root
     end
-    
+
     # Tree
     #
     # Duplicates the entire tree and calls #tree! on the copy.
-    
+
     def tree
       root.dup.tree!
     end
-    
+
     # Subtree!
     #
     # Extracts this node from the larger tree and wraps it in a Tree object.
-    
+
     def subtree!
       Tree.new extract
     end
-    
+
     # Subtree
     #
     # Duplicates this node and its descendants and wraps them in a Tree object.
-    
+
     def subtree
       Tree.new dup
     end

data/lib/rooted_tree/tree.rb

@@ -3,30 +3,30 @@
 module RootedTree
   class Tree
     attr_reader :root
-    
+
     def initialize(node)
       @root = node.root
       @root.freeze
     end
-    
+
     def tree
       self
     end
-    
+
     # Degree
     #
     # Returns the maximum degree (number of children) in the tree.
-    
+
     def degree
       @degree ||= root.max_degree
     end
-    
+
     # Depth
     #
     # Returns the maximum depth of the tree.
-    
+
     def depth
       @depth ||= root.max_depth
     end
   end
-end
+end

data/lib/rooted_tree/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RootedTree
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rooted_tree
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Sebastian Lindberg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-23 00:00:00.000000000 Z
+date: 2016-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler