movie-renamer 0.0.3

data/LICENSE

@@ -0,0 +1,3 @@
+Copyright (c) 2010 Mattia Gheda
+
+GPL v3 

data/README.rdoc

@@ -0,0 +1,17 @@
+= movie-renamer
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 tha. See LICENSE for details.

data/bin/movie-renamer

@@ -0,0 +1,70 @@
+#!/usr/bin/ruby
+
+require File.join(File.dirname(__FILE__),'..','lib','movie-renamer')
+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.on("-h","--help","Display this help") do
+        puts opts
+        exit 0
+    end
+
+    opts.on("-i","--imdb","Executes a query on imdb on <movie name>") do
+        options[:imdb] = true
+    end
+
+    opts.on("-s","--singlemovie","Acts on a single movie file <file name>") do
+        options[:single] = true
+    end
+
+    opts.on("-f","--folder","Acts on whole folder <folder>") do
+        options[:folder] = true
+    end
+
+    begin
+        opts.parse!(ARGV)
+    rescue OptionParser::ParseError => 
+        warn.message
+        puts opts
+        exit 1
+    end
+        
+end
+
+if options.empty?
+    options[:folder] = true
+end
+
+name = ARGV.join(' ')
+
+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
+
+
+
+if options[:folder] 
+    if name
+        MovieRenamer::folderPath = File.expand_path(name)
+    else
+        Movierenamer::folderPath = Dir.pwd 
+    end
+    MovieRenamer::folderLoop()
+elsif options[:single]
+    if name && File.file?(name)
+       MovieRenamer::folderPath = File.dirname(File.expand_path(name)) 
+       MovieRenamer::editMovie(name)
+    else
+        puts "Usage: #{File.basename($0)} -s <filename>"
+        exit 1
+    end
+
+elsif options[:imdb]
+    MovieRenamer::suggestMovies(name)
+end
+
+exit 0

data/lib/movie-renamer.rb

@@ -0,0 +1,249 @@
+#!/usr/bin/ruby
+#
+#
+#
+
+require 'imdb'
+
+module MovieRenamer
+    
+    NEWPATH = 'tmp'
+    # TODO insert default
+    @folderpath = '' 
+    @is_a_test = false
+    RENAMEPATTERN = ''
+    MOVIEPATTERN = %r{\.((avi)|(mkv)|(mpg))$} 
+    @input = STDIN
+    @output = STDOUT
+
+
+
+    class Movie
+        
+        def initialize(filename,year = '',director = '',title = '',part = '',imdb = nil)
+            @year = year
+            @director = director
+            @title = title
+            @part = part
+            @imdb = imdb
+            @filename = filename
+        end
+
+        attr_accessor :year, :director, :title, :part, :imdb, :filename
+
+        def == (movie)
+           if @year == movie.year and @director == movie.director and @title == movie.title and @part == movie.part and @imdb == movie.imdb and @filename == movie.filename
+                return true
+           else
+                return false
+           end
+        end
+
+    end
+
+    # setters
+    def MovieRenamer::folderPath=(folderpath)
+        @folderpath = folderpath
+    end
+
+
+    #test helpers
+    def MovieRenamer::input=(input)
+        @input = input
+    end
+
+    def MovieRenamer::is_a_test=(input)
+        @is_a_test = input
+    end
+    def MovieRenamer::output=(output)
+        @output = output
+    end
+
+    # returns an array of filenames
+    # TODO recursive find?
+    def MovieRenamer::findMovies(folder = @folderpath)
+        ar = Array.new
+        Dir.open(folder) do |dir|
+            dir.each do |file|
+               if file =~ MOVIEPATTERN
+                    ar << file
+               end
+            end
+        end
+        return ar.sort
+    end
+
+    # reads move filename and tries to initialize a movie object?
+    # returns the movie object
+    def MovieRenamer::readMovie(filename)
+        # TODO insert logic here
+        filename = File.basename(filename)
+        title = File.basename(filename,'.*')
+        return Movie.new(filename,'','', title)
+    end
+
+    # rename a movie according to movie data 
+    # and moves it to the new path in filesystem 
+    def MovieRenamer::renameMovie(movie,newpath = NEWPATH)
+        filename = MovieRenamer::newName(movie)
+        path = File.join(@folderpath,newpath)
+        unless File.exist?(path)
+            Dir.mkdir(path)   
+        end
+
+        begin 
+            require 'fileutils'
+            # remove noop
+            return FileUtils::mv(File.join(@folderpath,movie.filename), File.join(path,filename), :noop => @is_a_test) ? true : false
+        rescue SystemCallError => e
+            puts e
+        end
+    end
+
+    # plays the movie with mplayer
+    def MovieRenamer::playMovie(movie)
+        
+    end
+
+    # edit a movie interactively
+    # read the movie
+    # print movie info
+    # ask movie data
+    # rename movie
+    # play movie option?
+    # XXX add part integer check
+    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] "
+       if ans 
+           if ans == 'info'
+             MovieRenamer::suggestMovies(movie.title) 
+           elsif ans == 'play'
+             MovieRenamer::playMovie(movie) 
+           end
+           #if ask "play movie with mplayer?" 
+           #     MovieRenamer::playMovie(movie) 
+           #end
+
+           # TODO insert imdb suggestions here?
+           
+           @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 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)
+            
+
+           MovieRenamer::printMovieInfo(movie)
+
+           if ask "is this information correct" 
+               return MovieRenamer::renameMovie(movie)
+               #return true
+           else
+               editMovie(filename) 
+           end
+       else 
+           return true
+       end
+       
+    end
+
+    
+    # invoke edit movie on a whole folder
+    def MovieRenamer::folderLoop(folder = @folderpath)
+        MovieRenamer::findMovies(folder).each do |file|
+            MovieRenamer::editMovie(file)
+        end
+    end
+
+
+    def MovieRenamer::ask(question)
+        @output.puts question
+        response = @input.gets.chomp
+        case response
+        when /^y(es)?$/i
+            true
+        when /^no?$/i
+            false
+        else 
+            puts "I don't understand. Please retry"
+            ask(question)
+        end
+    end
+
+    def MovieRenamer::askMore(question)
+        @output.puts question
+        response = @input.gets.chomp
+        case response
+        when /^y(es)?$/i
+            true
+        when /^no?$/i
+            false
+        when /^q(uit)?$/i
+            exit 0
+        when /^i(nfo)?$/i
+            return "info"
+        when /^p(lay)?$/i
+            return "play"
+        else 
+            puts "I don't understand. Please retry"
+            askMore(question)
+        end
+    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
+    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}"        
+        if movie.part =~ /\w/
+            s+= " - part#{movie.part.to_i}"
+        end
+        s += File.extname(movie.filename)
+        return s
+    end
+
+
+    def MovieRenamer::sanitizeInput(input)
+        # XXX naive sanitize
+        # simply removing all non standard characters
+        input.gsub(/[^A-Za-z0-9\_\-\s]/,'').chomp.sub(/ +$/,'')
+    end
+
+    # makes a query to imdb database
+    def MovieRenamer::suggestMovies(name)
+        s = Imdb::Search.new(name) 
+        s.movies.each do |m|
+            @output.puts "#{m.year} - #{m.director.to_s.gsub(/(\[")|("\])/,'')} - #{m.title.gsub(/     .*/,'')}" 
+        end
+    end
+
+    # TODO output string variable
+    def MovieRenamer::suggestMovie(name)
+        s = Imdb::Search.new(name) 
+        m = s.movies.first
+        @output.puts "#{m.year} - #{m.director} - #{m.title}" 
+    end
+
+    # returns the first movie from imdb query
+    
+end
+

data/test/helper.rb

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'movie-renamer'
+
+
+module Test::Unit
+    class TestCase
+
+        def self.must(name,&block)
+            test_name = "test_#{name.gsub(/\s+/,'_')}".to_sym
+            defined = instance_method(test_name) rescue false
+            raise "#{test_name} is already defined in #{self}" if defined
+            if block_given?
+                define_method(test_name,&block)
+            else
+                define_method(test_name) do
+                    flunk "No implementation provided for #{name}"
+                end
+            end
+
+        end
+
+
+
+    end
+end

data/test/test_movie-renamer.rb

@@ -0,0 +1,113 @@
+require 'helper'
+require 'movie-renamer'
+require 'stringio'
+
+class TestMovieRenamer < Test::Unit::TestCase
+    
+    def setup
+       @folder = File.expand_path('temp')
+       MovieRenamer::folderPath =  @folder
+       @movies = MovieRenamer::findMovies(@folder)
+       @input = StringIO.new
+       @output = StringIO.new
+       MovieRenamer::input = @input 
+       MovieRenamer::output = @output 
+       MovieRenamer::is_a_test = true 
+    end
+
+    # test find movies
+    must "find avi movies in the folder" do
+        assert_equal %w{movie1.avi movie2.avi movie3.mkv movie4.mpg}, @movies
+        
+    end
+
+    # test read movie
+    must "create a movie object" do
+       assert_equal MovieRenamer::Movie.new('movie1.avi','','','movie1'),MovieRenamer::readMovie(@movies.first)
+    end
+
+    # simple checks that rename is done 
+    must "rename a file (and moves it) correctly" do
+        assert ! MovieRenamer::renameMovie(MovieRenamer::readMovie(@movies.first)), "file not renamed?"
+    end
+
+    # newname check
+    must "rename a movie correctly" do 
+        movie = MovieRenamer::Movie.new('movie1.avi','2001','me','famous')
+        assert_equal "2001 - me - famous.avi",MovieRenamer::newName(movie)
+    end
+    
+    must "rename a movie correctly with parts" do 
+        movie = MovieRenamer::Movie.new('movie1.avi','2001','me','famous','1')
+        assert_equal "2001 - me - famous - part1.avi",MovieRenamer::newName(movie)
+    end
+
+    must "rename a movie correctly without part because part is wrong" do 
+        movie = MovieRenamer::Movie.new('movie1.avi','2001','me','famous','  ')
+        assert_equal "2001 - me - famous.avi",MovieRenamer::newName(movie)
+    end
+
+    # print movie info check
+    # XXX usless check for now
+    must "print movie info correctly" do 
+        movie = MovieRenamer::Movie.new('movie1.avi','2001','me','famous','1')
+        assert MovieRenamer::printMovieInfo(movie)
+
+    end
+
+    # test for ask function movie
+    must "return true on yes input" do
+        provide_input "yes\n"
+        assert MovieRenamer::ask("do you want to edit this movie")
+        expect_output "do you want to edit this movie\n"
+    end
+    
+    must "return false on no input" do
+        provide_input "no\n"
+        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 = "very bad movie{}\@# son     "
+        assert_equal "very bad movie son", MovieRenamer::sanitizeInput(input)
+    end
+
+    # 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)
+    end
+
+    must "edit a movie correctly testing recursion" do 
+        provide_input "yes\n1984\nOrwell James\nBig Brother\n\nno\nyes\n1984\nOrwell James\nBig Brother\n1\nyes\n"
+        assert ! MovieRenamer::editMovie(@movies.first)
+        #expect_output("wow")
+    end
+
+
+    # test main loop over folder
+    must "ask for all movies in folder" do
+       provide_input "no\nno\nno\nno\n" 
+       assert MovieRenamer::folderLoop()
+    end
+    
+    # suggest movies XXX no test here
+    must "suggest a movie list from a movie title" do
+        MovieRenamer::suggestMovies("Kill Bill")
+        #expect_output "wow"
+    end
+
+    # helpers
+    def provide_input (string)
+        @input << string
+        @input.rewind
+    end
+
+    def expect_output(string)
+        assert_equal string, @output.string
+    end
+
+end
+

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: movie-renamer
+version: !ruby/object:Gem::Version 
+  version: 0.0.3
+platform: ruby
+authors: 
+- ghedamat
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-20 00:00:00 +02:00
+default_executable: movie-renamer
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: imdb
+  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
+  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: 
+- movie-renamer
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- bin/movie-renamer
+- lib/movie-renamer.rb
+- test/helper.rb
+- test/test_movie-renamer.rb
+- LICENSE
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/ghedamat/movie-renamer
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: rename movies in a folder asking questions
+test_files: 
+- test/helper.rb
+- test/test_movie-renamer.rb