treevisitor 0.1.4

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.rdoc

@@ -0,0 +1,42 @@
+= 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.
+
+ $ 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
+
+== Documentation
+
+http://rubydoc.info/gems/treevisitor
+
+== INSTALL:
+
+  sudo gem install treevisitor
+
+== Copyright
+
+Copyright (c) 2009-2010 tokiro.oyama@gmail.com. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'rake'
+
+# Load tasks
+Dir.glob('tasks/**/*.rake').each { |r| Rake.application.add_import r }
+
+task :test => :check_dependencies
+task :default => :spec
+

data/VERSION.yml

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

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/find_files.rb

@@ -0,0 +1,17 @@
+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 )
+    puts pathname
+  end
+end
+
+dtw = DirTreeWalker.new( ".." )
+dtw.match "leaf_node.rb"
+dtw.match "abs_node.rb"
+dtw.run( MyVisitor.new )
+

data/examples/print_files.rb

@@ -0,0 +1,15 @@
+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 )
+    puts pathname
+  end
+end
+
+dtw = DirTreeWalker.new( ".." )
+dtw.ignore ".git"
+dtw.run( MyVisitor.new )

data/lib/tree_visitor.rb

@@ -0,0 +1,2 @@
+# -*- coding: utf-8 -*-
+require 'treevisitor'

data/lib/treevisitor.rb

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+# rubygems
+require "rubygems"
+require "abstract"
+require 'pathname'
+require 'yaml'
+
+module TreeVisitor
+  def self.version
+    cwd = Pathname(__FILE__).dirname.expand_path.to_s
+    yaml = YAML.load_file(cwd + '/../VERSION.yml')
+    major = (yaml['major'] || yaml[:major]).to_i
+    minor = (yaml['minor'] || yaml[:minor]).to_i
+    patch = (yaml['patch'] || yaml[:patch]).to_i
+    "#{major}.#{minor}.#{patch}"
+  end
+end
+
+
+require "treevisitor/abs_node"
+require 'treevisitor/leaf_node'
+require 'treevisitor/tree_node_visitor.rb'
+
+require 'treevisitor/tree_node'
+require 'treevisitor/dir_tree_walker'
+require 'treevisitor/tree_node_visitor'
+require 'treevisitor/dir_processor'
+
+require 'treevisitor/visitors/block_tree_node_visitor.rb'
+require 'treevisitor/visitors/build_dir_tree_visitor'
+require 'treevisitor/visitors/print_dir_tree_visitor'

data/lib/treevisitor/abs_node.rb

@@ -0,0 +1,146 @@
+# -*- coding: utf-8 -*-
+module TreeVisitor
+
+  #
+  # @abstract Subclass to implement a concrete Node (Leaf or Tree).
+  #
+  # Abstract Node
+  #   Class hierarchy
+  #
+  #   AbsNode has a name, a parent
+  #    ^      and define a path i.e. concatenation ancestor names
+  #    |
+  #    |-- LeafNode
+  #    |
+  #    `-- 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 :content
+  
+    attr_accessor :prev
+    attr_accessor :next
+
+    #
+    # Create a new AbsNode
+    #
+    # @param content of node
+    #
+    def initialize( content )
+      @parent = nil
+      @content = content
+      @prefix_path = nil
+      invalidate
+    end
+  
+    #
+    # invalidate cached path info
+    #
+    def invalidate
+      @path = nil
+      @path_with_prefix = nil
+      @depth = nil
+      @root = nil
+    end
+
+    #
+    # Root node could have assigned a path
+    #
+    def prefix_path
+      if not @parent.nil?
+        raise "Not root!!"
+      end
+      @prefix_path
+    end
+  
+    def prefix_path=( prefix )
+      if not @parent.nil?
+        raise "Not root!!"
+      end
+      if prefix != @prefix_path
+        @prefix_path = prefix
+        invalidate
+      end
+    end
+
+    #
+    # Return the root of this node
+    #
+    # @return AbsNode
+    #
+    def root
+      return @root if @root
+      @root = parent.nil? ? self : parent.root
+    end
+
+    #
+    # @return [String] path to this node
+    #
+    def path
+      return @path unless @path.nil?
+      if @parent.nil?
+        @path = @content
+      else
+        @path = @parent.path + AbsNode::path_separator + @content
+      end
+      @path
+    end
+
+    #
+    # @return [String] path to this node with prefix
+    #
+    def path_with_prefix
+      return @path_with_prefix unless @path_with_prefix.nil?
+      if @parent.nil?
+        @path_with_prefix = @prefix_path.nil? ? @content : @prefix_path + @content
+      else
+        @path_with_prefix = @parent.path_with_prefix + AbsNode::path_separator + @content
+      end
+      @path_with_prefix
+    end
+
+    #
+    # @return [FixNum] depth of this node
+    #
+    def depth
+      return @depth unless @depth.nil?
+      @depth = @parent.nil? ? 1 : @parent.depth + 1
+      @depth
+    end
+
+    #
+    # Accept a node visitor
+    #
+    def accept( visitor )
+      not_implemented
+    end
+
+    def to_s
+      @content.to_s
+    end
+
+    protected
+
+    def parent=( parent )
+      @parent = parent
+    end
+
+  end
+end

data/lib/treevisitor/cli/cli_tree.rb

@@ -0,0 +1,98 @@
+# -*- coding: utf-8 -*-
+module TreeVisitor
+  #
+  #
+  #
+  class CliTree
+
+    def self.run
+      self.new.parse_args( ARGV )
+    end
+
+    def parse_args( argv )
+
+      options = { :verbose => true, :force => false, :algo => 'build' }
+
+      opts = OptionParser.new
+      opts.banner = "Usage: tree.rb [options] [directory]"
+    
+      opts.separator ""
+      opts.separator "list contents of directories in a tree-like format"
+      opts.separator "this is a clone of tree unix command written in ruby"
+    
+      opts.separator ""
+      opts.separator "options: "
+    
+      opts.on("-h", "--help", "Show this message") do
+        puts opts
+        return 0
+      end
+
+      opts.on("--version", "Show the version") do
+        puts "tree.rb version #{TreeVisitor::version}"
+        return 0
+      end
+
+      opts.on("-a", "All file are listed") do |v|
+        options[:all_files] = true
+      end
+
+      opts.on("-d", "List directories only") do |v|
+        options[:only_directories] = true
+      end
+
+      opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+        options[:verbose] = v
+      end
+
+      opts.on("-q", "--quiet", "quiet mode as --no-verbose") do |v|
+        options[:verbose] = false
+      end
+    
+      algos = %w[build visit]
+      algo_aliases = { "b" => "build", "v" => "visit" }
+
+      algo_list = (algo_aliases.keys + algos).join(',')
+      opts.on("--algo ALGO", algos, algo_aliases, "Select algo","  (#{algo_list})") do |algo|
+        options[:algo] = algo
+      end
+
+      rest = opts.parse(argv)
+
+      # p options
+      # p ARGV
+
+      if rest.length < 1
+        puts opts
+        return 1
+      end
+
+      dirname = rest[0]
+      dirname = File.expand_path( dirname )
+
+      # puts "reading : #{dirname}"
+
+      dtw = DirTreeWalker.new( dirname )
+      unless options[:all_files]
+        # TODO: la regex e' corretta ed un file che inizia con ".."??
+        dtw.ignore(/^\.[^.]+/) # ignore all file starting with "."
+      end
+
+      dtw.visit_leaf = !options[:only_directories]
+
+      case options[:algo]
+      when 'build'
+        visitor = BuildDirTreeVisitor.new
+        dtw.run( visitor )
+        puts visitor.root.to_str
+        puts
+        puts "#{visitor.nr_directories} directories, #{visitor.nr_files} files"
+      when 'visit'
+        visitor = PrintDirTreeVisitor.new
+        dtw.run( visitor )
+      end
+      return 0
+    end
+
+  end
+end

data/lib/treevisitor/dir_processor.rb

@@ -0,0 +1,46 @@
+# -*- coding: utf-8 -*-
+module TreeVisitor
+
+  #
+  # Visit a directory tree
+  # not TreeNode related
+  #
+  class DirProcessor
+
+    def initialize( &action )
+      @processors = {}
+      @default_processor = action
+    end
+
+    def add_processor( re, &action )
+      @processors[ re ] = action
+    end
+
+    def process( dirname )
+      @dirname = dirname
+      old_dirname = Dir.pwd
+      Dir.chdir( @dirname )
+      Dir["**/*"].each { |f|
+        pn = Pathname.new( f ).expand_path
+        # puts "#{self.class.name}#loadfromdir #{f}"
+        next if pn.directory?
+        process_file( pn )
+      }
+      Dir.chdir( old_dirname )
+      self
+    end
+
+    private
+  
+    def process_file( pn )
+      # puts "file: #{f}"
+      pair = @processors.find { |re,action| re =~ pn.to_s }
+      unless pair.nil?
+        pair[1].call( pn )
+      else
+        @default_processor.call( pn ) if @default_processor
+      end
+    end
+
+  end
+end