music_metadata_score 0.0.2 → 0.0.3

data/lib/music_metadata_score/title_case.rb

@@ -1,330 +1,332 @@
-class TitleCase
-	# Split string
-	# Capitalize all
-	# Find list of words
-	# If they're not first or last, or have a bracket on the beginning or end make em lower case
-	
-	def self.featuring_words
-		[
-			' Featuring',
-			'Feat ',
-			' Feat.',
-			' With '
-			
-		]
-	end
-	
-	def self.title_case(string)
-		if string.is_a?(String)
-			string = TitleCase.add_spacing_to_punctuation(string)
-			array = TitleCase.lower_case_array(TitleCase.titleize_array(TitleCase.split_string(string.downcase)))
-			new_string = TitleCase.capitalize_artist_the(array.join(' '))
-			return TitleCase.capitalize_anomalies(new_string)
-		else
-			""
+module MusicMetadataScore
+	class TitleCase
+		# Split string
+		# Capitalize all
+		# Find list of words
+		# If they're not first or last, or have a bracket on the beginning or end make em lower case
+		
+		def self.featuring_words
+			[
+				' Featuring',
+				'Feat ',
+				' Feat.',
+				' With '
+				
+			]
 		end
-	end
-	
-	# Add spaces after any punctuation if it doesn't already exist
-	def self.add_spacing_to_punctuation(string)
-		newstring = ""
-		string.split('').each_with_index do |letter, i|
-			newstring += ' ' if TitleCase.add_space_before?(string, letter, i)
-			newstring += letter
-			newstring += ' ' if TitleCase.add_space_after?(string, letter, i)
+		
+		def self.title_case(string)
+			if string.is_a?(String)
+				string = MusicMetadataScore::TitleCase.add_spacing_to_punctuation(string)
+				array = MusicMetadataScore::TitleCase.lower_case_array(MusicMetadataScore::TitleCase.titleize_array(MusicMetadataScore::TitleCase.split_string(string.downcase)))
+				new_string = MusicMetadataScore::TitleCase.capitalize_artist_the(array.join(' '))
+				return MusicMetadataScore::TitleCase.capitalize_anomalies(new_string)
+			else
+				""
+			end
 		end
-		return newstring
-	end
-	
-	def self.add_space_after?(string, letter, i)
-		if letter =~ /[,.)]/ && string[i + 1] != ' '
-			true
-		elsif letter == '"'
-			if string[i - 1] =~ /[[:alpha:]]/ && string[i + 1] != ' '
+		
+		# Add spaces after any punctuation if it doesn't already exist
+		def self.add_spacing_to_punctuation(string)
+			newstring = ""
+			string.split('').each_with_index do |letter, i|
+				newstring += ' ' if MusicMetadataScore::TitleCase.add_space_before?(string, letter, i)
+				newstring += letter
+				newstring += ' ' if MusicMetadataScore::TitleCase.add_space_after?(string, letter, i)
+			end
+			return newstring
+		end
+		
+		def self.add_space_after?(string, letter, i)
+			if letter =~ /[,.)]/ && string[i + 1] != ' '
 				true
+			elsif letter == '"'
+				if string[i - 1] =~ /[[:alpha:]]/ && string[i + 1] != ' '
+					true
+				end
+			else
+				false
 			end
-		else
-			false
 		end
-	end
-	
-	def self.add_space_before?(string, letter, i)
-		if letter =~ /[(]/ && string[i - 1] != ' '
-			true
-		else
-			false
+		
+		def self.add_space_before?(string, letter, i)
+			if letter =~ /[(]/ && string[i - 1] != ' '
+				true
+			else
+				false
+			end
 		end
-	end
-	
-	# String to Array
-	def self.split_string(string)
-		if string && string.is_a?(String)
-			string.split(' ')
-		else
-			[]
+		
+		# String to Array
+		def self.split_string(string)
+			if string && string.is_a?(String)
+				string.split(' ')
+			else
+				[]
+			end
 		end
-	end
-	
-	# Capitalize all first letters
-	def self.titleize_array(array)
-		array.each do |a|
-			a = TitleCase.titleize(a)
+		
+		# Capitalize all first letters
+		def self.titleize_array(array)
+			array.each do |a|
+				a = MusicMetadataScore::TitleCase.titleize(a)
+			end
+			return array
 		end
-		return array
-	end
-	
-	def self.titleize(string)
-		if string[0] =~ /[[:alpha:]]/
-			string.capitalize!
-		elsif string.length > 1 && !string.include?('feat.')
-			string[1] = string[1].capitalize
+		
+		def self.titleize(string)
+			if string[0] =~ /[[:alpha:]]/
+				string.capitalize!
+			elsif string.length > 1 && !string.include?('feat.')
+				string[1] = string[1].capitalize
+			end
+			return string
 		end
-		return string
-	end
-	
-	# Pick words for lower case
-	def self.lower_case_array(array)
-		array.each do |a|
-			if a != array.first && a != array.last
-				a = TitleCase.lower_case_string(a)
+		
+		# Pick words for lower case
+		def self.lower_case_array(array)
+			array.each do |a|
+				if a != array.first && a != array.last
+					a = MusicMetadataScore::TitleCase.lower_case_string(a)
+				end
 			end
+			return array
 		end
-		return array
-	end
-	
-	def self.lower_case_string(string)
-		#a, an, and, as, at, but, by, for, from, in, into, nor, of, off, on, onto, or, out, over, so, the, to, up, with and yet
-		words = ["a", "an", "and", "as", "at", "but", "by", "for", "from", "in", "into", "nor", "of", "off", "on", "onto", "or", "out", "over", "so", "the", "to", "up", "with", "yet"] 		
-		if words.include?(string.downcase)
-			string.downcase!
-		else
-			string
+		
+		def self.lower_case_string(string)
+			#a, an, and, as, at, but, by, for, from, in, into, nor, of, off, on, onto, or, out, over, so, the, to, up, with and yet
+			words = ["a", "an", "and", "as", "at", "but", "by", "for", "from", "in", "into", "nor", "of", "off", "on", "onto", "or", "out", "over", "so", "the", "to", "up", "with", "yet"] 		
+			if words.include?(string.downcase)
+				string.downcase!
+			else
+				string
+			end
 		end
-	end
-	
-	# Includes Featuring Artistst
-	def self.is_proper_title_format?(title, primary_artists, featuring_artists)
-		if MusicMetadataScore.is_title_case?(title) && TitleCase.includes_proper_featuring_artists?(title, featuring_artists) && !TitleCase.includes_version?(title) && !TitleCase.improper_abbreviations?(title)
-			true
-		else
-			false
+		
+		# Includes Featuring artistst
+		def self.is_proper_title_format?(title, primary_artists, featuring_artists)
+			if MusicMetadataScore.is_title_case?(title) && MusicMetadataScore::TitleCase.includes_proper_featuring_artists?(title, featuring_artists) && !MusicMetadataScore::TitleCase.includes_version?(title) && !MusicMetadataScore::TitleCase.improper_abbreviations?(title)
+				true
+			else
+				false
+			end
 		end
-	end
-	
-	def self.includes_proper_featuring_artists?(title, featuring_artists)
-		count = featuring_artists.count rescue 0
-		if count > 0
-			TitleCase.is_proper_featuring_artists?(title, featuring_artists)
-		else
-			true
+		
+		def self.includes_proper_featuring_artists?(title, featuring_artists)
+			count = featuring_artists.count rescue 0
+			if count > 0
+				MusicMetadataScore::TitleCase.is_proper_featuring_artists?(title, featuring_artists)
+			else
+				true
+			end
 		end
-	end
-	
-	def self.includes_featuring_artists?(title, featuring_artists)
-		value = false
-		featuring_artists.each do |a|
-			if title.include?(a)
-				value = true
-				break
+		
+		def self.includes_featuring_artists?(title, featuring_artists)
+			value = false
+			featuring_artists.each do |a|
+				if title.include?(a)
+					value = true
+					break
+				end
 			end
+			value
 		end
-		value
-	end
-	
-	def self.is_proper_featuring_artists?(title, featuring_artists)
-		if title.include?(TitleCase.featuring_artists_string(featuring_artists, "feat.")) || title.include?(TitleCase.featuring_artists_string(featuring_artists, "with")) || title.include?(TitleCase.featuring_artists_string(featuring_artists, "vs.")) || title.include?(TitleCase.featuring_artists_string(featuring_artists, "Meets"))
-			true
-		else
-			false
+		
+		def self.is_proper_featuring_artists?(title, featuring_artists)
+			if title.include?(MusicMetadataScore::TitleCase.featuring_artists_string(featuring_artists, "feat.")) || title.include?(MusicMetadataScore::TitleCase.featuring_artists_string(featuring_artists, "with")) || title.include?(MusicMetadataScore::TitleCase.featuring_artists_string(featuring_artists, "vs.")) || title.include?(MusicMetadataScore::TitleCase.featuring_artists_string(featuring_artists, "Meets"))
+				true
+			else
+				false
+			end
 		end
-	end
-	
-	def self.featuring_artists_string(featuring_artists, type)
-		string = ""
-		if featuring_artists.count > 0
-			string = " (#{type} " if type != 'vs.'
-			string = TitleCase.add_artists_to_string(string, featuring_artists, type)
-			string += ")"
+		
+		def self.featuring_artists_string(featuring_artists, type)
+			string = ""
+			if featuring_artists.count > 0
+				string = " (#{type} " if type != 'vs.'
+				string = MusicMetadataScore::TitleCase.add_artists_to_string(string, featuring_artists, type)
+				string += ")"
+			end
+			return string
 		end
-		return string
-	end
-	
-	def self.add_artists_to_string(string, featuring_artists, type)
-		featuring_artists.each do |a|
-			string += a
-			string += TitleCase.featuring_artists_join(featuring_artists, a, type)
+		
+		def self.add_artists_to_string(string, featuring_artists, type)
+			featuring_artists.each do |a|
+				string += a
+				string += MusicMetadataScore::TitleCase.featuring_artists_join(featuring_artists, a, type)
+			end
+			return string
 		end
-		return string
-	end
-	
-	def self.featuring_artists_join(featuring_artists, a, type)
-		if featuring_artists.count == 1 || a == featuring_artists.last
-			""
-		elsif featuring_artists.index(a) == featuring_artists.count - 2 && type != "vs."
-			" & "
-		elsif type == "vs."
-			" vs. "
-		elsif type == "Meets"
-			" Meets "
-		else
-			", "
+		
+		def self.featuring_artists_join(featuring_artists, a, type)
+			if featuring_artists.count == 1 || a == featuring_artists.last
+				""
+			elsif featuring_artists.index(a) == featuring_artists.count - 2 && type != "vs."
+				" & "
+			elsif type == "vs."
+				" vs. "
+			elsif type == "Meets"
+				" Meets "
+			else
+				", "
+			end
 		end
-	end
-	
-	def self.combined_artists(primary_artists, featuring_artists)
-		featuring_artists.each do |a|
-			primary_artists << a
+		
+		def self.combined_artists(primary_artists, featuring_artists)
+			featuring_artists.each do |a|
+				primary_artists << a
+			end
+			primary_artists
 		end
-		primary_artists
-	end
-	
-	# Includes a Version
-	def self.includes_version?(title)
-		if title.downcase.include?('version') || title.downcase.include?('edition') || title.downcase.include?('issue') || title.downcase.include?('print') || title.downcase.include?('anniversary')
-			true
-		else
-			false
+		
+		# Includes a Version
+		def self.includes_version?(title)
+			if title.downcase.include?('version') || title.downcase.include?('edition') || title.downcase.include?('issue') || title.downcase.include?('print') || title.downcase.include?('anniversary') || title.downcase.include?('remix')
+				true
+			else
+				false
+			end
 		end
-	end
-	
-	# Check for abbreviations
-	def self.improper_abbreviations?(title)
-		# TODO find pt. and vol. not formatted properly
-		if title.downcase.include?(' part') || title.downcase.include?(' volume') || title.downcase.include?(' number') || title.downcase.include?(' aka') || title.downcase.include?(' d.j') || title.downcase.include?(' num')
-			true
-		else
-			false
+		
+		# Check for abbreviations
+		def self.improper_abbreviations?(title)
+			# TODO find pt. and vol. not formatted properly
+			if title.downcase.include?(' part') || title.downcase.include?(' volume') || title.downcase.include?(' number') || title.downcase.include?(' aka') || title.downcase.include?(' d.j') || title.downcase.include?(' num')
+				true
+			else
+				false
+			end
 		end
-	end
-	
-	def self.replace_improper_abbreviations(title)
-		title.gsub!(" part", " Pt.")
-		title.gsub!(" volume", " Vol.")
-		title.gsub!(" number", " No.")
-		title.gsub!(" no ", " No. ")
-		title.gsub!(" num ", " No. ")
-		title.gsub!(" d.j", " DJ")
-		title.gsub!(" d.j.", " DJ")
-		title.gsub!(" aka", " a.k.a")
-		title.gsub!(" AKA", " a.k.a")
-		title.gsub!("featuring", "feat.")
-		title.gsub!("(feat ", "(feat. ")
-		title.gsub!(" feat ", " feat. ")
-		title.gsub!(" vs ", " Vs. ")
-		title.gsub!(" VS ", " Vs. ")
-		
-		return title
-	end
-	
-	# Capitalize The's in Artist Names
-	def self.capitalize_artist_the(title)
-		if title[0] != '(' && title.include?('(')
-			split_title = title.split('(')
-			inside_bracket = split_title[1].split(')')
-			new_inside_bracket = inside_bracket[0].gsub('the', 'The')
-			string = split_title[0] + "(" + new_inside_bracket + ")"
-			string += inside_bracket[1] if inside_bracket[1]
-			return string
-		else
+		
+		def self.replace_improper_abbreviations(title)
+			title.gsub!(" part", " Pt.")
+			title.gsub!(" volume", " Vol.")
+			title.gsub!(" number", " No.")
+			title.gsub!(" no ", " No. ")
+			title.gsub!(" num ", " No. ")
+			title.gsub!(" d.j", " DJ")
+			title.gsub!(" d.j.", " DJ")
+			title.gsub!(" aka", " a.k.a")
+			title.gsub!(" AKA", " a.k.a")
+			title.gsub!("featuring", "feat.")
+			title.gsub!("(feat ", "(feat. ")
+			title.gsub!(" feat ", " feat. ")
+			title.gsub!(" vs ", " Vs. ")
+			title.gsub!(" VS ", " Vs. ")
+			
 			return title
 		end
-	end
-	
-	# Capitalize any anomalies, like DJ
-	def self.capitalize_anomalies(title)
-		title.gsub('Dj ', 'DJ ')
-	end
-	
-	# Get Value Inside Brackets
-	def self.get_inside_brackets(string)
-		if string.include?('(') && string.include?(')')
-			split_string = string.split('(')
-			array = []
-			split_string.each do |s|
-				stripped = s.strip
-				if stripped[stripped.length - 1] == ')'
-					array << stripped[0..stripped.length - 2]
+		
+		# Capitalize The's in MusicMetadataScore::Artist Names
+		def self.capitalize_artist_the(title)
+			if title[0] != '(' && title.include?('(')
+				split_title = title.split('(')
+				inside_bracket = split_title[1].split(')')
+				new_inside_bracket = inside_bracket[0].gsub('the', 'The')
+				string = split_title[0] + "(" + new_inside_bracket + ")"
+				string += inside_bracket[1] if inside_bracket[1]
+				return string
+			else
+				return title
+			end
+		end
+		
+		# Capitalize any anomalies, like DJ
+		def self.capitalize_anomalies(title)
+			title.gsub('Dj ', 'DJ ')
+		end
+		
+		# Get Value Inside Brackets
+		def self.get_inside_brackets(string)
+			if string.include?('(') && string.include?(')')
+				split_string = string.split('(')
+				array = []
+				split_string.each do |s|
+					stripped = s.strip
+					if stripped[stripped.length - 1] == ')'
+						array << stripped[0..stripped.length - 2]
+					end
 				end
+				array
 			end
-			array
 		end
-	end
-	
-	# Build proper title
-	def self.build_proper_title(title, version, primary_artists, featuring_artists)
-		# Title Case
-		title = TitleCase.title_case(title)
-		# find any versions
-		split_out_version = TitleCase.strip_version_from_title(title, version)
-		# reformat featuring artists
-		title = TitleCase.strip_artists_from_title(split_out_version[:title], primary_artists, featuring_artists)
-		title += TitleCase.featuring_artists_string(featuring_artists, "feat.")
-		# replace abbreviations
-		return {:title => title, :version => split_out_version[:version]}
-	end
-	
-	def self.strip_version_from_title(title, version)
-		inside_brackets = TitleCase.get_inside_brackets(title)
-		#version = nil
-		if inside_brackets
-			inside_brackets.each do |b|
-				if TitleCase.includes_version?(b)
-					title.gsub!(" (#{b})", "")
-					version = b.strip
+		
+		# Build proper title
+		def self.build_proper_title(title, version, primary_artists, featuring_artists)
+			# Title Case
+			title = MusicMetadataScore::TitleCase.title_case(title)
+			# find any versions
+			split_out_version = MusicMetadataScore::TitleCase.strip_version_from_title(title, version)
+			# reformat featuring artists
+			title = MusicMetadataScore::TitleCase.strip_artists_from_title(split_out_version[:title], primary_artists, featuring_artists)
+			title += MusicMetadataScore::TitleCase.featuring_artists_string(featuring_artists, "feat.")
+			# replace abbreviations
+			return {:title => title, :version => split_out_version[:version]}
+		end
+		
+		def self.strip_version_from_title(title, version)
+			inside_brackets = MusicMetadataScore::TitleCase.get_inside_brackets(title)
+			#version = nil
+			if inside_brackets
+				inside_brackets.each do |b|
+					if MusicMetadataScore::TitleCase.includes_version?(b)
+						title.gsub!(" (#{b})", "")
+						version = b.strip
+					end
 				end
 			end
+			return {
+				:title => title.strip,
+				:version => version
+			}
 		end
-		return {
-			:title => title.strip,
-			:version => version
-		}
-	end
-	
-	def self.strip_artists_from_title(title, primary_artists, featuring_artists)
-		title = TitleCase.strip_artists_in_brackets_from_title(title, primary_artists, featuring_artists)
-		title = TitleCase.strip_artists_from_outside_brackets_from_title(title, primary_artists, featuring_artists)
-		title
-	end
-	
-	def self.strip_artists_in_brackets_from_title(title, primary_artists, featuring_artists)
-		inside_brackets = TitleCase.get_inside_brackets(title)
-		if inside_brackets
-			inside_brackets.each do |b|
-				if TitleCase.includes_featuring_artists?(b, featuring_artists)
-					title.gsub!(" (#{b})", "")
+		
+		def self.strip_artists_from_title(title, primary_artists, featuring_artists)
+			title = MusicMetadataScore::TitleCase.strip_artists_in_brackets_from_title(title, primary_artists, featuring_artists)
+			title = MusicMetadataScore::TitleCase.strip_artists_from_outside_brackets_from_title(title, primary_artists, featuring_artists)
+			title
+		end
+		
+		def self.strip_artists_in_brackets_from_title(title, primary_artists, featuring_artists)
+			inside_brackets = MusicMetadataScore::TitleCase.get_inside_brackets(title)
+			if inside_brackets
+				inside_brackets.each do |b|
+					if MusicMetadataScore::TitleCase.includes_featuring_artists?(b, featuring_artists)
+						title.gsub!(" (#{b})", "")
+					end
 				end
 			end
+			title
 		end
-		title
-	end
-	
-	def self.strip_artists_from_outside_brackets_from_title(title, primary_artists, featuring_artists)
-		title = TitleCase.remove_artist_names_from_title(title, TitleCase.combined_artists(primary_artists, featuring_artists))
-		TitleCase.strip_featuring_words_from_title(title)
-	end
-	
-	def self.remove_artist_names_from_title(title, artists)
-		artists.each do |a|
-			if title.include?(" #{a} &")
-				title.gsub!(" #{a} &", "")
-			elsif title.include?(" #{a} and")
-				title.gsub!(" #{a} and", "")
-			elsif title.include?(" #{a} And")
-				title.gsub!(" #{a} And", "")
-			elsif title.include?(" #{a},")
-				title.gsub!(" #{a},", "")
-			else
-				title.gsub!(" #{a}", "")
+		
+		def self.strip_artists_from_outside_brackets_from_title(title, primary_artists, featuring_artists)
+			title = MusicMetadataScore::TitleCase.remove_artist_names_from_title(title, MusicMetadataScore::TitleCase.combined_artists(primary_artists, featuring_artists))
+			MusicMetadataScore::TitleCase.strip_featuring_words_from_title(title)
+		end
+		
+		def self.remove_artist_names_from_title(title, artists)
+			artists.each do |a|
+				if title.include?(" #{a} &")
+					title.gsub!(" #{a} &", "")
+				elsif title.include?(" #{a} and")
+					title.gsub!(" #{a} and", "")
+				elsif title.include?(" #{a} And")
+					title.gsub!(" #{a} And", "")
+				elsif title.include?(" #{a},")
+					title.gsub!(" #{a},", "")
+				else
+					title.gsub!(" #{a}", "")
+				end
 			end
+			title
 		end
-		title
-	end
-	
-	def self.strip_featuring_words_from_title(title)
-		TitleCase.featuring_words.each do |w|
-			title.gsub!(" #{w.strip}", "")
+		
+		def self.strip_featuring_words_from_title(title)
+			MusicMetadataScore::TitleCase.featuring_words.each do |w|
+				title.gsub!(" #{w.strip}", "")
+			end
+			title
 		end
-		title
+		
 	end
-	
 end

data/lib/music_metadata_score/version.rb

@@ -1,3 +1,3 @@
 module MusicMetadataScore
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end