ogg_album_tagger 0.1.0 → 0.1.2

data/lib/ogg_album_tagger/exceptions.rb

@@ -2,8 +2,8 @@ module OggAlbumTagger
 
 class Error < ::StandardError; end
 
-class SystemError < Error; end
-class ArgumentError < Error; end
-class MetadataError < Error; end
+class SystemError < OggAlbumTagger::Error; end
+class ArgumentError < OggAlbumTagger::Error; end
+class MetadataError < OggAlbumTagger::Error; end
 
 end

data/lib/ogg_album_tagger/library.rb

@@ -3,9 +3,6 @@ require 'ogg_album_tagger/tag_container'
 require 'ogg_album_tagger/exceptions'
 
 require 'set'
-require 'shellwords'
-require 'pathname'
-require 'open3'
 require 'fileutils'
 
 module OggAlbumTagger
@@ -13,38 +10,32 @@ module OggAlbumTagger
 # A Library is just a hash associating each ogg file to a TagContainer.
 # A subset of file can be selected in order to be tagged.
 class Library
+	attr_reader :path
 	attr_reader :selected_files
 
-	# Build the library by parsing specified ogg file.
-	# In order to consider the library as a single album, you have to separately provide
-	# the absolute path to the album and relative paths to the ogg files.
-	# Otherwise, use absolute paths.
+	# Build a Library from a list of TagContainer.
 	#
-	# Paths must be provided as Pathnames.
-	#
-	# A OggAlbumTagger::SystemError will be raised if vorbiscomment cannot be invoked.
-	# A OggAlbumTagger::ArgumentError will be raised if one of the files is not a valid ogg file.
-	def initialize files, dir = nil
+	# dir:: The name of the directory supposed to contain all the files. Pass any name if the
+	#       tracks of that library are related, +nil+ otherwise.
+	# containers:: A hash mapping the files to the containers.
+	def initialize dir, tracks
 		@path = dir
-		@files = {}
 
-		files.each do |f|
-			@files[f] = TagContainer.new(fullpath(f))
-		end
+		@files = tracks.map { |e| e }
 
-		@selected_files = Set.new @files.keys
+		@selected_files = @files.slice(0, @files.size).to_set
 	end
 
-	# Return the full path to the file.
-	def fullpath(file)
-		@path.nil? ? file : @path + file
+	# Return the number of files in this library.
+	def size
+		@files.size
 	end
 
 	# Returns the list of the tags used in the selected files.
 	def tags_used
 		s = Set.new
 		@selected_files.each do |file|
-			s.merge @files[file].tags
+			s.merge file.tags
 		end
 		s.to_a.map { |v| v.downcase }
 	end
@@ -67,14 +58,14 @@ class Library
 	def summary(selected_tag = nil)
 		data = Hash.new { |h, k| h[k] = Hash.new }
 
-		positions = Hash[@files.keys.sort.each_with_index.to_a]
+		@files.each_with_index { |file, i|
+			next unless @selected_files.include? file
 
-		@selected_files.each do |file|
-			@files[file].each do |tag, values|
+			file.each do |tag, values|
 				next unless selected_tag.nil? or tag.eql?(selected_tag)
-				data[tag][positions[file]] = values.sort
+				data[tag][i] = values.sort
 			end
-		end
+		}
 
 		data
 	end
@@ -93,7 +84,7 @@ class Library
 	# Write the tags to the files.
 	def write
 		@selected_files.each do |file|
-			@files[file].write(fullpath(file))
+			file.write(file.path)
 		end
 	end
 
@@ -102,13 +93,15 @@ class Library
 	# Any previous value will be removed.
 	def set_tag(tag, *values)
 		tag.upcase!
-		@selected_files.each { |file| @files[file].set_values(tag, *values) }
+		@selected_files.each { |file| file.set_values(tag, *values) }
+		self
 	end
 
 	# Tags the selected files with the specified values.
 	def add_tag(tag, *values)
 		tag.upcase!
-		@selected_files.each { |file| @files[file].add_values(tag, *values) }
+		@selected_files.each { |file| file.add_values(tag, *values) }
+		self
 	end
 
 	# Remove the specified values from the selected files.
@@ -116,45 +109,47 @@ class Library
 	# If no value is specified, the tag will be removed.
 	def rm_tag(tag, *values)
 		tag.upcase!
-		@selected_files.each { |file| @files[file].rm_values(tag, *values) }
+		@selected_files.each { |file| file.rm_values(tag, *values) }
+		self
 	end
 
 	# Return a list of the files in the library.
 	def ls
-		@files.keys.sort.each_with_index.map do |file, i|
-			{ file: file, position: i+1, selected: @selected_files.include?(file) }
+		@files.each_with_index.map do |file, i|
+			{ file: (@path.nil? ? file.path : file.path.relative_path_from(@path)).to_s, selected: @selected_files.include?(file) }
 		end
 	end
 
-	# Modify the list of selected files.
+	# Build a Set representing the selected files specified by the selectors.
 	#
 	# The available selector are:
 	# * "all": all files.
 	# * "3": the third file.
-	# * "5-7" the files 5, 6 and 7.
+	# * "5-7": the files 5, 6 and 7.
 	#
 	# The two last selector can be prefixed by "+" or "-" in order to add or remove items
 	# from the current selection. They are called cumulative selectors.
 	#
-	# You can specify several selectors, but non-cumulative selectors cannot be specified after a cumulative one.
-	def select(args)
-		all_files = @files.keys.sort
+	# Non-cumulative selectors cannot be specified after a cumulative one.
+	def build_selection(selectors)
+		return @selected_files if selectors.empty?
+
 		mode = :absolute
 
-		first_rel = !!(args.first =~ /^[+-]/)
+		first_rel = !!(selectors.first =~ /^[+-]/)
 
 		sel = first_rel ? Set.new(@selected_files) : Set.new
 
-		args.each do |selector|
+		selectors.each do |selector|
 			case selector
 			when 'all'
 				raise OggAlbumTagger::ArgumentError, "Cannot use the \"#{selector}\" selector after a cumulative selector (+/-...)" if mode == :cumulative
-				sel.replace all_files
+				sel.replace @files
 			when /^([+-]?)([1-9]\d*)$/
 				i = $2.to_i - 1
-				raise OggAlbumTagger::ArgumentError, "Item #{$2} is out of range" if i >= all_files.length
+				raise OggAlbumTagger::ArgumentError, "Item #{$2} is out of range" if i >= @files.size
 
-				items = [all_files.slice(i)]
+				items = [@files.slice(i)]
 				case $1
 				when '-'
 					sel.subtract items
@@ -169,9 +164,9 @@ class Library
 			when /^([+-]?)(?:([1-9]\d*)-([1-9]\d*))$/
 				i = $2.to_i - 1
 				j = $3.to_i - 1
-				raise OggAlbumTagger::ArgumentError, "Range #{$2}-#{$3} is invalid" if i >= all_files.length or j >= all_files.length or i > j
+				raise OggAlbumTagger::ArgumentError, "Range #{$2}-#{$3} is invalid" if i >= @files.size or j >= @files.size or i > j
 
-				items = all_files.slice(i..j)
+				items = @files.slice(i..j)
 				case $1
 				when '-'
 					sel.subtract items
@@ -188,25 +183,57 @@ class Library
 			end
 		end
 
-		@selected_files.replace sel
+		return sel
+	end
+
+	# Modify the list of selected files.
+	def select(args)
+		@selected_files.replace(build_selection(args))
+
+		return self
+	end
+
+	def with_selection(selectors)
+		begin
+			previous_selection = Set.new(@selected_files)
+			@selected_files = build_selection(selectors)
+			yield
+		ensure
+			@selected_files = previous_selection
+		end
+	end
+
+	def move(from, to)
+		raise ::IndexError, "Invalid from index #{from}" unless (0...@files.size).include?(from)
+		raise ::IndexError, "Invalid to index #{to}"     unless (0..@files.size).include?(to)
+
+		# Moving item N before item N does nothing
+		# Just like moving item N before item N+1
+		return if to == from or to == from + 1
+
+		item = @files.delete_at(from)
+		@files.insert(from < to ? to - 1 : to, item)
 	end
 
 	# Automatically set the TRACKNUMBER tag of the selected files based on their position in the selection.
 	def auto_tracknumber
-		@selected_files.sort.each_with_index do |file, i|
-			@files[file].set_values('TRACKNUMBER', (i+1).to_s)
-		end
+		i = 0
+		@files.each { |file|
+			next unless @selected_files.include? file
+			file.set_values('TRACKNUMBER', (i+1).to_s)
+			i += 1
+		}
 	end
 
 	# Test if a tag satisfy a predicate on each selected files.
 	def validate_tag(tag)
-		values = @selected_files.map { |file| @files[file][tag] }
+		values = @selected_files.map { |file| file[tag] }
 		values.reduce(true) { |r, v| r && yield(v) }
 	end
 
 	# Test if a tag is used at least one time in an ogg file.
 	def tag_used?(tag)
-		values = @selected_files.map { |file| @files[file][tag] }
+		values = @selected_files.map { |file| file[tag] }
 		values.reduce(false) { |r, v| r || v.size > 0 }
 	end
 
@@ -220,10 +247,10 @@ class Library
 		self.tag_used_k_times?(tag, 1)
 	end
 
-	# Test if a tag has multiple values in a single file.
+	# Test if at least one of the files has multiple values for the specified tag..
 	def tag_used_multiple_times?(tag)
-		values = @selected_files.map { |file| @files[file][tag] }
-		values.reduce(false) { |r, v| r || v.size > 1 }
+		values = @selected_files.map { |file| file[tag] }
+		values.reduce(false) { |r, v| r || (v.size > 1) }
 	end
 
 	# Test if a tag is absent from each selected files.
@@ -238,7 +265,7 @@ class Library
 
 	# Test if a tag has a single value and is uniq across all selected files.
 	def uniq_tag?(tag)
-		values = @selected_files.map { |file| @files[file][tag] }
+		values = @selected_files.map { |file| file[tag] }
 		values.reduce(true) { |r, v| r && (v.size == 1) } && (values.map { |v| v.first }.uniq.length == 1)
 	end
 
@@ -247,6 +274,7 @@ class Library
 		validate_tag(tag) { |v| (v.size == 0) || (v.first.to_s =~ /^[1-9][0-9]*$/) }
 	end
 
+	# TODO ISO 8601 compliance (http://www.cl.cam.ac.uk/~mgk25/iso-time.html)
 	def date_tag?(tag)
 		validate_tag(tag) { |v| (v.size == 0) || (v.first.to_s =~ /^\d\d\d\d$/) }
 	end
@@ -262,8 +290,9 @@ class Library
 	# * DISCNUMBER must be used at most one time per file.
 	# * TRACKNUMBER and DISCNUMBER must have numerical values.
 	def check
+		# Catch all the tags that cannot have multiple values.
 		%w{ARTIST TITLE DATE ALBUM ALBUMDATE ARTISTALBUM TRACKNUMBER DISCNUMBER}.each do |t|
-			raise OggAlbumTagger::MetadataError, "The #{t} tag cannot be used multiple times in a single track." if tag_used_multiple_times?(t)
+			raise OggAlbumTagger::MetadataError, "The #{t} tag must not appear more than once per track." if tag_used_multiple_times?(t)
 		end
 
 		%w{DISCNUMBER TRACKNUMBER}.each do |t|
@@ -282,17 +311,25 @@ class Library
 
 		return if @path.nil?
 
-		raise OggAlbumTagger::MetadataError, "The ALBUM tag must have a single and uniq value among all songs." unless uniq_tag?('ALBUM')
+		raise OggAlbumTagger::MetadataError, "The ALBUM tag must have a single and unique value among all songs." unless uniq_tag?('ALBUM')
+
+		unless uniq_tag?('DATE')
+			raise OggAlbumTagger::MetadataError, "The ALBUMDATE tag must have a single and uniq value among all songs." unless uniq_tag?('ALBUMDATE')
+		end
+
+		if @selected_files.size == 1
+			raise OggAlbumTagger::MetadataError, 'This album has only one track. The consistency of some tags cannot be verified.'
+		end
 
 		if uniq_tag?('ARTIST')
-			raise OggAlbumTagger::MetadataError, 'The ALBUMARTIST is only required for compilations.' if tag_used?('ALBUMARTIST')
+			if tag_used?('ALBUMARTIST')
+				raise OggAlbumTagger::MetadataError, 'The ALBUMARTIST is not required since all tracks have the same and unique ARTIST.'
+			end
 		else
 			if not uniq_tag?('ALBUMARTIST') or (first_value('ALBUMARTIST') != 'Various artists')
 				raise OggAlbumTagger::MetadataError, 'This album seems to be a compilation. The ALBUMARTIST tag should have the value "Various artists".'
 			end
 		end
-
-		raise OggAlbumTagger::MetadataError, "The ALBUMDATE tag must have a single and uniq value among all songs." if not uniq_tag?('DATE') and not uniq_tag?('ALBUMDATE')
 	end
 
 	# Auto rename the directory and the ogg files of the library.
@@ -314,15 +351,15 @@ class Library
 	# Ogg file:  ALBUM - ALBUMDATE - [DISCNUMBER.]TRACKNUMBER - ARTIST - TITLE - DATE
 	#
 	# Disc and track numbers are padded with zeros.
-	def auto_rename
+
+	def compute_rename_mapping
 		check()
 
 		mapping = {}
 
 		if @path.nil?
 			@selected_files.each do |file|
-				tags = @files[file]
-				mapping[file] = sprintf('%s - %s - %s.ogg', tags.first('ARTIST'), tags.first('DATE'), tags.first('TITLE'))
+				mapping[file] = sprintf('%s - %s - %s.ogg', file.first('ARTIST'), file.first('DATE'), file.first('TITLE'))
 			end
 		else
 			tn_maxlength = tag_summary('TRACKNUMBER').values.map { |v| v.first.to_s.length }.max
@@ -346,15 +383,13 @@ class Library
 
 			if uniq_tag?('ARTIST')
 				@selected_files.each do |file|
-					tags = @files[file]
-
-					common_tags = [tags.first('ARTIST'), album_date, tags.first('ALBUM'),
-					               format_number.call(tags), tags.first('TITLE')]
+					common_tags = [file.first('ARTIST'), album_date, file.first('ALBUM'),
+					               format_number.call(file), file.first('TITLE')]
 
 					mapping[file] = if uniq_tag?('DATE')
 						sprintf('%s - %s - %s - %s - %s.ogg', *common_tags)
 					else
-						sprintf('%s - %s - %s - %s - %s - %s.ogg', *common_tags, tags.first('DATE'))
+						sprintf('%s - %s - %s - %s - %s - %s.ogg', *common_tags, file.first('DATE'))
 					end
 				end
 
@@ -364,10 +399,9 @@ class Library
 				                   first_value('ALBUM'))
 			else
 				@selected_files.each do |file|
-					tags = @files[file]
-					mapping[file] = sprintf('%s - %s - %s - %s - %s.ogg',
-					                        tags.first('ALBUM'), album_date, format_number.call(tags),
-					                        tags.first('ARTIST'), tags.first('TITLE'), tags.first('DATE'))
+					mapping[file] = sprintf('%s - %s - %s - %s - %s - %s.ogg',
+					                        file.first('ALBUM'), album_date, format_number.call(file),
+					                        file.first('ARTIST'), file.first('TITLE'), file.first('DATE'))
 				end
 
 				albumdir = sprintf('%s - %s', first_value('ALBUM'), album_date)
@@ -380,39 +414,62 @@ class Library
 		mapping.each { |k, v| mapping[k] = v.gsub(/[\\\/:*?"<>|]/, '') }
 
 		if mapping.values.uniq.size != @selected_files.size
-			raise OggAlbumTagger::MetadataError, 'Generated filenames are not uniq.'
+			raise OggAlbumTagger::MetadataError, 'Generated filenames are not unique.'
 		end
 
-		# Renaming the album directory
-		unless @path.nil?
+		newpath = @path.nil? ? nil : (@path.dirname + albumdir)
+
+		return newpath, mapping
+	end
+
+	def short_path(file)
+		@path.nil? ? file : file.relative_path_from(@path)
+	end
+
+	def auto_rename
+		newpath, mapping = compute_rename_mapping
+
+		# Renaming the ogg files
+		Set.new(@selected_files).each do |file|
 			begin
-				newpath = @path.dirname + albumdir
-				if @path.expand_path != newpath.expand_path
-					FileUtils.mv(@path, newpath)
-					@path = newpath
+				oldfilepath = file.path
+				newfilepath = (@path.nil? ? oldfilepath.dirname : @path) + mapping[file]
+
+				# Don't rename anything if there's no change.
+				if oldfilepath != newfilepath
+					rename(oldfilepath, newfilepath)
+					file.path = newfilepath
 				end
-			rescue Exception => ex
-				raise OggAlbumTagger::SystemError, "Cannot rename \"#{@path}\" to \"#{newpath}\"."
+			rescue Exception
+				raise OggAlbumTagger::SystemError, "Cannot rename \"#{short_path(oldfilepath)}\" to \"#{short_path(newfilepath)}\"."
 			end
 		end
 
-		# Renaming the ogg files
-		Set.new(@selected_files).each do |file|
+		# Renaming the album directory
+		unless @path.nil?
+			oldpath = @path
+
 			begin
-				oldpath = fullpath(file)
-				newpath = (@path.nil? ? file.dirname : @path) + mapping[file]
-				newpath_rel = file.dirname + mapping[file]
-
-				if oldpath != newpath
-					FileUtils.mv(oldpath, newpath)
-					@files[newpath_rel] = @files.delete(file)
-					@selected_files.delete(file).add(newpath_rel)
+				# Don't rename anything if there's no change.
+				if @path != newpath
+					rename(@path, newpath)
+					@path = newpath
+
+					@files.each { |file|
+						newfilepath = newpath + file.path.relative_path_from(oldpath)
+
+						file.path = newfilepath
+					}
 				end
-			rescue Exception => ex
-				raise OggAlbumTagger::SystemError, "Cannot rename \"#{file}\" to \"#{mapping[file]}\"."
+			rescue Exception
+				raise OggAlbumTagger::SystemError, "Cannot rename \"#{oldpath}\" to \"#{newpath}\"."
 			end
 		end
 	end
+
+	def rename(oldpath, newpath)
+		FileUtils.mv(oldpath, newpath)
+	end
 end
 
 end