treevisitor 0.1.5 → 0.1.6

data/README.md

@@ -0,0 +1,104 @@
+tree.rb / tree visitor library
+================================================
+
+**tree.rb** is a 'clone' of tree unix command. It is based on tree visitor library.
+Tree visitor is an implementation of visitor design pattern.
+
+<pre>
+ $ tree.rb lib
+
+  lib
+ |-- tree_visitor.rb
+ |-- treevisitor.rb
+ |-- treevisitor_cli.rb
+ `-- treevisitor
+     |-- abs_node.rb
+     |-- dir_processor.rb
+     |-- dir_tree_walker.rb
+     |-- leaf_node.rb
+     |-- tree_node.rb
+     |-- tree_node_visitor.rb
+     |-- cli
+     |   `-- cli_tree.rb
+     `-- visitors
+         |-- block_tree_node_visitor.rb
+         |-- build_dir_tree_visitor.rb
+         |-- callback_tree_node_visitor.rb
+         |-- callback_tree_node_visitor2.rb
+         |-- clone_tree_node_visitor.rb
+         |-- depth_tree_node_visitor.rb
+         |-- flat_print_tree_node_visitors.rb
+         |-- print_dir_tree_visitor.rb
+         `-- print_tree_node_visitor.rb
+</pre>
+
+The **tree.rb** can generate json structure suitable to be visualized with [protovis][1] javascript library.
+See the examples directory.
+
+<pre>
+$ ruby bin/tree.rb --format json lib
+
+{
+  "lib": {
+    "tree_visitor.rb": 45,
+    "treevisitor": {
+      "abs_node.rb": 2858,
+      "basic_tree_node_visitor.rb": 578,
+      "cli": {
+        "cli_tree.rb": 2929
+      },
+      "directory_walker.rb": 5049,
+      "leaf_node.rb": 526,
+      "tree_node.rb": 5665,
+      "tree_node_visitor.rb": 1263,
+      "util": {
+        "dir_processor.rb": 928
+      },
+      "visitors": {
+        "block_tree_node_visitor.rb": 386,
+        "build_dir_tree_visitor.rb": 1167,
+        "callback_tree_node_visitor.rb": 1029,
+        "callback_tree_node_visitor2.rb": 1652,
+        "clone_tree_node_visitor.rb": 837,
+        "depth_tree_node_visitor.rb": 427,
+        "directory_to_hash_visitor.rb": 639,
+        "flat_print_tree_node_visitors.rb": 341,
+        "print_dir_tree_visitor.rb": 387,
+        "print_tree_node_visitor.rb": 707
+      }
+    },
+    "treevisitor.rb": 976,
+    "treevisitor_cli.rb": 87
+  }
+</pre>
+
+The json structure can be transformed into image:
+
+<img src='https://github.com/tokiro/treevisitor/raw/master/examples/protovis/treevisitor.png'/>
+
+### Documentation
+
+http://rubydoc.info/gems/treevisitor
+
+Try tree.rb -h to get help on command line.
+See examples directory to use treevisitor in your code.
+
+### INSTALL:
+
+  sudo gem install treevisitor
+
+### Contributions
+
+Everybody is welcome to contribute to this project by commenting the source code, suggesting modifications or new ideas,
+reporting bugs, writing some documentation and, of course, you're also welcome to contribute with patches as well!
+
+### Rubies
+
+This gem have been tested on [MRI][8] 1.9.2.
+
+### Copyright
+
+Copyright (c) 2009-2011 tokiro.oyama@gmail.com. See LICENSE for details.
+
+[1]: http://vis.stanford.edu/protovis/
+[8]: http://www.ruby-lang.org/en/

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
 :major: 0
 :minor: 1
-:patch: 5
+:patch: 6
 :build: 

data/examples/{directory_without_subdirectory.rb → directory_walker/directory_without_subdirectory.rb}

@@ -1,12 +1,14 @@
-cwd = File.expand_path( File.join( File.dirname(__FILE__), "..", "lib" ) )
+# -*- coding: utf-8 -*-
+require 'ostruct'
+
+cwd = File.expand_path( File.join( File.dirname(__FILE__), "..", "..", "lib" ) )
 $:.unshift(cwd) unless $:.include?(cwd)
 require 'treevisitor'
 
-require 'ostruct'
 #
-# Find directory without subdirectories
+# Find directories without subdirectories
 #
-class DirWithoutSubDir < TreeVisitor::TreeNodeVisitor
+class DirWithoutSubDir < TreeVisitor::BasicTreeNodeVisitor
 
   def initialize
     super

data/examples/{find_files.rb → directory_walker/find_files.rb}

@@ -1,10 +1,11 @@
-cwd = File.expand_path( File.join( File.dirname(__FILE__), "..", "lib" ) )
+# -*- coding: utf-8 -*-
+
+cwd = File.expand_path( File.join( File.dirname(__FILE__), "..", "..", "lib" ) )
 $:.unshift(cwd) unless $:.include?(cwd)
 require 'treevisitor'
-
 include TreeVisitor
 
-class MyVisitor < TreeNodeVisitor
+class MyVisitor < BasicTreeNodeVisitor
   def visit_leaf_node( pathname )
     puts pathname
   end

data/examples/{print_files.rb → directory_walker/print_files.rb}

@@ -1,15 +1,12 @@
-cwd = File.expand_path( File.join( File.dirname(__FILE__), "..", "lib" ) )
+# -*- coding: utf-8 -*-
+cwd = File.expand_path( File.join( File.dirname(__FILE__), "..", "..", "lib" ) )
 $:.unshift(cwd) unless $:.include?(cwd)
 require 'treevisitor'
-
 include TreeVisitor
 
-class MyVisitor < TreeNodeVisitor
-  def visit_leaf_node( pathname )
+dtw = DirTreeWalker.new( :ignore => ".git" )
+dtw.run ".." do
+  on_visit_leaf_node do |pathname|
     puts pathname
   end
 end
-
-dtw = DirTreeWalker.new( ".." )
-dtw.ignore ".git"
-dtw.run( MyVisitor.new )

data/examples/protovis/directory_to_json_visitor.rb

@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+
+cwd = File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "lib"))
+$:.unshift(cwd) unless $:.include?(cwd)
+require 'treevisitor'
+include TreeVisitor
+
+dir = File.expand_path( File.join("..", "..", "lib") )
+
+dtw = TreeVisitor::DirTreeWalker.new( :ignore => [/^\./, "doc", "pkg"] )
+root = dtw.run(dir, DirectoryToHashVisitor.new(dir)).root
+str =  "var treevisitor = #{JSON.pretty_generate(root)};"
+File.open( File.dirname(__FILE__) + "/treevisitor.js", "w"){ |f| f.write str }

data/examples/protovis/index.html

@@ -0,0 +1,87 @@
+<html>
+  <head>
+    <title>Indented Tree</title>
+    <script type="text/javascript" src="protovis-d3.2.js"></script>
+    <script type="text/javascript" src="treevisitor.js"></script>
+
+  <style type="text/css">
+      body {
+        margin: 0;
+        display: table;
+        height: 100%;
+        width: 100%;
+        font: 14px/134% Helvetica Neue, sans-serif;
+      }
+
+      #center {
+        display: table-cell;
+        vertical-align: middle;
+      }
+
+      #fig {
+        position: relative;
+        margin: auto;
+      }
+
+  </style>
+  </head>
+  <body>
+
+
+    <script type="text/javascript+protovis">
+
+for (first in treevisitor) break;
+
+var root = pv.dom(treevisitor)
+    .root(first)
+    .sort(function(a, b) pv.naturalOrder(a.nodeName, b.nodeName));
+
+/* Recursively compute the package sizes. */
+root.visitAfter(function(n) {
+  if (n.firstChild) {
+    n.nodeValue = pv.sum(n.childNodes, function(n) n.nodeValue);
+  }
+});
+
+var vis = new pv.Panel()
+    .width(400)
+    .height(function() (root.nodes().length + 1) * 12)
+    .margin(5);
+
+var layout = vis.add(pv.Layout.Indent)
+    .nodes(function() root.nodes())
+    .depth(25)
+    .breadth(12);
+
+layout.link.add(pv.Line);
+
+var node = layout.node.add(pv.Panel)
+    .top(function(n) n.y - 6)
+    .height(12)
+    .right(6)
+    .strokeStyle(null)
+    .events("all")
+    .event("mousedown", toggle);
+
+node.anchor("left").add(pv.Dot)
+    .strokeStyle("#1f77b4")
+    .fillStyle(function(n) n.toggled ? "#1f77b4" : n.firstChild ? "#aec7e8" : "#ff7f0e")
+    .title(function t(d) d.parentNode ? (t(d.parentNode) + "." + d.nodeName) : d.nodeName)
+  .anchor("right").add(pv.Label)
+    .text(function(n) n.nodeName);
+
+node.anchor("right").add(pv.Label)
+    .textStyle(function(n) n.firstChild || n.toggled ? "#aaa" : "#000")
+    .text(function(n) (n.nodeValue >> 10) + "KB");
+
+vis.render();
+
+/* Toggles the selected node, then updates the layout. */
+function toggle(n) {
+  n.toggle(pv.event.altKey);
+  return layout.reset().root;
+}
+
+    </script>
+  </body>
+</html>