tree.rb 0.3.0

data/lib/treevisitor/visitors/print_dir_tree_visitor.rb

@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+module TreeVisitor
+  #
+  # Visitor for DirTreeWalker
+  # Prints the node at enter
+  # TODO: join this con PrintTreeNodeVisitor
+  class PrintDirTreeVisitor # < BasicTreeNodeVisitor
+
+    def enter_node( pathname )
+      puts pathname
+    end
+
+    def exit_node( pathname )
+    end
+
+    def visit_leaf( pathname )
+      puts pathname
+    end
+
+  end
+end

data/lib/treevisitor/visitors/print_tree_node_visitor.rb

@@ -0,0 +1,40 @@
+# -*- coding: utf-8 -*-
+module TreeVisitor
+  #
+  # Prints TreeNode names indenting according to depth
+  #
+  class PrintTreeNodeVisitor # < BasicTreeNodeVisitor
+
+    def initialize
+      @depth = 0
+    end
+
+    def enter_node( tree_node )
+      str = ""
+      (0...@depth).step {
+        str << " |-"
+      }
+
+      if @depth == 0
+        puts str + tree_node.name.to_s
+      else
+        puts str + tree_node.name.to_s
+      end
+      @depth += 1
+    end
+
+    def exit_node( tree_node )
+      @depth -= 1
+    end
+
+    def visit_leaf( leaf_node )
+      str = ""
+      (0...@depth-1).step {
+        str << " |-"
+      }
+      str << " |  "
+      puts str + leaf_node.name.to_s
+    end
+
+  end
+end

data/lib/treevisitor.rb

@@ -0,0 +1,40 @@
+# -*- coding: utf-8 -*-
+
+#
+# std lib
+#
+require 'pathname'
+require 'yaml'
+
+#
+# rubygems
+#
+# require 'rubygems' # rubygems must be loaded from binary file (tree.rb) so $LOAD_PATH is not modified
+require 'json'
+require 'ansi/code'
+
+#
+# treevisitor
+#
+
+require "treevisitor/version"
+require "treevisitor/abs_node"
+require 'treevisitor/leaf_node'
+require 'treevisitor/tree_node'
+require 'treevisitor/basic_tree_node_visitor'
+require 'treevisitor/tree_node_visitor'
+
+require 'treevisitor/directory_walker'
+
+#
+# visitors
+#
+require 'treevisitor/visitors/block_tree_node_visitor'
+require 'treevisitor/visitors/build_dir_tree_visitor'
+require 'treevisitor/visitors/callback_tree_node_visitor2'
+require 'treevisitor/visitors/clone_tree_node_visitor'
+require 'treevisitor/visitors/depth_tree_node_visitor'
+require 'treevisitor/visitors/print_dir_tree_visitor'
+require 'treevisitor/visitors/directory_to_hash_visitor'
+
+require 'treevisitor/util/dir_processor'

data/lib/treevisitor_cli.rb

@@ -0,0 +1,7 @@
+#
+# cli
+#
+
+require 'optparse'
+require 'treevisitor'
+require "treevisitor/cli/cli_tree"

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+#
+# std lib
+#
+require "stringio"
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'treevisitor'
+require 'treevisitor_cli'
+include TreeVisitor
+
+FIXTURES = File.expand_path( File.join( File.dirname(__FILE__), "fixtures" ) )
+
+def with_output_captured
+  old_stdout, old_stderr = $stdout, $stderr
+  out = StringIO.new
+  err = StringIO.new
+  $stdout = out
+  $stderr = err
+  begin
+    yield
+  ensure
+    $stdout = old_stdout
+    $stderr = old_stderr
+  end
+  { :stdout => out.string, :stderr => err.string }
+end

data/spec/treevisitor/cli/cli_tree_spec.rb

@@ -0,0 +1,69 @@
+# -*- coding: utf-8 -*-
+require File.join(File.dirname(__FILE__), "..", "..", "spec_helper")
+
+describe CliTree do
+
+  it "help message" do
+    out = with_output_captured do
+      args = %w{-h}
+      CliTree.new.parse_args(args)
+    end
+    out[:stdout].should match /Usage:/
+  end
+
+  it "version" do
+    out = with_output_captured do
+      args = %w{--version}
+      CliTree.new.parse_args(args)
+    end
+    version = TreeVisitor::VERSION
+    out[:stdout].should match version
+  end
+
+  it "should accepts switch -d (directories only)" do
+    out = with_output_captured do
+      args = %w{-d}
+      args << File.join(FIXTURES, "test_dir_1")
+      CliTree.new.parse_args(args)
+    end
+    # puts out
+    out[:stdout].split("\n").length.should == 6
+
+    out = with_output_captured do
+      args = %w{-da}
+      args << File.join(FIXTURES, "test_dir_1")
+      CliTree.new.parse_args(args)
+    end
+    # puts out
+    out[:stdout].split("\n").length.should == 7
+  end
+
+  it "should accepts switch -a (all files)" do
+    out = with_output_captured do
+      args = %w{-a}
+      args << File.join(FIXTURES, "test_dir_1")
+      CliTree.new.parse_args(args)
+    end
+    # pp out
+    out[:stdout].split("\n").length.should == 11
+
+    out = with_output_captured do
+      args = []
+      args << File.join(FIXTURES, "test_dir_1")
+      CliTree.new.parse_args(args)
+    end
+    # puts out
+    out[:stdout].split("\n").length.should == 9
+  end
+
+  it "should show tree with inaccessible directories" do
+    out = with_output_captured do
+      args = []
+      args << File.join(FIXTURES, "test_dir_3_with_error")
+      CliTree.new.parse_args(args)
+    end
+    puts out
+    out[:stderr].should_not be_empty
+    out[:stdout].split("\n").length.should == 4
+  end
+end

data/spec/treevisitor/directory_walker_spec.rb

@@ -0,0 +1,99 @@
+# -*- coding: utf-8 -*-
+require File.join(File.dirname(__FILE__), "..", "spec_helper")
+
+describe DirTreeWalker do
+
+  it "should accept option :ignore" do
+    walker = DirTreeWalker.new :ignore => /^\./
+    walker.ignore_file?(".thumbnails").should be_true
+    walker.ignore_dir?(".thumbnails").should be_true
+  end
+
+  it "should accept option :ignore" do
+    walker = DirTreeWalker.new :ignore => ".git"
+    walker.ignore_file?(".git").should be_true
+    walker.ignore_dir?(".git").should be_true
+  end
+
+
+  it "should accept option :ignore_dir" do
+    dtw = DirTreeWalker.new :ignore_dir => [/^\./, "private_dir" ]
+    dtw.should be_ignore_dir ".git"
+    dtw.should be_ignore_dir "private_dir"
+  end
+
+  it "should accept option :ignore_file" do
+    dtw = DirTreeWalker.new :ignore_file => [/.xml/, /(ignore)|(orig)/ ]
+    dtw.should be_ignore_file "pippo.xml"
+  end
+
+  it "should accept option :match" do
+    dtw = DirTreeWalker.new :match => /.jpg/
+    dtw.should be_match "foo.jpg"
+  end
+
+  it "should ignore files and directory" do
+    walker = DirTreeWalker.new(".")
+
+    walker.ignore(/^\./)
+    walker.ignore_file?(".thumbnails").should be_true
+    walker.ignore_dir?(".thumbnails").should be_true
+
+    walker.ignore_dir("thumbnails")
+    walker.ignore_dir?(".thumbnails").should be_true
+    walker.ignore_dir?("thumbnails").should be_true
+    walker.ignore_dir?("pippo").should be_false
+
+    walker.ignore_file("xvpics")
+    walker.ignore_file?("xvpics").should be_true
+
+    walker.ignore("sub")
+    walker.ignore_file?("[Dsube]").should be_false
+    walker.ignore_dir?("[Dsube]").should be_false
+  end
+
+  it "should accumulate file names" do
+    dir_tree_walker = DirTreeWalker.new(File.join(FIXTURES, "test_dir_1"))
+
+    accumulator     = []
+    visitor         = BlockTreeNodeVisitor.new { |pathname| accumulator << File.basename(pathname) }
+    dir_tree_walker.run(visitor)
+    accumulator.length.should == 9
+    accumulator.sort.should == %w{ test_dir_1 dir.1 dir.1.2 file.1.2.1 file.1.1 dir.2 file.2.1 .dir_with_dot dummy.txt }.sort
+  end
+
+  it "should accumulate file names 2" do
+    dir_tree_walker = DirTreeWalker.new(File.join(FIXTURES, "test_dir_2"))
+    dir_tree_walker.ignore("sub")
+
+    accumulator = []
+    visitor     = BlockTreeNodeVisitor.new { |pathname| accumulator << File.basename(pathname) }
+    dir_tree_walker.run(visitor)
+    accumulator.length.should == 2
+    accumulator.sort.should == %w{ [Dsube] test_dir_2 }.sort
+  end
+
+  it "should ignore not accessible directory" do
+
+    dir = File.join(FIXTURES, "test_dir_3_with_error")
+
+    f1 = File.join(dir, "no_accessible_dir")
+    Dir.rmdir(f1) if File.exist?(f1)
+    Dir.mkdir(f1, 0000)
+
+    f2 = File.join(dir, "accessible_dir")
+    Dir.rmdir(f2) if File.exist?(f2)
+    Dir.mkdir(f2)
+
+    dir_tree_walker = DirTreeWalker.new(File.join(FIXTURES, "test_dir_3_with_error"))
+    accumulator = []
+    visitor     = BlockTreeNodeVisitor.new { |pathname| accumulator << File.basename(pathname) }
+    dir_tree_walker.run(visitor)
+    accumulator.length.should == 2
+    accumulator.sort.should == %w{accessible_dir test_dir_3_with_error }.sort
+
+    # Dir.rmdir(f1)
+    # Dir.rmdir(f2)
+  end
+
+end

data/spec/treevisitor/tree_dsl_spec.rb

@@ -0,0 +1,57 @@
+# -*- coding: utf-8 -*-
+require File.join(File.dirname(__FILE__), "..", "spec_helper")
+
+describe "TreeNodeDsl" do
+
+  it "should build tree with dsl" do
+    tree = TreeNode.create do
+      node "root" do
+        leaf "l1"
+        leaf "l2"
+        node "sub" do
+          leaf "l3"
+        end
+        node "wo leaves"
+      end
+    end
+
+    # puts tree.to_str
+    out =<<EOS
+root
+|-- l1
+|-- l2
+|-- sub
+|   `-- l3
+`-- wo leaves
+EOS
+    tree.to_str.should == out
+  end
+
+  it "test_dsl_block_with_arg" do
+    tree = TreeNode.create do
+      node "root" do |node|
+        node.prefix_path=("pre/")        
+        leaf "l1"
+        leaf "l2"
+        node "sub" do
+          leaf "l3" do |leaf|            
+          end
+        end
+        node "woleaves"
+      end
+    end
+
+    # puts tree.to_str
+    out =<<EOS
+root
+|-- l1
+|-- l2
+|-- sub
+|   `-- l3
+`-- woleaves
+EOS
+    tree.to_str.should ==  out
+    tree.find("l3").path_with_prefix.should == "pre/root/sub/l3"
+  end
+
+end

data/spec/treevisitor/tree_dsl_with_derived_class1_spec.rb

@@ -0,0 +1,53 @@
+# -*- coding: utf-8 -*-
+require File.join(File.dirname(__FILE__), "..", "spec_helper")
+
+describe "Tree Node Dsl Derived Class with n-arg constructor" do
+
+  class ArgsTreeNode < TreeNode
+    attr_reader :description
+
+    def initialize(name, description, parent)
+      super(name, parent)
+      @description =  description
+    end
+
+    def to_s
+      "a: #{description}"
+    end
+  end
+
+  class ArgsLeafNode < LeafNode
+    attr_reader :description
+
+    def initialize(name, description, parent)
+      super(name, parent)
+      @description =  description
+    end
+
+    def to_s
+      "a: #{description}"
+    end
+  end
+
+  it "test_derivated_args" do
+    tree = TreeNode.create(ArgsTreeNode, ArgsLeafNode) do
+      node "root", "droot" do
+        leaf "l1", "dl1"
+        leaf "l2", "dl2"
+        node "sub", "dsub" do
+          leaf "l3", "dl3"
+        end
+      end
+    end
+
+    # puts tree.to_str
+    out =<<EOS
+a: droot
+|-- a: dl1
+|-- a: dl2
+`-- a: dsub
+    `-- a: dl3
+EOS
+    tree.to_str.should == out
+  end
+end

data/spec/treevisitor/tree_dsl_with_derived_class_spec.rb

@@ -0,0 +1,51 @@
+# -*- coding: utf-8 -*-
+require File.join(File.dirname(__FILE__), "..", "spec_helper")
+
+describe "Tree Node Dsl Derived Class with no-arg constructor " do
+
+  class DTreeNode < TreeNode
+    def to_s
+      "dt: #{content}"
+    end
+  end
+
+  class DLeafNode < LeafNode
+    def to_s
+      "dl: #{content}"
+    end
+  end
+
+  it "dsl with non-arg constructor" do
+    tree = TreeNode.create(DTreeNode, DLeafNode) do
+      node "root" do
+        leaf "l1"
+        leaf "l2"
+        node "sub" do
+          leaf "l3"
+        end
+      end
+    end
+
+    # puts tree.to_str
+    out =<<EOS
+dt: root
+|-- dl: l1
+|-- dl: l2
+`-- dt: sub
+    `-- dl: l3
+EOS
+    tree.to_str.should == out
+
+    tree = DTreeNode.create(DLeafNode) do
+      node "root" do
+        leaf "l1"
+        leaf "l2"
+        node "sub" do
+          leaf "l3"
+        end
+      end
+    end
+    tree.to_str.should == out
+  end
+
+end

data/spec/treevisitor/tree_node_paths_spec.rb

@@ -0,0 +1,70 @@
+# -*- coding: utf-8 -*-
+require File.join(File.dirname(__FILE__), "..", "spec_helper")
+
+describe TreeNode do
+
+  context "paths" do
+
+    before do
+      @tree     = TreeNode.new("a")
+      ln1       = LeafNode.new("1", @tree)
+      ln2       = LeafNode.new("2", @tree)
+      @sub_tree = TreeNode.new("b", @tree)
+      @ln3      = LeafNode.new("3", @sub_tree)
+      @ln4      = LeafNode.new("12", @sub_tree)
+    end
+
+    it "correct path" do
+      @tree.path.should == "a"
+      @sub_tree.path.should == "a/b"
+      @tree.path_with_prefix.should == "a"
+      @sub_tree.path_with_prefix.should == "a/b"
+    end
+
+    it "assign prefix path with a /" do
+      @tree.prefix_path= "<root>/"
+
+      @tree.prefix_path.should == "<root>/"
+      @tree.path.should == "a"
+      @sub_tree.path.should == "a/b"
+      @tree.path_with_prefix.should == "<root>/a"
+      @sub_tree.path_with_prefix.should == "<root>/a/b"
+    end
+
+    it "assign empty prefix path" do
+      @tree.prefix_path= ""
+
+      @tree.prefix_path.should == "/"
+      @tree.path.should == "a"
+      @sub_tree.path.should == "a/b"
+      @tree.path_with_prefix.should == "/a"
+      @sub_tree.path_with_prefix.should == "/a/b"
+    end
+
+    it "assign prefix path wo a /" do
+      @tree.prefix_path= "<root>"
+
+      @tree.prefix_path.should == "<root>/"
+      @tree.path_with_prefix.should == "<root>/a"
+      @sub_tree.path_with_prefix.should == "<root>/a/b"
+    end
+
+    it "invalidate" do
+      @tree.prefix_path="root/"
+      @sub_tree.path.should == "a/b"
+      @sub_tree.path_with_prefix.should == "root/a/b"
+      @sub_tree.depth.should == 2
+
+      r = TreeNode.new("r")
+      r.add_child(@tree)
+      @sub_tree.path.should == "r/a/b"
+      @sub_tree.path_with_prefix.should == "r/a/b"
+
+      r.prefix_path="new_root/"
+      @sub_tree.path.should == "r/a/b"
+      @sub_tree.path_with_prefix.should == "new_root/r/a/b"
+      @sub_tree.depth.should == 3
+    end
+
+  end
+end

data/spec/treevisitor/tree_node_spec.rb

@@ -0,0 +1,135 @@
+# -*- coding: utf-8 -*-
+require File.join(File.dirname(__FILE__), "..", "spec_helper")
+
+describe TreeNode do
+
+  it "should initialize correctly" do
+    ta = TreeNode.new("a")
+    ta.should be_root
+
+    ln1 = LeafNode.new("1", ta)
+    ln1.parent.should == ta
+    ln1.should_not be_root
+
+    ln2 = LeafNode.new("2", ta)
+    tb  = TreeNode.new("b", ta)
+    ln3 = LeafNode.new("3", tb)
+    ln3.parent.should == tb
+
+    # test depth
+    tb.depth.should == 2
+    ln3.depth.should == 3
+
+    # test nr_nodes
+    tb.nr_nodes.should == 1
+    ta.nr_nodes.should == 4
+
+    # puts ta.to_str
+  end
+
+  it "should add child and leaf" do
+    ta = TreeNode.new("a")
+    ta.should be_root
+
+    ln1 = LeafNode.new("1")
+    ta.add_leaf(ln1)
+    ln1.parent.should == ta
+
+    ln2 = LeafNode.new("2", ta)
+    ta.add_leaf(ln2)
+
+    tb  = TreeNode.new("b", ta)
+    ln3 = LeafNode.new("3", tb)
+    tb.add_leaf(ln3)
+    ln3.parent.should == tb
+
+    ta.add_child(tb)
+    # puts ta.to_str
+  end
+
+  it "next and prev" do
+    ta = TreeNode.new("a")
+    ta.prev.should be_nil
+    ta.next.should be_nil
+
+    ln1 = LeafNode.new("1", ta)
+    ln1.prev.should be_nil
+    ln1.next.should be_nil
+
+    ln2 = LeafNode.new("2", ta)
+    ln2.prev.should == ln1
+    ln2.next.should be_nil
+
+    ln3 = LeafNode.new("3", ta)
+    ln2.next.should == ln3
+
+    tb = TreeNode.new("b", ta)
+    tb.next.should be_nil
+    tb.prev.should be_nil
+
+    tc = TreeNode.new("c", ta)
+    tc.prev.should == tb
+    tc.next.should be_nil
+  end
+
+  context "navigate tree" do
+
+    before do
+      @tree     = TreeNode.new("a")
+      ln1       = LeafNode.new("1", @tree)
+      ln2       = LeafNode.new("2", @tree)
+      @sub_tree = TreeNode.new("b", @tree)
+      @ln3      = LeafNode.new("3", @sub_tree)
+      @ln4      = LeafNode.new("12", @sub_tree)
+    end
+
+    it "nr_nodes and nr_leaves and nr_children" do
+      @tree.nr_nodes.should == 5
+      @tree.nr_leaves.should == 4
+      @tree.nr_children.should == 1
+
+      @sub_tree.nr_nodes.should == 2
+      @sub_tree.nr_leaves.should == 2
+      @sub_tree.nr_children.should == 0
+    end
+
+
+    context "find" do
+
+      it "find by string" do
+        @tree.find("a").should === @tree
+        @tree.find("b").should === @sub_tree
+        @tree.find("3").should === @ln3
+        @tree.find("not existent").should be_nil
+      end
+
+      it "find by regex" do
+        @tree.find(/[a,b]/).should === @tree
+        @tree.find(/[b,c]/).should === @sub_tree
+        @tree.find(/\d\d/).should === @ln4
+        @tree.find(/not existent/).should be_nil
+      end
+
+      it "find with block" do
+        @tree.find { |e| e.content == "a" }.should === @tree
+        @tree.find { |e| e.content == "b" }.should === @sub_tree
+        @tree.find { |e| e.content == "3" }.should === @ln3
+        @tree.find { |e| e.content == "not existent" }.should be_nil
+      end
+
+      it "to_str" do
+        out = <<EOS
+a
+|-- 1
+|-- 2
+`-- b
+    |-- 3
+    `-- 12
+EOS
+        @tree.to_str.should == out
+      end
+
+    end
+
+  end
+end