tvshow_renamer 0.2.1 → 0.3

data/README.md

@@ -3,6 +3,20 @@ tvshow_renamer is a simple command line utility to rename automagically the tv s
 Thanks to [skamlet](https://github.com/skamlet) for his work on [tv-show-renamer](https://github.com/skamlet/tv-show-renamer), the java utility upon which I have based my work.
 
 
+Example
+-------
+
+Files like these ones:
+
+* FamousShow.S05E01.DVDRip.XviD-BLAH.avi
+* FamousShow.S05E02.DVDRip.XviD-BLAH.avi
+
+Will be renamed like this:
+
+* FamousShow - 05x01.avi
+* FamousShow - 05x02.avi
+
+
 Installation
 ------------
 
@@ -15,3 +29,5 @@ Usage
 `tvshow_renamer [options] <tvshow_name> 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.

data/lib/tvshow_renamer/cli.rb

@@ -3,7 +3,7 @@ require 'optparse'
 module TVShowRenamer
   class CLI
     def self.start
-      options = {}
+      options = {cli: true}
       opts = OptionParser.new do |opts|
         opts.banner = "Usage: tvshow_renamer [options] <tvshow_name> file|directory ..."
 
@@ -30,5 +30,29 @@ module TVShowRenamer
         Renamer.new(tvshow_name, options).rename(ARGV)
       end
     end
+
+    def self.prompt(prompt)
+      print prompt
+      $stdout.flush
+      $stdin.gets.chomp.strip
+    end
+
+    def self.prompt_edit_value(prompt, value = nil)
+      prompt << " (#{value})" if value
+      prompt << " : "
+      ok = false
+      until ok
+        str = self.prompt prompt
+        if value && str.empty?
+          ok = true
+        else
+          if str =~ /0{1,}/ || str.to_i > 0
+            value = str.to_i
+            ok = true
+          end
+        end
+      end
+      value
+    end
   end
 end

data/lib/tvshow_renamer/renamer.rb

@@ -34,93 +34,82 @@ module TVShowRenamer
     end
 
     def rename_file(filename)
-      filename = File.expand_path(filename)
-      extension = File.extname(filename)
+      renamed = false
+      tvfile = TVShowFile.new @tvshow_name, File.expand_path(filename)
 
-      if EXTENSIONS.include?(extension.downcase)
-        dirname = File.dirname(filename)
-        basename = File.basename(filename)
-        detected_season, detected_episode = get_season_and_episode(basename)
+      if EXTENSIONS.include?(tvfile.extname.downcase)
+        tvfile.detect_season_and_episode
 
-        season = detected_season
-        episode = detected_episode
-
-        rename_ok = false
-        until rename_ok
-          new_basename = format_filename(@tvshow_name, season, episode, extension)
-          print "Rename \"#{basename}\" to \"#{new_basename}\" ? (yneh) "
-          $stdout.flush
-          rename_value = $stdin.gets.chomp.strip
-          case rename_value.downcase
-          when 'y'
-            new_filename = File.join(dirname, new_basename)
-            if File.exists?(new_filename)
-              override_ok = false
-              until override_ok
-                print "File \"#{new_basename}\" already exists. Override ? (yn) "
-                $stdout.flush
-                override_value = $stdin.gets.chomp.strip
-                case override_value
-                when 'y'
-                  FileUtils.mv filename, new_filename
-                  log_rename dirname, basename, new_basename
-                  override_ok = true
-                  rename_ok = true
-                when 'n'
-                  override_ok = true
-                end
-              end
-            else
-              FileUtils.mv filename, new_filename
-              log_rename dirname, basename, new_basename
-              rename_ok = true
+        if tvfile.detected_season && tvfile.detected_episode
+          renamed = prompt_rename(tvfile)
+        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)
+              answered = true
+            when 'n'
+              answered = true
             end
-          when 'n'
-            rename_ok = true
-          when 'e'
-            season = edit_value "Season", detected_season
-            episode = edit_value "Episode", detected_episode
-          when '?', 'h'
-            puts "y: Yes, n: No, e: Edit"
           end
         end
       end
+      renamed
     end
 
-    def log_rename(dirname, basename, new_basename)
-      if @options[:log_file]
-        File.open(File.join(dirname, @options[:log_file]), 'a') do |file|
-          file.puts "\"#{basename}\" => \"#{new_basename}\"\n"
+    def prompt_rename(tvfile)
+      renamed = answered = false
+      until answered
+        case CLI.prompt("Rename \"#{tvfile.basename}\" to \"#{tvfile.new_basename}\" ? (yneh) ").downcase
+        when 'y'
+          if File.exists?(tvfile.new_filename)
+            renamed = answered = prompt_override(tvfile)
+          else
+            move_tvshow_file(tvfile)
+            renamed = answered = true
+          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
+        when '?', 'h'
+          puts "y: Yes, n: No, e: Edit"
         end
       end
+      renamed
     end
 
-    def get_season_and_episode(basename)
-      regex = /(?<season>\d{1,2})(e|x|\.)?(?<episode>\d{2,})/i
-      match = regex.match basename
-      [match[:season].to_i, match[:episode].to_i]
+    def prompt_override(tvfile)
+      overrided = answered = false
+      until answered
+        case CLI.prompt("File \"#{tvfile.new_basename}\" already exists. Override ? (yn) ").downcase
+        when 'y'
+          move_tvshow_file(tvfile)
+          answered = true
+          overrided = true
+        when 'n'
+          answered = true
+          overrided = false
+        end
+      end
+      overrided
     end
 
-    def format_filename(tvshow_name, season, episode, extension)
-      "#{tvshow_name} - %02ix%02i#{extension}" % [season, episode]
+    def move_tvshow_file(tvfile)
+      FileUtils.mv tvfile.filename, tvfile.new_filename
+      log_rename tvfile
     end
 
-    def edit_value(prompt, value)
-      ok = false
-      until ok
-        print "#{prompt} (#{value}) : "
-        $stdout.flush
-        str = $stdin.gets.chomp.strip
-        if str.empty?
-          ok = true
-        else
-          if str =~ /0{1,}/ || str.to_i > 0
-            value = str.to_i
-            ok = true
-          end
+    def log_rename(tvfile)
+      if @options[:log_file]
+        File.open(File.join(tvfile.dirname, @options[:log_file]), 'a') do |file|
+          file.puts "\"#{tvfile.basename}\" => \"#{tvfile.new_basename}\"\n"
         end
       end
-      value
     end
   end
 end

data/lib/tvshow_renamer/tvshow_file.rb

@@ -0,0 +1,66 @@
+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
+
+    def initialize(tvshow_name, filename)
+      @tvshow_name = tvshow_name
+      @filename = filename
+    end
+
+    # Custom setters
+
+    def season=(season)
+      @season = season
+      @new_basename = @new_filename = nil
+    end
+
+    def episode=(episode)
+      @episode = episode
+      @new_basename = @new_filename = nil
+    end
+
+    # Lazy getters
+
+    def basename
+      @basename ||= File.basename(@filename)
+    end
+
+    def dirname
+      @dirname ||= File.dirname(@filename)
+    end
+
+    def extname
+      @extname ||= File.extname(@filename)
+    end
+
+    def new_basename
+      unless @new_basename
+        @new_basename = "#{@tvshow_name} - %02ix%02i#{extname}" % [@season, @episode]
+        @new_filename = nil
+      end
+      @new_basename
+    end
+
+    def new_filename
+      @new_filename ||= File.join dirname, new_basename
+    end
+
+    # Active methods
+
+    def detect_season_and_episode
+      regex = /(?<season>\d{1,2})(e|x|\.)?(?<episode>\d{2,})/i
+      match = regex.match basename
+      if match && match[:season] && match[:episode]
+        @detected_season = match[:season].to_i
+        send :season=, @detected_season
+        @detected_episode = match[:episode].to_i
+        send :episode=, @detected_episode
+      end
+    end
+  end
+end

data/lib/tvshow_renamer/version.rb

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

data/lib/tvshow_renamer.rb

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

data/test/test_tvshow_renamer.rb

@@ -4,11 +4,7 @@ require 'tvshow_renamer'
 class TVShowRenamerTest < Test::Unit::TestCase
   TVSHOW_NAME = 'Famous Show'
 
-  def setup
-    @renamer = TVShowRenamer::Renamer.new(TVSHOW_NAME)
-  end
-
-  def test_get_season_and_episode
+  def test_detect_season_and_episode
     {
       'FamousShow.S05E01.DVDRip.XviD-BLAH.avi' => [5, 1],
       'FamousShow.12x03.DVDRip.XviD-BLAH.avi'  => [12,3],
@@ -17,14 +13,21 @@ class TVShowRenamerTest < Test::Unit::TestCase
       'Famous.Show.03.04.avi'                  => [3, 4],
       'Famous-Show.04x00.srt'                  => [4, 0],
     }.each do |k,v|
-      assert_equal v, @renamer.get_season_and_episode(k)
+      tvfile = TVShowRenamer::TVShowFile.new(TVSHOW_NAME, k)
+      tvfile.detect_season_and_episode
+      
+      assert_equal v, [tvfile.season, tvfile.episode]
     end
   end
 
-  def test_format_filename
-    assert_equal 'Famous Show - 01x02.mkv',
-                 @renamer.format_filename(TVSHOW_NAME, 1, 2, '.mkv')
-    assert_equal 'Famous Show - 01x101.mkv',
-                 @renamer.format_filename(TVSHOW_NAME, 1, 101, '.mkv')
+  def test_new_basename
+    tvfile = TVShowRenamer::TVShowFile.new(TVSHOW_NAME, '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
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tvshow_renamer
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: '0.3'
   prerelease: 
 platform: ruby
 authors:
@@ -23,6 +23,7 @@ files:
 - Rakefile
 - lib/tvshow_renamer/cli.rb
 - lib/tvshow_renamer/renamer.rb
+- lib/tvshow_renamer/tvshow_file.rb
 - lib/tvshow_renamer/version.rb
 - lib/tvshow_renamer.rb
 - test/test_tvshow_renamer.rb