music_metadata_score 0.0.2 → 0.0.3

data/lib/music_metadata_score/publisher.rb

@@ -1,30 +1,32 @@
-class Publisher
-	
-	def self.are_proper_format?(publishers)
-		if publishers && publishers != []
-			Publisher.loop_publishers(publishers)
-		else
-			false
+module MusicMetadataScore
+	class Publisher
+		
+		def self.are_proper_format?(publishers)
+			if publishers && publishers != []
+				MusicMetadataScore::Publisher.loop_publishers(publishers)
+			else
+				false
+			end
 		end
-	end
-	
-	def self.loop_publishers(publishers)
-		value = true
-		publishers.each do |c|
-			if !Publisher.is_proper_format?(c)
-				value = false
-				break
+		
+		def self.loop_publishers(publishers)
+			value = true
+			publishers.each do |c|
+				if !MusicMetadataScore::Publisher.is_proper_format?(c)
+					value = false
+					break
+				end
 			end
+			value
 		end
-		value
-	end
-	
-	def self.is_proper_format?(publisher)
-		if publisher && publisher != ""
-			true
-		else
-			false
+		
+		def self.is_proper_format?(publisher)
+			if publisher && publisher != ""
+				true
+			else
+				false
+			end
 		end
+		
 	end
-	
 end

data/lib/music_metadata_score/score.rb

@@ -1,245 +1,249 @@
-class Score
-	
-	# Product level scores
-	def self.product_score(metadata)
-		score = Score.product_fields_exist(metadata) + Score.product_fields_quality(metadata)
-		percent = score.to_f / 87 * 100
-		return percent.round(1)
-	end
-	
-	def self.product_fields_exist(metadata)
-		score = 0
-		score += 2 if !Score.object_is_blank?(metadata[:title])
-		score += 2 if !Score.object_is_blank?(metadata[:cat_no])
-		score += 2 if !Score.object_is_blank?(metadata[:barcode])
-		score += 2 if !Score.object_is_blank?(metadata[:label])
-		score += 2 if !Score.object_is_blank?(metadata[:primary_artists])
-		score += 2 if !Score.object_is_blank?(metadata[:release_date])
-		score += 1 if !Score.object_is_blank?(metadata[:original_release_date])
-		score += 2 if !Score.object_is_blank?(metadata[:p_year])
-		score += 2 if !Score.object_is_blank?(metadata[:p_line])
-		score += 2 if !Score.object_is_blank?(metadata[:c_year])
-		score += 2 if !Score.object_is_blank?(metadata[:c_line])
-		score += 2 if !Score.object_is_blank?(metadata[:parental_advisory])
-		score += 1 if !Score.object_is_blank?(metadata[:live])
-		score += 1 if !Score.object_is_blank?(metadata[:remastered])
-		score += 2 if !Score.object_is_blank?(metadata[:type])
-		score += 2 if !Score.object_is_blank?(metadata[:media])
-		score += 2 if !Score.object_is_blank?(metadata[:format])
-		score += 2 if !Score.object_is_blank?(metadata[:primary_genre])
-		score += 1 if !Score.object_is_blank?(metadata[:secondary_genre])
-		score += 1 if !Score.object_is_blank?(metadata[:description])
-		return score
-	end
-	
-	def self.product_fields_quality(metadata)
-		score = 0
-		score += 10 if TitleCase.is_proper_title_format?(metadata[:title], metadata[:primary_artists], metadata[:featuring_artists])
-		score += 10 if MusicMetadataScore.is_title_case?(metadata[:version])
-		score += 5 if MusicMetadataScore.valid_barcode?(metadata[:barcode])
-		score += 2 if MusicMetadataScore.is_title_case?(metadata[:label])
-		score += 5 if MusicMetadataScore.is_title_case?(metadata[:p_line])
-		score += 5 if MusicMetadataScore.is_title_case?(metadata[:c_line])
-		score += 10 if Artist.are_proper_artist_format?(metadata[:primary_artists], false, :product)
-		score += 5 if Artist.are_proper_artist_format?(metadata[:featuring_artists], false, :product)
-		return score
-	end
-	
-	def self.product_fields_corrected(metadata)
-		titles = TitleCase.build_proper_title(metadata[:title], metadata[:version], metadata[:primary_artists], metadata[:featuring_artists])
-		{
-			:title => titles[:title],
-			:version => titles[:version],
-			:cat_no => metadata[:cat_no].upcase,
-			:barcode => Barcode.valid_barcode_or_nil(metadata[:barcode]),
-			:label => TitleCase.title_case(metadata[:label]),
-			:primary_artists => Artist.format_artists(metadata[:primary_artists], false, :product),
-			:featuring_artists => Artist.format_artists(metadata[:featuring_artists], false, :product),
-			:release_date => metadata[:release_date],
-			:original_release_date => metadata[:original_release_date],
-			:p_year => metadata[:p_year],
-			:p_line => TitleCase.title_case(metadata[:p_line]),
-			:c_year => metadata[:c_year],
-			:c_line => TitleCase.title_case(metadata[:c_line]),
-			:parental_advisory => metadata[:parental_advisory],
-			:live => metadata[:live],
-			:remastered => metadata[:remastered],
-			:type => metadata[:type],
-			:media => metadata[:media],
-			:format => metadata[:format],
-			:primary_genre => TitleCase.title_case(metadata[:primary_genre]),
-			:secondary_genre => TitleCase.title_case(metadata[:secondary_genre]),
-			:description => metadata[:description]
-		}
-	end
-	
-	# Track level scores
-	def self.track_score(metadata)
-		score = Score.track_fields_exist(metadata) + Score.track_fields_quality(metadata)
-		percent = score.to_f / 107 * 100
-		return percent.round(1)
-	end
-	
-	def self.track_fields_exist(metadata)
-		score = 0
-		score += 2 if !Score.object_is_blank?(metadata[:title])
-		score += 2 if !Score.object_is_blank?(metadata[:isrc])
-		score += 2 if !Score.object_is_blank?(metadata[:primary_artists])
-		score += 2 if !Score.object_is_blank?(metadata[:p_year])
-		score += 2 if !Score.object_is_blank?(metadata[:p_line])
-		score += 2 if !Score.object_is_blank?(metadata[:parental_advisory])
-		score += 2 if !Score.object_is_blank?(metadata[:primary_genre])
-		score += 2 if !Score.object_is_blank?(metadata[:secondary_genre])
-		score += 2 if !Score.object_is_blank?(metadata[:recording_year])
-		score += 2 if !Score.object_is_blank?(metadata[:recording_country])
-		score += 2 if !Score.object_is_blank?(metadata[:recording_location])
-		score += 2 if !Score.object_is_blank?(metadata[:country_of_commission])
-		score += 2 if !Score.object_is_blank?(metadata[:rights_holder])
-		score += 2 if !Score.object_is_blank?(metadata[:contributors])
-		score += 2 if !Score.object_is_blank?(metadata[:composers])
-		score += 2 if !Score.object_is_blank?(metadata[:publishers])
-		return score
-	end
-	
-	def self.track_fields_quality(metadata)
-		score = 0
-		score += 10 if TitleCase.is_proper_title_format?(metadata[:title], metadata[:primary_artists], metadata[:featuring_artists])
-		score += 10 if MusicMetadataScore.is_title_case?(metadata[:version])
-		score += 5 if MusicMetadataScore.valid_isrc?(metadata[:isrc])
-		score += 5 if MusicMetadataScore.is_title_case?(metadata[:p_line])
-		score += 10 if Artist.are_proper_artist_format?(metadata[:primary_artists], false, :product)
-		score += 5 if Artist.are_proper_artist_format?(metadata[:featuring_artists], false, :product)
-		score += 10 if Contributor.are_proper_format?(metadata[:contributors])
-		score += 10 if Composer.are_proper_format?(metadata[:composers])
-		score += 10 if Publisher.are_proper_format?(metadata[:publishers])
-		return score
-	end
-	
-	def self.track_fields_corrected(metadata)
-		titles = TitleCase.build_proper_title(metadata[:title], metadata[:version], metadata[:primary_artists], metadata[:featuring_artists])
-		{
-			:title => titles[:title],
-			:version => titles[:version],
-			:isrc => Isrc.valid_isrc_or_nil(metadata[:isrc]),
-			:primary_artists => Artist.format_artists(metadata[:primary_artists], false, :track),
-			:featuring_artists => Artist.format_artists(metadata[:featuring_artists], false, :track),
-			:p_year => metadata[:p_year],
-			:p_line => TitleCase.title_case(metadata[:p_line]),
-			:parental_advisory => metadata[:parental_advisory],
-			:primary_genre => TitleCase.title_case(metadata[:primary_genre]),
-			:secondary_genre => TitleCase.title_case(metadata[:secondary_genre]),
-			:recording_year => metadata[:recording_year],
-			:recording_country => metadata[:recording_country],
-			:recording_location => metadata[:recording_location],
-			:country_of_commission => metadata[:country_of_commission],
-			:rights_holder => metadata[:rights_holder],
-			:contributors => metadata[:contributors],
-			:composers => metadata[:composers],
-			:publishers => metadata[:publishers]
-		}
-	end
-	
-	def self.object_is_blank?(value)
-		if value != nil && value != "" && value != [] && value != {}
-			false
-		else
-			true
+module MusicMetadataScore
+	class Score
+		
+		# Product level scores
+		def self.product_score(metadata)
+			score = MusicMetadataScore::Score.product_fields_exist(metadata) + MusicMetadataScore::Score.product_fields_quality(metadata)
+			percent = score.to_f / 87 * 100
+			return percent.round(1)
 		end
-	end
-	
-	# Total Product Score
-	def self.total_product_score(metadata)
-		product_score = Score.product_score(metadata[:product])
-		tracks_score = Score.tracks_score(metadata[:tracks])
-		final_score = (product_score + tracks_score) / (metadata[:tracks].count + 1)
-		return final_score.round(1)
-	end
-	
-	def self.tracks_score(tracks)
-		tracks_score = 0
-		if tracks
-			tracks.each do |t|
-				tracks_score += Score.track_score(t)
+		
+		def self.product_fields_exist(metadata)
+			score = 0
+			score += 2 if !MusicMetadataScore::Score.object_is_blank?(metadata[:title])
+			score += 2 if !MusicMetadataScore::Score.object_is_blank?(metadata[:cat_no])
+			score += 2 if !MusicMetadataScore::Score.object_is_blank?(metadata[:barcode])
+			score += 2 if !MusicMetadataScore::Score.object_is_blank?(metadata[:label])
+			score += 2 if !MusicMetadataScore::Score.object_is_blank?(metadata[:primary_artists])
+			score += 2 if !MusicMetadataScore::Score.object_is_blank?(metadata[:release_date])
+			score += 1 if !MusicMetadataScore::Score.object_is_blank?(metadata[:original_release_date])
+			score += 2 if !MusicMetadataScore::Score.object_is_blank?(metadata[:p_year])
+			score += 2 if !MusicMetadataScore::Score.object_is_blank?(metadata[:p_line])
+			score += 2 if !MusicMetadataScore::Score.object_is_blank?(metadata[:c_year])
+			score += 2 if !MusicMetadataScore::Score.object_is_blank?(metadata[:c_line])
+			score += 2 if !MusicMetadataScore::Score.object_is_blank?(metadata[:parental_advisory])
+			score += 1 if !MusicMetadataScore::Score.object_is_blank?(metadata[:live])
+			score += 1 if !MusicMetadataScore::Score.object_is_blank?(metadata[:remastered])
+			score += 2 if !MusicMetadataScore::Score.object_is_blank?(metadata[:type])
+			score += 2 if !MusicMetadataScore::Score.object_is_blank?(metadata[:media])
+			score += 2 if !MusicMetadataScore::Score.object_is_blank?(metadata[:format])
+			score += 2 if !MusicMetadataScore::Score.object_is_blank?(metadata[:primary_genre])
+			score += 1 if !MusicMetadataScore::Score.object_is_blank?(metadata[:secondary_genre])
+			score += 1 if !MusicMetadataScore::Score.object_is_blank?(metadata[:description])
+			return score
+		end
+		
+		def self.product_fields_quality(metadata)
+			score = 0
+			score += 10 if MusicMetadataScore::TitleCase.is_proper_title_format?(metadata[:title], metadata[:primary_artists], metadata[:featuring_artists])
+			score += 10 if MusicMetadataScore.is_title_case?(metadata[:version])
+			score += 5 if MusicMetadataScore.valid_barcode?(metadata[:barcode])
+			score += 2 if MusicMetadataScore.is_title_case?(metadata[:label])
+			score += 5 if MusicMetadataScore.is_title_case?(metadata[:p_line])
+			score += 5 if MusicMetadataScore.is_title_case?(metadata[:c_line])
+			score += 10 if MusicMetadataScore::Artist.are_proper_artist_format?(metadata[:primary_artists], false, :product)
+			score += 5 if MusicMetadataScore::Artist.are_proper_artist_format?(metadata[:featuring_artists], false, :product)
+			return score
+		end
+		
+		def self.product_fields_corrected(metadata)
+			titles = MusicMetadataScore::TitleCase.build_proper_title(metadata[:title], metadata[:version], metadata[:primary_artists], metadata[:featuring_artists])
+			{
+				:title => titles[:title],
+				:version => titles[:version],
+				:cat_no => metadata[:cat_no].upcase,
+				:barcode => MusicMetadataScore::Barcode.valid_barcode_or_nil(metadata[:barcode]),
+				:label => MusicMetadataScore::TitleCase.title_case(metadata[:label]),
+				:primary_artists => MusicMetadataScore::Artist.format_artists(metadata[:primary_artists], false, :product),
+				:featuring_artists => MusicMetadataScore::Artist.format_artists(metadata[:featuring_artists], false, :product),
+				:release_date => metadata[:release_date],
+				:original_release_date => metadata[:original_release_date],
+				:p_year => metadata[:p_year],
+				:p_line => MusicMetadataScore::TitleCase.title_case(metadata[:p_line]),
+				:c_year => metadata[:c_year],
+				:c_line => MusicMetadataScore::TitleCase.title_case(metadata[:c_line]),
+				:parental_advisory => metadata[:parental_advisory],
+				:live => metadata[:live],
+				:remastered => metadata[:remastered],
+				:type => metadata[:type],
+				:media => metadata[:media],
+				:format => metadata[:format],
+				:primary_genre => MusicMetadataScore::TitleCase.title_case(metadata[:primary_genre]),
+				:secondary_genre => MusicMetadataScore::TitleCase.title_case(metadata[:secondary_genre]),
+				:description => metadata[:description]
+			}
+		end
+		
+		# Track level scores
+		def self.track_score(metadata)
+			score = MusicMetadataScore::Score.track_fields_exist(metadata) + MusicMetadataScore::Score.track_fields_quality(metadata)
+			percent = score.to_f / 107 * 100
+			return percent.round(1)
+		end
+		
+		def self.track_fields_exist(metadata)
+			score = 0
+			score += 2 if !MusicMetadataScore::Score.object_is_blank?(metadata[:title])
+			score += 2 if !MusicMetadataScore::Score.object_is_blank?(metadata[:isrc])
+			score += 2 if !MusicMetadataScore::Score.object_is_blank?(metadata[:primary_artists])
+			score += 2 if !MusicMetadataScore::Score.object_is_blank?(metadata[:p_year])
+			score += 2 if !MusicMetadataScore::Score.object_is_blank?(metadata[:p_line])
+			score += 2 if !MusicMetadataScore::Score.object_is_blank?(metadata[:parental_advisory])
+			score += 2 if !MusicMetadataScore::Score.object_is_blank?(metadata[:primary_genre])
+			score += 2 if !MusicMetadataScore::Score.object_is_blank?(metadata[:secondary_genre])
+			score += 2 if !MusicMetadataScore::Score.object_is_blank?(metadata[:recording_year])
+			score += 2 if !MusicMetadataScore::Score.object_is_blank?(metadata[:recording_country])
+			score += 2 if !MusicMetadataScore::Score.object_is_blank?(metadata[:recording_location])
+			score += 2 if !MusicMetadataScore::Score.object_is_blank?(metadata[:country_of_commission])
+			score += 2 if !MusicMetadataScore::Score.object_is_blank?(metadata[:rights_holder])
+			score += 2 if !MusicMetadataScore::Score.object_is_blank?(metadata[:contributors])
+			score += 2 if !MusicMetadataScore::Score.object_is_blank?(metadata[:composers])
+			score += 2 if !MusicMetadataScore::Score.object_is_blank?(metadata[:publishers])
+			return score
+		end
+		
+		def self.track_fields_quality(metadata)
+			score = 0
+			score += 10 if MusicMetadataScore::TitleCase.is_proper_title_format?(metadata[:title], metadata[:primary_artists], metadata[:featuring_artists])
+			score += 10 if MusicMetadataScore.is_title_case?(metadata[:version])
+			score += 5 if MusicMetadataScore.valid_isrc?(metadata[:isrc])
+			score += 5 if MusicMetadataScore.is_title_case?(metadata[:p_line])
+			score += 10 if MusicMetadataScore::Artist.are_proper_artist_format?(metadata[:primary_artists], false, :product)
+			score += 5 if MusicMetadataScore::Artist.are_proper_artist_format?(metadata[:featuring_artists], false, :product)
+			score += 10 if MusicMetadataScore::Contributor.are_proper_format?(metadata[:contributors])
+			score += 10 if MusicMetadataScore::Composer.are_proper_format?(metadata[:composers])
+			score += 10 if MusicMetadataScore::Publisher.are_proper_format?(metadata[:publishers])
+			return score
+		end
+		
+		def self.track_fields_corrected(metadata)
+			titles = MusicMetadataScore::TitleCase.build_proper_title(metadata[:title], metadata[:version], metadata[:primary_artists], metadata[:featuring_artists])
+			{
+				:title => titles[:title],
+				:version => titles[:version],
+				:isrc => MusicMetadataScore::Isrc.valid_isrc_or_nil(metadata[:isrc]),
+				:primary_artists => MusicMetadataScore::Artist.format_artists(metadata[:primary_artists], false, :track),
+				:featuring_artists => MusicMetadataScore::Artist.format_artists(metadata[:featuring_artists], false, :track),
+				:p_year => metadata[:p_year],
+				:p_line => MusicMetadataScore::TitleCase.title_case(metadata[:p_line]),
+				:parental_advisory => metadata[:parental_advisory],
+				:primary_genre => MusicMetadataScore::TitleCase.title_case(metadata[:primary_genre]),
+				:secondary_genre => MusicMetadataScore::TitleCase.title_case(metadata[:secondary_genre]),
+				:recording_year => metadata[:recording_year],
+				:recording_country => metadata[:recording_country],
+				:recording_location => metadata[:recording_location],
+				:country_of_commission => metadata[:country_of_commission],
+				:rights_holder => metadata[:rights_holder],
+				:contributors => metadata[:contributors],
+				:composers => metadata[:composers],
+				:publishers => metadata[:publishers]
+			}
+		end
+		
+		def self.object_is_blank?(value)
+			if value != nil && value != "" && value != [] && value != {}
+				false
+			else
+				true
 			end
 		end
-		return tracks_score
-	end
-	
-	# Corrections
-	def self.corrections(metadata)
-		array = []
-		array = Score.combine_arrays(array, Score.product_corrections(metadata[:product]))
-		array = Score.combine_arrays(array, Score.tracks_corrections(metadata[:tracks]))
-	end
-	
-	def self.product_corrections(metadata)
-		array = []
-		corrected_metadata = Score.product_fields_corrected(metadata)
-		metadata.each do |m|
-			error = Score.missing_or_corrected(m[0].to_s, m[1], corrected_metadata[m[0]])
-			array << "Product " + error if error
-		end
-		array
-	end
-	
-	def self.tracks_corrections(tracks)
-		array = []
-		tracks.each_with_index do |t, index|
-			track_returned = Score.track_corrections(t)
-			track_returned.each do |tr|
-				array << "Track #{index + 1} #{tr}"
+		
+		# Total Product Score
+		def self.total_product_score(metadata)
+			product_score = MusicMetadataScore::Score.product_score(metadata[:product])
+			tracks_score = MusicMetadataScore::Score.tracks_score(metadata[:tracks])
+			final_score = (product_score + tracks_score) / (metadata[:tracks].count + 1)
+			return final_score.round(1)
+		end
+		
+		def self.tracks_score(tracks)
+			tracks_score = 0
+			if tracks
+				tracks.each do |t|
+					tracks_score += MusicMetadataScore::Score.track_score(t)
+				end
 			end
+			return tracks_score
 		end
-		array
-	end
-	
-	def self.track_corrections(metadata)
-		array = []
-		corrected_metadata = Score.track_fields_corrected(metadata)
-		metadata.each do |m|
-			error = Score.missing_or_corrected(m[0].to_s, m[1], corrected_metadata[m[0]])
-			array << error if error
-		end
-		array
-	end
-	
-	def self.missing_or_corrected(field, original, corrected)
-		field = Score.format_field_name(field)
-		is_or_are = Score.is_or_are(field)
-			if original && original != "" && original != [] || original == false
-				if original == corrected || corrected == ''
+		
+		# Corrections
+		def self.corrections(metadata)
+			array = []
+			array = MusicMetadataScore::Score.combine_arrays(array, MusicMetadataScore::Score.product_corrections(metadata[:product]))
+			array = MusicMetadataScore::Score.combine_arrays(array, MusicMetadataScore::Score.tracks_corrections(metadata[:tracks]))
+		end
+		
+		def self.product_corrections(metadata)
+			array = []
+			corrected_metadata = MusicMetadataScore::Score.product_fields_corrected(metadata)
+			metadata.each do |m|
+				error = MusicMetadataScore::Score.missing_or_corrected(m[0].to_s, m[1], corrected_metadata[m[0]])
+				array << "Product " + error if error
+			end
+			array
+		end
+		
+		def self.tracks_corrections(tracks)
+			array = []
+			tracks.each_with_index do |t, index|
+				track_returned = MusicMetadataScore::Score.track_corrections(t)
+				track_returned.each do |tr|
+					array << "Track #{index + 1} #{tr}"
+				end
+			end
+			array
+		end
+		
+		def self.track_corrections(metadata)
+			array = []
+			corrected_metadata = MusicMetadataScore::Score.track_fields_corrected(metadata)
+			metadata.each do |m|
+				error = MusicMetadataScore::Score.missing_or_corrected(m[0].to_s, m[1], corrected_metadata[m[0]])
+				array << error if error
+			end
+			array
+		end
+		
+		def self.missing_or_corrected(field, original, corrected)
+			field = MusicMetadataScore::Score.format_field_name(field)
+			is_or_are = MusicMetadataScore::Score.is_or_are(field)
+				if original && original != "" && original != [] || original == false
+					if original == corrected || corrected == ''
+						nil
+					else
+						"#{field} #{is_or_are} incorrect. It should be #{corrected}"
+					end
+				elsif corrected == nil && field == 'Version' || field == 'Featuring Artists'
 					nil
-				else
+				elsif corrected != nil && field == 'Version' || field == 'Featuring Artists'
 					"#{field} #{is_or_are} incorrect. It should be #{corrected}"
+				else
+					"#{field} #{is_or_are} missing"
 				end
-			elsif field == 'Version' || field == 'Featuring Artists'
-				nil
+		end
+		
+		def self.is_or_are(field)
+			if field[field.length - 1].downcase == 's'
+				'are'
 			else
-				"#{field} #{is_or_are} missing"
+				'is'
 			end
-	end
-	
-	def self.is_or_are(field)
-		if field[field.length - 1].downcase == 's'
-			'are'
-		else
-			'is'
 		end
-	end
-	
-	def self.format_field_name(field)
-		split = field.split('_')
-		split.each do |s|
-			s = TitleCase.titleize(s)
+		
+		def self.format_field_name(field)
+			split = field.split('_')
+			split.each do |s|
+				s = MusicMetadataScore::TitleCase.titleize(s)
+			end
+			split.join(' ')
 		end
-		split.join(' ')
-	end
-	
-	def self.combine_arrays(first, second)
-		second.each do |s|
-			first << s
+		
+		def self.combine_arrays(first, second)
+			second.each do |s|
+				first << s
+			end
+			first
 		end
-		first
+		
 	end
-	
 end