fixnames 0.3.0 → 0.4.0

data/README.md

@@ -4,22 +4,65 @@ Fix filenames to be bash-script safe and easy to type.
 
 ## Usage
 
-  See the {Fixnames::Option} for the various settings.
+ee the {Fixnames::Option} for the various settings.
 
+``` sh
     fixnames [options] <files>
     fixdirs [options] <directories>
+```    
 
 ### examples
 
 cleanup a dir:
+
+``` sh
     fixnames -fvv somedir/*
+```
 
 Remove all "`xyzzy`" from filenames:
+
+``` sh
     fixnames -x xyzzy *
+```
 
 Remove all *digits* from filenames and replace them with "`X`":
+
+``` sh
     fixnames -x \[0-9] -r X *
+```
+
+## Suggested Alias
+
+I keep the actually changing of massive amounts of filenames
+as something you must _requrest_ proactively. Higher levels of
+verbosity are often essential, and the "-p" flag to _pretend_
+to make changes at first cna save you from MASSIVE data loss.
+
+I also include the `-f/--full` option to turn on all of the 
+standard filters, which is the aggressive renaming I want to do,
+but i's still probably a good idea tol leave it explicitly "opt-in".
+
+Because of all of this, I usually run with this alias:
+
+``` sh
+    alias fn='fixnames -fvv'
+```
+
+With that I can use the fact that it auto-supplies `"./*"`
+as what to work on means I can an entire directoy of bad
+files with just `"fn"`.
+
+## Fixdirs still unfinished
+
+Recursive-descent into sub-dirs with `fixdirs` isn't really
+finished yet. It might be a bit too much to have a command
+that can wipe out an entire filesystem.
 
+It should go
+withoutsaying, you should **NEVER** use this stuff as *Root*!
+It doesn't matter, though, as it's proving in practice
+to be suficient easy to just do things directory-at-a-time.
+with `fixnames` by itself.
 
 ## Copyright
 

data/Rakefile

@@ -37,12 +37,12 @@ end
 
 task :default => :spec
 
-# require 'yard'
-# YARD::Rake::YardocTask.new do |t|
-#   t.files = ['lib/**/*.rb']
-#   t.files += ['bin/*']
-#   #t.files += ['spec/**/*_spec.rb']
-#   #t.options += ['--plugin', 'yard-rspec']
-#   t.options += ['--markup', 'markdown']
-#   t.options += ['--debug']
-# end
+require 'yard'
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb']
+  t.files += ['bin/*']
+  #t.files += ['spec/**/*_spec.rb']
+  #t.options += ['--plugin', 'yard-rspec']
+  t.options += ['--markup', 'markdown']
+  t.options += ['--debug']
+end

data/bin/fixdirs

@@ -20,12 +20,17 @@ end
 optparse = OptionParser.new do |opts|
   opts.banner = $banner
   opts.define_head "Usage: #{$0} [options] <file> [<file> ... ]"
+  opts.summary_width = 24
+  opts.summary_indent = '  '
+
+  desc_pad = ' ' * (opts.summary_width + 3)
 
   opts.separator ''
-  opts.separator '  DIRECTORIES:'
+  opts.separator 'DIRECTORIES:'
 
   opts.on('-g', '--glob=GLOB_STRING',
-          'Filename glob inside each directory (default: #{options[:glob]})'
+          "Filename glob to use inside each directory for when
+#{desc_pad}we are left to ourself. Default: #{options.dir_glob}"
           ) { |val| options.dir_glob = val }
 
   opts.on('-R', '--[no-]recursive',
@@ -33,7 +38,7 @@ optparse = OptionParser.new do |opts|
           ) { |val| options.recursive = val }
 
   opts.separator ''
-  opts.separator '  FILTERS:'
+  opts.separator 'FILTERS:'
 
   opts.on('-A', '--[no-]hack_and',
           'Replace "&" with "_and_"'
@@ -52,11 +57,14 @@ optparse = OptionParser.new do |opts|
           ) { |val| options.brackets = val }
 
   opts.on('-k', '--[no-]checksums',
-         'Trims [0A1B2C3D] CRC32 checksums from names. ( [] or () )'
+         "Trims [0A1B2C3D] CRC32 bracket-wrapped checksums
+#{desc_pad}from names, when wrapped with square brackes []
+#{desc_pad}or round parens ()"
           ) { |val| options.checksums = val }
 
   opts.on('-d', '--[no-]dots',
-         'Trims excessive dots from files (before the .extention)'
+         'Trims excessive dots from files
+ (before the .extention)'
           ) { |val| options.fix_dots = val }
 
   opts.on('-D', '--[no-]dashes',
@@ -72,10 +80,11 @@ optparse = OptionParser.new do |opts|
           ) { |val| options.lowercase = val }
 
   opts.separator ''
-  opts.separator '  CHARACTERS:'
+  opts.separator 'CHARACTERS:'
 
-  opts.on('-w', '--whitespace=CHARLIST',
-          "Characters to treat as whitespace, to be replaced with underscores."
+  opts.on('-w', '--whitespace=CHARS',
+          "Characters to treat as whitespace, to be
+#{desc_pad}replaced with underscores."
           ) { |val| options.whitespace = val }
 
   opts.on('-W', '--no-whitespace',
@@ -83,7 +92,8 @@ optparse = OptionParser.new do |opts|
           ) {       options.whitespace = nil }
 
   opts.on('-s', '--strip=CHARLIST',
-          "Characters to strip from names. default: #{options.charstrip}"
+          "Individual characters to strip from names.
+#{desc_pad}Default: #{options.charstrip}"
           ) { |val| options.charstrip = val }
 
   opts.on('-S', '--no-strip',
@@ -91,29 +101,44 @@ optparse = OptionParser.new do |opts|
           ) {       options.charstrip = nil }
 
   opts.separator ''
-  opts.separator '  REGEX-REPLACE:'
-
-  opts.on('-x', '--expunge=REGEX',
-          'Expung a regexp from all filenames'
-          ) { |val| options.expunge = val }
+  opts.separator 'REGEX-REPLACE:'
+
+  opts.on('-x', '--expunge [REGEX]',
+          "Expung a regexp from all filenames. If a REGEX is
+#{desc_pad}not specified, it searches the current directory's
+#{desc_pad}filenames for a common prefix that can be removed."
+          ) do |val|
+    if val.nil?
+      options.expunge_common_prefix!
+    else
+      options.expunge = val
+    end
+  end
 
   opts.on('-r', '--replace=STRING',
-          'Replace expunged text with'
+          'Replace expunged text with the given STRING'
           ) { |val| options.mendstr = val }
 
   opts.separator ''
-  opts.separator '  COLLECTIONS:'
+  opts.separator 'COLLECTIONS:'
 
   opts.on('-f', '--full',
           'All filters are turned on!'
           ) do
-    Fixnames::Option::FLAG_FILTERS.each do |f|
-      options.send(f, true)
-    end
+    options.all_flags = true
+  end
+
+  opts.on('-M', '--max-autofix',
+          "All of --full plus standard options elsewhere.
+#{desc_pad}Should be mostly safe, as we do not clobber fixes
+#{desc_pad}when renaming, but could still be dangerous!"
+          ) do
+    options.all_flags = true
+    options.expunge_common_prefix! if options.expunge.nil?
   end
 
   opts.separator ''
-  opts.separator '  META:'
+  opts.separator 'META:'
 
   opts.on('-p', '--pretend',
           'Pretend to run; no filesystem changes are made'
@@ -144,5 +169,3 @@ filelist = ARGV
 filelist = Dir['*'] if ARGV.length < 1
 
 Fixnames::FixFile.fix_list! filelist, options
-
-

data/bin/fixnames

@@ -20,12 +20,17 @@ end
 optparse = OptionParser.new do |opts|
   opts.banner = $banner
   opts.define_head "Usage: #{$0} [options] <file> [<file> ... ]"
+  opts.summary_width = 24
+  opts.summary_indent = '  '
+
+  desc_pad = ' ' * (opts.summary_width + 3)
 
   opts.separator ''
-  opts.separator '  DIRECTORIES:'
+  opts.separator 'DIRECTORIES:'
 
   opts.on('-g', '--glob=GLOB_STRING',
-          'Filename glob inside each directory (default: #{options[:glob]})'
+          "Filename glob to use inside each directory for when
+#{desc_pad}we are left to ourself. Default: #{options.dir_glob}"
           ) { |val| options.dir_glob = val }
 
   opts.on('-R', '--[no-]recursive',
@@ -33,7 +38,7 @@ optparse = OptionParser.new do |opts|
           ) { |val| options.recursive = val }
 
   opts.separator ''
-  opts.separator '  FILTERS:'
+  opts.separator 'FILTERS:'
 
   opts.on('-A', '--[no-]hack_and',
           'Replace "&" with "_and_"'
@@ -52,11 +57,14 @@ optparse = OptionParser.new do |opts|
           ) { |val| options.brackets = val }
 
   opts.on('-k', '--[no-]checksums',
-         'Trims [0A1B2C3D] CRC32 checksums from names. ( [] or () )'
+         "Trims [0A1B2C3D] CRC32 bracket-wrapped checksums
+#{desc_pad}from names, when wrapped with square brackes []
+#{desc_pad}or round parens ()"
           ) { |val| options.checksums = val }
 
   opts.on('-d', '--[no-]dots',
-         'Trims excessive dots from files (before the .extention)'
+         'Trims excessive dots from files
+ (before the .extention)'
           ) { |val| options.fix_dots = val }
 
   opts.on('-D', '--[no-]dashes',
@@ -72,10 +80,11 @@ optparse = OptionParser.new do |opts|
           ) { |val| options.lowercase = val }
 
   opts.separator ''
-  opts.separator '  CHARACTERS:'
+  opts.separator 'CHARACTERS:'
 
-  opts.on('-w', '--whitespace=CHARLIST',
-          "Characters to treat as whitespace, to be replaced with underscores."
+  opts.on('-w', '--whitespace=CHARS',
+          "Characters to treat as whitespace, to be
+#{desc_pad}replaced with underscores."
           ) { |val| options.whitespace = val }
 
   opts.on('-W', '--no-whitespace',
@@ -83,7 +92,8 @@ optparse = OptionParser.new do |opts|
           ) {       options.whitespace = nil }
 
   opts.on('-s', '--strip=CHARLIST',
-          "Characters to strip from names. default: #{options.charstrip}"
+          "Individual characters to strip from names.
+#{desc_pad}Default: #{options.charstrip}"
           ) { |val| options.charstrip = val }
 
   opts.on('-S', '--no-strip',
@@ -91,29 +101,44 @@ optparse = OptionParser.new do |opts|
           ) {       options.charstrip = nil }
 
   opts.separator ''
-  opts.separator '  REGEX-REPLACE:'
-
-  opts.on('-x', '--expunge=REGEX',
-          'Expung a regexp from all filenames'
-          ) { |val| options.expunge = val }
+  opts.separator 'REGEX-REPLACE:'
+
+  opts.on('-x', '--expunge [REGEX]',
+          "Expung a regexp from all filenames. If a REGEX is
+#{desc_pad}not specified, it searches the current directory's
+#{desc_pad}filenames for a common prefix that can be removed."
+          ) do |val|
+    if val.nil?
+      options.expunge_common_prefix!
+    else
+      options.expunge = val
+    end
+  end
 
   opts.on('-r', '--replace=STRING',
-          'Replace expunged text with'
+          'Replace expunged text with the given STRING'
           ) { |val| options.mendstr = val }
 
   opts.separator ''
-  opts.separator '  COLLECTIONS:'
+  opts.separator 'COLLECTIONS:'
 
   opts.on('-f', '--full',
           'All filters are turned on!'
           ) do
-    Fixnames::Option::FLAG_FILTERS.each do |f|
-      options.send(f, true)
-    end
+    options.all_flags = true
+  end
+
+  opts.on('-M', '--max-autofix',
+          "All of --full plus standard options elsewhere.
+#{desc_pad}Should be mostly safe, as we do not clobber fixes
+#{desc_pad}when renaming, but could still be dangerous!"
+          ) do
+    options.all_flags = true
+    options.expunge_common_prefix! if options.expunge.nil?
   end
 
   opts.separator ''
-  opts.separator '  META:'
+  opts.separator 'META:'
 
   opts.on('-p', '--pretend',
           'Pretend to run; no filesystem changes are made'
@@ -144,5 +169,3 @@ filelist = ARGV
 filelist = Dir['*'] if ARGV.length < 1
 
 Fixnames::FixFile.fix_list! filelist, options
-
-

data/fixnames.gemspec

@@ -4,20 +4,18 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{fixnames}
-  s.version = "0.3.0"
+  s.name = "fixnames"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = [%q{Brent Sanders}]
-  s.date = %q{2011-10-04}
-  s.description = %q{Cleans up filenames so they can easily be used
-in scripts, without annoyances such as spaces or other bad characters}
-  s.email = %q{git@thoughtnoise.net}
-  s.executables = [%q{fixnames}, %q{fixdirs}]
+  s.authors = ["Brent Sanders"]
+  s.date = "2012-02-26"
+  s.description = "Cleans up filenames so they can easily be used\nin scripts, without annoyances such as spaces or other bad characters"
+  s.email = "git@thoughtnoise.net"
+  s.executables = ["fixnames", "fixdirs"]
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.md",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
@@ -25,9 +23,7 @@ in scripts, without annoyances such as spaces or other bad characters}
     "COPYING",
     "LICENSE.txt",
     "README.md",
-    "README.rdoc",
     "Rakefile",
-    "VERSION",
     "bin/fixdirs",
     "bin/fixnames",
     "fixnames.gemspec",
@@ -59,11 +55,11 @@ in scripts, without annoyances such as spaces or other bad characters}
     "test/test_semicolon.rb",
     "test/test_whitespace.rb"
   ]
-  s.homepage = %q{http://github.com/pdkl95/fixnames}
-  s.licenses = [%q{MIT}]
-  s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.5}
-  s.summary = %q{Filename cleanup for script compatability}
+  s.homepage = "http://github.com/pdkl95/fixnames"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.11"
+  s.summary = "Filename cleanup for script compatability"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/lib/fixnames/option.rb

@@ -1,3 +1,5 @@
+require 'abbrev'
+
 module Fixnames
   class Option
     # filters that MUST run early
@@ -159,5 +161,25 @@ module Fixnames
     # if set, we just pretend to work, and skip the final
     # move command, so the filesystem is never altered
     mkopt :pretend, [TrueClass, FalseClass], false
+
+
+    #################################################################
+
+    def all_flags=(val)
+      Fixnames::Option::FLAG_FILTERS.each do |f|
+        send(f, val)
+      end
+    end
+
+    def expunge_common_prefix!
+      STDERR.puts "DWIM-WARN: No REGEX was given to -x/--expunge"
+      pfx = Dir['*'].abbrev.keys.min_by{ |k| k.length }.chop
+      if pfx && pfx.length > 0
+        STDERR.puts "DWIM-WARN: Will expunge the common prefix: %r{^#{pfx}}"
+        self.expunge = "^#{pfx}"
+      else
+        raise  RuntimeError, 'ERROR: No common prefixes found in $PWD/*'
+      end
+    end
   end
 end

data/lib/fixnames/version.rb

@@ -1,7 +1,7 @@
 class Fixnames
   module Version
     MAJOR = 0
-    MINOR = 3
+    MINOR = 4
     PATCH = 0
     BUILD = nil
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fixnames
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-04 00:00:00.000000000 Z
+date: 2012-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
-  requirement: &5016780 !ruby/object:Gem::Requirement
+  requirement: &10980100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.0.6
   type: :runtime
   prerelease: false
-  version_requirements: *5016780
+  version_requirements: *10980100
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &5012940 !ruby/object:Gem::Requirement
+  requirement: &10979300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *5012940
+  version_requirements: *10979300
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &5010180 !ruby/object:Gem::Requirement
+  requirement: &10978520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *5010180
+  version_requirements: *10978520
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &5057860 !ruby/object:Gem::Requirement
+  requirement: &10977640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *5057860
+  version_requirements: *10977640
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &5056700 !ruby/object:Gem::Requirement
+  requirement: &10976840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *5056700
+  version_requirements: *10976840
 description: ! 'Cleans up filenames so they can easily be used
 
   in scripts, without annoyances such as spaces or other bad characters'
@@ -77,16 +77,13 @@ extensions: []
 extra_rdoc_files:
 - LICENSE.txt
 - README.md
-- README.rdoc
 files:
 - .document
 - .rspec
 - COPYING
 - LICENSE.txt
 - README.md
-- README.rdoc
 - Rakefile
-- VERSION
 - bin/fixdirs
 - bin/fixnames
 - fixnames.gemspec
@@ -138,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Filename cleanup for script compatability

data/README.rdoc

@@ -1,17 +0,0 @@
-= fixnames
-
-Description goes here.
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2010 Brent Sanders. See LICENSE for details.

data/VERSION

@@ -1 +0,0 @@
-0.0.1