tree.rb 0.3.11 → 0.3.12

data/lib/tree_rb/core/tree_node.rb

@@ -266,7 +266,7 @@ module TreeRb
       visitor
     end
 
-    ###################################################################################################################
+    ############################################################################################
     #
     # Format the content of tree
     #
@@ -365,10 +365,14 @@ module TreeRb
 
     def prepare_color_map
       @fileToColor = { }
-      ENV['LS_COLORS'].split(":").each do |e|
-        k, v            = e.split('=')
-        @fileToColor[k] = v
+
+      if ENV['LS_COLORS']
+        ENV['LS_COLORS'].split(":").each do |e|
+          k, v            = e.split('=')
+          @fileToColor[k] = v
+        end
       end
+
     end
 
     def color_file(filename)
@@ -383,14 +387,11 @@ module TreeRb
     end
 
     def prepare_prefix_map(options)
-      #
       # check console character encoding
       # altre variabili LC_CTYPE
       # LC_ALL
       # comando locale
       # puts "enconding: #{ENV['LANG']}"
-      #
-
 
       # │ (ascii 179)
       # ├ (ascii 195)

data/lib/tree_rb/core/tree_node_visitor.rb

@@ -51,6 +51,13 @@ module TreeRb
       @stack.push(tree_node)
     end
 
+    #
+    # called when the tree node is not accessible or an exception is raise when the node is accessed
+    #
+    # @param [Object] error
+    def cannot_enter_node( tree_node, error)
+    end
+
     #
     # called on tree node at end of the visit i.e. oll subtree are visited
     #
@@ -92,8 +99,8 @@ module TreeRb
     # add a block to be called when entering into a tree_node
     #
     def on_enter_node(&block)
-      raise "already defined a delegate" if @delegate
-      raise "block missing" unless block
+      raise 'already defined a delegate' if @delegate
+      raise 'block missing' unless block
       @on_enter_tree_node_blocks << block
     end
 
@@ -101,8 +108,8 @@ module TreeRb
     # add a block to be called when exiting from a TreeNode
     #
     def on_exit_node(&block)
-      raise "already defined a delegate" if @delegate
-      raise "block missing" unless block
+      raise 'already defined a delegate' if @delegate
+      raise 'block missing' unless block
       @on_exit_tree_node_blocks << block
     end
 
@@ -110,8 +117,8 @@ module TreeRb
     # add a block to be called when visiting a leaf node
     #
     def on_leaf(&block)
-      raise "already defined a delegate" if @delegate
-      raise "block missing" unless block
+      raise 'already defined a delegate' if @delegate
+      raise 'block missing' unless block
       @on_visit_leaf_node_blocks << block
     end
 

data/lib/tree_rb/extension_numeric.rb

@@ -15,12 +15,12 @@ class Numeric
 
   def to_human
     if self == 0
-      return "0B"
-    end 
+      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     = '%.3f' % (to_f / 1024**e)
     s.sub(/\.?0*$/, units[e])
   end
 

data/lib/tree_rb/{input_file_system → input_plugins/file_system}/dir_processor.rb

@@ -20,7 +20,7 @@ module TreeRb
       @dirname = dirname
       old_dirname = Dir.pwd
       Dir.chdir( @dirname )
-      Dir["**/*"].each { |f|
+      Dir['**/*'].each { |f|
         pn = Pathname.new( f ).expand_path
         # puts "#{self.class.name}#loadfromdir #{f}"
         next if pn.directory?

data/lib/tree_rb/{input_file_system → input_plugins/file_system}/directory_walker.rb

@@ -11,7 +11,7 @@ module TreeRb
     # if dirname is missing, must be supplied when invoking run
     #
     # @yield [a, b, c] TreeNodeVisitor
-    # @yieldparam [optional, types, ...] argname description
+    # @yieldparam [optional, types, ...] argument name description
     # @yieldreturn [optional, types, ...] description
     #
     # @overload initialize(dirname)
@@ -112,7 +112,12 @@ module TreeRb
     # @param [RegEx] pattern
     #
     def ignore_dir(pattern)
-      @ignore_dir_patterns << pattern
+      # it transforms all in regexp
+      if pattern.kind_of? Regexp
+        @ignore_dir_patterns << pattern
+      else
+        @ignore_dir_patterns << /#{pattern}/
+      end
       self
     end
 
@@ -132,7 +137,11 @@ module TreeRb
     # @param [RegEx] pattern
     #
     def match(pattern)
-      @match_file_patterns << pattern
+      if pattern.kind_of? Regexp
+        @match_file_patterns << pattern
+      else
+        @match_file_patterns << /#{pattern}/
+      end
       self
     end
 
@@ -167,7 +176,7 @@ module TreeRb
     end
 
     #
-    # Test common ignore pattern
+    # Test match pattern
     #
     # @param [String] filename
     # @return [boolean] if filename match almost one pattern
@@ -237,7 +246,7 @@ module TreeRb
       end
 
       unless @visitor
-        raise "missing visitor"
+        raise 'missing visitor'
       end
 
       #
@@ -250,14 +259,13 @@ module TreeRb
     private
 
     def _include?(patterns, basename)
-      # return false if the patters.empty?
-      patterns.find { |pattern|
+      patterns.find do |pattern|
         if pattern.kind_of? Regexp
           pattern.match(basename)
         else
           basename == pattern
         end
-      }
+      end
     end
 
     #
@@ -284,7 +292,7 @@ module TreeRb
       @visitor.enter_node(dirname)
       entries.each do |basename|
         begin
-          next if basename == "." or basename == ".." # ignore always "." and ".."
+          next if basename == '.' or basename == '..' # ignore always "." and ".."
           pathname = File.join(dirname, basename)
 
           if File.directory?(pathname)

data/lib/tree_rb/{output_dircat/dircat_helper.rb → output_plugins/dircat/dircat_output.rb}

@@ -1,14 +1,14 @@
 # -*- coding: utf-8 -*-
-require 'tree_rb/output_dircat/entry'
-require 'tree_rb/output_dircat/dircat_visitor'
-
 module TreeRb
 
-  class DirCatHelper
+  class DirCatOutput
 
     def run(directory_tree_walker, options)
+      require 'tree_rb/output_dircat/entry'
+      require 'tree_rb/output_dircat/dircat_visitor'
+
       unless options[:output]
-        $stderr.puts "need to specify the -o options"
+        $stderr.puts 'need to specify the -o options'
       else
         filename = options[:output]
         visitor  = DirCatVisitor.new(filename)

data/lib/tree_rb/{output_dircat → output_plugins/dircat}/entry.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 module DirCat
 
-  FORMAT_VERSION="0.2.1"
+  FORMAT_VERSION='0.2.1'
 
   class EntrySer < OpenStruct
   end

data/lib/tree_rb/{output_html/d3js_helper.rb → output_plugins/html/d3js_output.rb}

@@ -1,17 +1,18 @@
 # -*- coding: utf-8 -*-
-require 'tree_rb/output_html/directory_to_hash2_visitor'
-require 'tree_rb/output_html/erb_render'
 
 module TreeRb
 
-  class D3jsHelper
+  class D3jsOutput
 
     def run(directory_tree_walker, dirname, template, output)
+      require 'tree_rb/output_plugins/html/directory_to_hash2_visitor'
+      require 'tree_rb/output_plugins/html/erb_render'
+
       visitor = DirectoryToHash2Visitor.new(dirname)
       root    = directory_tree_walker.run(visitor).root
       begin
         str_json = JSON.pretty_generate(root)
-        str_json = "var data = " + str_json
+        str_json = 'var data = ' + str_json
 
         if template
           render = ErbRender.new(template, str_json)

data/lib/tree_rb/{output_sqlite → output_plugins/sqlite}/sqlite_dir_tree_visitor.rb

@@ -5,14 +5,19 @@ module TreeRb
 
     def initialize(filename)
       @db = SQLite3::Database.new(filename)
-      @db.execute("create table files(path varchar(1024), size integer, digest varchar(40))")
+      @db.execute('create table files(path varchar(1024), name varchar(40), size integer, sha1 varchar(40))')
     end
 
     def visit_leaf(pathname)
       puts pathname
       stat = File.lstat(pathname)
       digest = SHA1.file(pathname).hexdigest
-      @db.execute("insert into files (path, size, digest) values ( \"#{pathname}\", \"#{stat.size}\", \"#{digest}\")")
+      sql = 'insert into files (path, name, size, sha1) values ('
+      sql << "\"#{File.dirname(pathname)}\","
+      sql << "\"#{File.basename(pathname)}\","
+      sql << "\"#{stat.size}\","
+      sql << "\"#{digest}\")"
+      @db.execute(sql)
 
       # entry = Entry.from_filename(filename)
       # me.add_entry(entry)
@@ -32,9 +37,9 @@ module TreeRb
 
     def find_duplicates
       # Loop through digests.
-      @db.execute("select digest,count(1) as count from files group by digest order by count desc").each do |row|
+      @db.execute('select sha1,count(1) as count from files group by sha1 order by count desc').each do |row|
         if row[1] > 1 # Skip unique files.
-          puts "Duplicates found:"
+          puts 'Duplicates found:'
           digest = row[0]
           # List the duplicate files.
           db.execute("select digest,path from files where digest='#{digest}'").each do |dup_row|

data/lib/tree_rb/{output_sqlite/sqlite_helper.rb → output_plugins/sqlite/sqlite_output.rb}

@@ -1,18 +1,20 @@
 # -*- coding: utf-8 -*-
-begin
-  require 'sqlite3'
-  require 'tree_rb/output_sqlite/sqlite_dir_tree_visitor'
-rescue LoadError
-  $stderr.puts 'You must gem install sqlite3 to use this output format'
-end
-
 module TreeRb
 
-  class SqliteHelper
+  class SqliteOutput
 
     def run(directory_tree_walker, output, options)
+
+      begin
+        require 'sqlite3'
+        require 'tree_rb/output_plugins/sqlite/sqlite_dir_tree_visitor'
+      rescue LoadError
+        $stderr.puts 'You must gem install sqlite3 to use this output format'
+        exit(1)
+      end
+
       unless options[:output]
-        $stderr.puts "need to specify the -o options"
+        $stderr.puts 'need to specify the -o options'
       else
         output.close
         filename = options[:output]

data/lib/tree_rb/version.rb

@@ -1,4 +1,4 @@
 # -*- coding: utf-8 -*-
 module TreeRb
-  VERSION="0.3.11"
+  VERSION='0.3.12'
 end

data/lib/tree_rb/visitors/print_tree_node_visitor.rb

@@ -10,9 +10,9 @@ module TreeRb
     end
 
     def enter_node( tree_node )
-      str = ""
+      str = ''
       (0...@depth).step {
-        str << " |-"
+        str << ' |-'
       }
 
       if @depth == 0
@@ -36,9 +36,9 @@ module TreeRb
     def visit_leaf( leaf_node )
       str = ""
       (0...@depth-1).step {
-        str << " |-"
+        str << ' |-'
       }
-      str << " |  "
+      str << ' |  '
       puts str + leaf_node.name.to_s
     end
 

data/spec/fixtures/test_dir_1/.dir_with_dot/dummy.txt

@@ -0,0 +1 @@
+dummy.txt

data/spec/spec_helper.rb

@@ -2,7 +2,7 @@
 #
 # std lib
 #
-require "stringio"
+require 'stringio'
 require 'ostruct'
 
 #
@@ -13,7 +13,7 @@ require 'tree_rb'
 require 'tree_rb_cli'
 include TreeRb
 
-FIXTURES = File.expand_path( File.join( File.dirname(__FILE__), "fixtures" ) )
+FIXTURES = File.expand_path( File.join( File.dirname(__FILE__), 'fixtures') )
 
 def capture_output
   old_stdout, old_stderr = $stdout, $stderr

data/spec/tree_rb/cli/cli_json_spec.rb

@@ -1,9 +1,9 @@
 # -*- coding: utf-8 -*-
-require File.join(File.dirname(__FILE__), "..", "..", "spec_helper")
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
 
 describe CliJson do
 
-  it "should accepts --help switch" do
+  it 'should accepts --help switch' do
     captured = capture_output do
       args = %w{--help}
       # args << File.join(FIXTURES, "test_dir_1")
@@ -12,7 +12,7 @@ describe CliJson do
     captured.out.should match /Usage:/
   end
 
-  it "should accept --version switch" do
+  it 'should accept --version switch' do
     captured     = capture_output do
       args = %w{--version}
       CliJson.new.parse_args(args)
@@ -21,10 +21,10 @@ describe CliJson do
     captured.out.should match version
   end
 
-  it "should format simple json file" do
+  it 'should format simple json file' do
     captured = capture_output do
       args = []
-      args << File.join(FIXTURES, "test_json", "1.json")
+      args << File.join(FIXTURES, 'test_json', '1.json')
       CliJson.new.parse_args(args)
     end
 

data/spec/tree_rb/cli/cli_tree_d3js_spec.rb

@@ -3,7 +3,7 @@ require File.join(File.dirname(__FILE__), "..", "..", "spec_helper")
 
 describe CliTree do
 
-  it "should accepts --format html_partition" do
+  it 'should accepts --format html_partition' do
     captured = capture_output do
       args = %w{--format html_partition}
       args << File.join(FIXTURES, "test_dir_1")
@@ -12,7 +12,7 @@ describe CliTree do
     captured.out.should match  /d3.layout.partition/
   end
 
-  it "should accepts --format html_tree" do
+  it 'should accepts --format html_tree' do
     captured = capture_output do
       args = %w{--format html_tree}
       args << File.join(FIXTURES, "test_dir_1")
@@ -21,7 +21,7 @@ describe CliTree do
     captured.out.should match  /d3.layout.tree/
   end
 
-  it "should accepts --format html_treemap" do
+  it 'should accepts --format html_treemap' do
     captured = capture_output do
       args = %w{--format html_treemap}
       args << File.join(FIXTURES, "test_dir_1")

data/spec/tree_rb/cli/cli_tree_generic_spec.rb

@@ -1,95 +1,126 @@
-# -*- coding: utf-8 -*-
-require File.join(File.dirname(__FILE__), "..", "..", "spec_helper")
-
-describe CliTree do
-
-  it "should accept --help switch" do
-    captured = capture_output do
-      args = %w{--help}
-      CliTree.new.parse_args(args)
-    end
-    captured.out.should match /Usage:/
-  end
-
-  it "should accept --version switch" do
-    captured     = capture_output do
-      args = %w{--version}
-      CliTree.new.parse_args(args)
-    end
-    version = TreeRb::VERSION
-    captured.out.should match version
-  end
-
-  it "should accepts -d switch (directories only)" do
-    captured = capture_output do
-      args = %w{-d}
-      args << File.join(FIXTURES, "test_dir_1")
-      CliTree.new.parse_args(args)
-    end
-    expected = "test_dir_1\n|-- dir.1\n|   `-- dir.1.2\n`-- dir.2\n\n4 directories, 0 files\n"
-    captured.out.should == expected
-    captured.out.split("\n").length.should == 6
-  end
-
-  it "should accepts -da switch (directories only)" do
-    captured = capture_output do
-      args = %w{-da}
-      args << File.join(FIXTURES, "test_dir_1")
-      CliTree.new.parse_args(args)
-    end
-    expected = "test_dir_1\n|-- .dir_with_dot\n|-- dir.1\n|   `-- dir.1.2\n`-- dir.2\n\n5 directories, 0 files\n"
-    captured.out.should == expected
-    captured.out.split("\n").length.should == 7
-  end
-
-  it "should accepts -a switch (all files)" do
-    captured = capture_output do
-      args = %w{-a}
-      args << File.join(FIXTURES, "test_dir_1")
-      CliTree.new.parse_args(args)
-    end
-    # pp captured
-    expected ="test_dir_1\n|-- .dir_with_dot\n|   `-- dummy.txt\n|-- dir.1\n|   |-- file.1.1\n|   `-- dir.1.2\n|       `-- file.1.2.1\n`-- dir.2\n    `-- file.2.1\n\n5 directories, 4 files\n"
-    captured.out.should == expected
-    captured.out.split("\n").length.should == 11
-  end
-
-  it "should accepts -a switch (all files)" do
-    captured = capture_output do
-      args = []
-      args << File.join(FIXTURES, "test_dir_1")
-      CliTree.new.parse_args(args)
-    end
-    # puts captured
-    expected ="test_dir_1\n|-- dir.1\n|   |-- file.1.1\n|   `-- dir.1.2\n|       `-- file.1.2.1\n`-- dir.2\n    `-- file.2.1\n\n4 directories, 3 files\n"
-    captured.out.should == expected
-    captured.out.split("\n").length.should == 9
-  end
-
-  it "should accepts -A switch (ascii line graphics)" do
-    captured = capture_output do
-      args = %w{-A}
-      args << File.join(FIXTURES, "test_dir_1")
-      CliTree.new.parse_args(args)
-    end
-    # puts captured
-    expected ="test_dir_1\n├── dir.1\n│   ├── file.1.1\n│   └── dir.1.2\n│       └── file.1.2.1\n└── dir.2\n    └── file.2.1\n\n4 directories, 3 files\n"
-    captured.out.should == expected
-  end
-
-  it "should show tree with inaccessible directories" do
-    captured = capture_output do
-      args = []
-      args << File.join(FIXTURES, "test_dir_3_with_error")
-      CliTree.new.parse_args(args)
-    end
-    # puts captured
-
-    expected_out="test_dir_3_with_error\n`-- accessible_dir\n\n2 directories, 0 files\n"
-    expected_err=/Permission denied/
-    captured.out.should == expected_out
-    captured.err.should match expected_err
-    captured.err.should_not be_empty
-    captured.out.split("\n").length.should == 4
-  end
-end
+# -*- coding: utf-8 -*-
+require File.join(File.dirname(__FILE__), "..", "..", "spec_helper")
+
+describe CliTree do
+
+  it "should accept --help switch" do
+    captured = capture_output do
+      args = %w{--help}
+      CliTree.new.parse_args(args)
+    end
+    captured.out.should match /Usage:/
+  end
+
+  it "should accept --version switch" do
+    captured     = capture_output do
+      args = %w{--version}
+      CliTree.new.parse_args(args)
+    end
+    version = TreeRb::VERSION
+    captured.out.should match version
+  end
+
+  it "should accepts -d switch (directories only)" do
+    captured = capture_output do
+      args = %w{-d}
+      args << File.join(FIXTURES, "test_dir_1")
+      CliTree.new.parse_args(args)
+    end
+    expected = "test_dir_1\n|-- dir.1\n|   `-- dir.1.2\n`-- dir.2\n\n4 directories, 0 files\n"
+    captured.out.should == expected
+    captured.out.split("\n").length.should == 6
+  end
+
+  it "should accepts -da switch (directories only)" do
+    captured = capture_output do
+      args = %w{-da}
+      args << File.join(FIXTURES, "test_dir_1")
+      CliTree.new.parse_args(args)
+    end
+    expected = "test_dir_1\n|-- .dir_with_dot\n|-- dir.1\n|   `-- dir.1.2\n`-- dir.2\n\n5 directories, 0 files\n"
+    captured.out.should == expected
+    captured.out.split("\n").length.should == 7
+  end
+
+  it "should accepts -a switch (all files)" do
+    captured = capture_output do
+      args = %w{-a}
+      args << File.join(FIXTURES, "test_dir_1")
+      CliTree.new.parse_args(args)
+    end
+    # pp captured
+    expected ="test_dir_1\n|-- .dir_with_dot\n|   `-- dummy.txt\n|-- dir.1\n|   |-- file.1.1\n|   `-- dir.1.2\n|       `-- file.1.2.1\n`-- dir.2\n    `-- file.2.1\n\n5 directories, 4 files\n"
+    captured.out.should == expected
+    captured.out.split("\n").length.should == 11
+  end
+
+  it "should accepts -a switch (all files)" do
+    captured = capture_output do
+      args = []
+      args << File.join(FIXTURES, "test_dir_1")
+      CliTree.new.parse_args(args)
+    end
+    # puts captured
+    expected ="test_dir_1\n|-- dir.1\n|   |-- file.1.1\n|   `-- dir.1.2\n|       `-- file.1.2.1\n`-- dir.2\n    `-- file.2.1\n\n4 directories, 3 files\n"
+    captured.out.should == expected
+    captured.out.split("\n").length.should == 9
+  end
+
+  it "should accepts -A switch (ascii line graphics)" do
+    captured = capture_output do
+      args = %w{-A}
+      args << File.join(FIXTURES, "test_dir_1")
+      CliTree.new.parse_args(args)
+    end
+    # puts captured
+    expected = <<EOS
+test_dir_1
+├── dir.1
+│   ├── file.1.1
+│   └── dir.1.2
+│       └── file.1.2.1
+└── dir.2
+    └── file.2.1
+
+4 directories, 3 files
+EOS
+    captured.out.encode('utf-8').should == expected.encode('utf-8') 
+  end
+
+  it "should show tree with inaccessible directories" do
+
+#    begin
+      d = File.join(FIXTURES, "test_dir_3_with_error", "no_accessible_dir")
+      if File.exists?(d)
+        File.chmod(0644,d) 
+        Dir.rmdir(d) 
+      end
+      FileUtils.mkdir(d)
+      File.chmod(0000, d)
+#    rescue
+#    end
+
+    captured = capture_output do
+      args = []
+      args << File.join(FIXTURES, "test_dir_3_with_error")
+      CliTree.new.parse_args(args)
+    end
+    # puts captured
+
+    expected_out= <<EOS
+test_dir_3_with_error
+`-- accessible_dir
+
+2 directories, 0 files
+EOS
+    expected_err=/Permission denied/
+
+    captured.out.should == expected_out
+    captured.err.should match expected_err
+    captured.err.should_not be_empty
+    captured.out.split("\n").length.should == 4
+
+    # File.chmod(0644,d) 
+    # Dir.unlink(d) 
+  end
+end