dircat 0.0.5 → 0.1.4

data/lib/dircat/cli/dircat_query.rb

@@ -1,59 +1,69 @@
-require 'optparse'
-require 'dircat/dircat.rb'
+module DirCat
 
-#
-# DirCatQuery
-#
-class DirCatQuery
+  class DirCatQuery
 
-  def self.run
-    self.new.parse_args( ARGV)
-  end
+    def self.run
+      return self.new.parse_args( ARGV)
+    end
 
-  def parse_args( args )
-    options = {}
-    opts = OptionParser.new
-    opts.banner =
-      "Usage: dircat_query [options] <filedircat> <command>\n" +
-      "mostra informazioni su un dircat\n"
+    def parse_args( args )
+      options = {}
+      opts = OptionParser.new
+      opts.banner =
+        "Usage: dircat-query [options] <filedircat> [<command>]\n" +
+        "show info on dircat catalogs\n"
 
-    opts.on("-h", "--help", "Print this message") do
-      puts opts
-      return
-    end
+      opts.on("--version", "show the dircat version") do
+        puts "dircat version #{DirCat::version}"
+        return 0
+      end
 
-    opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
-      options[:verbose] = v
-    end
+      opts.on("-h", "--help", "Print this message") do
+        puts opts
+        return 0
+      end
 
-    rest = opts.parse( args )
+      opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+        options[:verbose] = v
+      end
 
-    # p options
-    # p ARGV
+      rest = opts.parse( args )
 
-    if rest.length < 2
-      puts "inserire il nome del catalogo da interrogare e il comando da eseguire"
-      puts "-h to print help"
-      return
-    end
+      # p options
+      # p ARGV
 
-    cat_filename = rest[0]
-    command = rest[1]
+      if rest.length < 1
+        puts "missing catalog!"
+        puts "-h to print help"
+        return 0
+      end
 
-    #
-    # option verbose
-    #
-    if options.has_key?(:verbose)
-      if options[:verbose]
-        $VERBOSE_LEVEL = 1
+      cat_opts = {}
+      cat_filename = rest[0]
+      unless File.exists?(cat_filename)
+        puts "first args must be a catalogue"
+        return 1
       end
-    end
 
-    s = DirCat.loadfromfile( cat_filename )
+      if rest.length > 1
+        command = rest[1]
+      else
+        command = "report"
+      end
+
+      #
+      # option verbose
+      #
+      if options.has_key?(:verbose)
+        if options[:verbose]
+          cat_opts[:verbose_level] = 1
+        end
+      end
+
+      s = Cat.from_file( cat_filename, cat_opts )
 
-    #case command
-    #else
       puts s.send( command.to_sym )
-    #end
+      0
+    end
   end
 end

data/lib/dircat/entry.rb

@@ -0,0 +1,60 @@
+module DirCat
+
+  class EntrySer < OpenStruct
+  end
+
+  #
+  # Entry
+  #
+  class Entry
+
+    attr_reader :md5
+    attr_reader :name
+    attr_reader :path
+    attr_reader :size
+    attr_reader :mtime
+
+    def from_filename( filename )
+      @name = File.basename(filename)
+      @path = File.dirname(filename)
+      stat = File.stat(filename)
+      @size = stat.size
+      @mtime = stat.mtime
+      # self.md5 = Digest::MD5.hexdigest(File.read( f ))
+      @md5 = MD5.file( filename ).hexdigest
+      self
+    end
+
+    def from_ser( entry_ser )
+      @md5   = entry_ser.md5
+      @name  = entry_ser.name
+      @path  = entry_ser.path
+      @size  = entry_ser.size
+      @mtime = entry_ser.mtime
+      self
+    end
+
+    def to_ser
+      entry_ser = EntrySer.new
+      entry_ser.md5   = @md5
+      entry_ser.name  = @name
+      entry_ser.path  = @path
+      entry_ser.size  = @size
+      entry_ser.mtime = @mtime
+      entry_ser
+    end
+
+    def to_s
+      @md5 + "  " + @name + "\t " + @path + "\n"
+    end
+
+  end
+
+  class DirCatSer < OpenStruct
+  end
+
+
+  class DirCatException < RuntimeError
+  end
+
+end

data/lib/dircat/extension_md5.rb

@@ -0,0 +1,24 @@
+#
+# calculate md5 of big files, found on usenet
+#
+
+if RUBY_VERSION =~ /1\.8/
+  # stdlib
+  require 'md5'
+else
+  # stdlib
+  require 'digest/md5'
+  include Digest
+end
+
+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/dircat/extension_numeric.rb

@@ -0,0 +1,17 @@
+class Numeric
+  #
+  # ritorna una stringa con le migliaia serparate da <separator>
+  # es.: 100000 -> 1.000.000
+  #
+  #
+  # copiata da http://wiki.rubygarden.org/Ruby/page/show/FixNumFormat
+  #
+  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
+end

data/lib/dircat/report.rb

@@ -0,0 +1,61 @@
+module DirCat
+
+  # From http://gist.github.com/72234
+  #
+  # mysql-style output for an array of ActiveRecord objects
+  #
+  # Usage:
+  #   report(records)  # displays report with all fields
+  #   report(records, :field1, :field2, ...) # displays report with given fields
+  #
+  # Example:
+  # >> report(records, :id, :amount, :created_at)
+  # +------+-----------+--------------------------------+
+  # | id   | amount    | created_at                     |
+  # +------+-----------+--------------------------------+
+  # | 8301 | $12.40    | Sat Feb 28 09:20:47 -0800 2009 |
+  # | 6060 | $39.62    | Sun Feb 15 14:45:38 -0800 2009 |
+  # | 6061 | $167.52   | Sun Feb 15 14:45:38 -0800 2009 |
+  # | 6067 | $12.00    | Sun Feb 15 14:45:40 -0800 2009 |
+  # | 6059 | $1,000.00 | Sun Feb 15 14:45:38 -0800 2009 |
+  # +------+-----------+--------------------------------+
+  # 5 rows in set
+  #
+  def self.report(items, *fields)
+    # find max length for each field; start with the field names themselves
+    max_len = Hash[*fields.map {|f| [f, f.to_s.length]}.flatten]
+
+    items.each do |item|
+      fields.each do |field|
+        len = item.send(field).to_s.length
+        max_len[field] = len if len > max_len[field]
+      end
+    end
+
+    border = '+-' + fields.map {|f| '-' * max_len[f] }.join('-+-') + '-+'
+    title_row = '| ' + fields.map {|f| sprintf("%-#{max_len[f]}s", f.to_s) }.join(' | ') + ' |'
+
+    puts border
+    puts title_row
+    puts border
+
+    items.each do |item|
+      row = '| ' + fields.map {|f| sprintf("%-#{max_len[f]}s", item.send(f)) }.join(' | ') + ' |'
+      puts row
+    end
+
+    puts border
+    puts "#{items.length} rows in set\n"
+  end
+end
+
+if __FILE__ == $0
+  require 'ostruct'
+  o1 = OpenStruct.new
+  o1.a = 1
+  o1.b = 2
+
+  o2 = OpenStruct.new :a => 2, :b => 4
+  
+  DirCat::report( [o1, o2], :a, :b )
+end

data/lib/dircat.rb

@@ -1,3 +1,30 @@
-class Dircat
-  VERSION = '0.0.1'
+#
+# stdlib
+#
+require 'fileutils'
+require 'tmpdir'
+require 'yaml'
+require 'ostruct'
+require 'optparse'
+
+module DirCat
+  def self.version
+    cwd = File.dirname( __FILE__)
+    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 'dircat/extension_md5'
+require 'dircat/extension_numeric'
+
+require 'dircat/cat'
+require 'dircat/entry'
+require 'dircat/report'
+
+require 'dircat/cli/dircat_build'
+require 'dircat/cli/dircat_diff'
+require 'dircat/cli/dircat_query'

data/spec/dircat/cat_spec.rb

@@ -0,0 +1,71 @@
+require File.expand_path( File.join(File.dirname(__FILE__), "..", "spec_helper") )
+
+#
+# dir1 contains 2 files
+#
+# dir2 contains 3 files (one more than dir2)
+#
+# dir3 contains two duplicated files
+
+describe Cat do
+
+  before do
+    @data_dir = TEST_DIR
+    @tmp_dir  = File.join( @data_dir, "tmp" )
+  end
+
+  it "should build catalog from dir1" do
+    cat1 = Cat.from_dir( File.join(@data_dir, "dir1") )
+    cat1.size.should == 2
+    cat1.bytes.size.should == 8
+  end
+
+  it "should load catalog from dir2" do
+    cat2 = Cat.from_dir( File.join(@data_dir, "dir2") )
+    cat2.size.should == 3
+    cat2.bytes.should == 6
+  end
+
+  it "(dir1 - dir2) the difference from dir1 and dir2 is empty" do
+    cat1 = Cat.from_dir( File.join(@data_dir, "dir1") )
+    cat2 = Cat.from_dir( File.join(@data_dir, "dir2") )
+    # dir1 contiene tutti i file di dir2
+    cat_diff = cat1 - cat2
+    cat_diff.size.should == 0
+  end
+
+  it "(dir2 - dir1) the difference from dir2 and dir1 is a file" do
+    cat1 = Cat.from_dir( File.join(@data_dir, "dir1") )
+    cat2 = Cat.from_dir( File.join(@data_dir, "dir2") )
+
+    # dir2 contiene un file in piu' di dir1
+    cat_diff = cat2 - cat1
+    cat_diff.size.should == 1
+  end
+
+  it "saving to an inexistents file shoud raise an exception" do
+    cat1  = Cat.from_dir( File.join(@data_dir, "dir1") )
+
+    not_existent_file = File.join(@tmp_dir, "not_existent", "dircat1.yaml")
+    lambda {cat1.save_to( not_existent_file )}.should raise_exception(DirCatException)
+  end
+
+  it "saving to a file" do
+    cat1  = Cat.from_dir( File.join(@data_dir, "dir1") )
+    tmp_file = File.join(@tmp_dir, "dircat1.yaml")
+    cat1.save_to( tmp_file )
+
+    dircat1_bis = Cat.from_file( tmp_file )
+    (cat1 - dircat1_bis).size.should == 0
+    (dircat1_bis - cat1).size.should == 0
+
+    FileUtils.rm( tmp_file )
+  end
+
+
+  it "should detect duplicates" do
+    cat1  = Cat.from_dir( File.join(@data_dir, "dir3") )
+    cat1.duplicates.should have(1).files
+  end
+
+end

data/spec/dircat/cli/dircat_build_spec.rb

@@ -0,0 +1,59 @@
+require File.expand_path( File.join(File.dirname(__FILE__), "..", "..", "spec_helper") )
+
+describe DirCatBuild do
+
+  before do
+    @testdata_dirname         = TEST_DIR
+    @dir1_dirname             = File.join( @testdata_dirname, "dir1" )
+    @dir2_dirname             = File.join( @testdata_dirname, "dir2" )
+    @certified_output_dirname = File.join( @testdata_dirname, "certified_output" )
+    @tmp_output_dirname       = File.join( @testdata_dirname, "tmp" )
+  end
+
+  it "should accept -h (-help) option" do
+    out = with_stdout_captured do
+      args = %w{-h}
+      DirCatBuild.new.parse_args(args)
+    end
+    out.should match /Usage:/
+  end
+
+  it "should accept --version option" do
+    out = with_stdout_captured do
+      args = %w{--version}
+      DirCatBuild.new.parse_args(args)
+    end
+    out.should match /#{DirCat::version}/
+  end
+
+  it "should not accept more then -o options" do
+    out = with_stdout_captured do
+      args = "-f -o filename -o filename1"
+      DirCatBuild.new.parse_args( args.split )
+    end
+    out.should match /only one file/
+  end
+
+
+  it "should build a catalog from a directory" do
+    expect_filename = File.join( @certified_output_dirname, "dircat1.yaml" )
+    result_filename = File.join( @tmp_output_dirname,       "dircat1.yaml")
+
+    out = with_stdout_captured do
+      args = "-f -o #{result_filename} #{@dir1_dirname}"
+      DirCatBuild.new.parse_args( args.split )
+    end
+    # out.should match /Usage:/
+
+    cat_expect = Cat.from_file( expect_filename )
+    cat_result = Cat.from_file( result_filename )
+
+    (cat_result - cat_result).size.should == 0
+
+    (cat_result - cat_expect).size.should == 0
+    (cat_expect - cat_result).size.should == 0
+
+    FileUtils.rm(result_filename)
+  end
+
+end

data/spec/dircat/cli/dircat_query_diff_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path( File.join(File.dirname(__FILE__), "..", "..", "spec_helper") )
+
+describe DirCatDiff do
+
+  before do
+    @testdata_dirname         = TEST_DIR
+    @certified_output_dirname = File.join( @testdata_dirname, "certified_output" )
+  end
+
+  it "should accept -h (help) option" do
+    out = with_stdout_captured do
+      args = %w{-h}
+      DirCatDiff.new.parse_args(args)
+    end
+    out.should match /Usage:/
+  end
+
+  it "should accept --version option" do
+    out = with_stdout_captured do
+      args = %w{--version}
+      DirCatDiff.new.parse_args(args)
+    end
+    out.should match /#{DirCat::version}/
+  end
+
+end

data/spec/dircat/cli/dircat_query_spec.rb

@@ -0,0 +1,35 @@
+require File.expand_path( File.join(File.dirname(__FILE__), "..", "..", "spec_helper") )
+
+describe DirCatQuery do
+
+  before do
+    @testdata_dirname         = TEST_DIR
+    @certified_output_dirname = File.join( @testdata_dirname, "certified_output" )
+  end
+
+  it "should accept -h (help) option" do
+    out = with_stdout_captured do
+      args = %w{-h}
+      DirCatQuery.new.parse_args(args)
+    end
+    out.should match /Usage:/
+  end
+
+  it "should accept --version option" do
+    out = with_stdout_captured do
+      args = %w{--version}
+      DirCatQuery.new.parse_args(args)
+    end
+    out.should match /#{DirCat::version}/
+  end
+
+  it "should show catalogs info" do
+    cat_filename = File.join( @certified_output_dirname, "dircat1.yaml" )
+    out = with_stdout_captured do
+      args = "#{cat_filename}"
+      DirCatQuery.new.parse_args(args.split)
+    end
+    out.should match /file: 2/
+    out.should match /Bytes: 4/
+  end
+end

data/spec/dircat/md5_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path( File.join(File.dirname(__FILE__), "..", "spec_helper") )
+
+describe "MD5" do
+
+  TEST_FILE = File.expand_path( File.join( File.dirname(__FILE__), "..", "..", "lib", "dircat", "extension_md5.rb" ) )
+
+  it "test_simple_md5" do
+    file_name = File.join( TEST_FILE )
+    MD5.file( file_name ).to_s.should  ==  "8777d9d35da17496e21dcc8a4f9f8191"
+  end
+
+end

data/spec/dircat/numeric_spec.rb

@@ -0,0 +1,11 @@
+require File.expand_path( File.join(File.dirname(__FILE__), "..", "spec_helper") )
+
+describe "TCNumeric" do
+
+  it "test_simple" do
+    10.with_separator.should == "10"
+    10.0.with_separator.should == "10.0"
+    1000000.with_separator.should == "1,000,000"
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$:.unshift(File.dirname(__FILE__))
+
+require 'dircat'
+include DirCat
+
+TEST_DIR = File.expand_path( File.join( File.dirname(__FILE__), "fixtures" ) )
+
+# Spec::Runner.configure do |config|
+# end
+
+# require 'test/unit'
+require "stringio"
+
+def with_stdout_captured
+  old_stdout = $stdout
+  out = StringIO.new
+  $stdout = out
+  begin
+    yield
+  ensure
+    $stdout = old_stdout
+  end
+  out.string
+end