easytag 0.4.3 → 1.0.0

data/lib/easytag/version.rb

@@ -1,10 +1,9 @@
 module EasyTag
   class Version
-    MAJOR = 0
-    MINOR = 4
-    TINY  = 3
+    MAJOR = 1
+    MINOR = 0
+    TINY  = 0
   end
  
   VERSION = [Version::MAJOR, Version::MINOR, Version::TINY].join('.')
- 
 end

data/scripts/build_attributes_table.rb

@@ -0,0 +1,34 @@
+require 'date'
+require 'easytag'
+
+DOT = '●'
+TAGGERS = {
+    mp3: EasyTag::MP3Tagger,
+    mp4: EasyTag::MP4Tagger,
+    flac: EasyTag::FLACTagger,
+    ogg: EasyTag::OggTagger
+}
+
+NOTES = {
+}
+
+methods = Set.new
+
+IGNORED_METHODS = [:method_missing, :taglib, :close]
+
+TAGGERS.each_value do |klass|
+  methods.merge(klass.instance_methods - Object.instance_methods - IGNORED_METHODS)
+end
+
+puts "#### Standard Attributes (Last Updated: #{Date.today}) ####"
+puts '| Method | MP3 | MP4 | FLAC | Ogg | Notes|'
+puts '|-------|:---:|:---:|:----:|:---:|------|'
+
+methods.to_a.sort.each do |method|
+  line = "| `##{method}` "
+  [:mp3, :mp4, :flac, :ogg].each do |key|
+    line << (TAGGERS[key].instance_methods.include?(method) ? "| #{DOT} " : '| ')
+  end
+  line << '|'
+  puts line
+end

data/spec/flac_tagger_spec.rb

@@ -0,0 +1,24 @@
+require_relative 'spec_helper'
+
+describe EasyTag::FLACTagger do
+  before(:all) do
+    @no_tags = described_class.new(data_path('no_tags.flac'))
+  end
+
+  after(:all) do
+    easytag_close @no_tags
+  end
+
+  include_context 'no tags', described_class.new(data_path('no_tags.flac'))
+  include_context 'consistency', described_class.new(data_path('consistency.flac'))
+  include_context 'consistency with multiple images', described_class.new(data_path('consistency.multiple_images.flac'))
+
+  it 'should return the audio properties of the track correctly' do
+    @no_tags.length.should              be(4)
+    @no_tags.bitrate.should             be(250)
+    @no_tags.channels.should            be(2)
+    @no_tags.sample_rate.should         be(44100)
+    @no_tags.sample_width.should        be(16)
+    @no_tags.signature.bytes.should     eql([97, 202, 139, 118, 67, 37, 2, 125, 159, 68, 118, 5, 249, 172, 220, 101])
+  end
+end

data/spec/mp3_tagger_spec.rb

@@ -0,0 +1,64 @@
+require_relative 'spec_helper'
+
+describe EasyTag::MP3Tagger do
+  before(:all) do
+    @id3v1_only = described_class.new(data_path('only_id3v1.mp3'))
+    @id3v2_only = described_class.new(data_path('only_id3v2.mp3'))
+    @no_tags    = described_class.new(data_path('no_tags.mp3'))
+  end
+
+  after(:all) do
+    easytag_close @id3v1_only, @id3v2_only, @no_tags
+  end
+
+  include_context 'no tags', described_class.new(data_path('no_tags.mp3'))
+  include_context 'consistency', described_class.new(data_path('consistency.mp3'))
+  include_context 'consistency with multiple images', described_class.new(data_path('consistency.multiple_images.mp3'))
+
+  context 'when containing only id3v1 tags' do
+    it 'should read all id3v1 tags correctly' do
+      @id3v1_only.title.should        eql('Track Title')
+      @id3v1_only.artist.should       eql('Track Artist')
+      @id3v1_only.album.should        eql('Album Name')
+      @id3v1_only.comments.should     eql(['this is a comment'])
+      @id3v1_only.genre.should        eql('Swing')
+      @id3v1_only.year.should         be(1988)
+      @id3v1_only.date.year.should    be(1988)
+      @id3v1_only.track_number.should be(3)
+      @id3v1_only.total_tracks.should be(0)
+      @id3v1_only.disc_number.should  be(0)
+      @id3v1_only.total_discs.should  be(0)
+    end
+
+    it 'should return proper responses for attributes that require id3v2' do
+      @id3v1_only.album_art.empty?.should be(true)
+    end
+  end
+
+  context 'when containing only id3v2 tags' do
+    it 'should read all id3v2 tags correctly' do
+      @id3v2_only.title.should        eql('Track Title')
+      @id3v2_only.artist.should       eql('Track Artist')
+      @id3v2_only.album.should        eql('Album Name')
+      @id3v2_only.comments.should     eql(['this is a comment'])
+      @id3v2_only.genre.should        eql('Swing')
+      @id3v2_only.year.should         be(1988)
+      @id3v2_only.date.year.should    be(1988)
+      @id3v2_only.track_number.should be(3)
+      @id3v2_only.total_tracks.should be(0)
+      @id3v2_only.disc_number.should  be(0)
+      @id3v2_only.total_discs.should  be(0)
+    end
+  end
+
+  it 'should return the audio properties of the track correctly' do
+    @no_tags.length.should              be(4)
+    @no_tags.bitrate.should             be(74)
+    @no_tags.sample_rate.should         be(44100)
+    @no_tags.channels.should            be(2)
+    @no_tags.layer.should               be(3)
+    @no_tags.original?.should           be(true)
+    @no_tags.copyrighted?.should        be(false)
+    @no_tags.protection_enabled?.should be(false)
+  end
+end

data/spec/mp4_tagger_spec.rb

@@ -0,0 +1,22 @@
+require_relative 'spec_helper'
+
+describe EasyTag::MP4Tagger do
+  before(:all) do
+    @no_tags = described_class.new(data_path('no_tags.m4a'))
+  end
+
+  after(:all) do
+    easytag_close @no_tags
+  end
+
+  include_context 'no tags', described_class.new(data_path('no_tags.m4a'))
+  include_context 'consistency', described_class.new(data_path('consistency.m4a'))
+
+  it 'should return the audio properties of the track correctly' do
+    @no_tags.length.should          be(4)
+    @no_tags.bitrate.should         be(176)
+    @no_tags.channels.should        be(2)
+    @no_tags.sample_rate.should     be(44100)
+    @no_tags.bits_per_sample.should be(16)
+  end
+end

data/spec/ogg_tagger_spec.rb

@@ -0,0 +1,21 @@
+require_relative 'spec_helper'
+
+describe EasyTag::OggTagger do
+  before(:all) do
+    @no_tags = described_class.new(data_path('no_tags.ogg'))
+  end
+  include_context 'no tags', described_class.new(data_path('no_tags.ogg'))
+  include_context 'consistency', described_class.new(data_path('consistency.ogg'))
+  include_context 'consistency with multiple images', described_class.new(data_path('consistency.multiple_images.ogg'))
+
+  it 'should return the audio properties of the track correctly' do
+    @no_tags.length.should          be(4)
+    @no_tags.bitrate.should         be(64)
+    @no_tags.channels.should        be(2)
+    @no_tags.sample_rate.should     be(44100)
+    @no_tags.bitrate_maximum.should be(0)
+    @no_tags.bitrate_minimum.should be(0)
+    @no_tags.bitrate_nominal.should be(64000)
+    @no_tags.vorbis_version.should  be(0)
+  end
+end

data/spec/shared_examples.rb

@@ -0,0 +1,115 @@
+shared_context 'no tags' do |tagger|
+  after(:all) do
+    easytag_close tagger
+  end
+
+  it 'should return nil for non-list/non-int attributes' do
+    [:title, :title_sort_order, :artist, :artist_sort_order,
+     :album_artist, :album_artist_sort_order, :album, :album_sort_order,
+     :genre, :lyrics, :date, :encoded_by, :group, :mood, :copyright, :subtitle, :disc_subtitle, :media,
+     :label, :composer, :remixer, :lyricist, :asin, :barcode, :catalog_number,
+     :musicbrainz_recording_id, :musicbrainz_track_id, :musicbrainz_album_artist_id,
+     :musicbrainz_album_id, :musicbrainz_release_group_id,
+     :musicbrainz_release_status, :musicbrainz_release_country].each do |attr|
+      actual = tagger.send(attr)
+      actual.should be(nil), "##{attr} should return nil but returned #{actual.class}:#{actual}"
+    end
+  end
+
+  it 'should return zero for int attributes' do
+    [:year, :bpm, :track_number, :total_tracks, :disc_number, :total_discs].each do |attr|
+      actual = tagger.send(attr)
+      actual.should be(0), "##{attr} should return 0 but returned #{actual.class}:#{actual}"
+    end
+  end
+
+  it 'should return an empty array for list attributes' do
+    [:comments, :album_art, :musicbrainz_artist_id, :musicbrainz_release_type].each do |attr|
+      actual = tagger.send(attr)
+      actual.should be_a(Array), "##{attr} should return an Array but returned #{actual.class}"
+      actual.empty?.should be(true), "##{attr} should be empty but isn't"
+    end
+  end
+end
+
+shared_context 'consistency' do |tagger|
+  after(:all) do
+    tagger.close
+  end
+
+  it 'should return all standard attributes consistently' do
+    tagger.title.should                   eql('She Lives in My Lap')
+    tagger.title_sort_order.should        be(nil)
+    tagger.artist.should                  eql('OutKast feat. Rosario Dawson')
+    tagger.artist_sort_order.should       eql('OutKast feat. Dawson, Rosario')
+    tagger.album_artist.should            eql('OutKast')
+    tagger.album_artist_sort_order.should eql('OutKast')
+    tagger.album.should                   eql('Speakerboxxx / The Love Below')
+    tagger.album_sort_order.should        be(nil)
+    tagger.comments.count.should          be(0)
+    tagger.genre.should                   be(nil)
+    tagger.year.should                    be(2003)
+    tagger.date.year.should               be(2003)
+    tagger.date.month.should              be(9)
+    tagger.date.day.should                be(23)
+    tagger.track_number.should            be(8)
+    tagger.total_tracks.should            be(21)
+    tagger.disc_number.should             be(2)
+    tagger.total_discs.should             be(2)
+    tagger.disc_subtitle.should           eql('The Love Below')
+    tagger.media.should                   eql('CD')
+    tagger.label.should                   eql('Arista')
+    tagger.compilation?.should            be(true)
+    tagger.bpm.should                     be(0)
+    tagger.asin.should                    eql('B0000AGWFX')
+    tagger.isrc.should                    eql('USAR10300997')
+    tagger.script.should                  eql('Latn')
+    tagger.barcode.should                 eql('828765013321')
+    tagger.catalog_number.should          eql('82876 50133 2')
+  end
+
+  it 'should return consistent album art' do
+    tagger.album_art.count.should be(1)
+
+    art = tagger.album_art[0]
+    Digest::SHA1.hexdigest(art.data).should eql('de2e3998753d4a11241205788b5c6fe4bf9dc722')
+    art.mime_type.should                    eql('image/jpeg')
+    art.width.should                        eq(500)
+    art.height.should                       eq(500)
+  end
+
+  it 'should return musicbrainz data consistently' do
+    tagger.musicbrainz_recording_id.should      eql('e1402418-eaea-4108-81e3-a12c22178325')
+    tagger.musicbrainz_track_id.should          be(nil)
+    tagger.musicbrainz_release_type.should      eql(['album'])
+    tagger.musicbrainz_album_artist_id.should   eql('73fdb566-a9b1-494c-9f32-51768ec9fd27')
+    tagger.musicbrainz_artist_id.count.should   be(2)
+    tagger.musicbrainz_artist_id.should         include('73fdb566-a9b1-494c-9f32-51768ec9fd27')
+    tagger.musicbrainz_artist_id.should         include('9facf8dc-df23-4561-85c5-ece75d692f21')
+    tagger.musicbrainz_album_id.should          eql('468cd19e-d55c-46a2-a5a6-66292d2f0a90')
+    tagger.musicbrainz_release_group_id.should  eql('fa64febd-61e0-346e-aaa2-04564ed4f0a3')
+    tagger.musicbrainz_release_country.should   eql('US')
+    tagger.musicbrainz_release_status.should    eql('official')
+  end
+end
+
+shared_context 'consistency with multiple images' do |tagger|
+  after(:all) do
+    easytag_close tagger
+  end
+  it 'should return consistent album art' do
+    tagger.album_art.count.should be(2)
+
+    art = tagger.album_art[0]
+    Digest::SHA1.hexdigest(art.data).should eql('17bd6b61a49c57fb4b2658e66db159c5bdef1106')
+    art.mime_type.should                    eql('image/jpeg')
+    art.width.should                        eq(15)
+    art.height.should                       eq(15)
+
+    art = tagger.album_art[1]
+    Digest::SHA1.hexdigest(art.data).should eql('2a48f42183fb60891532f0ada60ffb7ea63d706a')
+    art.mime_type.should                    eql('image/png')
+    art.width.should                        eq(20)
+    art.height.should                       eq(20)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+require 'simplecov'
+require 'coveralls'
+
+DATA_DIR = File.join(File.dirname(__FILE__), 'data')
+
+def data_path(file_name)
+  File.join(DATA_DIR, file_name)
+end
+
+class SimpleFormatter
+  def format(result)
+    puts "Coverage: #{result.covered_lines} / #{result.total_lines} LOC (#{result.covered_percent.round(2)}%) covered."
+  end
+end
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleFormatter,
+    Coveralls::SimpleCov::Formatter
+]
+
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+def easytag_close(*instances)
+  instances.each { |instance| instance.close }
+end
+
+require 'rspec'
+require 'digest/sha1'
+
+require 'easytag'
+require_relative 'shared_examples'
+

data/spec/tagger_factory_spec.rb

@@ -0,0 +1,27 @@
+require_relative 'spec_helper'
+
+def tagger_for_signature_helper(file)
+  fp = File.open(data_path(file), 'rb')
+  data = fp.read(16)
+  fp.close
+  EasyTag::TaggerFactory.tagger_for_signature(data.bytes)
+end
+
+describe EasyTag::TaggerFactory do
+  it 'should return the correct tagger class based on filename' do
+    EasyTag::TaggerFactory.tagger_for_filename('file.mp3').should   be(EasyTag::MP3Tagger)
+    EasyTag::TaggerFactory.tagger_for_filename('file.mp4').should   be(EasyTag::MP4Tagger)
+    EasyTag::TaggerFactory.tagger_for_filename('file.m4a').should   be(EasyTag::MP4Tagger)
+    EasyTag::TaggerFactory.tagger_for_filename('file.flac').should  be(EasyTag::FLACTagger)
+    EasyTag::TaggerFactory.tagger_for_filename('file.ogg').should   be(EasyTag::OggTagger)
+  end
+
+  it 'should return the correct tagger class based on the file signature' do
+    tagger_for_signature_helper('consistency.mp3').should   be(EasyTag::MP3Tagger)
+    tagger_for_signature_helper('only_id3v1.mp3').should    be(EasyTag::MP3Tagger)
+    tagger_for_signature_helper('only_id3v2.mp3').should    be(EasyTag::MP3Tagger)
+    tagger_for_signature_helper('consistency.m4a').should   be(EasyTag::MP4Tagger)
+    tagger_for_signature_helper('consistency.flac').should  be(EasyTag::FLACTagger)
+    tagger_for_signature_helper('consistency.ogg').should   be(EasyTag::OggTagger)
+  end
+end

data/spec/util_spec.rb

@@ -0,0 +1,47 @@
+require_relative 'spec_helper'
+
+describe EasyTag::Utilities do
+  it '#get_int_pair parses int pairs' do
+    EasyTag::Utilities.get_int_pair(nil).should     eql([0, 0])
+    EasyTag::Utilities.get_int_pair('').should      eql([0, 0])
+    EasyTag::Utilities.get_int_pair('3').should     eql([3, 0])
+    EasyTag::Utilities.get_int_pair('/9').should    eql([0, 9])
+    EasyTag::Utilities.get_int_pair('5/10').should  eql([5, 10])
+    EasyTag::Utilities.get_int_pair([8, 21]).should eql([8, 21])
+  end
+
+  it '#get_datetime parses dates' do
+    date = EasyTag::Utilities.get_datetime('2006')
+    date.year.should  be(2006)
+    date.month.should be(1)
+    date.day.should   be(1)
+
+    date = EasyTag::Utilities.get_datetime('1955-05')
+    date.year.should  be(1955)
+    date.month.should be(5)
+    date.day.should   be(1)
+
+    date = EasyTag::Utilities.get_datetime('2012-12-07T08:00:00Z')
+    date.year.should  be(2012)
+    date.month.should be(12)
+    date.day.should   be(7)
+
+    date = EasyTag::Utilities.get_datetime('19880711')
+    date.year.should  be(1988)
+    date.month.should be(11)
+    date.day.should   be(7)
+
+    date = EasyTag::Utilities.get_datetime('2006-99-99')
+    date.year.should  be(2006)
+    date.month.should be(1)
+    date.day.should   be(1)
+
+    date = EasyTag::Utilities.get_datetime('2000-00-00')
+    date.year.should  be(2000)
+    date.month.should be(1)
+    date.day.should   be(1)
+
+    date = EasyTag::Utilities.get_datetime('')
+    date.should be(nil)
+  end
+end