gf-treevisitor 0.0.10 → 0.0.11

data/VERSION

@@ -1 +1 @@
-0.0.10
+0.0.11

data/lib/treevisitor.rb

@@ -1,3 +1,3 @@
 class TreeVisitor
-  VERSION = '0.0.10'
+  VERSION = '0.0.11'
 end

data/lib/treevisitor/abs_node.rb

@@ -3,27 +3,40 @@ require "rubygems"
 require "abstract"
 
 #
-# Nodo Astratto
-#   Gerarchia delle classi
+# Abstract Node
+#   Class hierarchy
 #
-#   AbsNode ha un nome, un parent
-#    |      definisce un path
+#   AbsNode has a name, a parent
+#    ^      and define a path i.e. concatenation ancestor names
 #    |
-#    |- LeafNode
+#    |-- LeafNode
 #    |
-#    |- TreeNode
-# 
+#    `-- TreeNode
 #
+#  Object diagram
+#
+#           TreeNode (parent: nil)
+#             |
+#             |--->[ LeafNode, LeafNode, LeafNode ]
+#             |
+#             |--->[ TreeNode, TreeNode ]
+#                         |
+#                         |--> [LeafNode]
+#                         |
+#                         `--> [TreeNode, TreeNode]
 class AbsNode
 
+  class << self
+    attr_accessor :path_separator
+  end
+  self.path_separator = File::SEPARATOR
+
   attr_reader :parent
   attr_reader :name
   
-  # solo TreeNode puo' scrivere vedi funzione add_leaf
   attr_accessor :prev
   attr_accessor :next
   
-
   def initialize( name )
     @parent = nil
     @name = name
@@ -68,13 +81,9 @@ class AbsNode
   def path
     return @path unless @path.nil?
     if @parent.nil?
-      if @prefix_path
-        @path = @prefix_path + @name
-      else
-        @path = @name
-      end
+      @path = @prefix_path.nil? ? @name : @prefix_path + @name
     else
-      @path = File.join( @parent.path, @name )
+      @path = @parent.path + AbsNode::path_separator + @name
     end
     @path
   end
@@ -82,24 +91,16 @@ class AbsNode
   def path_from_root
     return @path_from_root unless @path_from_root.nil?
     if @parent.nil?
-      if @prefix_path
-        @path_from_root = @prefix_path
-      else
-        @path_from_root = ""
-      end
+      @path_from_root = @prefix_path.nil? ? "" : @prefix_path
     else
-      @path_from_root = File.join( @parent.path_from_root, @name )
+      @path_from_root = @parent.path_from_root + AbsNode::path_separator + @name
     end
     @path_from_root
   end
 
   def depth
     return @depth unless @depth.nil?
-    if @parent.nil?
-      @depth = 1
-    else
-      @depth = @parent.depth + 1
-    end
+    @depth = @parent.nil? ? 1 : @parent.depth + 1
     @depth
   end
   

data/lib/treevisitor/dir_tree_walker.rb

@@ -1,5 +1,3 @@
-require 'treevisitor/visitors/block_tree_node_visitor'
-
 class DirTreeWalker
 
   def initialize( dirname )
@@ -21,7 +19,6 @@ class DirTreeWalker
     #
     # options
     #
-
     @visit_leaf = true
   end
 
@@ -70,9 +67,13 @@ class DirTreeWalker
     include?( @inspect_file_patterns, File.basename( filename ) )
   end
 
-  def run( treeNodeVisitor )
-    @visitor = treeNodeVisitor
+  #
+  # return the visitor
+  #
+  def run( tree_node_visitor )
+    @visitor = tree_node_visitor
     process_directory( File.expand_path( @dirname ) )
+    tree_node_visitor
   end
 
   private
@@ -91,7 +92,6 @@ class DirTreeWalker
   #
   # recurse on other directories
   #
-  # def process_directory( parentNode, dirname )
   def process_directory( dirname )
     @visitor.enter_tree_node( dirname )
     # return if ignore_dir?( dirname )

data/lib/treevisitor/leaf_node.rb

@@ -1,12 +1,5 @@
-# common
 require "treevisitor/abs_node"
 
-#
-# Deriva da AbsNode
-# 
-# definisce un metodo to_str
-#
-#
 class LeafNode < AbsNode
 
   def initialize( name, parent = nil )
@@ -16,12 +9,18 @@ class LeafNode < AbsNode
     end
   end
 
+  #
+  # a leaf_node cannot be a root
   def root?
     false
   end
 
+  #
+  # return the visitor
+  #
   def accept( visitor )
     visitor.visit_leaf_node( self )
+    visitor
   end
 
   def to_str

data/lib/treevisitor/tree_node.rb

@@ -1,10 +1,8 @@
-# common
 require 'treevisitor/leaf_node'
 
 #
-# Un treeNode e' come un AbsNode
-# in piu' ha la possibilita' di contenere
-# altri treeNode e LeafNode
+# TreeNode can contains other TreeNode (children)
+# and can contains LeafNode (leves)
 #
 # TreeNode @childs -1---n-> TreeNode
 #          @leaves -1---n-> LeafNode
@@ -12,11 +10,11 @@ require 'treevisitor/leaf_node'
 class TreeNode < AbsNode
   
   attr_reader :leaves
-  attr_reader :childs
+  attr_reader :children
 
   def initialize( name, parent = nil )
     @leaves = []
-    @childs = []
+    @children = []
     super( name )
     if parent
       parent.add_child( self )
@@ -29,30 +27,31 @@ class TreeNode < AbsNode
   
   #
   # invalidate cached info
+  # invalidate propagates form parent to children and leaves
   #
   def invalidate
     super
-    @childs.each{ |c| c.invalidate }
+    @children.each{ |c| c.invalidate }
     @leaves.each{ |l| l.invalidate }
   end
   
   def nr_nodes
-    nr = @leaves.length + @childs.length
-    @childs.inject( nr ) { |nr,c| nr + c.nr_nodes }
+    nr = @leaves.length + @children.length
+    @children.inject( nr ) { |nr,c| nr + c.nr_nodes }
   end
   
   def nr_leaves
-    @leaves.length + @childs.inject(0) { |sum, child| sum + child.nr_leaves }
+    @leaves.length + @children.inject(0) { |sum, child| sum + child.nr_leaves }
   end
 
-  def nr_childs
-    @childs.length + @childs.inject(0) { |sum, child| sum + child.nr_childs }
+  def nr_children
+    @children.length + @children.inject(0) { |sum, child| sum + child.nr_children }
   end
         
   def add_leaf( leaf )
     return if leaf.parent == self
     if not leaf.parent.nil?
-      leaf.remove_from_parent()
+      leaf.remove_from_parent
     end  
     leaf.parent = self
     if @leaves.length > 0
@@ -71,35 +70,37 @@ class TreeNode < AbsNode
     end  
     treeNode.invalidate
     treeNode.parent = self
-    @childs << treeNode
+    @children << treeNode
   end
   
   def find( name )
-    if self.name == name
-      return self
-    end
+    return self if self.name == name
     
     leaf = @leaves.find { |l| l.name == name }
     if leaf
       return leaf
     end
     
-    @childs.each {|c| 
+    @children.each {|c|
       node = c.find(name)
       return node if node
     }
     nil
   end
 
+  #
+  # return the visitor
+  #
   def accept( visitor )
     visitor.enter_tree_node( self )
-    @leaves.each{ |l|
-      l.accept( visitor )
+    @leaves.each{ |leaf|
+      leaf.accept( visitor )
     }
-    @childs.each { |tn|
-      tn.accept( visitor )
+    @children.each { |child|
+      child.accept( visitor )
     }
     visitor.exit_tree_node( self )
+    visitor
   end
 
   def to_str( depth = 0 )
@@ -116,7 +117,7 @@ class TreeNode < AbsNode
         (0...depth-1).step {
           str << " |-"
         }
-        if @childs.empty?
+        if @children.empty?
           str << " |    "
         else
           str << " |  | "
@@ -126,7 +127,7 @@ class TreeNode < AbsNode
       }
     end
 
-    @childs.each { |tn|
+    @children.each { |tn|
       str << tn.to_str( depth + 1 )
     }
     str

data/lib/treevisitor/tree_node_visitor.rb

@@ -1,22 +1,16 @@
-# rubygems
-require 'rubygems'
-require 'abstract'
-
 #
-# Classe astratta per visitare un TreeNode
+# Callback methods used to visit a tree
+# Are empty so it is possible defined only a subset
 #
 class TreeNodeVisitor
 
-  def enter_tree_node( treeNode )
-    not_implemented
+  def enter_tree_node( tree_node )
   end
 
-  def exit_tree_node( treeNode )
-    not_implemented
+  def exit_tree_node( tree_node )
   end
-
-  def visit_leaf_node( leafNode )
-    not_implemented
+  
+  def visit_leaf_node( leaf_node )
   end
 
 end

data/lib/treevisitor/visitors/block_tree_node_visitor.rb

@@ -9,15 +9,15 @@ class BlockTreeNodeVisitor < TreeNodeVisitor
     @block = action
   end
 
-  def enter_tree_node( treeNode )
-    @block.call( treeNode )
+  def enter_tree_node( tree_node )
+    @block.call( tree_node )
   end
 
-  def exit_tree_node( treeNode )
+  def exit_tree_node( tree_node )
   end
 
-  def visit_leaf_node( leafNode )
-    @block.call( leafNode )
+  def visit_leaf_node( leaf_node )
+    @block.call( leaf_node )
   end
 
 end

data/lib/treevisitor/visitors/build_dir_tree_visitor.rb

@@ -23,13 +23,13 @@ class BuildDirTreeVisitor < TreeNodeVisitor
   
   def enter_tree_node( pathname )
     if @stack.empty?
-      treeNode = TreeNode.new( File.basename( pathname ) )
-      @root = treeNode
+      tree_node = TreeNode.new( File.basename( pathname ) )
+      @root = tree_node
     else
-      treeNode = TreeNode.new( File.basename( pathname ), @stack.last )
+      tree_node = TreeNode.new( File.basename( pathname ), @stack.last )
     end
     @nr_directories += 1
-    @stack.push( treeNode )
+    @stack.push( tree_node )
   end
 
   def exit_tree_node( pathname )
@@ -38,7 +38,8 @@ class BuildDirTreeVisitor < TreeNodeVisitor
 
   def visit_leaf_node( pathname )
     @nr_files  += 1
-    leafNode = LeafNode.new( File.basename(pathname), @stack.last )
+    # connect the leaf_node created to the last tree_node on the stack
+    LeafNode.new( File.basename(pathname), @stack.last )
   end
 
 end

data/lib/treevisitor/visitors/callback_tree_node_visitor.rb

@@ -5,41 +5,36 @@
 #
 class CallbackTreeNodeVisitor < TreeNodeVisitor
 
-  def initialize( root = nil )
+  def initialize
     super()
     @stack = []
-    @root = root
-    @stack.push( root ) if root
-    @action_enterTreeNode = nil
-    @action_visitLeafNode = nil
+    @root = nil
+    @action_enter_tree_node = nil
+    @action_visit_leaf_node = nil
   end
 
-  def onEnterTreeNode( &action )
-    @action_enterTreeNode = action
+  def on_enter_tree_node( &action )
+    @action_enter_tree_node = action
   end
 
-  def onVisitLeafNode( &action )
-    @action_visitLeafNode = action
+  def on_visit_leaf_node( &action )
+    @action_visit_leaf_node = action
   end
 
-  def enter_tree_node( treeNode )
-    parentNode = if @stack.empty?
-                   nil
-                 else
-                   @stack.last
-                 end
-    @root = treeNode if @stack.empty?
-    @stack.push( treeNode )
-    @action_enterTreeNode.call( treeNode ) if @action_enterTreeNode
+  def enter_tree_node( tree_node )
+    # parent_node = @stack.empty? ? nil : @stack.last
+    @root = tree_node if @stack.empty?
+    @stack.push( tree_node )
+    @action_enter_tree_node.call( tree_node ) if @action_enter_tree_node
   end
 
-  def exit_tree_node( treeNode )
+  def exit_tree_node( tree_node )
     @stack.pop
   end
 
-  def visit_leaf_node( leafNode )
-    parentNode = @stack.last
-    @action_visitLeafNode.call( leafNode ) if @action_visitLeafNode
+  def visit_leaf_node( leaf_node )
+    # parent_node = @stack.last
+    @action_visit_leaf_node.call( leaf_node ) if @action_visit_leaf_node
   end
 
 end

data/lib/treevisitor/visitors/callback_tree_node_visitor2.rb

@@ -8,39 +8,34 @@ class CallbackTreeNodeVisitor2 < TreeNodeVisitor
 
   attr_reader :root
 
-  def initialize( root = nil )
+  def initialize
     super()
     @stack = []
-    @root = root
-    @stack.push( root ) if root
+    @root = nil
   end
 
-  def onEnterTreeNode( &action )
-    @action_enterTreeNode = action
+  def on_enter_tree_node( &action )
+    @action_enter_tree_node = action
   end
 
-  def onVisitLeafNode( &action )
-    @action_visitLeafNode = action
+  def on_visit_leaf_node( &action )
+    @action_visit_leaf_node = action
   end
 
-  def enter_tree_node( treeNode )
-    newParentNode = if @stack.empty?
-                      nil
-                    else
-                      @stack.last
-                    end
-    newTreeNode = @action_enterTreeNode.call( treeNode, newParentNode )
-    @root = newTreeNode if @stack.empty?
-    @stack.push( newTreeNode )
+  def enter_tree_node( tree_node )
+    parent_node = @stack.empty? ? nil : @stack.last
+    new_tree_node = @action_enter_tree_node.call( tree_node, parent_node )
+    @root = new_tree_node if @stack.empty?
+    @stack.push( new_tree_node )
   end
 
-  def exit_tree_node( treeNode )
+  def exit_tree_node( tree_node )
     @stack.pop
   end
 
-  def visit_leaf_node( leafNode )
-    newParentNode = @stack.last
-    @action_visitLeafNode.call( leafNode, newParentNode )
+  def visit_leaf_node( leaf_node )
+    parent_node = @stack.last
+    @action_visit_leaf_node.call( leaf_node, parent_node )
   end
 
 end

data/lib/treevisitor/visitors/clone_tree_node_visitor.rb

@@ -3,30 +3,30 @@
 #
 class CloneTreeNodeVisitor < TreeNodeVisitor
 
-  attr_reader :clonedRoot
+  attr_reader :cloned_root
 
   def initialize
     super
-    @clonedRoot = nil
+    @cloned_root = nil
     @stack = []
   end
 
   def enter_tree_node( treeNode )
     if @stack.empty?
-      clonedTreeNode = TreeNode.new( treeNode.name )
-      @clonedRoot = clonedTreeNode
+      cloned_tree_node = TreeNode.new( treeNode.name )
+      @cloned_root = cloned_tree_node
     else
-      clonedTreeNode = TreeNode.new( treeNode.name, @stack.last )
+      cloned_tree_node = TreeNode.new( treeNode.name, @stack.last )
     end
-    @stack.push( clonedTreeNode )
+    @stack.push( cloned_tree_node )
   end
 
   def exit_tree_node( treeNode )
     @stack.pop
   end
 
-  def visit_leaf_node( leafNode )
-    clonedLeafNode = LeafNode.new( leafNode.name, @stack.last )
+  def visit_leaf_node( leaf_node )
+    LeafNode.new( leaf_node.name, @stack.last )
   end
 
 end

data/lib/treevisitor/visitors/depth_tree_node_visitor.rb

@@ -10,15 +10,15 @@ class DepthTreeNodeVisitor < TreeNodeVisitor
     @depth = 0
   end
 
-  def enter_tree_node( treeNode )
+  def enter_tree_node( tree_node )
     @depth += 1
   end
 
-  def exit_tree_node( treeNode )
+  def exit_tree_node( tree_node )
     @depth -= 1
   end
 
-  def visit_leaf_node( leafNode )
+  def visit_leaf_node( leaf_node )
   end
 
 end

data/lib/treevisitor/visitors/flat_print_tree_node_visitors.rb

@@ -3,15 +3,15 @@
 #
 class FlatPrintTreeNodeVisitor < TreeNodeVisitor
 
-  def enter_tree_node( treeNode )
-    puts treeNode.name
+  def enter_tree_node( tree_node )
+    puts tree_node.name
   end
 
-  def exit_tree_node( treeNode )
+  def exit_tree_node( tree_node )
   end
 
-  def visit_leaf_node( leafNode )
-    puts leafNode.name
+  def visit_leaf_node( leaf_node )
+    puts leaf_node.name
   end
 
 end

data/lib/treevisitor/visitors/print_dir_tree_visitor.rb

@@ -8,7 +8,7 @@ class PrintDirTreeVisitor < TreeNodeVisitor
     puts pathname
   end
 
-  def exit_tree_node( treeNode )
+  def exit_tree_node( pathname )
   end
 
   def visit_leaf_node( pathname )

data/lib/treevisitor/visitors/print_tree_node_visitor.rb

@@ -3,21 +3,11 @@
 #
 class PrintTreeNodeVisitor < TreeNodeVisitor
 
-  def initialize( *args )
-    super( *args )
+  def initialize
     @depth = 0
   end
 
-  def visit_leaf_node( leafNode )
-    str = ""
-    (0...@depth-1).step {
-      str << " |-"
-    }
-    str << " |  "
-    puts str + leafNode.name.to_s
-  end
-
-  def enter_tree_node( treeNode )
+  def enter_tree_node( tree_node )
 
     str = ""
     (0...@depth).step {
@@ -25,14 +15,24 @@ class PrintTreeNodeVisitor < TreeNodeVisitor
     }
 
     if @depth == 0
-      puts str + treeNode.name.to_s
+      puts str + tree_node.name.to_s
     else
-      puts str + treeNode.name.to_s
+      puts str + tree_node.name.to_s
     end
     @depth += 1
   end
 
-  def exit_tree_node( treeNode )
+  def exit_tree_node( tree_node )
     @depth -= 1
   end
+
+  def visit_leaf_node( leaf_node )
+    str = ""
+    (0...@depth-1).step {
+      str << " |-"
+    }
+    str << " |  "
+    puts str + leaf_node.name.to_s
+  end
+
 end

data/lib/treevisitor/visitors/print_tree_node_visitor2.rb

@@ -3,20 +3,10 @@
 # TODO: join this with PrintTreeNodeVisitor
 class PrintTreeNodeVisitor2 < TreeNodeVisitor
 
-  def initialize( *args )
-    super( *args )
+  def initialize
     @depth = 0
   end
 
-  def visit_leaf_node( leaf_node )
-    str = ""
-    (0...@depth-1).step {
-      str << " |-"
-    }
-    str << " |  "
-    puts str + leaf_node.to_s
-  end
-
   def enter_tree_node( tree_node )
 
     str = ""
@@ -35,4 +25,14 @@ class PrintTreeNodeVisitor2 < TreeNodeVisitor
   def exit_tree_node( tree_node )
     @depth -= 1
   end
+
+  def visit_leaf_node( leaf_node )
+    str = ""
+    (0...@depth-1).step {
+      str << " |-"
+    }
+    str << " |  "
+    puts str + leaf_node.to_s
+  end
+
 end

data/test/treevisitor/tc_dir_tree_walker.rb

@@ -2,6 +2,8 @@ require File.join(File.dirname(__FILE__), "test_helper")
 
 require 'treevisitor/dir_tree_walker.rb'
 require 'treevisitor/tree_node_visitor.rb'
+require 'treevisitor/visitors/block_tree_node_visitor.rb'
+
 
 class TCDirTreeWalker < Test::Unit::TestCase
 

data/test/treevisitor/tc_tree_node.rb

@@ -72,11 +72,11 @@ class TCTreeNode < Test::Unit::TestCase
     
     assert_equal( 4, ta.nr_nodes )
     assert_equal( 3, ta.nr_leaves )
-    assert_equal( 1, ta.nr_childs )
+    assert_equal( 1, ta.nr_children )
     
     assert_equal( 1, tb.nr_nodes )
     assert_equal( 1, tb.nr_leaves )
-    assert_equal( 0, tb.nr_childs )
+    assert_equal( 0, tb.nr_children )
   end
   
   def test_prefix_path

data/test/treevisitor/tc_tree_node_visitor.rb

@@ -36,14 +36,14 @@ class TCTreeNodeVisitor < Test::Unit::TestCase
     
     visitor = CloneTreeNodeVisitor.new
     @tree.accept( visitor )
-    assert_equal(@tree.nr_nodes, visitor.clonedRoot.nr_nodes )
+    assert_equal(@tree.nr_nodes, visitor.cloned_root.nr_nodes )
   end
   
   def test_callback_tree_node_visitor
     accumulator = []
     visitor = CallbackTreeNodeVisitor.new
-    visitor.onEnterTreeNode{ |treeNode| accumulator << treeNode.name }
-    visitor.onVisitLeafNode{ |leafNode| accumulator << leafNode.name }
+    visitor.on_enter_tree_node{ |treeNode| accumulator << treeNode.name }
+    visitor.on_visit_leaf_node{ |leafNode| accumulator << leafNode.name }
     @tree.accept( visitor )
     assert_equal( 5, accumulator.length )
     assert_equal( %w{ a 1 2 b 3 }, accumulator )
@@ -51,10 +51,10 @@ class TCTreeNodeVisitor < Test::Unit::TestCase
   
   def test_callback_tree_node_visitor2
     visitor = CallbackTreeNodeVisitor2.new
-    visitor.onEnterTreeNode{ |treeNode, newParentNode| 
+    visitor.on_enter_tree_node{ |treeNode, newParentNode|
       TreeNode.new("n" + treeNode.name, newParentNode) 
     }
-    visitor.onVisitLeafNode{ |leafNode, newParentNode| 
+    visitor.on_visit_leaf_node{ |leafNode, newParentNode|
       LeafNode.new( "n" + leafNode.name, newParentNode )
     }
     @tree.accept( visitor )

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gf-treevisitor
 version: !ruby/object:Gem::Version 
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors: 
 - gf
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-02 00:00:00 -07:00
+date: 2009-06-06 00:00:00 -07:00
 default_executable: tree.rb
 dependencies: 
 - !ruby/object:Gem::Dependency