weigh 0.0.3 → 0.1.0

data/README.md

@@ -1,5 +1,7 @@
 # Weigh
 
+[![Build Status](https://travis-ci.org/xaque208/weigh.png?branch=master)](https://travis-ci.org/xaque208/weigh)
+
 A small ruby utility to weigh directory contents.  Heavy stuff to the bottom.
 
 ## Example output

data/bin/weigh

@@ -1,6 +1,13 @@
 #! /usr/bin/env ruby
-# Weigh directory contents
+
+# Summarize the size of directories and rank the totals.
 
 require 'weigh/cli'
+require 'colored'
 
-Weigh::CLI.run ARGV
+begin
+  Weigh::CLI.command.run ARGV
+rescue Interrupt
+  $stderr.puts "Terminating!".red
+  exit 1
+end

data/lib/weigh/cli.rb

@@ -1,44 +1,44 @@
-require 'weigh/flags'
-require 'weigh/runner'
+require 'weigh/run'
+require 'weigh/util'
+require 'cri'
 
-module Weigh
-  class CLI
+module Weigh::CLI
 
-    attr_reader :flags
-    attr_reader :runner
+  def self.command
+    @cmd ||= Cri::Command.define do
+      name 'weigh'
+      usage 'weigh [options] <path1> <path2>'
+      summary 'Summarize the size of directories and files'
 
-    def initialize(flags)
-      @flags  = flags
-      @runner = Weigh::Runner.new(@flags)
-    end
+      w = Weigh::Run.new
 
-    def run
-      if flags.help?
-        puts flags
-        exit
+      flag :h, :help, 'show help for this command' do |value, cmd|
+        puts cmd.help
+        exit 0
       end
 
-      runner.run
-    end
-
-    def self.shutdown
-      puts "Terminating..."
-      exit 0
-    end
-
-    Signal.trap("TERM") do
-      shutdown()
-    end
+      flag :V, :version, 'show help for this command' do |value, cmd|
+        require 'weigh/version'
+        puts "Weigh.rb version " + Weigh::VERSION
+        exit 0
+      end
 
-    Signal.trap("INT") do
-      shutdown()
-    end
+      flag :v, :verbose, 'speak up' do |value, cmd|
+        w.verbose = true
+      end
 
-    def self.run(*args)
-      flags = Weigh::Flags.new args
+      flag :d, :depth, 'Sumarize deeper than depth' do |value, cmd|
+        #w.depth = value
+      end
 
-      return Weigh::CLI.new(flags).run
+      run do |opts, args, cmd|
+        if args.size > 0
+          w.pathlist = args
+        end
+        w.run
+        w.report
+        exit 0
+      end
     end
-
   end
 end

data/lib/weigh/run.rb

@@ -0,0 +1,86 @@
+require 'weigh/util'
+require 'find'
+
+module Weigh
+  class Run
+
+    attr_accessor :verbose, :pathlist
+
+    def initialize(pathlist=['.'])
+      @pathlist = pathlist
+
+      @data              = {
+        :total_size => 0,
+        :summary    => {},
+        :count      => 0
+      }
+    end
+
+    def verbose=(value)
+      @verbose = value
+    end
+
+    def verbose
+      @verbose
+    end
+
+    def pathlist=(value)
+      @pathlist = value
+    end
+
+    def pathlist
+      @pathlist
+    end
+
+    def run
+      # Dig into each path given
+      @pathlist.each do |p|
+        Find.find(p) do |path|
+          @data[:count] += 1
+
+          # Skip symlinks
+          next if FileTest.symlink?(path)
+
+          if FileTest.directory?(path)
+
+            # Skip the path that we are already on
+            next if p == path
+
+            # Summarize the directory data
+            ret = Weigh::Util.sum_dir(path,@verbose)
+            dir_size = ret[:dir_size]
+
+            # Skip empty directories
+            next if dir_size == 0
+
+            # Record the data from the directory
+            @data[:count]      += ret[:count]
+            @data[:total_size] += dir_size
+
+            # Add a trailing slash to the key for directories
+            pathname = path + "/"
+
+            @data[:summary][pathname] = dir_size
+
+            Find.prune
+          else
+            # Store the size of the current file
+            size = FileTest.size(path)
+
+            # Don't count zero sized files
+            next if size == 0
+
+            @data[:total_size] += size
+            @data[:summary][path] = size
+          end
+        end
+      end
+
+      @data
+    end
+
+    def report
+      Weigh::Util.report @data
+    end
+  end
+end

data/lib/weigh/util.rb

@@ -1,6 +1,11 @@
 module Weigh
   module Util
 
+    # Convert a byte count into something a bit more human friendly
+    #
+    # @param [Int] a byte count
+    #
+    # @return [String] human readable byte count 
     def self.neat_size(bytes)
       # return a human readble size from the bytes supplied
       bytes = bytes.to_f
@@ -20,73 +25,68 @@ module Weigh
       neat
     end
 
+    # Sumarize the size of the given directory
+    #
+    # @param [String] full path to directory
+    # @param [Boolean] increase verbosity
+    #
+    # @return Hash {:dir_size => Hash, :count => Int}
     def self.sum_dir(dir,verbose=false)
       # return the size of a given directory
       #"Entering: #{dir}"
-      count=0
-      dir_size=0
-      data={}
+      count    = 0
+      dir_size = 0
+      data     = {}
+
       Find.find(dir) do |path|
-        count += 1
-        next if FileTest.symlink?(path)
-        next if dir == path
-        if FileTest.directory?(path)
-          ret = sum_dir(path,verbose)
-          size = ret[:dir_size]
-          count += ret[:count]
-          dir_size += size
-          Find.prune
-        else
-          size = FileTest.size(path)
-          #puts "File: #{path} is #{size}"
-          puts "Found zero size file: #{path}" if verbose
-          dir_size += size
+        begin
+          puts path if verbose
+          count += 1
+          if FileTest.symlink?(path)
+            puts "skipping symlink " + path if verbose
+            next
+          end
+          if dir == path and File.directory?(path)
+            puts "skipping current directory " + path if verbose
+            next
+          end
+          if FileTest.directory?(path)
+            ret = sum_dir(path,verbose)
+            size = ret[:dir_size]
+            count += ret[:count]
+            dir_size += size
+            Find.prune
+          else
+            size = FileTest.size(path)
+            #puts "File: #{path} is #{size}"
+            puts "Found zero size file: #{path}" if verbose
+            dir_size += size
+          end
+        rescue IOError
+          puts "file vanished: " + path
         end
       end
-      #puts "Exiting: #{dir} with #{dir_size}"
       data[:dir_size] = dir_size
       data[:count] = count
       data
     end
 
-    def self.report(summary,total_size)
-      summary.sort{|a,b| a[1]<=>b[1]}.each { |elem|
+    # Print a summary of the received data
+    #
+    # @param [Hash]
+    #
+    # @returns [Hash] the unmodified data
+    def self.report(data)
+      data[:summary].sort{|a,b| a[1]<=>b[1]}.each { |elem|
         size     = elem[1]
         filename = elem[0]
         puts sprintf("%15s   %s\n", neat_size(size), filename)
       }
 
       puts sprintf("%16s %s\n", "---", "---")
-      puts sprintf("%15s   %s\n", self.neat_size(total_size), ":total size")
+      puts sprintf("%15s   %s\n", self.neat_size(data[:total_size]), ":total size")
       puts sprintf("%16s %s\n", "---", "---")
-    end
 
-    def sum_dir(dir,verbose=false)
-      # return the size of a given directory
-      #"Entering: #{dir}"
-      count=0
-      dir_size=0
-      data={}
-      Find.find(dir) do |path|
-        count += 1
-        next if FileTest.symlink?(path)
-        next if dir == path
-        if FileTest.directory?(path)
-          ret = sum_dir(path,verbose)
-          size = ret[:dir_size]
-          count += ret[:count]
-          dir_size += size
-          Find.prune
-        else
-          size = FileTest.size(path)
-          #puts "File: #{path} is #{size}"
-          puts "Found zero size file: #{path}" if verbose
-          dir_size += size
-        end
-      end
-      #puts "Exiting: #{dir} with #{dir_size}"
-      data[:dir_size] = dir_size
-      data[:count] = count
       data
     end
   end

data/lib/weigh/version.rb

@@ -1,7 +1,3 @@
 module Weigh
-  VERSION = '0.0.3'
-
-  def self.version
-    VERSION
-  end
+  VERSION = '0.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: weigh
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-12 00:00:00.000000000 Z
+date: 2014-05-12 00:00:00.000000000 Z
 dependencies: []
 description: Useful utility to weigh the directory contents and sort the output by
   size in a neatly formatted list.
@@ -21,8 +21,7 @@ extra_rdoc_files: []
 files:
 - bin/weigh
 - lib/weigh/cli.rb
-- lib/weigh/flags.rb
-- lib/weigh/runner.rb
+- lib/weigh/run.rb
 - lib/weigh/util.rb
 - lib/weigh/version.rb
 - README.md
@@ -51,3 +50,4 @@ signing_key:
 specification_version: 3
 summary: Weigh directory contents
 test_files: []
+has_rdoc: 

data/lib/weigh/flags.rb

@@ -1,48 +0,0 @@
-require 'optparse'
-
-module Weigh
-  class Flags
-
-    attr_reader :args
-    attr_reader :verbose
-    attr_reader :depth
-    attr_reader :pathlist
-
-    def initialize(*args)
-      @args     = []
-      @verbose  = false
-      @depth    = 1
-      @pathlist = []
-
-      @options = OptionParser.new do|o|
-        o.banner = "Usage: #{File.basename $0} [options] [file|directory...]\n\n"
-
-        o.on( '--verbose', '-v', 'Speak up' ) do
-          @verbose = true
-        end
-
-        o.on( '--depth DEPTH', '-d', 'Sumarize deeper than DEPTH' ) do|d|
-          @depth = d
-        end
-
-        o.on( '-h', '--help', 'Display this screen' ) do
-          @help = true
-        end
-      end
-
-      @args = @options.parse!
-
-      if ARGV.size > 0
-        ARGV.each do |f|
-          @pathlist << f
-        end
-      else
-        @pathlist << "."
-      end
-
-      def help?
-        @help
-      end
-    end
-  end
-end

data/lib/weigh/runner.rb

@@ -1,47 +0,0 @@
-require 'weigh/util'
-require 'pp'
-require 'find'
-
-module Weigh
-  class Runner
-
-    attr_reader :flags
-
-    def initialize(flags)
-      @flags = flags
-    end
-
-    def run
-      total_size = 0
-      summary = {}
-      count = 0
-      sumdep = @flags.depth
-
-      @flags.pathlist.each do |p|
-        curdep = 0
-        Find.find(p) do |path|
-          count += 1
-          next if FileTest.symlink?(path)
-          if FileTest.directory?(path)
-            next if p == path
-            ret = Weigh::Util.sum_dir(path,@flags.verbose)
-            dir_size = ret[:dir_size]
-            next if dir_size == 0
-            count += ret[:count]
-            total_size += dir_size
-            summary["#{path}/"] = dir_size
-            Find.prune
-          else
-            size = FileTest.size(path)
-            next if size == 0
-            total_size += size
-            summary["#{path}"] = size
-          end
-        end
-      end
-
-      Weigh::Util.report(summary,total_size)
-    end
-
-  end
-end