deblank 0.0.1 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 39b5293f35eba93c2a7b59401af1484d9959df73
+  data.tar.gz: d9e64611e4839b69a0fe1cfc5fa238156dbddfac
+SHA512:
+  metadata.gz: 9c2f513577c3047515d67525590729e8f47d493592a6a5888e0b53b309cd7c04486df92bb7db510e9ac5222bba9709461e813329bf692a4af2abcc746712211a
+  data.tar.gz: a02f35e87252e960c005b035bfe7a5949ad790b55d6cec21d12a5896dabc86009c44bc98b825c6433e39d3e0d3bb1462ca2ba52fd841a8418d3c4ca3ea0b4925

data/README.md

@@ -37,7 +37,7 @@ Installation
 
 You can either
 
-- use `gem install deblank`,
+- use `gem install deblank` to install from RubyGems.org,
 
 - copy `lib/deblank.rb` under the name `deblank` into your search path,
 
@@ -51,8 +51,8 @@ Requirements
 
 - No additional Ruby gems are needed to run `deblank`.
 
-- `deblank` has been tested with Ruby 1.9.3 on a Linux machine
-  and on Windows (command prompt with code page 850).
+- `deblank` has been tested with Ruby 1.9.3 and Ruby 2.0.0
+  on Linux and on Windows (command prompt with code page 850).
 
 Documentation
 -------------
@@ -77,7 +77,7 @@ Report bugs on the `deblank` home page: <https://github.com/stomar/deblank/>
 License
 -------
 
-Copyright &copy; 2012, Marcus Stollsteimer
+Copyright &copy; 2012-2013 Marcus Stollsteimer
 
 `deblank` is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License version 3 or later (GPLv3+),

data/Rakefile

@@ -1,6 +1,6 @@
 # rakefile for the deblank script.
 #
-# Copyright (C) 2012 Marcus Stollsteimer
+# Copyright (C) 2012-2013 Marcus Stollsteimer
 
 require 'rake/testtask'
 
@@ -30,7 +30,6 @@ end
 task :default => [:test]
 
 Rake::TestTask.new do |t|
-  t.libs << '.'
   t.pattern = 'test/**/test_*.rb'
   t.ruby_opts << '-rubygems'
   t.verbose = true

data/bin/deblank

@@ -1,4 +1,4 @@
-#!/usr/bin/ruby -w
+#!/usr/bin/env ruby
 
 require 'deblank'
 

data/deblank.gemspec

@@ -9,7 +9,6 @@ Gem::Specification.new do |s|
   s.name              = 'deblank'
   s.version           = version
   s.date              = date
-  s.rubyforge_project = 'deblank'
 
   s.description = 'deblank is a command line tool that ' +
                   'renames files and replaces or removes special characters ' +
@@ -22,14 +21,16 @@ Gem::Specification.new do |s|
 
   s.license = 'GPL-3'
 
-  # s.requirements = ''
+  s.required_ruby_version = '>=1.9.2'
+
+  s.add_development_dependency('rake')
 
   s.executables = ['deblank']
   s.bindir = 'bin'
+
   s.require_path = 'lib'
-  s.test_files = Dir.glob('test/**/test_*.rb')
 
-  s.rdoc_options = ['--charset=UTF-8']
+  s.test_files = Dir.glob('test/**/test_*.rb')
 
   s.files = %w{
       README.md
@@ -39,5 +40,5 @@ Gem::Specification.new do |s|
     } +
     Dir.glob('{bin,lib,man,test}/**/*')
 
-  s.add_development_dependency('rake')
+  s.rdoc_options = ['--charset=UTF-8']
 end

data/lib/deblank.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/ruby -w
+#!/usr/bin/env ruby
 # encoding: UTF-8
 # == Name
 #
@@ -15,7 +15,7 @@
 #
 # == Author
 #
-# Copyright (C) 2012 Marcus Stollsteimer
+# Copyright (C) 2012-2013 Marcus Stollsteimer
 #
 # License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
 
@@ -25,15 +25,17 @@ require 'optparse'
 module Deblank
 
   PROGNAME  = 'deblank'
-  VERSION   = '0.0.1'
-  DATE      = '2012-12-20'
+  VERSION   = '0.1.0'
+  DATE      = '2013-10-27'
   HOMEPAGE  = 'https://github.com/stomar/deblank'
   TAGLINE   = 'remove special characters from filenames'
 
-  COPYRIGHT = "Copyright (C) 2012 Marcus Stollsteimer.\n" +
-              "License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n" +
-              "This is free software: you are free to change and redistribute it.\n" +
-              "There is NO WARRANTY, to the extent permitted by law."
+  COPYRIGHT = <<-copyright.gsub(/^ +/, '')
+    Copyright (C) 2012-2013 Marcus Stollsteimer.
+    License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.
+    This is free software: you are free to change and redistribute it.
+    There is NO WARRANTY, to the extent permitted by law.
+  copyright
 
   # Parser for the command line options.
   # The class method parse! does the job.
@@ -50,23 +52,23 @@ module Deblank
 
       options = {
         :files  => nil,
-        :simulate => false,
+        :simulate => false
       }
 
       opt_parser = OptionParser.new do |opt|
         opt.banner = "Usage: #{PROGNAME} [options] file[s]"
-        opt.separator ''
-        opt.separator 'deblank renames files and replaces or removes special characters'
-        opt.separator 'like spaces, parentheses, or umlauts.'
-        opt.separator 'The new filename will only contain the following characters:'
-        opt.separator ''
-        opt.separator '    ' << NameConverter::VALID_CHARS
-        opt.separator ''
-        opt.separator 'Spaces are replaced by underscores, German umlauts and eszett are'
-        opt.separator 'transliterated, all other invalid characters are removed.'
-        opt.separator ''
-        opt.separator 'Options'
-        opt.separator ''
+        opt.separator %Q{
+          deblank renames files and replaces or removes special characters
+          like spaces, parentheses, or umlauts.
+          The new filename will only contain the following characters:
+
+          ____#{NameConverter.default_valid_chars_to_s}
+
+          Spaces are replaced by underscores, German umlauts and eszett are
+          transliterated, all other invalid characters are removed.
+
+          Options
+        }.gsub(/^ +/, '').gsub(/^____/, '    ')
 
         # process --version and --help first,
         # exit successfully (GNU Coding Standards)
@@ -85,7 +87,7 @@ module Deblank
 
         opt.on('-l', '--list',
                'List the used character substitutions.') do
-          puts NameConverter.substitutions_to_string
+          puts NameConverter.default_substitutions_to_s
           exit
         end
 
@@ -124,11 +126,11 @@ module Deblank
     end
   end
 
-  # This module provides a converter method for filenames
+  # This class provides a converter method for filenames
   # (only the base name is modified).
-  module NameConverter
+  class NameConverter
 
-    VALID_CHARS = 'A-Z a-z 0-9 . _ -'  # spaces are ignored, `-' must be last
+    VALID_CHARS = 'A-Za-z0-9._-'  # `-' must be last
 
     SUBSTITUTIONS = {
       ' ' => '_',
@@ -141,26 +143,36 @@ module Deblank
       'ß' => 'ss'
     }
 
-    def self.convert(filename)
-      invalid_chars = /[^#{VALID_CHARS.tr(' ', '')}]/
-      basename = File.basename(filename)
-      dir = File.dirname(filename)
+    def initialize
+      @valid_characters = VALID_CHARS
+      @substitutions = SUBSTITUTIONS
+    end
 
-      SUBSTITUTIONS.each do |from, to|
-        basename.gsub!(/#{from}/, to)
-      end
-      basename.gsub!(invalid_chars, '')
+    def convert(filename)
+      dir, basename = File.dirname(filename), File.basename(filename)
+
+      @substitutions.each {|from, to| basename.gsub!(/#{from}/, to) }
+      basename.gsub!(invalid_characters, '')
 
       dir == '.' ? basename : "#{dir}/#{basename}"
     end
 
-    def self.substitutions_to_string
-      output = ''
-      SUBSTITUTIONS.each do |from, to|
-        output << "#{from} => #{to}\n"
-      end
+    def invalid?(filename)
+      invalid_characters === filename
+    end
+
+    def self.default_valid_chars_to_s
+      VALID_CHARS.scan(/.-.|./).join(' ')
+    end
+
+    def self.default_substitutions_to_s
+      SUBSTITUTIONS.map {|from, to| "#{from} => #{to}\n" }.join
+    end
+
+    private
 
-      output
+    def invalid_characters
+      /[^#{@valid_characters}]/
     end
   end
 
@@ -174,11 +186,12 @@ module Deblank
     def initialize
       begin
         options = Optionparser.parse!(ARGV)
-        @files = options[:files]
-        @simulate = options[:simulate]
       rescue => e
         usage_fail(e.message)
       end
+      @files = options[:files]
+      @simulate = options[:simulate]
+      @converter = NameConverter.new
     end
 
     # The main program.
@@ -187,28 +200,41 @@ module Deblank
       warn "#{message}\n#{'-' * message.size}\n"  if @simulate
 
       @files.each do |filename|
-        unless File.exist?(filename)
-          warn "There is no file `#{filename}'. (Skipped.)"
-          next
-        end
+        next  unless file_exist?(filename)
+        next  unless invalid?(filename)
 
-        new_filename = NameConverter.convert(filename)
+        new_filename = @converter.convert(filename)
+        secure_rename(filename, new_filename)
+      end
+    end
 
-        # filenames are identical
-        if new_filename == filename
-          warn("`#{filename}' and `#{new_filename}' are the same file. (Skipped.)")
-          next
-        end
+    private
 
-        # move file
-        if File.exist?(new_filename)
-          overwrite_ok = ask("File `#{new_filename}' already exists. Overwrite?")
-          next  unless overwrite_ok
-        end
+    def skip_warn(message)
+      warn "#{message} (Skipped.)"
+    end
+
+    def file_exist?(filename)
+      fail_message = "There is no file `#{filename}'."
+
+      File.exist?(filename)  or skip_warn(fail_message)
+    end
 
-        warn "Moving from `#{filename}' to `#{new_filename}'."
-        File.rename(filename, new_filename)  unless @simulate
-      end   # of each
+    def invalid?(filename)
+      fail_message = "`#{filename}' already is a valid filename."
+
+      @converter.invalid?(filename)  or skip_warn(fail_message)
+    end
+
+    def secure_rename(old_filename, new_filename)
+      return  if File.exist?(new_filename) && !overwrite?(new_filename)
+
+      warn "Moving from `#{old_filename}' to `#{new_filename}'."
+      File.rename(old_filename, new_filename)  unless @simulate
+    end
+
+    def overwrite?(filename)
+      confirm("File `#{filename}' already exists. Overwrite?")
     end
 
     # Asks for yes or no (y/n).
@@ -216,28 +242,26 @@ module Deblank
     # +question+ - string to be printed
     #
     # Returns +true+ if the answer is yes.
-    def ask(question) # :nodoc:
+    def confirm(question)
       loop do
         $stderr.print "#{question} [y/n] "
-        reply = $stdin.gets.chomp.downcase  # $stdin: avoids gets / ARGV problem
-        return true   if reply == 'y'
-        return false  if reply == 'n'
+        reply = $stdin.gets.chomp.downcase  # $stdin avoids gets/ARGV problem
+        return reply == 'y'  if /\A[yn]\Z/ =~ reply
         warn "Please answer `y' or `n'."
       end
     end
 
     # Prints an error message and a short help information, then exits.
-    def usage_fail(message) # :nodoc:
+    def usage_fail(message)
       warn "#{PROGNAME}: #{message}"
       warn "Use `#{PROGNAME} --help' for valid options."
       exit ERRORCODE[:usage]
     end
   end
+end  # module
 
 ### call main method only if called on command line
 
 if __FILE__ == $0
-  Application.new.run!
+  Deblank::Application.new.run!
 end
-
-end  # module

data/man/deblank.1

@@ -1,5 +1,5 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.40.4.
-.TH DEBLANK "1" "December 2012" "deblank 0.0.1" "User Commands"
+.TH DEBLANK "1" "October 2013" "deblank 0.1.0" "User Commands"
 .SH NAME
 deblank \- remove special characters from filenames
 .SH SYNOPSIS
@@ -30,7 +30,7 @@ Print a brief version information and exit.
 .SH "REPORTING BUGS"
 Report bugs on the deblank home page: <https://github.com/stomar/deblank>
 .SH COPYRIGHT
-Copyright \(co 2012 Marcus Stollsteimer.
+Copyright \(co 2012\-2013 Marcus Stollsteimer.
 .br
 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.
 .br

data/test/test_nameconverter.rb

@@ -1,9 +1,8 @@
-#!/usr/bin/ruby -w
 # encoding: UTF-8
 #
 # test_nameconverter.rb: Unit tests for the deblank script.
 #
-# Copyright (C) 2012 Marcus Stollsteimer
+# Copyright (C) 2012-2013 Marcus Stollsteimer
 
 require 'minitest/spec'
 require 'minitest/autorun'
@@ -13,7 +12,13 @@ require 'deblank'
 describe Deblank::NameConverter do
 
   before do
-    @nc = Deblank::NameConverter
+    @nc = Deblank::NameConverter.new
+  end
+
+  it 'recognizes invalid filenames' do
+    @nc.invalid?('path/to/filename with spaces.txt').must_equal true
+    @nc.invalid?('filename_with_ä.txt').must_equal true
+    @nc.invalid?('Valid_filename-1.txt').must_equal false
   end
 
   it 'does not change the path name' do
@@ -31,4 +36,12 @@ describe Deblank::NameConverter do
   it 'transliterates umlauts and eszett' do
     @nc.convert('Ä_Ö_Ü_ä_ö_ü_ß.txt').must_equal 'Ae_Oe_Ue_ae_oe_ue_ss.txt'
   end
+
+  it 'can return the default valid characters as string' do
+    Deblank::NameConverter.default_valid_chars_to_s.must_equal 'A-Z a-z 0-9 . _ -'
+  end
+
+  it 'can return the default substitutions as string' do
+    Deblank::NameConverter.default_substitutions_to_s.split("\n")[0].must_equal '  => _'
+  end
 end

data/test/test_optionparser.rb

@@ -1,9 +1,8 @@
-#!/usr/bin/ruby -w
 # encoding: UTF-8
 #
 # test_optionparser.rb: Unit tests for the deblank script.
 #
-# Copyright (C) 2012 Marcus Stollsteimer
+# Copyright (C) 2012-2013 Marcus Stollsteimer
 
 require 'minitest/spec'
 require 'minitest/autorun'

metadata

@@ -1,30 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: deblank
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Marcus Stollsteimer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-20 00:00:00.000000000 Z
+date: 2013-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: deblank is a command line tool that renames files and replaces or removes
@@ -47,30 +44,28 @@ files:
 homepage: https://github.com/stomar/deblank
 licenses:
 - GPL-3
+metadata: {}
 post_install_message: 
 rdoc_options:
 - --charset=UTF-8
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: deblank
-rubygems_version: 1.8.24
+rubyforge_project: 
+rubygems_version: 2.1.9
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: deblank - remove special characters from filenames
 test_files:
 - test/test_nameconverter.rb
 - test/test_optionparser.rb
-has_rdoc: