tree.rb 0.3.2 → 0.3.3

data/lib/tree_rb.rb

@@ -18,6 +18,9 @@ require 'ansi/code'
 #
 
 require "tree_rb/version"
+require "tree_rb/extension_md5"
+require "tree_rb/extension_numeric"
+
 require "tree_rb/abs_node"
 require 'tree_rb/leaf_node'
 require 'tree_rb/tree_node'

data/lib/tree_rb/abs_node.rb

@@ -130,10 +130,6 @@ module TreeRb
       not_implemented
     end
 
-    def to_s
-      @content.to_s
-    end
-
     protected
 
     def parent=(parent)

data/lib/tree_rb/cli/cli_tree.rb

@@ -22,7 +22,7 @@ module TreeRb
       opts.separator ""
       opts.separator "options: "
 
-      opts.on("-h", "--help", "Show this message") do
+      opts.on("--help", "Show this message") do
         puts opts
         return 0
       end
@@ -78,6 +78,25 @@ module TreeRb
         options[:show_size] = true
       end
 
+      msg =<<-EOS
+       Print the size of each file but in a more human readable way, e.g. appending  a  size  letter  for  kilobytes  (K),
+              megabytes (M), gigabytes (G), terrabytes (T), petabytes (P) and exabytes (E).
+      EOS
+
+      opts.on("-h", msg) do
+        options[:show_size_human] = true
+      end
+
+      options[:show_indentation] = true
+      opts.on("-i", "Makes tree not print the indentation lines, useful when used in conjunction with the -f option.") do
+        options[:show_indentation] = false
+      end
+
+      options[:show_md5] = false
+      opts.on("--md5", "show md5 of file") do
+        options[:show_md5] = true
+      end
+
       begin
         rest = opts.parse(argv)
       rescue OptionParser::InvalidOption => e
@@ -96,6 +115,9 @@ module TreeRb
         dirname = rest[0]
       end
 
+
+
+
       dirname = File.expand_path(dirname)
 
       dtw = DirTreeWalker.new(dirname)
@@ -108,16 +130,14 @@ module TreeRb
       case options[:algo]
 
         when 'build-dir'
-          # TODO: capture CTRL^C
+          # TODO: capture CTRL^C to avoid show the stack trace
           # http://ruby-doc.org/core-1.9.3/Kernel.html#method-i-trap
           Signal.trap('INT') { put "User interrupted exit"; exit }
 
-          visitor = BuildDirTreeVisitor.new
-          visitor.show_size = options[:show_size]
-  
+          visitor = BuildDirTreeVisitor.new(options)
           dtw.run(visitor)
 
-          puts visitor.root.to_str('', options[:colorize])
+          puts visitor.root.to_str('', options)
           puts
           puts "#{visitor.nr_directories} directories, #{visitor.nr_files} files"
 

data/lib/tree_rb/extension_md5.rb

@@ -0,0 +1,29 @@
+# -*- coding: utf-8 -*-
+#
+# calculate md5 of big files, snipped found on usenet
+#
+
+if RUBY_VERSION =~ /1\.8/
+  # std lib
+  require 'md5'
+else
+  # std lib
+  require 'digest/md5'
+  include Digest
+end
+
+# Return an MD5 object
+# example:
+# MD5.file( filename ).hexdigest
+#
+class MD5
+  def self.file(file)
+    File.open(file, "rb") do |f|
+      res = self.new
+      while (data = f.read(4096))
+        res << data
+      end
+      res
+    end
+  end
+end

data/lib/tree_rb/extension_numeric.rb

@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+class Numeric
+  #
+  # returns a string separated by the thousands <separator>
+  # es.: 100000 -> 1.000.000
+  #
+  def with_separator(separator = ',', length = 3)
+    splitter      = Regexp.compile "(\\d{#{length}})"
+    before, after = self.to_s.split('.')
+    before        = before.reverse.gsub splitter, '\1' + separator
+    str           = "#{ before.chomp(separator).reverse }"
+    str += ".#{ after }" if after
+    str
+  end
+
+  def to_human
+    if self == 0
+      return "0B"
+    end 
+    units = %w{B KB MB GB TB}
+   
+    e     = (Math.log(self)/Math.log(1024)).floor
+    s     = "%.3f" % (to_f / 1024**e)
+    s.sub(/\.?0*$/, units[e])
+  end
+
+end

data/lib/tree_rb/tree_node.rb

@@ -90,7 +90,7 @@ module TreeRb
         end
         leaf_node
       end
-    end  # end class << self
+    end # end class << self
 
     # leaves of this node
     attr_reader :leaves
@@ -249,56 +249,106 @@ module TreeRb
     # TODO: integrate with ansi color
     # TODO: see dircolors command
     # http://isthe.com/chongo/tech/comp/ansi_escapes.html
+
     # puts "\033[2J" # clear screen
-    # puts "aaaa \033[7;31;40m ciao \033[0m"
     # ESC[K Clear to end of line
+    # puts "aaaa \033[7;31;40m ciao \033[0m"
+
+
+    #
+    # check console character encoding
+    # altre variabili LC_CTYPE
+    # LC_ALL
+    # comando locale
+    # puts "enconding: #{ENV['LANG']}"
+    #
+
+
+    # │ (ascii 179)
+    # ├ (ascii 195)
+    # └ (ascii 192)
+    # ─ (ascii 196)
+
 
-    def to_str(prefix= "", tty_color = false)
-      str = ""
+    BRANCH      = '|-- '
+    LAST_BRANCH = '`-- '
+    CONT_1      = "|   "
+    CONT_2      = "    "
+
+    def to_str(prefix= "", options = { })
+      #TODO: find a more idiomatic mode to assign an array of options
+      tty_color        = options[:colorize].nil? ? false : options[:colorize]
+      show_indentation = options[:show_indentation].nil? ? true : options[:show_indentation]
+      str              = ""
 
       # print node itself
       if root?
-        if tty_color
-          str << ANSI.red{ to_s } << "\n"
-        else
-          str << to_s << "\n"
-        end
+        str << node_content_to_str(content, options)
       else
-        str << prefix
-        if self.next
-          str << '|-- '
-        else
-          str << '`-- '
+
+        if show_indentation
+          str << prefix
+          if self.next
+            str << BRANCH
+          else
+            str << LAST_BRANCH
+          end
         end
-        if tty_color
-          str << ANSI.red{ to_s } << "\n"
-        else
-          str << to_s << "\n"
+
+        str << node_content_to_str(content, options)
+        if show_indentation
+          prefix += self.next ? CONT_1 : CONT_2
         end
-        prefix += self.next ? "|   " : "    "
       end
 
       # print leaves
       @leaves.each do |leaf|
-        str << prefix
-        if !leaf.next.nil? or !@children.empty?
-          str << '|-- '
-        else
-          str << '`-- '
-        end
-        if tty_color
-          str << ANSI.green{ leaf.to_s } << "\n"
-        else
-          str << leaf.to_s << "\n"
+
+        if show_indentation
+          str << prefix
+          if !leaf.next.nil? or !@children.empty?
+            str << BRANCH
+          else
+            str << LAST_BRANCH
+          end
         end
+
+        str << leaf_content_to_str(leaf.content, options)
       end
 
       # print children
       @children.each do |child|
-        str << child.to_str(prefix, tty_color)
+        str << child.to_str(prefix, options)
       end
       str
     end
 
-  end
-end
+    def self.method_added(s)
+      if s == :to_str
+        puts "Warning: you should not override method 'to_str'"
+      else
+        super
+      end
+    end
+
+    private
+
+    def node_content_to_str(content, options)
+      if options[:tty_color]
+        "#{ANSI.red { content }}\n"
+      else
+        "#{content}\n"
+      end
+    end
+
+    def leaf_content_to_str(content, options)
+      if options[:tty_color]
+        "#{ANSI.green { content }}\n"
+      else
+        "#{content}\n"
+      end
+    end
+
+
+  end # end class
+end # end module TreeRb

data/lib/tree_rb/version.rb

@@ -1,4 +1,4 @@
 # -*- coding: utf-8 -*-
 module TreeRb
-  VERSION="0.3.2"
+  VERSION="0.3.3"
 end

data/lib/tree_rb/visitors/build_dir_tree_visitor.rb

@@ -1,11 +1,51 @@
 # -*- coding: utf-8 -*-
 module TreeRb
 
+  #
+  # contains informataion related to directory (TreeNode)
+  #
+  class ContentDir
+    def initialize( basename, options )
+      @basename = basename
+      @options = options
+    end
+    def to_str
+      @basename
+    end
+  end
+
+  #
+  # contains information related to file (LeafNode)
+  #
+  class ContentFile
+    def initialize( pathname, options )
+      stat = File.lstat(pathname)
+      # stat.symlink?
+
+      if options[:show_size]
+        str  = "#{File.basename(pathname)} #{stat.size}"
+      elsif options[:show_size_human]
+        str  = "#{File.basename(pathname)} #{stat.size.to_human}"
+      else
+        str  = "#{File.basename(pathname)}"
+      end
+    
+      if options[:show_md5]
+        str << " #{MD5.file( pathname ).hexdigest}"
+      end
+      @str = str
+
+    end
+    def to_str
+      @str
+    end
+  end
+
   #
   # Builds a TreeNode from a filesystem directory
   # It similar to CloneTreeNodeVisitor
   #
-  class BuildDirTreeVisitor # < BasicTreeNodeVisitor
+  class BuildDirTreeVisitor 
 
     attr_reader :root
 
@@ -19,23 +59,22 @@ module TreeRb
     # @see AbsNode#nr_leaves
     #
     attr_reader :nr_files
-
-    attr_accessor :show_size
-
-    def initialize
-      super
+    
+    def initialize(options = {})
       @root = nil
       @stack = []
       @nr_directories = 0
       @nr_files = 0
+      @options = options
     end
 
     def enter_node( pathname )
+      content = ContentDir.new(File.basename( pathname ), @options)
       if @stack.empty?
-        tree_node = TreeNode.new( File.basename( pathname ) )
+        tree_node = TreeNode.new( content )
         @root = tree_node
       else
-        tree_node = TreeNode.new( File.basename( pathname ), @stack.last )
+        tree_node = TreeNode.new( content, @stack.last )
       end
       @nr_directories += 1
       @stack.push( tree_node )
@@ -49,16 +88,10 @@ module TreeRb
     end
 
     def visit_leaf( pathname )
-      @nr_files  += 1
+      content = ContentFile.new(pathname, @options)
       # connect the leaf_node created to the last tree_node on the stack
-      stat = File.lstat(pathname)
-      # stat.symlink?
-      if show_size
-        str  = "#{File.basename(pathname)} #{stat.size}"
-      else
-        str  = "#{File.basename(pathname)}"
-      end
-      LeafNode.new( str, @stack.last )
+      @nr_files  += 1
+      LeafNode.new( content, @stack.last )
     end
 
   end

data/lib/tree_rb_cli.rb

@@ -1,18 +1,22 @@
 # -*- coding: utf-8 -*-
+
 #
-# cli
+# stdlib
 #
-
 require 'optparse'
-require 'treevisitor'
+
+#
+# gem
+#
 
 begin
-  require 'Win32/Console/ANSI' if RUBY_PLATFORM =~ /win32/
+  require 'Win32/Console/ANSI'
 rescue LoadError
   puts 'You must gem install win32console to use color on Windows'
 end
 
 #
-# gem
+# tree_rb cli
 #
+require 'tree_rb'
 require "tree_rb/cli/cli_tree"

data/lib/tree_visitor.rb

@@ -1,2 +1,3 @@
 # -*- coding: utf-8 -*-
-require 'treevisitor'
+warn "use require 'tree_rb' instead of require 'treevisitor'"
+require 'treevisitor'

data/lib/treevisitor.rb

@@ -1,2 +1,3 @@
 # -*- coding: utf-8 -*-
+warn "use require 'tree_rb' instead of require 'treevisitor'"
 require 'tree_rb'

data/spec/spec_helper.rb

@@ -5,8 +5,8 @@
 require "stringio"
 
 $:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'treevisitor'
-require 'treevisitor_cli'
+require 'tree_rb'
+require 'tree_rb_cli'
 include TreeRb
 
 FIXTURES = File.expand_path( File.join( File.dirname(__FILE__), "fixtures" ) )

data/spec/tree_rb/cli/cli_tree_spec.rb

@@ -5,7 +5,7 @@ describe CliTree do
 
   it "help message" do
     out = with_output_captured do
-      args = %w{-h}
+      args = %w{--help}
       CliTree.new.parse_args(args)
     end
     out[:stdout].should match /Usage:/

data/spec/tree_rb/tree_dsl_with_derived_class1_spec.rb

@@ -7,26 +7,22 @@ describe "Tree Node Dsl Derived Class with n-arg constructor" do
     attr_reader :description
 
     def initialize(name, description, parent)
-      super(name, parent)
-      @description =  description
+      content = "a: #{description}"
+      super(content, 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
+      content = "a: #{description}"
+      super(content, parent)
+      @description = description
     end
 
-    def to_s
-      "a: #{description}"
-    end
   end
 
   it "test_derivated_args" do

data/spec/tree_rb/tree_dsl_with_derived_class_spec.rb

@@ -4,14 +4,14 @@ 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}"
+    def content
+      "dt: #{super}"
     end
   end
 
   class DLeafNode < LeafNode
-    def to_s
-      "dl: #{content}"
+    def content
+      "dl: #{super}"
     end
   end
 
@@ -26,7 +26,7 @@ describe "Tree Node Dsl Derived Class with no-arg constructor " do
       end
     end
 
-    # puts tree.to_str
+    puts tree.to_str
     out =<<EOS
 dt: root
 |-- dl: l1

data/tree.rb.gemspec

@@ -26,10 +26,18 @@ An example of DSL to build tree:
 </pre>
   EOF
 
-  gem.authors = ["Tokiro"]
+  gem.authors = %w{ Tokiro }
   gem.email = "tokiro.oyama@gmail.com"
   gem.homepage = "http://github.com/tokiro/tree.rb"
-  gem.require_paths = ["lib"]
+
+  gem.post_install_message = %q{
+
+  Thank you to have installed tree.rb, any feedback is appreciated.
+
+}
+
+
+  gem.require_paths = %w{ lib }
 
   #
   # dependencies
@@ -38,6 +46,10 @@ An example of DSL to build tree:
   gem.add_runtime_dependency(%q<json>, [">= 0"])
   gem.add_runtime_dependency(%q<ansi>, [">= 0"])
 
+  # win32 depends on win32console.gem but this must be installed from ext/mkrf_conf.rb
+  # gem.add_runtime_dependency(%q<win32console>, [">= 0"])
+  #
+
   gem.add_development_dependency(%q<rake>, [">= 0"])
   gem.add_development_dependency(%q<yard>, [">= 0"])
   gem.add_development_dependency(%q<bundler>, [">= 0"])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tree.rb
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-16 00:00:00.000000000 Z
+date: 2012-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -124,63 +124,66 @@ files:
 - Rakefile
 - tree.rb.gemspec
 - .gemtest
-- lib/treevisitor.rb
+- lib/treevisitor_cli.rb
 - lib/tree_visitor.rb
-- lib/tree_rb_cli.rb
+- lib/tree_rb/cli/cli_tree.rb
 - lib/tree_rb/util/dir_processor.rb
-- lib/tree_rb/abs_node.rb
-- lib/tree_rb/version.rb
 - lib/tree_rb/directory_walker.rb
-- lib/tree_rb/tree_node.rb
-- lib/tree_rb/basic_tree_node_visitor.rb
-- lib/tree_rb/tree_node_visitor.rb
-- lib/tree_rb/cli/cli_tree.rb
-- lib/tree_rb/visitors/block_tree_node_visitor.rb
-- lib/tree_rb/visitors/flat_print_tree_node_visitors.rb
-- lib/tree_rb/visitors/clone_tree_node_visitor.rb
+- lib/tree_rb/visitors/print_dir_tree_visitor.rb
 - lib/tree_rb/visitors/build_dir_tree_visitor.rb
-- lib/tree_rb/visitors/directory_to_hash_visitor.rb
 - lib/tree_rb/visitors/depth_tree_node_visitor.rb
-- lib/tree_rb/visitors/callback_tree_node_visitor2.rb
 - lib/tree_rb/visitors/print_tree_node_visitor.rb
-- lib/tree_rb/visitors/print_dir_tree_visitor.rb
+- lib/tree_rb/visitors/callback_tree_node_visitor2.rb
+- lib/tree_rb/visitors/directory_to_hash_visitor.rb
+- lib/tree_rb/visitors/flat_print_tree_node_visitors.rb
+- lib/tree_rb/visitors/block_tree_node_visitor.rb
+- lib/tree_rb/visitors/clone_tree_node_visitor.rb
+- lib/tree_rb/abs_node.rb
+- lib/tree_rb/extension_numeric.rb
 - lib/tree_rb/leaf_node.rb
+- lib/tree_rb/tree_node_visitor.rb
+- lib/tree_rb/tree_node.rb
+- lib/tree_rb/basic_tree_node_visitor.rb
+- lib/tree_rb/version.rb
+- lib/tree_rb/extension_md5.rb
+- lib/treevisitor.rb
 - lib/tree_rb.rb
-- lib/treevisitor_cli.rb
+- lib/tree_rb_cli.rb
 - tasks/rspec.rake
 - tasks/yard.rake
+- examples/directory_walker/print_files.rb
 - examples/directory_walker/directory_without_subdirectory.rb
 - examples/directory_walker/find_files.rb
-- examples/directory_walker/print_files.rb
-- examples/protovis/treevisitor.js
+- examples/protovis/treevisitor.png
 - examples/protovis/protovis-r3.2.js
 - examples/protovis/index.html
-- examples/protovis/treevisitor.png
+- examples/protovis/treevisitor.js
 - examples/protovis/directory_to_json_visitor.rb
-- spec/tree_rb/tree_node_paths_spec.rb
-- spec/tree_rb/util/dir_processor_spec.rb
-- spec/tree_rb/tree_node_spec.rb
-- spec/tree_rb/directory_walker_spec.rb
-- spec/tree_rb/tree_dsl_spec.rb
-- spec/tree_rb/tree_dsl_with_derived_class1_spec.rb
+- spec/spec_helper.rb
 - spec/tree_rb/cli/cli_tree_spec.rb
+- spec/tree_rb/util/dir_processor_spec.rb
 - spec/tree_rb/visitors/depth_tree_node_visitor_spec.rb
-- spec/tree_rb/visitors/tree_node_visitors_spec.rb
-- spec/tree_rb/visitors/block_tree_node_visitor_spec.rb
 - spec/tree_rb/visitors/callback_tree_node_visitor2_spec.rb
+- spec/tree_rb/visitors/block_tree_node_visitor_spec.rb
+- spec/tree_rb/visitors/tree_node_visitors_spec.rb
 - spec/tree_rb/tree_dsl_with_derived_class_spec.rb
+- spec/tree_rb/directory_walker_spec.rb
+- spec/tree_rb/tree_dsl_spec.rb
+- spec/tree_rb/tree_node_paths_spec.rb
+- spec/tree_rb/tree_dsl_with_derived_class1_spec.rb
 - spec/tree_rb/tree_node_visitor_delegate_spec.rb
+- spec/tree_rb/tree_node_spec.rb
 - spec/tree_rb/tree_node_visitor_dsl_spec.rb
-- spec/spec_helper.rb
-- spec/fixtures/test_dir_1/dir.2/file.2.1
-- spec/fixtures/test_dir_1/dir.1/file.1.1
 - spec/fixtures/test_dir_1/dir.1/dir.1.2/file.1.2.1
+- spec/fixtures/test_dir_1/dir.1/file.1.1
+- spec/fixtures/test_dir_1/dir.2/file.2.1
 - spec/fixtures/test_dir_2/[Dsube]/sub/.gitkeep
 - spec/fixtures/test_dir_1/.dir_with_dot/dummy.txt
 - bin/tree.rb
 homepage: http://github.com/tokiro/tree.rb
 licenses: []
-post_install_message: 
+post_install_message: ! "\n\n  Thank you to have installed tree.rb, any feedback is
+  appreciated.\n\n"
 rdoc_options: []
 require_paths:
 - lib
@@ -190,18 +193,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3293516785273926334
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3293516785273926334
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -210,24 +207,24 @@ specification_version: 3
 summary: tree.rb is a 'clone' of tree unix command. The gem implements a library to
   mange tree structures.
 test_files:
-- spec/tree_rb/tree_node_paths_spec.rb
-- spec/tree_rb/util/dir_processor_spec.rb
-- spec/tree_rb/tree_node_spec.rb
-- spec/tree_rb/directory_walker_spec.rb
-- spec/tree_rb/tree_dsl_spec.rb
-- spec/tree_rb/tree_dsl_with_derived_class1_spec.rb
+- spec/spec_helper.rb
 - spec/tree_rb/cli/cli_tree_spec.rb
+- spec/tree_rb/util/dir_processor_spec.rb
 - spec/tree_rb/visitors/depth_tree_node_visitor_spec.rb
-- spec/tree_rb/visitors/tree_node_visitors_spec.rb
-- spec/tree_rb/visitors/block_tree_node_visitor_spec.rb
 - spec/tree_rb/visitors/callback_tree_node_visitor2_spec.rb
+- spec/tree_rb/visitors/block_tree_node_visitor_spec.rb
+- spec/tree_rb/visitors/tree_node_visitors_spec.rb
 - spec/tree_rb/tree_dsl_with_derived_class_spec.rb
+- spec/tree_rb/directory_walker_spec.rb
+- spec/tree_rb/tree_dsl_spec.rb
+- spec/tree_rb/tree_node_paths_spec.rb
+- spec/tree_rb/tree_dsl_with_derived_class1_spec.rb
 - spec/tree_rb/tree_node_visitor_delegate_spec.rb
+- spec/tree_rb/tree_node_spec.rb
 - spec/tree_rb/tree_node_visitor_dsl_spec.rb
-- spec/spec_helper.rb
-- spec/fixtures/test_dir_1/dir.2/file.2.1
-- spec/fixtures/test_dir_1/dir.1/file.1.1
 - spec/fixtures/test_dir_1/dir.1/dir.1.2/file.1.2.1
+- spec/fixtures/test_dir_1/dir.1/file.1.1
+- spec/fixtures/test_dir_1/dir.2/file.2.1
 - spec/fixtures/test_dir_2/[Dsube]/sub/.gitkeep
 - spec/fixtures/test_dir_1/.dir_with_dot/dummy.txt
 has_rdoc: