charset_move 0.2.1

data/COPYING

@@ -0,0 +1,24 @@
+# Copyright and Copying Information
+
+CharsetMove is Copyright 2012 Chad Perrin.  It may be distributed under the
+terms of the Nietzsche Public License.  See LICENSE file for details.
+
+## Dependencies
+
+CharsetMove depends only on a standard Ruby runtime and its standard library.
+The reference implementation of Ruby is MRI/YARV, disjunctively dual-licensed
+under the terms of the Ruby License and the Simplified BSD License.  The same
+licensing terms apply to the standard library.
+
+## Licensing Philosophy
+
+The intent in selecting the Nietzsche Public License (or NPL) is to keep
+licensing simple, and to inject a modicum of philosophical humor into the
+otherwise dry and serious matter of copyright licensing.  The NPL is a
+[copyfree](http://copyfree.org) license which, like many copyfree licenses, is
+[usage optimized](http://univacc.net/?page=license_simplicity) -- that is,
+designed to minimize friction imposed on the development and distribution
+process by legal issues.  The Simplified BSD License offered as one of two
+licensing options for MRI/YARV is another simple copyfree license.  The goal is
+to ensure that you can use the software however you like with a minimum of
+fuss, risk, and bureaucratic overhead.

data/LICENSE

@@ -0,0 +1,22 @@
+Nietzsche Public License v0.5
+
+Copyright 2012 Chad Perrin
+
+Copyright, like God, is dead.  Let its corpse serve only to guard against its
+resurrection.  You may do anything with this work that copyright law would
+normally restrict, so long as you retain the above notice(s), this license, and
+the following misquote and disclaimer of warranty with all redistributed copies
+and derived works.  You may also replace this license with the Open Works
+License, available at the http://owl.apotheon.org website.
+
+    Copyright is dead.  Copyright remains dead, and we have killed it.  How
+    shall we comfort ourselves, the murderers of all murderers?  What was
+    holiest and mightiest of all that the world of censorship has yet owned has
+    bled to death under our knives: who will wipe this blood off us?  What
+    water is there for us to clean ourselves?  What festivals of atonement,
+    what sacred games shall we have to invent?  Is not the greatness of this
+    deed too great for us?  Must we ourselves not become authors simply to
+    appear worthy of it?
+                                     - apologies to Friedrich Wilhelm Nietzsche
+
+This license implies no warranty.

data/README.md

@@ -0,0 +1,42 @@
+# CharsetMove
+
+A trivial series of coincidences led to me wanting to create a simple, Ruby
+based, copyfree licensed tool for changing the encodings used for filenames.
+
+## cmv
+
+The executable command line utility `cmv` is simple enough to use.  To change
+the names of all files in the current directory from UTF-8 to 8-bit ASCII,
+without any chance of a filename overwriting an existing file (including
+possibly multiple files being written to the same filename after transcoding
+filenames):
+
+    cmv -nf UTF-8 -t ACII-8BIT *
+
+The `-n` option is "noclobber" (thus using numbers at the ends of filenames to
+avoid files overwriting each other; default behavior simply overwrites existing
+files, just like `mv` would on standard Unix systems), the `-f` is "from" (the
+source encoding), and `-t` is "to" (the target encoding).  The program tries to
+set sensible defaults for from and to, but they will both probably end up with
+the same encoding if you do not specify an encoding for at least one of the
+two.
+
+If you are not sure how to specify an encoding, a list of supported encodings
+can be displayed with the `-l` option.  It is likely to be long; you may want
+to pipe the output to a pager such as `less`, or narrow down the displayed
+output by piping it to a `grep` command.
+
+Use the `--help` or `-h` option to learn more about how to use `cmv`.
+
+## installing
+
+For now, just copying the `cmv` file into your execution path somewhere should
+suffice for "installation".  At some point, it will probably be turned into a
+really minimal gem so you can use a `gem install` command.
+
+## credits
+
+This program was written by Chad Perrin, Copyright 2012.  It can be
+redistributed under the terms of the Nietzsche Public License for now (see
+LICENSE file).  This may change at some point -- probably to the Open Works
+License, which the NPL allows you to use in place of the NPL itself anyway.

data/bin/cmv

@@ -0,0 +1,104 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require 'charset_move'
+
+=begin
+
+Nietzsche Public License v0.5
+
+Copyright 2012 Chad Perrin
+
+Copyright, like God, is dead.  Let its corpse serve only to guard against its
+resurrection.  You may do anything with this work that copyright law would
+normally restrict, so long as you retain the above notice(s), this license, and
+the following misquote and disclaimer of warranty with all redistributed copies
+and derived works.  You may also replace this license with the Open Works
+License, available at the http://owl.apotheon.org website.
+
+    Copyright is dead.  Copyright remains dead, and we have killed it.  How
+    shall we comfort ourselves, the murderers of all murderers?  What was
+    holiest and mightiest of all that the world of censorship has yet owned has
+    bled to death under our knives: who will wipe this blood off us?  What
+    water is there for us to clean ourselves?  What festivals of atonement,
+    what sacred games shall we have to invent?  Is not the greatness of this
+    deed too great for us?  Must we ourselves not become authors simply to
+    appear worthy of it?
+                                     - apologies to Friedrich Wilhelm Nietzsche
+
+This license implies no warranty.
+
+=end
+
+help_text = {
+  :from         => 'Specify a source encoding.',
+  :to           => 'Specify a destination encoding.',
+  :noclobber    => 'Do not clobber existing files.',
+  :list         => 'Display supported encodings.',
+  :help         => 'Display this help text.',
+  :version      => 'Display version and license information.'
+}
+
+@usage = <<EOF
+
+USAGE: #{File.basename $0} [options] FILE [FILE [. . .]]
+
+EOF
+
+version_help = <<EOF
+
+CharsetMove #{CharsetMove.version}, Copyright 2012 Chad Perrin
+May be distributed under the terms of the Nietzsche Public License.
+
+EOF
+
+
+@options = {
+  :from         => Encoding.default_external,
+  :to           => Encoding.default_external,
+  :noclobber    => false
+}
+
+OptionParser.new do |opts|
+  opts.banner = @usage
+
+  opts.on('--from=ENCODING', '-f', help_text[:from]) do |arg|
+    @options[:from] = arg
+  end
+
+  opts.on('--to=ENCODING', '-t', help_text[:to]) do |arg|
+    @options[:to] = arg
+  end
+
+  opts.on('--noclobber', '-n', help_text[:noclobber]) do
+    @options[:noclobber] = true
+  end
+
+  opts.on('--list', '-l', help_text[:list]) do
+    puts CharsetMove.sorted_encodings
+    exit(0)
+  end
+
+  opts.on('--help', '-h', help_text[:help]) do
+    puts opts
+    puts
+    exit(0)
+  end
+
+  opts.on_tail('--version', help_text[:version]) do
+    puts version_help
+    exit(0)
+  end
+end.parse!
+
+
+
+if 0 < ARGV.size
+  cmv = CharsetMove.new(@options)
+  ARGV.each do |old_filename|
+    puts cmv.transcode_filename(old_filename)
+  end
+else
+  puts @usage
+  puts %Q{    Try "#{File.basename $0} --help" for usage information.}
+  puts
+end

data/lib/charset_move.rb

@@ -0,0 +1,162 @@
+require 'fileutils'
+
+=begin rdoc
+
+CharsetMove provides a Ruby class as a simple wrapper around Ruby's
+Encoding::Converter functionality, designed for easy use by a command line
+utility.
+
+=== API
+
+        require 'charset_move'
+
+        config = {
+          :from         => 'UTF-8',
+          :to           => 'ASCII-8BIT',
+          :noclobber    => true
+        }
+
+        cmv = CharsetMove(config)
+
+        # filenames listed in ASCIIbetical order
+        ['file_öne', 'file_threë', 'file_twó', 'file_twö'].each do |fname|
+          puts cmv.transcode_filename(fname)
+        end
+
+The above code produces this command line output:
+
+        file_öne -> file_?ne
+        file_threë -> file_thre?
+        file_twó -> file_tw?
+        file_twö -> file_tw?1
+
+=== Use and Sharing
+
+Nietzsche Public License v0.5
+
+Copyright 2012 Chad Perrin
+
+Copyright, like God, is dead.  Let its corpse serve only to guard against its
+resurrection.  You may do anything with this work that copyright law would
+normally restrict, so long as you retain the above notice(s), this license, and
+the following misquote and disclaimer of warranty with all redistributed copies
+and derived works.  You may also replace this license with the Open Works
+License, available at the http://owl.apotheon.org website.
+
+    Copyright is dead.  Copyright remains dead, and we have killed it.  How
+    shall we comfort ourselves, the murderers of all murderers?  What was
+    holiest and mightiest of all that the world of censorship has yet owned has
+    bled to death under our knives: who will wipe this blood off us?  What
+    water is there for us to clean ourselves?  What festivals of atonement,
+    what sacred games shall we have to invent?  Is not the greatness of this
+    deed too great for us?  Must we ourselves not become authors simply to
+    appear worthy of it?
+                                     - apologies to Friedrich Wilhelm Nietzsche
+
+This license implies no warranty.
+
+=end
+
+class CharsetMove
+
+=begin rdoc
+
+This method returns the version number for the CharsetMove gem.
+
+=end
+
+  def self.version; '0.2.1'; end
+
+=begin rdoc
+
+The +config+ argument is a hash containing a source encoding string, a
+destination encoding string, and an optional +:noclobber+ boolean value.  By
+default, +:noclobber+ is treated as false.
+
+=end
+
+  def initialize(config)
+    @config = config
+    @conv = Encoding::Converter.new(@config[:from], @config[:to])
+  end
+
+  @encodings = Encoding.list.collect {|e| e.to_s }
+
+=begin rdoc
+
+This method returns an array containing supported encoding strings.
+
+=end
+
+  def self.encodings
+    @encodings
+  end
+
+=begin rdoc
+
+This method returns an alphabetically sorted array containing supported
+encoding strings.
+
+=end
+
+  def self.sorted_encodings
+    @encodings.sort {|a,b| a.upcase <=> b.upcase }
+  end
+
+=begin rdoc
+
+This method checks the current directory for filneames matching the +name+
+argument string and adds a number to the end to differentiate the string from
+the names of existing files.
+
+=end
+
+  def unclobber_name(name)
+    n = 0
+
+    if File.exists? name
+      while File.exists? name
+        n += 1
+
+        num = n
+        name.chop! if num > 1
+        while (num / 10) > 0
+          name.chop! if num > 10
+          num = num / 10
+        end
+
+        name += n.to_s
+      end
+    end
+
+    name
+  end
+
+=begin rdoc
+
+This method transcodes a string representing a filename and renames a file from
+the source encoding specified by +@config[:from]+ to the destination encoding
+specified by +@config[:to]+ to a new encoding.  It optionally differentiates
+destination filenames from existing filenames by sending the +unclobber_name+
+message.
+
+=end
+
+  def transcode_filename(old_filename)
+    begin
+      new_filename = @conv.convert old_filename
+    rescue Exception => e
+      if old_filename.match(/[^[:ascii:]]/)
+        new_filename = @conv.convert old_filename.gsub(/[^[:ascii:]]/, '?')
+      else
+        return e
+      end
+    end
+
+    new_filename = unclobber_name(new_filename) if @config[:noclobber]
+
+    FileUtils.mv old_filename, new_filename
+
+    "#{old_filename} -> #{new_filename}"
+  end
+end

data/test/charset_move_tests.rb

@@ -0,0 +1,34 @@
+# coding: utf-8
+require 'test/unit'
+require '../lib/charset_move'
+
+class CharsetMoveTests < Test::Unit::TestCase
+  def setup
+    @name = 'tfile_bëcëdäföñü'
+    @cmv1 = CharsetMove.new( {
+      :from         => 'UTF-8',
+      :to           => 'ASCII-8BIT',
+      :noclobber    => true
+    } )
+
+    @cmv2 = CharsetMove.new( {
+      :from         => 'ASCII-8BIT',
+      :to           => 'UTF-8',
+      :noclobber    => true
+    } )
+
+    `./manage clean`
+    `./manage reset`
+  end
+
+  def teardown
+    `./manage clean`
+  end
+
+  def test_unclobber_name
+    assert_equal(
+      @cmv2.unclobber_name(@cmv1.unclobber_name(@name)),
+      'tfile_bëcëdäföñü1'
+    )
+  end
+end

data/test/manage

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+case ARGV[0]
+when 'clean'
+  system "ls; rm tfile_*; ls"
+when 'reset'
+  system "ls; rm tfile_*; ls"
+
+  vowels = %w{ä ë ï ö ü}
+  vowels.each do |a|
+    vowels.each do |e|
+      vowels.each do |i|
+        vowels.each do |o|
+          vowels.each do |u|
+            vowels.each do |y|
+              system("echo 'foo' > tfile_b#{a}c#{e}d#{i}f#{o}ñ#{u}")
+            end
+          end
+        end
+      end
+    end
+  end
+
+  system "ls; ls|wc"
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: charset_move
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+  prerelease: 
+platform: ruby
+authors:
+- Chad Perrin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-12 00:00:00.000000000 Z
+dependencies: []
+description: ! "    CharsetMove is a simple, Ruby based, copyfree licensed command
+  line utility\n    for changing the encodings used for filenames.\n"
+email: code@apotheon.net
+executables:
+- cmv
+extensions: []
+extra_rdoc_files: []
+files:
+- COPYING
+- LICENSE
+- README.md
+- lib/charset_move.rb
+- bin/cmv
+- test/charset_move_tests.rb
+- test/manage
+homepage: http://cmv.fossrec.com
+licenses:
+- NPL
+post_install_message: ! "    Thank you for using CharsetMove.  The \"cmv\" command
+  line utility can be\n    used to change the encodings of filenames from one encoding
+  to another.\n    Use the \"-h\" command line option to get more information about
+  how to use\n    the command.\n"
+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.15
+signing_key: 
+specification_version: 3
+summary: CharsetMove - filename transcoder
+test_files: []