movie-renamer 0.0.12 → 0.0.15

data/README.rdoc

@@ -1,13 +1,22 @@
 = movie-renamer
 
 A simple command line interface to rename movies in a folder
+and get your movies collection organized!
 
-
-Uses imdb gem to query imdb about current movie trying to obtain useful infos
+It works in an interactive way and 
+uses imdb gem to query imdb about current movie trying to obtain useful infos
 
 to see the usage type
 
 $ movie-renamer -h
+Usage: movie-renamer [-i|-s|-f|-h|-p] <folder>
+Default behavior is -f on current working directory
+    -h, --help                       Display this help
+    -i, --imdb                       Executes a query on imdb on <movie name>
+    -s, --singlemovie FILE           Acts on a single movie file <file name>
+    -f, --folder FOLDER              Acts on whole folder <folder>
+    -p, --path PATH                  path for moving renamed movies default is tmp/ in current working directory 
+
 
 == How it works
 
@@ -15,13 +24,17 @@ Default behavior is to scan the current working directory
 For each movie in the folder a question about what to do is asked.
 
 Then movie is renamed using input provided by the user
+You can query imdb using the filename or enter use manual search
 
-Each renamed movie is moved into a tmp/ subfolder of the current working directory.
-Movies are renamed like this:
+Each renamed movie is moved into a tmp/ subfolder of the current working directory or 
+in the folder specified with the -p option
 
-YEAR - DIRECTOR - TITLE - optionalPART.extension
+By default Movies are renamed like this:
+$year - $director - $title partXX.file_extension
+You can set the rename pattern creating a .movie-renamer file in your home
 
-There are plans to add the rename pattern like an optional parameter
+example:
+filename: ($year) - $title - $director
 
 
 

data/bin/movie-renamer

@@ -6,7 +6,7 @@ require 'optparse'
 options = {}
 
 OptionParser.new do |opts|
-    opts.banner = "Usage: #{File.basename($0)} [opts] <name>\nOnly one options each run\nDefault behavior is -f on current working directory"
+    opts.banner = "Usage: #{File.basename($0)} [-i|-s|-f|-h|-p] <folder>\nDefault behavior is -f on current working directory"
 
     opts.on("-h","--help","Display this help") do
         puts opts
@@ -17,12 +17,16 @@ OptionParser.new do |opts|
         options[:imdb] = true
     end
 
-    opts.on("-s","--singlemovie","Acts on a single movie file <file name>") do
-        options[:single] = true
+    opts.on("-s","--singlemovie FILE","Acts on a single movie file <file name>") do |f|
+        options[:single] = f
     end
 
-    opts.on("-f","--folder","Acts on whole folder <folder>") do
-        options[:folder] = true
+    opts.on("-f","--folder FOLDER","Acts on whole folder <folder>") do |f|
+        options[:folder] = f
+    end
+    
+    opts.on("-p","--path PATH", "path for moving renamed movies default is tmp/ in current working directory ") do |p|
+        options[:path] = p
     end
 
     begin
@@ -35,36 +39,42 @@ OptionParser.new do |opts|
         
 end
 
-if options.empty?
-    options[:folder] = true
-end
-
 name = ARGV.join(' ')
 
+=begin
 if options.length != 1
     puts "Usage: #{File.basename($0)} [opts] <name>\nOnly one options each run\nDefault behavior is -f on current working directory"
 end
+=end
 
-
+if options[:path] 
+    MovieRenamer::newpath = options[:path]
+end
 
 if options[:folder] 
-    if name
-        MovieRenamer::folderPath = File.expand_path(name)
-    else
-        Movierenamer::folderPath = Dir.pwd 
-    end
+    MovieRenamer::folderPath = File.expand_path(options[:folder])
     MovieRenamer::folderLoop()
+    exit 0
 elsif options[:single]
-    if name && File.file?(name)
-       MovieRenamer::folderPath = File.dirname(File.expand_path(name)) 
-       MovieRenamer::editMovie(name)
+    if File.file?(File.expand_path(options[:single]))
+       MovieRenamer::folderPath = File.dirname(File.expand_path(options[:single])) 
+       MovieRenamer::editMovie(options[:single])
     else
         puts "Usage: #{File.basename($0)} -s <filename>"
         exit 1
     end
+    exit 0
 
 elsif options[:imdb]
     MovieRenamer::suggestMovies(name)
+    exit 0
+elsif name
+    MovieRenamer::folderPath = File.expand_path(name)
+    MovieRenamer::folderLoop()
+    exit 0
+else
+    Movierenamer::folderPath = Dir.pwd 
+    MovieRenamer::folderLoop()
+    exit 0
 end
 
-exit 0

data/lib/movie-renamer.rb

@@ -1,19 +1,45 @@
 #!/usr/bin/ruby
 
 require 'imdb'
+require 'highline'
+require 'highline/import'
+require 'yaml'
+
+$config = ''
+CONFIGFILE = File.join(File.expand_path(ENV['HOME']), '.movie-renamer')
+begin 
+    $config = YAML.load_file(CONFIGFILE)
+rescue
+=begin
+    raise "\nplease create a .movie-renamer file in your $HOME
+example:
+filename: /path/to/your/movies/dir"
+exit
+=end
+end
+
+
+begin
+    require 'imdb'
+rescue LoadError
+    $stderr.print "#{File.basename($0)} requires imdb gem to work\nPlease install it with gem install imdb\n"
+    exit
+end
 
 module MovieRenamer
     
-    NEWPATH = 'tmp'
+    @newpath = 'tmp'
     # TODO insert default
     @folderpath = '' 
     @is_a_test = false
-    RENAMEPATTERN = ''
+    @renamepattern = '$year - $director - $title'
     MOVIEPATTERN = %r{\.((avi|AVI)|(mkv|MKV)|(mpg|MPG|mpeg|MPEG))$} 
     @input = STDIN
     @output = STDOUT
-
-
+    
+    if $config['filename']
+        @renamepattern = $config['filename']
+    end
 
     class Movie
         
@@ -44,6 +70,9 @@ module MovieRenamer
         @folderpath = folderpath
     end
 
+    def MovieRenamer::newpath=(newpath)
+        @newpath = newpath
+    end
 
     #test helpers
     def MovieRenamer::input=(input)
@@ -82,7 +111,7 @@ module MovieRenamer
 
     # attempt to remove the divx part from a filename
     def MovieRenamer::titleExtract(filename)
-        r1 = %r{\s*\[?\(?\s*(d|D)(i|I)(v|V)(x|X)\s?(-|_)?\s?\w+\s*\)?\]?\s*}
+        r1 = %r{\s*\[?\(?\s*[dD](i|I)(v|V)(x|X)\s?(-|_)?\s?\w+\s*\)?\]?\s*}
         r2 = %r{\s*\[?\(?\s*(x|X)(v|V)(i|I)(d|D)\s?(-|_)?\s?\w+\s*\)?\]?\s*}
         r3 = %r{\s*\[?\(?\s*(d|D)(v|V)(d|D)(r|R)(i|I)(p|P)\s?(-|_)?\s*\)?\]?\s*}
         r = /(#{r1}|#{r2}|#{r3})/
@@ -91,9 +120,9 @@ module MovieRenamer
 
     # rename a movie according to movie data 
     # and moves it to the new path in filesystem 
-    def MovieRenamer::renameMovie(movie,newpath = NEWPATH)
+    def MovieRenamer::renameMovie(movie,newpath = @newpath)
         filename = MovieRenamer::newName(movie)
-        path = File.join(@folderpath,newpath)
+        path = File.expand_path(newpath)
         unless File.exist?(path)
             Dir.mkdir(path)   
         end
@@ -122,11 +151,11 @@ module MovieRenamer
     def MovieRenamer::editMovie(filename)
        movie = MovieRenamer::readMovie(filename)  
        MovieRenamer::printMovieInfo(movie)
-       ans = askMore "would you like to edit this movie? [ yes, no, quit, info , play] "
+       ans = askMore "would you like to edit this movie? [ Yes, No, Quit, Info]"# , play] "
        if ans 
-           if ans == 'info'
-             MovieRenamer::suggestMovies(movie.title) 
-           elsif ans == 'play'
+           if ans == :info
+             MovieRenamer::suggestMovies(movie) 
+           elsif ans == :play
              MovieRenamer::playMovie(movie) 
            end
            #if ask "play movie with mplayer?" 
@@ -134,23 +163,27 @@ module MovieRenamer
            #end
 
            # TODO insert imdb suggestions here?
-           
-           @output.puts "Enter a year"
-           movie.year = @input.gets.chomp.to_i
+          
+           if movie.year == ''
+               @output.puts "Enter a year"
+               movie.year = @input.gets.chomp.to_i
 
-           @output.puts "Enter a director"
-           movie.director = MovieRenamer::sanitizeInput(@input.gets.chomp)
+               @output.puts "Enter a director"
+               movie.director = MovieRenamer::sanitizeInput(@input.gets.chomp)
 
-           @output.puts "Enter a title"
-           movie.title = MovieRenamer::sanitizeInput(@input.gets.chomp)
+               @output.puts "Enter a title"
+               movie.title = MovieRenamer::sanitizeInput(@input.gets.chomp)
 
-           @output.puts "Enter a part (you can leave this blank)"
-           movie.part = MovieRenamer::sanitizeInput(@input.gets.chomp)
-            
+               @output.puts "Enter a part (you can leave this blank)"
+               movie.part = MovieRenamer::sanitizeInput(@input.gets.chomp)
+           end
 
            MovieRenamer::printMovieInfo(movie)
 
-           if ask "is this information correct" 
+           ans = ask("is this information correct: Yes, No") do |q|
+                q.validate = /^y(es)?|^n(o)?/
+           end
+           if ans =~/^y(es)?/
                return MovieRenamer::renameMovie(movie)
                #return true
            else
@@ -170,6 +203,7 @@ module MovieRenamer
         end
     end
 
+=begin
     # yes or no questioner
     def MovieRenamer::ask(question)
         @output.puts question
@@ -181,9 +215,10 @@ module MovieRenamer
             false
         else 
             puts "I don't understand. Please retry"
-            ask(question)
+            MovieRenamer::ask(question)
         end
     end
+=end
 
     # yes no quit info play questioner
     def MovieRenamer::askMore(question)
@@ -197,9 +232,9 @@ module MovieRenamer
         when /^q(uit)?$/i
             exit 0
         when /^i(nfo)?$/i
-            return "info"
+            return :info
         when /^p(lay)?$/i
-            return "play"
+            return :play
         else 
             puts "I don't understand. Please retry"
             askMore(question)
@@ -207,21 +242,22 @@ module MovieRenamer
     end
 
     def MovieRenamer::printMovieInfo(movie)
-        s = "Movie info is:\n"
-        s+= "@oldfilename: #{movie.filename}\n"
-        s+= "@year: #{movie.year}\n"
-        s+= "@director: #{movie.director}\n"
-        s+= "@title: #{movie.title}\n"
-        s+= "@part: #{movie.part}\n"
-        s+= "New filename = #{MovieRenamer::newName(movie)}\n"
-        @output.puts s
-        return s
+        say("Movie info is:
+<%= color('old filename:', :red) %> #{movie.filename}
+<%= color('year:', :red) %> #{movie.year}
+<%= color('director:', :red) %> #{movie.director}
+<%= color('title:', :red) %> #{movie.title}
+<%= color('part:', :red) %> #{movie.part}
+<%= color('filename:', :red) %> #{MovieRenamer::newName(movie)}")
+        #@output.puts s
+        #return s
     end
 
     # calculates new movie name based on a pattern? XXX
     # TODO change this and include a globalpattern
     def MovieRenamer::newName(movie)
-        s = "#{movie.year} - #{movie.director} - #{movie.title}"        
+        @renamepattern.gsub!(/\$[a-z]*/) { |m| ;'#{movie.'+m.sub(/\$/,'').chomp+'}' }
+        s = eval( '"' + @renamepattern + '"')
         if movie.part =~ /\w/
             s+= " - part#{movie.part.to_i}"
         end
@@ -239,11 +275,24 @@ module MovieRenamer
     end
 
     # makes a query to imdb database
-    def MovieRenamer::suggestMovies(name)
-        s = Imdb::Search.new(name) 
-        s.movies[0..5].each do |m|
-            @output.puts "#{m.year} - #{m.director.to_s.gsub(/(\[")|("\])/,'')} - #{m.title.gsub(/     .*/,'')}" 
+    def MovieRenamer::suggestMovies(movie)
+        s = Imdb::Search.new(movie.title) 
+        s.movies[0..4].each_with_index do |m,i|
+            @output.puts "#{i}, #{m.year} - #{m.director.to_s.gsub(/(\[")|("\])/,'')} - #{m.title.gsub(/     .*/,'')}" 
+        end
+        cmd = ask("pick a choice [0..4], Manual search, Edit Manually", %w{0 1 2 3 4 m e}) do |q|
+            q.readline = true
+        end
+        if %w{0 1 2 3 4}.include?(cmd)
+            m = s.movies[cmd.to_i]
+            movie.title = m.title.gsub(/     .*/,'').gsub(/\s*\([0-9]+\)/,'')
+            movie.year = m.year
+            movie.director = m.director.to_s.gsub(/(\[")|("\])/,'')
+        elsif cmd == "m" 
+            movie.title = ask("enter title")
+            MovieRenamer::suggestMovies(movie )
         end
+        return movie
     end
 
     # TODO output string variable

data/test/test_movie-renamer.rb

@@ -58,6 +58,7 @@ class TestMovieRenamer < Test::Unit::TestCase
         assert_equal "2001 - me - famous.avi",MovieRenamer::newName(movie)
     end
 
+=begin
     # print movie info check
     # XXX usless check for now
     must "print movie info correctly" do 
@@ -78,14 +79,7 @@ class TestMovieRenamer < Test::Unit::TestCase
         assert ! MovieRenamer::ask("do you want to edit this movie")
         expect_output "do you want to edit this movie\n"
     end
-
-    # test input sanitize
-    must "sanitize input correctly" do
-        input = "ain't a very bad movie{}\@# son     "
-        assert_equal "ain't a very bad movie son", MovieRenamer::sanitizeInput(input)
-    end
-
-    # test edit movie
+     # test edit movie
     must "edit a movie correctly" do 
         provide_input "yes\n1984\nOrwell James\nBig Brother\n\nyes\n"
         assert ! MovieRenamer::editMovie(@movies.first)
@@ -97,7 +91,16 @@ class TestMovieRenamer < Test::Unit::TestCase
         #expect_output("wow")
     end
 
+=end
+    # test input sanitize
+    must "sanitize input correctly" do
+        input = "ain't a very bad movie{}\@# son     "
+        assert_equal "ain't a very bad movie son", MovieRenamer::sanitizeInput(input)
+    end
+
+   
 
+=begin
     # test main loop over folder
     must "ask for all movies in folder" do
        provide_input "no\nno\nno\nno\n" 
@@ -109,6 +112,7 @@ class TestMovieRenamer < Test::Unit::TestCase
         MovieRenamer::suggestMovies("Kill Bill")
         #expect_output "wow"
     end
+=end
 
     # helpers
     def provide_input (string)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: movie-renamer
 version: !ruby/object:Gem::Version 
-  version: 0.0.12
+  version: 0.0.15
 platform: ruby
 authors: 
 - ghedamat
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-06 00:00:00 +02:00
+date: 2010-09-04 00:00:00 +02:00
 default_executable: movie-renamer
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,6 +22,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: highlight
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 - !ruby/object:Gem::Dependency 
   name: imdb
   type: :runtime
@@ -32,6 +42,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: highlight
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: rename movies in a folder
 email: thamayor@gmail.com
 executables: