tree.rb 0.3.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2009-2010 tokiro.oyama@gmail.com
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,160 @@
+tree.rb / tree visitor library
+================================================
+
+**tree.rb** is a 'clone' of tree unix command. 
+The gem contains also a library to build tree with a dsl (domain specific language), and 
+an implementation of visitor design pattern.
+
+## Usage as command line
+
+To use the command line tool tree.rb execute into command line tree.rb --help
+Try tree.rb -h to get help on command line.
+
+<pre>
+$ tree.rb --help
+Usage: tree.rb [options] [directory]
+list contents of directories in a tree-like format
+this is a almost :-) a clone of tree unix command written in ruby
+Code https://github.com/tokiro/treevisitor. Feedback to tokiro.oyama@gmail.com
+
+options: 
+    -h, --help                       Show this message
+        --version                    Show the version
+    -a                               All file are listed
+    -d                               List directories only
+    -v, --[no-]verbose               Run verbosely
+    -q, --quiet                      quiet mode as --no-verbose
+    -f, --format ALGO                select an algo
+                                       (b,v,j,y,build-dir,print-dir,json,yaml)
+</pre>
+
+To print the tree of a directory execute tree.rb with the name of the directory. 
+For example:
+
+<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_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_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/tree.rb/raw/master/examples/protovis/treevisitor.png'/>
+
+## Usage as library
+See examples directory to use treevisitor in your code.
+
+DSL to build tree:
+<pre>
+   tree = TreeNode.create do
+     node "root" do
+       leaf "l1"
+       node "sub" do
+         leaf "l3"
+       end
+       node "wo leaves"
+     end
+</pre>
+
+## Documentation
+
+http://rubydoc.info/gems/tree.rb
+
+
+## Installation
+
+To use the command line tool tree.rb, it is enough to install the gem:
+
+  [sudo] gem install tree.rb
+
+To use into your project, add this line to your application's Gemfile:
+
+    gem 'tree.rb'
+
+And then execute:
+
+    $ bundle
+
+## Contributing
+
+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!
+
+To contribute:
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+### Rubies
+
+This gem have been tested on [MRI][8] 1.9.3
+
+### Copyright
+
+Copyright (c) 2009-2012 tokiro.oyama@gmail.com. See LICENSE for details.
+
+[1]: http://vis.stanford.edu/protovis/
+[8]: http://www.ruby-lang.org/en/
+

data/Rakefile

@@ -0,0 +1,12 @@
+# -*- encoding: utf-8; mode: ruby -*-
+require 'rubygems'
+require 'rake'
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+# Load tasks
+Dir.glob('tasks/**/*.rake').each { |r| Rake.application.add_import r }
+
+task :test => :spec
+task :default => :spec

data/bin/tree.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+
+cwd = File.expand_path( File.join( File.dirname(__FILE__), "..", "lib" ) )
+$:.unshift(cwd) unless $:.include?(cwd)
+require 'treevisitor_cli'
+
+include TreeVisitor
+exit CliTree.run

data/examples/directory_walker/directory_without_subdirectory.rb

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+require 'ostruct'
+
+cwd = File.expand_path( File.join( File.dirname(__FILE__), "..", "..", "lib" ) )
+$:.unshift(cwd) unless $:.include?(cwd)
+require 'treevisitor'
+
+#
+# Find directories without subdirectories
+#
+class DirWithoutSubDir < TreeVisitor::BasicTreeNodeVisitor
+
+  def initialize
+    super
+    @stack = []
+    @nr = 0
+  end
+
+  def enter_node( pathname )
+    @nr += 1
+    info = OpenStruct.new(:nr => @nr, :pathname => pathname)
+    @stack.push( info )
+  end
+
+  def exit_node( pathname )
+    info = @stack.pop
+    if info.nr == @nr
+      puts "leaf: #{pathname}"
+    end
+  end
+
+end
+
+dtw = TreeVisitor::DirTreeWalker.new( ".." )
+dtw.ignore /^\./
+dtw.visit_file=false
+dtw.run( DirWithoutSubDir.new )

data/examples/directory_walker/find_files.rb

@@ -0,0 +1,18 @@
+# -*- coding: utf-8 -*-
+
+cwd = File.expand_path( File.join( File.dirname(__FILE__), "..", "..", "lib" ) )
+$:.unshift(cwd) unless $:.include?(cwd)
+require 'treevisitor'
+include TreeVisitor
+
+class MyVisitor < BasicTreeNodeVisitor
+  def visit_leaf( pathname )
+    puts pathname
+  end
+end
+
+dtw = DirTreeWalker.new( File.join(File.dirname(__FILE__), "..", ".." ) )
+dtw.match "leaf_node.rb"
+dtw.match "abs_node.rb"
+dtw.run( MyVisitor.new )
+

data/examples/directory_walker/print_files.rb

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

data/examples/protovis/directory_to_json_visitor.rb

@@ -0,0 +1,15 @@
+# -*- coding: utf-8 -*-
+
+require 'rubygems'
+
+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-r3.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>