tvshow_renamer 0.3 → 0.4

data/README.md

@@ -26,8 +26,20 @@ Installation
 Usage
 -----
 
-`tvshow_renamer [options] <tvshow_name> file|directory ...`
+`tvshow_renamer [options] file|directory ...`
 
 You can specify many files to rename.
 
-The option `-l FILENAME` ou `--log FILENAME` will 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.
+
+### 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.
+
+
+Todo
+----
+
+* Add possibility to customize the renaming format.

data/lib/tvshow_renamer/cli.rb

@@ -5,7 +5,11 @@ module TVShowRenamer
     def self.start
       options = {cli: true}
       opts = OptionParser.new do |opts|
-        opts.banner = "Usage: tvshow_renamer [options] <tvshow_name> file|directory ..."
+        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
@@ -23,10 +27,14 @@ module TVShowRenamer
       end
       opts.parse!
 
-      if ARGV.length <= 1
+      if ARGV.empty?
         puts opts
       else
-        tvshow_name = ARGV.shift
+        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
@@ -37,7 +45,7 @@ module TVShowRenamer
       $stdin.gets.chomp.strip
     end
 
-    def self.prompt_edit_value(prompt, value = nil)
+    def self.prompt_edit_value(prompt, value = nil, regex = nil)
       prompt << " (#{value})" if value
       prompt << " : "
       ok = false
@@ -46,8 +54,8 @@ module TVShowRenamer
         if value && str.empty?
           ok = true
         else
-          if str =~ /0{1,}/ || str.to_i > 0
-            value = str.to_i
+          if !regex || str =~ regex
+            value = str
             ok = true
           end
         end

data/lib/tvshow_renamer/renamer.rb

@@ -6,6 +6,7 @@ module TVShowRenamer
     attr_accessor :tvshow_name
 
     EXTENSIONS = %w( .mkv .avi .mp4 .srt )
+    NUMBER_REGEX = /\A\d+\z/
 
     def initialize(tvshow_name, options = {})
       @tvshow_name = tvshow_name
@@ -35,21 +36,21 @@ module TVShowRenamer
 
     def rename_file(filename)
       renamed = false
-      tvfile = TVShowFile.new @tvshow_name, File.expand_path(filename)
+      @tvfile = TVShowFile.new @tvshow_name, File.expand_path(filename)
 
-      if EXTENSIONS.include?(tvfile.extname.downcase)
-        tvfile.detect_season_and_episode
+      if EXTENSIONS.include?(@tvfile.extname.downcase)
+        @tvfile.detect_season_and_episode
 
-        if tvfile.detected_season && tvfile.detected_episode
-          renamed = prompt_rename(tvfile)
+        if @tvfile.detected_season && @tvfile.detected_episode
+          renamed = prompt_rename
         else
           answered = false
           until answered
             case CLI.prompt("No season and episode values have been detected for this file, do you want to rename it ? (yn) ").downcase
             when 'y'
-              tvfile.season = CLI.prompt_edit_value "Season"
-              tvfile.episode = CLI.prompt_edit_value "Episode"
-              renamed = prompt_rename(tvfile)
+              @tvfile.season = CLI.prompt_edit_value("Season", nil, NUMBER_REGEX).to_i
+              @tvfile.episode = CLI.prompt_edit_value("Episode", nil, NUMBER_REGEX).to_i
+              renamed = prompt_rename
               answered = true
             when 'n'
               answered = true
@@ -60,35 +61,43 @@ module TVShowRenamer
       renamed
     end
 
-    def prompt_rename(tvfile)
+    def prompt_rename
       renamed = answered = false
       until answered
-        case CLI.prompt("Rename \"#{tvfile.basename}\" to \"#{tvfile.new_basename}\" ? (yneh) ").downcase
+        case CLI.prompt("Rename \"#{@tvfile.basename}\" to \"#{@tvfile.new_basename}\" ? (ynemqh) ").downcase
         when 'y'
-          if File.exists?(tvfile.new_filename)
-            renamed = answered = prompt_override(tvfile)
+          if @tvfile.filename == @tvfile.new_filename
+            puts "The two filenames are the same."
           else
-            move_tvshow_file(tvfile)
-            renamed = answered = true
+            if File.exists?(@tvfile.new_filename)
+              renamed = answered = prompt_override
+            else
+              move_tvshow_file
+              renamed = answered = true
+            end
           end
         when 'n'
           answered = true
         when 'e'
-          tvfile.season = CLI.prompt_edit_value "Season", tvfile.detected_season
-          tvfile.episode = CLI.prompt_edit_value "Episode", tvfile.detected_episode
+          @tvfile.season = CLI.prompt_edit_value("Season", @tvfile.detected_season, NUMBER_REGEX)
+          @tvfile.episode = CLI.prompt_edit_value("Episode", @tvfile.detected_episode, NUMBER_REGEX)
+        when 'm'
+          show_menu
+        when 'q'
+          exit
         when '?', 'h'
-          puts "y: Yes, n: No, e: Edit"
+          puts "y: Yes, n: No, e: Edit, m: Menu, q: Quit"
         end
       end
       renamed
     end
 
-    def prompt_override(tvfile)
+    def prompt_override
       overrided = answered = false
       until answered
-        case CLI.prompt("File \"#{tvfile.new_basename}\" already exists. Override ? (yn) ").downcase
+        case CLI.prompt("File \"#{@tvfile.new_basename}\" already exists. Override ? (yn) ").downcase
         when 'y'
-          move_tvshow_file(tvfile)
+          move_tvshow_file
           answered = true
           overrided = true
         when 'n'
@@ -99,15 +108,35 @@ module TVShowRenamer
       overrided
     end
 
-    def move_tvshow_file(tvfile)
-      FileUtils.mv tvfile.filename, tvfile.new_filename
-      log_rename tvfile
+    def show_menu
+      puts "Menu"
+      puts "----"
+      puts "1. Change TV Show name"
+      puts "2. Change format (not yet available)"
+      puts "q. Quit menu"
+      puts "----"
+      quit = false
+      until quit
+        case CLI.prompt("Choice : ")
+        when '1'
+          @tvfile.tvshow_name = CLI.prompt_edit_value("TV Show Name", @tvfile.tvshow_name)
+        when '2'
+          puts "You cannot change the format yet, sorry."
+        when 'q'
+          quit = true
+        end
+      end
+    end
+
+    def move_tvshow_file
+      FileUtils.mv @tvfile.filename, @tvfile.new_filename
+      log_rename
     end
 
-    def log_rename(tvfile)
+    def log_rename
       if @options[:log_file]
-        File.open(File.join(tvfile.dirname, @options[:log_file]), 'a') do |file|
-          file.puts "\"#{tvfile.basename}\" => \"#{tvfile.new_basename}\"\n"
+        File.open(File.join(@tvfile.dirname, @options[:log_file]), 'a') do |file|
+          file.puts "\"#{@tvfile.basename}\" => \"#{@tvfile.new_basename}\"\n"
         end
       end
     end

data/lib/tvshow_renamer/tvshow_file.rb

@@ -1,11 +1,6 @@
 module TVShowRenamer
   class TVShowFile
-    attr_reader :tvshow_name
-    attr_reader :filename
-    attr_accessor :season
-    attr_accessor :episode
-    attr_reader :detected_season
-    attr_reader :detected_episode
+    attr_reader :tvshow_name, :filename, :season, :episode, :detected_season, :detected_episode
 
     def initialize(tvshow_name, filename)
       @tvshow_name = tvshow_name
@@ -14,6 +9,11 @@ module TVShowRenamer
 
     # 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

data/lib/tvshow_renamer/version.rb

@@ -1,3 +1,3 @@
 module TVShowRenamer
-  Version = VERSION = '0.3'
+  Version = VERSION = '0.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tvshow_renamer
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: '0.4'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-25 00:00:00.000000000 Z
+date: 2012-11-26 00:00:00.000000000 Z
 dependencies: []
 description: Utility to rename TV Show files to a correct format
 email: francois@fklingler.com