tvshow_renamer 0.4.1 → 0.5

data/README.md

@@ -33,13 +33,15 @@ You can specify many files to rename.
 
 ### Options
 * `-n TVSHOW_NAME` or `--name TVSHOW_NAME`  
-  This option define the TV show name used to rename the files. If the option is not present, the name will be asked first.
-
-* `-l FILENAME` or `--log FILENAME`  
-  This option make the utility create a file inside the same directory as the renamed files containing the old and new names of the files. It can be useful to keep the episode or version names.
+  This option defines the TV show name used to rename the files. If the option is not present, the name will be asked first.
 
+* `-f FORMAT` or `--format FORMAT`  
+  This option defines the format for the new filenames.  
+  `$n` will be substitued by the TV show name, `$s` by the season number, `$e` by the episode number.  
+  The default format is : `$n - $sx$e`.
 
-Todo
-----
+* `-l FILENAME` or `--log FILENAME`  
+  This option makes the utility create a file inside the same directory as the renamed files containing the old and new names of the files. It can be useful to keep the episode or version names.
 
-* Add possibility to customize the renaming format.
+* `-r` or `--recursive`
+  If any directory is passed as parameter, this option makes the utility look recursively inside directories for files to rename.

data/bin/tvshow_renamer

@@ -2,4 +2,4 @@
 require 'rubygems'
 require 'tvshow_renamer'
 
-TVShowRenamer::CLI.start
+TVShowRenamer::Runner.start

data/lib/tvshow_renamer.rb

@@ -1,4 +1,5 @@
 require 'tvshow_renamer/cli'
 require 'tvshow_renamer/renamer'
+require 'tvshow_renamer/runner'
 require 'tvshow_renamer/tvshow_file'
 require 'tvshow_renamer/version'

data/lib/tvshow_renamer/cli.rb

@@ -1,44 +1,5 @@
-require 'optparse'
-
 module TVShowRenamer
   class CLI
-    def self.start
-      options = {cli: true}
-      opts = OptionParser.new do |opts|
-        opts.banner = "Usage: tvshow_renamer [options] file|directory ..."
-
-        opts.on("-n", "--name TVSHOW_NAME", "Log all renames to FILENAME, inside the TV show files directory") do |tvshow_name|
-          options[:tvshow_name] = tvshow_name
-        end
-
-        opts.on("-l", "--log FILENAME", "Log all renames to FILENAME, inside the TV show files directory") do |log_file|
-          options[:log_file] = log_file
-        end
-
-        opts.on_tail("-h", "--help", "Show this message") do
-          puts opts
-          exit
-        end
-
-        opts.on_tail("--version", "Show version") do
-          puts TVShowRenamer::VERSION
-          exit
-        end
-      end
-      opts.parse!
-
-      if ARGV.empty?
-        puts opts
-      else
-        tvshow_name = if options[:tvshow_name]
-          options.delete(:tvshow_name)
-        else
-          self.prompt 'Please enter the name of the TV Show for these files : '
-        end
-        Renamer.new(tvshow_name, options).rename(ARGV)
-      end
-    end
-
     def self.prompt(prompt)
       print prompt
       $stdout.flush

data/lib/tvshow_renamer/renamer.rb

@@ -3,13 +3,10 @@ require 'fileutils'
 
 module TVShowRenamer
   class Renamer
-    attr_accessor :tvshow_name
-
     EXTENSIONS = %w( .mkv .avi .mp4 .srt )
     NUMBER_REGEX = /\A\d+\z/
 
-    def initialize(tvshow_name, options = {})
-      @tvshow_name = tvshow_name
+    def initialize(options = {})
       @options = options
     end
 
@@ -29,14 +26,14 @@ module TVShowRenamer
 
     def rename_dir(dirname)
       puts "Renaming files in directory \"#{dirname}\""
-      Dir.glob(dirname + '/**').each do |filename|
+      Dir.glob(dirname + (@options[:recursive] ? '/**/*' : '/**')).each do |filename|
         rename_file(filename)
       end
     end
 
     def rename_file(filename)
       renamed = false
-      @tvfile = TVShowFile.new @tvshow_name, File.expand_path(filename)
+      @tvfile = TVShowFile.new @options, File.expand_path(filename)
 
       if EXTENSIONS.include?(@tvfile.extname.downcase)
         @tvfile.detect_season_and_episode
@@ -112,20 +109,26 @@ module TVShowRenamer
       puts "Menu"
       puts "----"
       puts "1. Change TV Show name"
-      puts "2. Change format (not yet available)"
+      puts "2. Change format"
       puts "q. Quit menu"
       puts "----"
       quit = false
       until quit
         case CLI.prompt("Choice : ")
         when '1'
-          new_tvshow_name = CLI.prompt_edit_value("TV Show Name", @tvfile.tvshow_name)
-          if new_tvshow_name != @tvshow_name
-            @tvshow_name = @tvfile.tvshow_name = new_tvshow_name
-            puts "TV Show Name is now #{@tvshow_name}."
+          new_tvshow_name = CLI.prompt_edit_value("TV Show Name", @options[:tvshow_name])
+          if new_tvshow_name != @options[:tvshow_name]
+            @options[:tvshow_name] = new_tvshow_name
+            @tvfile.options_modified
+            puts "TV Show Name is now #{new_tvshow_name}."
           end
         when '2'
-          puts "You cannot change the format yet, sorry."
+          new_format = CLI.prompt_edit_value("Format - $n : TV show name, $s : Season, $e : Episode", @options[:format])
+          if new_format != @options[:format]
+            @options[:format] = new_format
+            @tvfile.options_modified
+            puts "Format is now #{new_format}."
+          end
         when 'q'
           quit = true
         end

data/lib/tvshow_renamer/runner.rb

@@ -0,0 +1,52 @@
+require 'optparse'
+
+module TVShowRenamer
+  class Runner
+    def self.start
+      options = {}
+      options[:format] = "$n - $sx$e"
+
+      opts = OptionParser.new do |opts|
+        opts.banner = "Usage: tvshow_renamer [options] file|directory ..."
+
+        opts.on("-n", "--name TVSHOW_NAME", "Define the TV show name used to rename the files") do |tvshow_name|
+          options[:tvshow_name] = tvshow_name
+        end
+
+        opts.on("-f", "--format FORMAT",
+          "Define the format for the new filenames - Default : \"$n - $sx$e\"",
+          "$n will be substitued by the TV show name, $s by the season number, $e by the episode number") do |format|
+          options[:format] = format
+        end
+
+        opts.on("-l", "--log FILENAME", "Log all renames to FILENAME, inside the TV show files directory") do |log_file|
+          options[:log_file] = log_file
+        end
+
+        opts.on("-r", "--recursive", "If passed a directory, look recursively inside it for files to rename") do |recursive|
+          options[:recursive] = recursive
+        end
+
+        opts.separator ""
+
+        opts.on_tail("-h", "--help", "Show this message") do
+          puts opts
+          exit
+        end
+
+        opts.on_tail("--version", "Show version") do
+          puts TVShowRenamer::VERSION
+          exit
+        end
+      end
+      opts.parse!
+
+      if ARGV.empty?
+        puts opts
+      else
+        options[:tvshow_name] ||= CLI.prompt 'Please enter the name of the TV Show for these files : '
+        Renamer.new(options).rename(ARGV)
+      end
+    end
+  end
+end

data/lib/tvshow_renamer/tvshow_file.rb

@@ -1,19 +1,14 @@
 module TVShowRenamer
   class TVShowFile
-    attr_reader :tvshow_name, :filename, :season, :episode, :detected_season, :detected_episode
+    attr_reader :filename, :season, :episode, :detected_season, :detected_episode
 
-    def initialize(tvshow_name, filename)
-      @tvshow_name = tvshow_name
+    def initialize(options = {}, filename = nil)
+      @options = options
       @filename = filename
     end
 
     # Custom setters
 
-    def tvshow_name=(tvshow_name)
-      @tvshow_name = tvshow_name
-      @new_basename = @new_filename = nil
-    end
-
     def season=(season)
       @season = season
       @new_basename = @new_filename = nil
@@ -40,7 +35,10 @@ module TVShowRenamer
 
     def new_basename
       unless @new_basename
-        @new_basename = "#{@tvshow_name} - %02ix%02i#{extname}" % [@season, @episode]
+        @new_basename = @options[:format].gsub('$n', @options[:tvshow_name])
+                                         .gsub('$s', '%02i' % @season)
+                                         .gsub('$e', '%02i' % @episode)
+                                         .concat(extname)
         @new_filename = nil
       end
       @new_basename
@@ -52,6 +50,10 @@ module TVShowRenamer
 
     # Active methods
 
+    def options_modified
+      @new_basename = @new_filename = nil
+    end
+
     def detect_season_and_episode
       regex = /(?<season>\d{1,2})(e|x|\.)?(?<episode>\d{2,})/i
       match = regex.match basename

data/lib/tvshow_renamer/version.rb

@@ -1,3 +1,3 @@
 module TVShowRenamer
-  Version = VERSION = '0.4.1'
+  Version = VERSION = '0.5'
 end

data/test/test_tvshow_renamer.rb

@@ -2,9 +2,11 @@ require 'test/unit'
 require 'tvshow_renamer'
 
 class TVShowRenamerTest < Test::Unit::TestCase
+  FORMAT = '$n - $sx$e'
   TVSHOW_NAME = 'Famous Show'
 
   def test_detect_season_and_episode
+    options = {:format => FORMAT, :tvshow_name => TVSHOW_NAME}
     {
       'FamousShow.S05E01.DVDRip.XviD-BLAH.avi' => [5, 1],
       'FamousShow.12x03.DVDRip.XviD-BLAH.avi'  => [12,3],
@@ -13,7 +15,7 @@ class TVShowRenamerTest < Test::Unit::TestCase
       'Famous.Show.03.04.avi'                  => [3, 4],
       'Famous-Show.04x00.srt'                  => [4, 0],
     }.each do |k,v|
-      tvfile = TVShowRenamer::TVShowFile.new(TVSHOW_NAME, k)
+      tvfile = TVShowRenamer::TVShowFile.new(options, k)
       tvfile.detect_season_and_episode
       
       assert_equal v, [tvfile.season, tvfile.episode]
@@ -21,13 +23,14 @@ class TVShowRenamerTest < Test::Unit::TestCase
   end
 
   def test_new_basename
-    tvfile = TVShowRenamer::TVShowFile.new(TVSHOW_NAME, 'test.mkv')
+    options = {:format => FORMAT, :tvshow_name => TVSHOW_NAME}
+    tvfile = TVShowRenamer::TVShowFile.new(options, 'test.mkv')
     tvfile.season = 1
-
     tvfile.episode = 2
     assert_equal 'Famous Show - 01x02.mkv', tvfile.new_basename
 
-    tvfile.episode = 101
-    assert_equal 'Famous Show - 01x101.mkv', tvfile.new_basename
+    options[:format] = '$n$s$e'
+    tvfile.options_modified
+    assert_equal 'Famous Show0102.mkv', tvfile.new_basename
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tvshow_renamer
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: '0.5'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-26 00:00:00.000000000 Z
+date: 2012-11-27 00:00:00.000000000 Z
 dependencies: []
 description: Utility to rename TV Show files to a correct format
 email: francois@fklingler.com
@@ -23,6 +23,7 @@ files:
 - Rakefile
 - lib/tvshow_renamer/cli.rb
 - lib/tvshow_renamer/renamer.rb
+- lib/tvshow_renamer/runner.rb
 - lib/tvshow_renamer/tvshow_file.rb
 - lib/tvshow_renamer/version.rb
 - lib/tvshow_renamer.rb