clean 1.1.1

data/bin/clean

@@ -0,0 +1,22 @@
+#!/usr/local/bin/ruby
+
+require 'rubygems'
+require 'clean'
+
+include Options
+include Config
+include Destinations
+include CommandUtil
+
+$OPTS=get_options(ARGV.dup)
+
+##################################################
+### Make and run commands ########################
+##################################################
+
+$OPTS[:dirs].each do |dir|
+  cmds=dir_commands(dir)
+  cmds+=file_commands(dir)
+
+  cmds.sort.map &:run
+end

data/lib/clean.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'yaml'
+require 'activesupport'
+require 'fileutils'
+require 'trollop'
+
+Dir[File.join(File.dirname(__FILE__),'*.rb')].each do |file|
+  require file
+end

data/lib/command_util.rb

@@ -0,0 +1,46 @@
+##################################################
+### Make commands ################################
+##################################################
+
+module CommandUtil
+  def make_file_command filename
+    dest=destination_for filename
+
+    return nil unless dest
+
+    if dest=="_rm"
+      RemoveCommand.new filename
+    else
+      MoveCommand.new filename, dest
+    end
+  end
+
+  def file_commands dir
+    dir=File.expand_path dir
+    cmds=Dir[File.join(dir, '*')].map do |filename|
+      nil if File.directory? filename
+      make_file_command(File.basename(filename))
+    end
+
+    cmds.compact.map { |c| c.path=dir ; c }
+  end
+
+  def dir_commands dir
+    dir=File.expand_path dir
+
+    cmds=config['directories'].keys.map do |dest|
+      next if dest=='_rm'
+      path=File.join(dir,dest)
+      if File.exists?(path)
+        if !File.directory?(path)
+          Trollop::die "#{path} already exists, and isn't a directory"
+        else
+          nil
+        end
+      else
+        CreateCommand.new dest,dir
+      end
+    end
+    cmds.compact
+  end
+end

data/lib/commands.rb

@@ -0,0 +1,143 @@
+class Command
+  attr_accessor :path
+
+  def priority ; nil ; end
+
+  def transform filename
+    if path
+      File.join path, filename
+    else
+      File.join '.', filename
+    end
+  end
+
+  def run
+    unless $OPTS[:silent]
+      dr=dry_run
+      puts(dry_run) if dry_run
+    end
+
+    real_run unless $OPTS[:dry_run]
+  end
+
+  def dry_run ; raise NotImplementedError ; end
+  def real_run ; raise NotImplementedError ; end
+
+  def <=> other
+    priority <=> other.priority
+  end
+end
+
+##################################################
+### Move files ###################################
+##################################################
+
+class MoveCommand < Command
+  def priority ; 2 ; end
+
+  def initialize *args
+    (@filename, @directory, @path)=args
+  end
+
+  def filename ; transform @filename ; end
+  def directory ; transform @directory ; end
+
+  def dry_run
+    case $OPTS[:on_collision]
+    when 'overwrite'
+      "mv #{filename} #{directory}"
+    when 'rename'
+      "mv #{filename} #{File.join(directory,unique_name)}"
+    else # 'ignore' also
+      # emit nothing
+    end
+  end
+
+  def real_run
+    case $OPTS[:on_collision]
+    when 'overwrite'
+      mv
+    when 'rename'
+      if collision?
+        FileUtils.mv filename, File.join(directory,unique_name)
+      else
+        mv
+      end
+    else # captures the 'ignore' option too
+      # do nothing
+    end
+  end
+
+  private
+
+  def mv
+    FileUtils.mv filename, directory
+  end
+
+  def collision? fname=filename
+    File.exists?(File.join(directory,File.basename(fname)))
+  end
+
+  def unique_name
+    fname=filename
+
+    # make sure there's a real collision
+    return fname unless collision? fname
+
+    # ext is like ".jpg"
+    ext=File.extname(fname)
+
+    # Base is the filename - dir and extension, so /foo/bar.txt -> bar
+    base=File.basename(fname,ext)
+
+    # loop until we find an n that'll work. Start with bar-1.txt
+    n=1
+    n+=1 while collision?("#{base}-#{n}#{ext}")
+
+    "#{base}-#{n}#{ext}"
+  end
+end
+
+##################################################
+### Create directories ###########################
+##################################################
+
+class CreateCommand < Command
+  def priority ; 1 ; end
+
+  def initialize *args
+    (@dirname, @path)=args
+  end
+
+  def dirname ; transform @dirname ; end
+
+  def dry_run
+    "mkdir #{dirname}"
+  end
+
+  def real_run
+    FileUtils.mkdir_p dirname
+  end
+end
+
+##################################################
+### Remove files #################################
+##################################################
+
+class RemoveCommand < Command
+  def priority ; 3 ; end
+
+  def initialize *args
+    (@filename, @path)=args
+  end
+
+  def filename ; transform @filename ; end
+
+  def dry_run
+    "rm #{filename}"
+  end
+
+  def real_run
+    FileUtils.rm filename
+  end
+end

data/lib/config.rb

@@ -0,0 +1,31 @@
+##################################################
+### Read config file #############################
+##################################################
+
+module Config
+  def config
+    return @config if @config
+
+    file=File.expand_path($OPTS[:config_file])
+    if File.exists? file
+      @config||=YAML.load(File.open(file))
+    else
+      ex=File.expand_path(File.join(File.dirname(__FILE__),
+                                    '..','res','clean.yml'))
+      puts "Warning: config file #{file} not found; using default #{ex}"
+      @config||=YAML.load(File.open(ex))
+    end
+  end
+
+  def destination_map
+    unless @destination_map
+      @destination_map={}
+      config['directories'].each do |directory, extensions|
+        extensions.each do |ext|
+          @destination_map[ext]=directory
+        end
+      end
+    end
+    @destination_map
+  end
+end

data/lib/destinations.rb

@@ -0,0 +1,21 @@
+##################################################
+### Find move destinations #######################
+##################################################
+
+module Destinations
+  def all_extensions_for filename
+    destination_map.keys.map{ |extension|
+      safe_extension=Regexp.escape(extension)
+      (filename =~ Regexp.new("#{safe_extension}$")) ? extension : nil
+    }.compact
+  end
+  
+  def destination_for filename
+    longest_extension=
+      all_extensions_for(filename).sort{|a,b| 
+      -(a<=>b)
+    }[0]
+
+    destination_map[longest_extension]
+  end
+end

data/lib/options.rb

@@ -0,0 +1,31 @@
+##################################################
+### Options ######################################
+##################################################
+
+module Options
+  def get_options args=ARGV
+    opts=Trollop::options(args) do
+      version "cleaner 1.1.1"
+      banner <<-EOS
+Cleaner is a program for automatically sorting files based on their extensions.
+
+Usage:
+       clean [options] <dirs>+
+
+where [options] are:
+EOS
+      opt(:dry_run, "Just print commands, don't move anything",
+          :default=>false)
+      opt(:config_file, "Where to load mappings from",
+          :default=>'~/.clean.yml', :type=>String)
+      opt(:silent, "Don't print commands",
+          :default=>false)
+      opt(:on_collision, "If the destination file already exists, rename, overwrite, or ignore?",
+          :default=>'rename')
+    end
+
+    opts[:dirs]=( args.empty? ? ['.'] : args )
+
+    opts
+  end
+end

data/res/clean.yml

@@ -0,0 +1,36 @@
+directories:
+  images:
+    - .jpg
+    - .JPG
+    - .gif
+    - .GIF
+    - .png
+    - .jpeg
+
+  documents:
+    - .pdf
+    - .doc
+    - .ps
+
+  archives:
+    - .tar.gz
+    - .gz
+    - .zip
+    - .bzip
+
+  programs:
+    - .dmg
+    - .app
+    - .pkg
+
+  windows:
+    - .exe
+    - .EXE
+
+  code:
+    - .java
+    - .rb
+
+  _rm:
+    - .torrent
+    - "~"

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: clean
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  - 1
+  version: 1.1.1
+platform: ruby
+authors: 
+- Andrews, Ross
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-08 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: trollop
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 10
+        - 2
+        version: 1.10.2
+  type: :runtime
+  version_requirements: *id002
+description: 
+email: randrews@geekfu.org
+executables: 
+- clean
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- res/clean.yml
+- lib/clean.rb
+- lib/command_util.rb
+- lib/commands.rb
+- lib/config.rb
+- lib/destinations.rb
+- lib/options.rb
+has_rdoc: true
+homepage: http://geekfu.org
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A utility for sorting messy folders
+test_files: []
+