filerenamer 0.0.2 → 0.0.3

data/CHANGES

@@ -1,6 +1,12 @@
 = filerenamer Changelog
 
-== Master (for 0.0.2)
+== Master (for 0.0.4)
+
+== Version 0.0.3
+* Restruct class and module name
+* Add bin/renpad.
+
+== Version 0.0.2
 * Command name changes. rensub, rennum, etc.
 * Add bin/renpar.
 

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/bin/classify1stchar

@@ -1,16 +1,18 @@
 #! /usr/bin/env ruby
 # coding: utf-8
 
-require "filerenamer/filerenamer.rb"
-require "filerenamer/filerenameroptionparser.rb"
+#gem "filerenamer"
+require "filerenamer.rb"
+#require "filerenamer/commander.rb"
+#require "filerenamer/optionparser.rb"
 
 OPTIONS = {}
-op = FileRenamerOptionParser.new
+op = FileRenamer::OptionParser.new
 op.parse!(ARGV)
-files = ARGV
+#files = ARGV
 
-fr = FileRenamer.new(op.options)
-fr.execute(files) do |filename|
+fr = FileRenamer::Commander.new(op.options, ARGV)
+fr.execute do |filename|
   next if filename.size == 1
 
   yomi = `echo #{filename} | nkf -e | kakasi -JH | nkf -w`

data/bin/rennum

@@ -4,11 +4,12 @@
 # 拡張子は保存
 # -i オプションで開始番号を指定
 # -p : preserve old name 元のファイル名を残す。foo.txt -> 001-foo.txt
-require "filerenamer/filerenamer.rb"
-require "filerenamer/filerenameroptionparser.rb"
+require "filerenamer/commander.rb"
+require "filerenamer/optionparser.rb"
+
 
 OPTIONS = {}
-op = FileRenamerOptionParser.new
+op = FileRenamer::OptionParser.new
 op.on("-i num", "--initial", "Indicate initial number."){ |val|
   OPTIONS[:init] = val.to_i
 }
@@ -19,8 +20,8 @@ op.parse!(ARGV)
 
 OPTIONS[:init] ||= 0
 
-fr = FileRenamer.new(op.options)
-fr.execute(ARGV) do |filename|
+fr = FileRenamer::Commander.new(op.options, ARGV)
+fr.execute do |filename|
   @counter ||= OPTIONS[:init]
   if (OPTIONS[:preserve])
     new_name = sprintf("%03d-%s", @counter, filename)

data/bin/renpad

@@ -0,0 +1,48 @@
+#! /usr/bin/ruby -w
+# coding: utf-8
+
+# Pad 0 onto the first numeric character series in filenames to become the same length.
+
+require "pp"
+require "filerenamer/commander.rb"
+require "filerenamer/optionparser.rb"
+
+PATTERN = /^(\D*)(\d+)(.*)$/
+
+class String
+  def num_length
+    self =~ PATTERN
+    $2.length
+  end
+end
+
+
+OPTIONS = {}
+op = FileRenamer::OptionParser.new
+op.parse!(ARGV)
+
+#pp length
+#exit
+
+fr = FileRenamer::Commander.new(op.options, ARGV)
+
+length ||= fr.files.max_by { |str| str.num_length }.num_length
+#pp length
+
+fr.execute do |filename|
+  filename =~ PATTERN
+  head = $1
+  body = $2.to_i
+  tail = $3
+
+  #pp head
+  #pp body
+  #pp tail
+  #pp length
+  #puts
+
+  new_name = head + sprintf("%0#{length}d", body) + tail
+  new_name
+end
+
+

data/bin/renpar

@@ -11,15 +11,16 @@ require "rubygems"
 gem "builtinextension"
 require "string_split_parens.rb"
 
-require "filerenamer/filerenamer.rb"
-require "filerenamer/filerenameroptionparser.rb"
+require "filerenamer/commander.rb"
+require "filerenamer/optionparser.rb"
+
 
 OPTIONS = {}
-op = FileRenamerOptionParser.new
+op = FileRenamer::OptionParser.new
 op.parse!(ARGV)
 
-fr = FileRenamer.new(op.options)
-fr.execute(ARGV) do |filename|
+fr = FileRenamer::Commander.new(op.options, ARGV)
+fr.execute do |filename|
   extname  = File.extname( filename)
   basename = File.basename(filename).sub(/#{extname}$/, "")
 

data/bin/renreg

@@ -1,14 +1,14 @@
 #! /usr/bin/env ruby
 # coding: utf-8
 
-require "filerenamer/filerenamer.rb"
-require "filerenamer/filerenameroptionparser.rb"
+require "filerenamer/commander.rb"
+require "filerenamer/optionparser.rb"
 
-op = FileRenamerOptionParser.new
+op = FileRenamer::OptionParser.new
 op.parse!(ARGV)
 
-fr = FileRenamer.new(op.options)
-fr.execute(ARGV) do |filename|
+fr = FileRenamer::Commander.new(op.options, ARGV)
+fr.execute do |filename|
   new_name = filename.dup
   new_name.gsub!('ａ','a'); new_name.gsub!('ｂ','b'); new_name.gsub!('ｃ','c');
   new_name.gsub!('ｄ','d'); new_name.gsub!('ｅ','e'); new_name.gsub!('ｆ','f');

data/bin/rensub

@@ -1,23 +1,22 @@
 #! /usr/bin/env ruby
 # coding: utf-8
 
-require "filerenamer/filerenamer.rb"
-require "filerenamer/filerenameroptionparser.rb"
+require "filerenamer/commander.rb"
+require "filerenamer/optionparser.rb"
 
 OPTIONS = {}
-op = FileRenamerOptionParser.new
+op = FileRenamer::OptionParser.new
 op.on("-g", "--global", "Global substitution."){ OPTIONS[:global] = true }
 op.on("-r", "--reg-exp", "Regular expression."){ OPTIONS[:regexp] = true }
 op.parse!(ARGV)
 
 old_str = ARGV.shift
 new_str = ARGV.shift
-files = ARGV
 
 old_str = /#{old_str}/ if OPTIONS[:regexp]
 
-fr = FileRenamer.new(op.options)
-fr.execute(files) do |filename|
+fr = FileRenamer::Commander.new(op.options, ARGV)
+fr.execute do |filename|
   if OPTIONS[:global]
     new_name = filename.gsub(old_str, new_str)
   else

data/filerenamer.gemspec

@@ -5,14 +5,14 @@
 
 Gem::Specification.new do |s|
   s.name = "filerenamer"
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["ippei94da"]
-  s.date = "2012-07-04"
+  s.date = "2012-08-20"
   s.description = "This library provide common dealing to rename many files with safe method. Automatically mkdir if need and rmdir when empty."
   s.email = "ippei94da@gmail.com"
-  s.executables = ["classify1stchar", "rennum", "renpar", "renreg", "rensub"]
+  s.executables = ["classify1stchar", "rennum", "renpad", "renpar", "renreg", "rensub"]
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.rdoc"
@@ -27,22 +27,49 @@ Gem::Specification.new do |s|
     "VERSION",
     "bin/classify1stchar",
     "bin/rennum",
+    "bin/renpad",
     "bin/renpar",
     "bin/renreg",
     "bin/rensub",
     "filerenamer.gemspec",
     "lib/filerenamer.rb",
-    "lib/filerenamer/filerenamer.rb",
-    "lib/filerenamer/filerenameroptionparser.rb",
+    "lib/filerenamer/commander.rb",
+    "lib/filerenamer/optionparser.rb",
+    "test/classify1stchar/123",
+    "test/classify1stchar/abc",
+    "test/classify1stchar/def",
     "test/filerenamer/a0.txt",
     "test/filerenamer/dummy.txt",
     "test/helper.rb",
+    "test/rennum/a",
+    "test/rennum/b",
+    "test/rennum/c",
+    "test/rennum/d",
+    "test/renpad/1",
+    "test/renpad/10",
+    "test/renpad/100",
+    "test/renpad/100b",
+    "test/renpad/10b",
+    "test/renpad/1b",
+    "test/renpad/a1",
+    "test/renpad/a10",
+    "test/renpad/a100",
+    "test/renpad/a100b",
+    "test/renpad/a10b",
+    "test/renpad/a1b",
     "test/renpar/((ab)(cd(ef))gh(ij)kl(mn).txt",
     "test/renpar/(ab)(cd(ef)))gh(ij)kl(mn).txt",
     "test/renpar/(ab)(cd(ef))gh(ij)kl(mn).txt",
     "test/renpar/(ab)(cd).txt",
-    "test/test_filerenamer.rb",
-    "test/test_filerenameroptionparser.rb"
+    "test/renreg/a(b)",
+    "test/renreg/１",
+    "test/renreg/ａ",
+    "test/rensub/a0",
+    "test/rensub/a1",
+    "test/rensub/b0",
+    "test/rensub/b1",
+    "test/test_commander.rb",
+    "test/test_optionparser.rb"
   ]
   s.homepage = "http://github.com/ippei94da/filerenamer"
   s.licenses = ["MIT"]

data/lib/filerenamer.rb

@@ -0,0 +1,4 @@
+require "filerenamer/commander.rb"
+require "filerenamer/optionparser.rb"
+
+module FileRenamer; end

data/lib/filerenamer/commander.rb

@@ -0,0 +1,262 @@
+#! /usr/bin/env ruby
+# coding: utf-8
+
+require "rubygems"
+gem "builtinextension"
+require "string_escape_zsh.rb"
+require "string_width.rb"
+
+require "fileutils"
+require "optparse"
+require "filerenamer/optionparser.rb"
+
+# ファイル群の名前変更を一括して行うためのクラス。
+# 他のアプリケーションからも使えるけれど、
+# 基本的にはコマンドライン関係の取り扱いを全部まとめてできるようにするもの。
+# そのため、initialize で files を受け取ってしまい、
+# execute の度に指定しなくても良いことにしている。
+# execute の度に指定するようにすると、renpad のように対象全体を見てどうこうする
+# コマンドで不便。
+#
+# MEMO:
+# 一度 temporary directory にリネームして格納し、
+# これをカレントディレクトリからのパスに移動する形を取ると、
+# ディレクトリをまたぐリネームが非常に面倒なことになる。
+# - 他のリネームに依存する場合に順序問題。
+# - 相互依存のデッドロック
+# gem などで提供される temporary directory は
+# 基本的に 抜けたときに削除される筈なので、
+# 途中まで変換してから interrupt されたときに
+# 中にあるファイルごと消される可能性がありそう。
+# そのため、メソッド内で自分で temporary directory を作成する。
+# 
+# 没案
+#   rename_rule メソッドをデフォルトで例外にしておいて、
+#   コマンドスクリプト側で定義するという方法は、
+#   メソッドの引数で ArgumentError のもとになり、
+#   自由度が少なくなる。
+#   たとえば old_str, new_str を渡したい時と、
+#   更新時刻でリネームしたいときでは必要な引数の数が異なる。
+module FileRenamer
+  class Commander
+    attr_reader :files
+
+    class NoRenameRuleError < Exception; end
+    class OptionError < Exception; end
+
+    #:yes と :no が両方 true ならば例外。
+    #:copy, :move, :hardlink, :symlink のうち、1つ以下が true。
+    #全て nil ならば :move が true になる。
+    #:quiet が true ならば自動的に :yes が立てられる。
+    #:quiet が true で :no も true ならば例外。
+    def initialize(options, files)
+      @options = options
+
+      if (@options[:yes] && @options[:no])
+        raise OptionError,
+          "Conflict options: --yes and --no."
+      end
+
+      fileProcessModes = []
+      [:move, :copy, :hardlink, :symlink].each do |mode|
+        fileProcessModes << mode if @options[mode]
+      end
+      # 1つもなければ :move に。
+      @options[:move] = true if fileProcessModes == []
+      # 2つ以上あれば例外。
+      if fileProcessModes.size > 1
+        raise OptionError,
+          "File process modes duplicate: #{fileProcessModes.join(", ")}"
+      end
+      @command = "mv"     if @options[:move]
+      @command = "cp -r"  if @options[:copy]
+      @command = "ln"     if @options[:hardlink]
+      @command = "ln -s"  if @options[:symlink]
+
+      # :quiet ならば自動的に :yes
+      @options[:yes] = true if @options[:quiet]
+
+      # :quiet と同時に :no なら例外
+      if @options[:quiet] && @options[:no]
+        raise OptionError,
+          "Conflict options: --quiet and --no"
+      end
+
+      @files = files
+      @files = Dir::glob("*").sort if files.empty?
+    end
+
+    # 変更される名前のリストを表示し、ユーザの指示に従って実行する。
+    # ユーザの入力は [y|Y] で始まる文字列ならば実行、
+    # それ以外なら実行しない。
+    # files は対象のファイル名のリスト。
+    # 新しい名前の生成方法をブロックで渡す。
+    # ブロックがなければ例外 FileRenamerNoRenameRuleError
+    def execute(&block)
+      new_names = make_new_names(&block)
+
+      ok_files, ng_files = check_new_names(new_names)
+
+      unless @options[:quiet]
+        if ok_files.size > 0
+          puts "Enable files:"
+          max_width = ok_files.keys.max_by{|file| file.width}.width
+          ok_files.keys.sort.each do |old|
+            printf("  %s %s%s %s\n",
+              @command, old, " " * (max_width - old.width), ok_files[old]
+            )
+          end
+        end
+
+        if ng_files.size > 0
+          puts "Unable files:"
+          max_width = ng_files.keys.max_by{|file| file.width}.width
+          ng_files.keys.sort.each do |old|
+            printf("  %s %s%s %s\n",
+              @command, old, " " * (max_width - old.width), ng_files[old]
+            )
+          end
+        puts
+        end
+      end
+
+      if ok_files.empty?
+        puts "Done. No executable files." unless @options[:quiet]
+        return
+      elsif @options[:no]
+        puts "Execute? no"
+        return
+      end
+
+      if @options[:yes]
+        puts "Execute? yes" unless @options[:quiet]
+      elsif (! ask_yes?)
+        return
+      end
+      ok_files.each do |old, new|
+        run(old, new)
+      end
+    end
+
+    private
+
+    def make_new_names(&block)
+      #pp @files
+      results = {}
+      @files.each { |i| results[i] = yield i }
+      return results
+    end
+
+    # 新しい名前リストを受け取り、問題なくリネームできるものと
+    # できないものを選別する。
+    # OK, NG の順に2つの配列を返す。
+    #
+    # 判断基準は、以下の AND 条件。
+    #   - 新しい名前が古い名前リストに含まれないこと。
+    #   - 新しい名前が新しい名前リストに1つ(自分)のみしかないこと。
+    #   - 新しい名前のファイルが既に存在しないこと。
+    #
+    # 没案
+    #   新しい名前が変換されない古い名前であれば、
+    #   これも NG リストに追加する。(表示用)
+    #   このルールにすると、変換に順序依存が生じる可能性があり、
+    #   temporary directory を経由する必要ができる。
+    #   その結果、リネーム過程で深い temporary directory を
+    #   作成したり削除したりしなければならなくなる。
+    def check_new_names(old_new_hash)
+      ok_files = {}
+      ng_files = {}
+
+      old_new_hash.each do |old, new|
+        # 変化がない場合はスルー
+        next if old == new
+
+        # 新しい名前に nil が定義されていてもスルー
+        next if new == nil
+
+        # 既に存在していれば、既に存在するファイルごと NG に登録。
+        if FileTest.exist?(new)
+          ng_files[old] = new
+          ng_files[new] = new
+          next
+        end
+
+        # new が複数 重複していれば、 NG。
+        if (old_new_hash.values.select{|name| name == new}.size > 1)
+          ng_files[old] = new
+          next
+        end
+
+        # new が old に含まれていれば、NG。
+        if (old_new_hash.keys.include?(new))
+          ng_files[old] = new
+          next
+        end
+
+        # 上記以外の場合ならば OK
+
+        ok_files[old] = new
+      end
+      return ok_files, ng_files
+    end
+
+    # ユーザに判断を求める。
+    # 標準入力から文字列を受け取り、
+    # [y|Y] から始まる文字列なら true を、
+    # それ以外なら false を返す。
+    def ask_yes?
+      puts "Execute?"
+      str = $stdin.gets
+      if /^y/i =~ str
+        return true
+      else
+        return false
+      end
+    end
+
+    # コマンドを表示しつつ実行。
+    # 既にファイルチェックされているはずなので、チェックはしない。
+    # 少なくとも当面は。
+    # ディレクトリが必要ならここで作成。
+    # ディレクトリが不要になればここで削除。
+    # 本来ここでない方が分かり易い気もするのだが、ここに追加するのが一番簡単なので。
+    def run(old, new)
+      # 変換先のディレクトリがなければ生成
+      #pp old, new; exit
+      paths(new).each do |directory|
+        unless FileTest.exist?(directory)
+          puts "  make directory: #{directory}" unless @options[:quiet]
+          FileUtils.mkdir_p(directory)
+        end
+      end
+
+      # 変換の実行
+      command = "  #{@command} #{old.escape_zsh} #{new.escape_zsh}"
+      puts command unless @options[:quiet]
+      system(command)
+
+      # 変換元のディレクトリが空になっていれば削除
+      dirs = paths(old)
+      dirs.reverse.each do |directory|
+        if Dir.entries(directory).size == 2 # . と .. のみ
+          puts "  remove directory: #{directory}" unless @options[:quiet]
+          Dir.rmdir(directory)
+        end
+      end
+    end
+
+    # パスに含まれるディレクトリ名を、階層ごとに切り分けたソート済配列にして返す。
+    # 最後の要素は含まない。
+    # e.g. foo/bar/baz.txt => ["foo", "foo/bar"]
+    # e.g. /foo/bar/baz.txt => ["/foo", "foo/bar"]
+    def paths(path)
+      dirs = path.split("/")
+      results = []
+      (dirs.size - 1).times do |i|
+        results << dirs[0..i].join("/")
+      end
+      results.delete_at(0) if results[0] == ""
+      return results
+    end
+  end
+end