dir_size_renamer 0.0.1

data/README.md

@@ -0,0 +1,92 @@
+DirSizeRenamer
+==============
+
+This console utility lets you rename subdirectories within a specified directory, so that subdirectories' names contain their sizes.
+
+DirSizeRenamer goes through all files within each subfolder recursively, calculating their sizes.
+
+What it does
+------------
+
+Directory structure before using DirSizeRenamer:
+
+*   backups
+  *   G 2012-04-17 12;40;29 (Full)
+  *   G 2012-04-18 09;45;04 (Differential)
+  *   G 2012-04-18 19;15;24 (Differential)
+  *   G 2012-04-19 19;11;22 (Differential)
+  *   G 2012-04-20 19;12;22 (Full)
+  *   G 2012-04-23 19;12;14 (Differential)
+  *   G 2012-04-24 19;12;15 (Differential)
+  *   H 2012-04-17 22;08;23 (Full)
+  *   H 2012-04-18 10;03;33 (Differential)
+  *   H 2012-04-18 19;35;54 (Differential)
+  *   H 2012-04-19 19;30;49 (Differential)
+  *   H 2012-04-21 04;04;29 (Full)
+  *   H 2012-04-23 19;30;24 (Differential)
+  *   H 2012-04-24 19;31;37 (Differential)
+
+Directory structure after applying DirSizeRenamer to the `backups` folder:
+
+*   backups
+  *   G 2012-04-17 12;40;29 (Full) [466.965GB]
+  *   G 2012-04-18 09;45;04 (Differential) [965.34MB]
+  *   G 2012-04-18 19;15;24 (Differential) [1.279GB]
+  *   G 2012-04-19 19;11;22 (Differential) [1.954GB]
+  *   G 2012-04-20 19;12;22 (Full) [469.197GB]
+  *   G 2012-04-23 19;12;14 (Differential) [1001.337MB]
+  *   G 2012-04-24 19;12;15 (Differential) [2.13GB]
+  *   H 2012-04-17 22;08;23 (Full) [886.031GB]
+  *   H 2012-04-18 10;03;33 (Differential) [485.532MB]
+  *   H 2012-04-18 19;35;54 (Differential) [5.975GB]
+  *   H 2012-04-19 19;30;49 (Differential) [7.922GB]
+  *   H 2012-04-21 04;04;29 (Full) [892.858GB]
+  *   H 2012-04-23 19;30;24 (Differential) [5.343GB]
+  *   H 2012-04-24 19;31;37 (Differential) [6.822GB]
+
+File Access Warning
+-------------------
+
+Please note that it will skip files if it has no access to their sizes. Thus, subfolder sizes may appear inaccurate. To resolve this issue, either make sure that the user running the program has access to all target files, or run DirSizeRenamer with `rvmsudo`.
+
+If you use `rvmsudo` and you escape characters or wrap directory name into quotes, then you should escape the quotes and backslashes. This is not a feature of DirSizeRenamer, it's how POSIX works.
+
+Usage
+-----
+
+dir_size_renamer -d <directory> [options]
+
+    -d, --directory      Target directory. dir_size_renamer will process subdirectories within it. Mandatory!
+    -f, --force          Process and re-rename already renamed subdirectories.
+    -v, --verbose        Report results to console.
+    -u, --undo           Derename mode. No calculation is done, sizes are removed from directory names.
+    -h, --help           Display this help message.
+
+### Examples
+
+Rename the subdirectories that don't contain sizes in their names:
+  dir_size_renamer -d /mnt/backups
+
+Rename the subdirectories that don't contain sizes in their names, and display the results in console:
+  dir_size_renamer -d /mnt/backups -v
+
+The above command is the recommended usage for renaming backups.
+
+Rename all the subdirectories, recalculate sizes for those subdirectories that already had sizes in their names:
+  dir_size_renamer -d /mnt/backups -f
+
+Remove sizes from all subdirectories:
+  dir_size_renamer -d /mnt/backups -u
+
+Disclaimer
+----------
+
+I hope this script will not ruin your filesystem! I does not ruin mine at least. If it ruins yours, i don't take responsibility!
+
+Authors and license
+-------------------
+
+Coded by Andrey 'lolmaus' Mikhaylov. lolmaus@gmail.com
+
+DirSizeRenamer is released under the Ruby license.
+

data/bin/dir_size_renamer

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require "dir_size_renamer"
+require "slop"
+
+opts = Slop.parse(help: true) do
+  banner "Usage: dir_size_renamer -d <directory> [options]\n"
+  on :d, :directory, "Target directory. dir_size_renamer will process subdirectories within it.",      :argument => :optional
+  on :f, :force,     "Process and re-rename already renamed subdirectories."
+  on :v, :verbose,   "Report results to console."
+  on :u, :undo,      "Derename mode. No calculation is done, sizes are removed from directory names."
+end
+
+if not (opts[:directory] or opts.force? or opts.verbose? or opts.undo?)
+  puts opts.to_s
+elsif not opts.help?
+  if opts.force? and opts.undo?
+    puts "Please choose either undo renaming or force renaming."
+  elsif opts[:directory]
+
+    dir = opts[:directory].gsub("\\","/")
+
+    if Dir.exists?(dir)
+
+      if opts.undo?
+        DirSizeRenamer.new(dir, verbose: opts.verbose?).rename_undo!
+      else
+        DirSizeRenamer.new(dir, verbose: opts.verbose?, rerename: opts.force?).rename!
+      end
+
+    else
+      puts "Target directory does not exist or is inaccessible: " + opts[:directory]
+    end
+  else
+    puts "Directory not specified."
+  end
+end

data/lib/dir_size_renamer.rb

@@ -0,0 +1,66 @@
+require_relative 'subfolder'
+require 'chronic_duration'
+
+class DirSizeRenamer
+
+  def initialize(directory, options = { verbose: false, rerename: false })
+    # An existing directory should be provided
+    raise "Invalid path given: #{directory}" if not Dir.exists?(directory)
+    @directory = directory
+    @verbose   = options[:verbose]
+    @rerename  = options[:rerename]
+  end
+
+  def rename!
+
+    start_time = Time.now
+
+    report "Starting to rename directories within #{@directory}"
+
+    Dir["#{@directory}/*/"].each do |dir|
+      subfolder = Subfolder.new(dir.chomp("/"))
+
+      report("Processing #{File.basename(subfolder.directory)}... ", inline: true)
+
+      # Derenaming during renaming is necessary only in rerename mode
+      # and only if actual size does not match size in the name
+      subfolder.remove_size_from_name! if @rerename == true and not subfolder.name_matches_size?
+
+      subfolder.add_path_to_name! if not subfolder.name_contains_size?
+      report(subfolder.size_human_readable,skip_time: true)
+
+    end
+
+    report "Finished! Elapsed time: #{ChronicDuration.output(Time.now - start_time)}"
+  end
+
+  def rename_undo!
+    report "Starting to derename directories within #{@directory}"
+
+    Dir["#{@directory}/*/"].each do |dir|
+      subfolder = Subfolder.new(dir.chomp("/"))
+
+      report("Processing #{File.basename(subfolder.directory)}... ")
+      subfolder.remove_size_from_name! if subfolder.name_contains_size?
+      #report(subfolder.size_human_readable,skip_time: true) if @verbose
+
+    end
+
+    report "Finished derenaming!"
+  end
+
+  private
+    def report(text, options = {inline: false, skip_time: false})
+
+      return unless @verbose
+
+      print "[#{Time.new.strftime("%H:%M:%S")}] " unless options[:skip_time]
+
+      if options[:inline]
+        print text
+      else
+        puts text
+      end
+
+    end
+end

data/lib/subfolder.rb

@@ -0,0 +1,84 @@
+require 'find'
+
+class Subfolder
+
+  attr_reader :directory
+
+  def self.renamed_eof_regex
+    / \[\d+(\.\d{1,3})?[KMGT]?B\]$/
+  end
+
+  def initialize(directory)
+    # An existing directory should be provided
+    raise "Invalid path given: #{directory}" if not Dir.exists?(directory)
+    @directory = directory
+  end
+
+  def calc_size!
+    dirsize = 0
+    Find.find(@directory) do |f|
+      dirsize += File.stat(f).size if File.exists?(f) and not File.symlink?(f)
+    end
+
+    @size = dirsize
+
+  end
+
+  def size
+    @size or calc_size!
+  end
+
+  def name_contains_size?
+    @directory =~ Subfolder.renamed_eof_regex
+  end
+
+  def name_matches_size?
+    name_contains_size? and (@directory =~ / \[#{size_human_readable}\]/)
+  end
+
+  def add_path_to_name!
+    new_name = name_with_size
+    File.rename(@directory, new_name)
+    @directory = new_name
+  end
+
+  def remove_size_from_name!
+    return if not name_contains_size?
+    new_name = name_without_size
+    File.rename(@directory, new_name)
+    @directory = new_name
+  end
+
+  def size_human_readable
+    Subfolder.size_human_readable(size)
+  end
+
+  def self.size_human_readable(number_of_bytes)
+    raise "Tried to convert invalid value to human-readable file size: #{number_of_bytes}, #{number_of_bytes.class}" if (number_of_bytes.class != Fixnum \
+                                                                                                                         and number_of_bytes.class != Bignum) \
+                                                                                                                     or number_of_bytes < 0
+    return "0B" if number_of_bytes == 0
+    units = %w{B KB MB GB TB}
+    e = (Math.log(number_of_bytes)/Math.log(1024)).floor
+    s = "%.3f" % (number_of_bytes.to_f / 1024**e)
+    s.sub(/\.?0*$/, units[e])
+  end
+
+  def self.remove_size_from_string(name)
+    name.gsub(Subfolder.renamed_eof_regex,"")
+  end
+
+  private
+    def name_with_size
+      "#{@directory} [#{Subfolder.size_human_readable(size)}]"
+    end
+
+    def name_without_size
+      Subfolder.remove_size_from_string(@directory)
+    end
+
+
+
+end
+
+

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: dir_size_renamer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Andrey 'lolmaus' Mikhaylov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-25 00:00:00.000000000 Z
+dependencies: []
+description: This console utility lets you rename subdirectories within a specified
+  directory, so that subdirectories' names contain their sizes.
+email: lolmaus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/dir_size_renamer.rb
+- lib/subfolder.rb
+- bin/dir_size_renamer
+- README.md
+homepage: https://github.com/lolmaus/dir_size_renamer
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: DirSizeRenamer
+test_files: []