taglib-ruby 0.6.0 → 1.1.0

data/test/id3v1_genres_test.rb

@@ -0,0 +1,23 @@
+require File.join(File.dirname(__FILE__), 'helper')
+
+class TestVorbisTag < Test::Unit::TestCase
+  context "TagLib::ID3v1" do
+    should "list genres" do
+      assert_equal "Jazz", TagLib::ID3v1::genre_list[8]
+    end
+
+    should "map genres to their index" do
+      assert_equal 8, TagLib::ID3v1::genre_map["Jazz"]
+    end
+
+    should "support to query the value of a genre" do
+      assert_equal "Jazz", TagLib::ID3v1::genre(8)
+      assert_equal "", TagLib::ID3v1::genre(255)
+    end
+
+    should "support to query the index of a genre" do
+      assert_equal 8, TagLib::ID3v1::genre_index("Jazz")
+      assert_equal 255, TagLib::ID3v1::genre_index("Unknown")
+    end
+  end
+end

data/test/id3v1_tag_test.rb

@@ -22,6 +22,7 @@ class TestID3v1Tag < Test::Unit::TestCase
         assert_equal 'Album', @tag.album
         assert_equal 'Comment', @tag.comment
         assert_equal 'Pop', @tag.genre
+        assert_equal 13, @tag.genre_number
         assert_equal 2011, @tag.year
         assert_equal 7, @tag.track
         assert_equal false, @tag.empty?

data/test/id3v2_frames_test.rb

@@ -92,6 +92,70 @@ class TestID3v2Frames < Test::Unit::TestCase
       end
     end
 
+    context 'CTOC and CHAP frames' do
+      setup do
+        @chapters = [
+          { id: 'CH1', start_time: 100, end_time: 200 },
+          { id: 'CH2', start_time: 201, end_time: 300 },
+          { id: 'CH3', start_time: 301, end_time: 400 }
+        ]
+
+        @default_ctoc = TagLib::ID3v2::TableOfContentsFrame.new('Test')
+        @default_chap = TagLib::ID3v2::ChapterFrame.new('Test', 0, 1, 0xFFFFFFFF, 0xFFFFFFFF)
+      end
+
+      should 'not have a CTOC frame' do
+        assert_equal [], @tag.frame_list('CTOC')
+      end
+
+      should 'not have a CHAP frame' do
+        assert_equal [], @tag.frame_list('CHAP')
+      end
+
+      should 'have one CTOC frame (only one Table of Contents)' do
+        toc = TagLib::ID3v2::TableOfContentsFrame.new('TOC')
+        toc.is_top_level = true
+        toc.is_ordered = true
+
+        @chapters.each do |chapter|
+          toc.add_child_element(chapter[:id])
+        end
+
+        @tag.add_frame(toc)
+
+        ctoc_frame_list = @tag.frame_list('CTOC')
+        assert_equal @default_ctoc.class, ctoc_frame_list.first.class
+        assert_equal 1, ctoc_frame_list.size
+        assert_equal 'TOC', ctoc_frame_list.first.element_id
+        assert_equal 3, ctoc_frame_list.first.child_elements.size
+        assert_equal %w[CH1 CH2 CH3], ctoc_frame_list.first.child_elements
+      end
+
+      should 'have CHAP frames (multiple chapters)' do
+        start_offset = 0xFFFFFFFF
+        end_offset = 0xFFFFFFFF
+
+        @chapters.each do |chapter|
+          chapter_frame = TagLib::ID3v2::ChapterFrame.new(
+            chapter[:id],
+            chapter[:start_time].to_i,
+            chapter[:end_time].to_i,
+            start_offset,
+            end_offset
+          )
+
+          @tag.add_frame(chapter_frame)
+        end
+
+        chap_frame_list = @tag.frame_list('CHAP')
+        assert_equal @default_chap.class, chap_frame_list.first.class
+        assert_equal 3, chap_frame_list.size
+        assert_equal 'CH1', chap_frame_list[0].element_id
+        assert_equal 'CH2', chap_frame_list[1].element_id
+        assert_equal 'CH3', chap_frame_list[2].element_id
+      end
+    end
+
     context "TXXX frame" do
       setup do
         @txxx_frame = @tag.frame_list('TXXX').first

data/test/id3v2_tag_test.rb

@@ -43,12 +43,12 @@ class TestID3v2Tag < Test::Unit::TestCase
       assert @tag.empty?
     end
 
-    should "have nil for string attributes" do
-      assert_nil @tag.title
-      assert_nil @tag.artist
-      assert_nil @tag.album
-      assert_nil @tag.comment
-      assert_nil @tag.genre
+    should "have empty string attributes" do
+      assert_equal "", @tag.title
+      assert_equal "", @tag.artist
+      assert_equal "", @tag.album
+      assert_equal "", @tag.comment
+      assert_equal "", @tag.genre
     end
 
     should "have 0 for numeric attributes" do

data/test/id3v2_unknown_frames_test.rb

@@ -0,0 +1,30 @@
+require File.join(File.dirname(__FILE__), 'helper')
+
+class TestID3v2UnknownFrames < Test::Unit::TestCase
+  context "UnknownFrame" do
+    setup do
+      read_properties = false
+      @file = TagLib::MPEG::File.new("test/data/sample.mp3", read_properties)
+      @tag = @file.id3v2_tag
+    end
+
+    should "should be returned with correct class" do
+      f = TagLib::ID3v2::UnknownFrame.new("TDAT")
+      assert_not_nil f
+      @tag.add_frame(f)
+      frames = @tag.frame_list("TDAT")
+      tdat = frames.first
+      assert_not_nil tdat
+      # By looking at ID alone, it would have returned a
+      # TextIdentificationFrame. So make sure the correct
+      # class is returned here, because it would result in
+      # segfaults when calling methods on it.
+      assert_equal TagLib::ID3v2::UnknownFrame, tdat.class
+    end
+
+    teardown do
+      @file.close
+      @file = nil
+    end
+  end
+end

data/test/id3v2_write_test.rb

@@ -54,21 +54,18 @@ class TestID3v2Write < Test::Unit::TestCase
       end
     end
 
-    should "be able to save ID3v2.3 when compiled against TagLib >= 1.8" do
-      if TagLib::TAGLIB_MAJOR_VERSION > 1 ||
-        (TagLib::TAGLIB_MAJOR_VERSION == 1 && TagLib::TAGLIB_MINOR_VERSION >= 8)
-        success = @file.save(TagLib::MPEG::File::ID3v2, true, 3)
-        assert_equal true, success
-        @file.close
-        @file = nil
+    should "be able to save ID3v2.3" do
+      success = @file.save(TagLib::MPEG::File::ID3v2, true, 3)
+      assert_equal true, success
+      @file.close
+      @file = nil
 
-        header = File.open(OUTPUT_FILE, 'rb') do |f|
-          f.read(5)
-        end
-        # 3 stands for v2.3
-        s = "ID3" + 3.chr + 0.chr
-        assert_equal s, header
+      header = File.open(OUTPUT_FILE, 'rb') do |f|
+        f.read(5)
       end
+      # 3 stands for v2.3
+      s = "ID3" + 3.chr + 0.chr
+      assert_equal s, header
     end
 
     should "be able to set fields to nil" do

data/test/mp4_file_test.rb

@@ -7,6 +7,11 @@ class MP4FileTest < Test::Unit::TestCase
       @tag = @file.tag
     end
 
+    should "have an MP4 tag" do
+      assert @file.mp4_tag?
+      refute_nil @tag
+    end
+
     should "contain basic tag information" do
       assert_equal "Title", @tag.title
       assert_equal "Artist", @tag.artist
@@ -15,9 +20,33 @@ class MP4FileTest < Test::Unit::TestCase
       assert_equal "Pop", @tag.genre
       assert_equal 2011, @tag.year
       assert_equal 7, @tag.track
+
       assert_equal false, @tag.empty?
     end
 
+    should "support testing for the presence of items" do
+      refute @tag.contains "unknown"
+      assert @tag.contains "trkn"
+    end
+
+    should "support accessing items" do
+      refute @tag["unkn"].valid?
+
+      assert @tag["trkn"].valid?
+      assert_equal 7, @tag.track
+    end
+
+    should "support editing items" do
+      @tag["trkn"] = TagLib::MP4::Item.from_int(1)
+      assert_equal 1, @tag.track
+    end
+
+    should "support removing items" do
+      assert @tag.contains "trkn"
+      @tag.remove_item("trkn")
+      refute @tag.contains "trkn"
+    end
+
     context "audio properties" do
       setup do
         @properties = @file.audio_properties
@@ -28,8 +57,8 @@ class MP4FileTest < Test::Unit::TestCase
       end
 
       should "contain basic information" do
-        assert_equal 1, @properties.length
-        assert_equal 54, @properties.bitrate
+        assert_equal 1, @properties.length_in_seconds
+        assert_equal 55, @properties.bitrate
         assert_equal 44100, @properties.sample_rate
         # The test file is mono, this appears to be a TagLib bug
         assert_equal 2, @properties.channels
@@ -37,8 +66,8 @@ class MP4FileTest < Test::Unit::TestCase
 
       should "contain mp4-specific information" do
         assert_equal 16, @properties.bits_per_sample
-        # Properties#encrypted? raises a NoMethodError
-        # assert_equal false, @properties.encrypted?
+        assert_equal false, @properties.encrypted?
+        assert_equal TagLib::MP4::Properties::AAC, @properties.codec
       end
     end
 

data/test/mp4_file_write_test.rb

@@ -34,22 +34,22 @@ class MP4FileWriteTest < Test::Unit::TestCase
     end
 
     should "be able to add and save new cover art" do
-      item_list_map = @file.tag.item_list_map
-      cover_art_list = item_list_map['covr'].to_cover_art_list
+      item_map = @file.tag.item_map
+      cover_art_list = item_map['covr'].to_cover_art_list
       assert_equal 1, cover_art_list.size
 
       data = File.open(PICTURE_FILE, 'rb') { |f| f.read }
       new_cover_art = TagLib::MP4::CoverArt.new(TagLib::MP4::CoverArt::JPEG, data)
 
       cover_art_list << new_cover_art
-      item_list_map.insert('covr', TagLib::MP4::Item.from_cover_art_list(cover_art_list))
-      assert_equal 2, item_list_map['covr'].to_cover_art_list.size
+      item_map.insert('covr', TagLib::MP4::Item.from_cover_art_list(cover_art_list))
+      assert_equal 2, item_map['covr'].to_cover_art_list.size
 
       success = @file.save
       assert success
 
       reloaded do |file|
-        written_cover_art = file.tag.item_list_map['covr'].to_cover_art_list.last
+        written_cover_art = file.tag.item_map['covr'].to_cover_art_list.last
         assert_equal TagLib::MP4::CoverArt::JPEG, written_cover_art.format
         assert_equal data, written_cover_art.data
       end

data/test/mp4_items_test.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
 require File.join(File.dirname(__FILE__), 'helper')
+require 'set'
 
 class MP4ItemsTest < Test::Unit::TestCase
   ITUNES_LEADER = "\xC2\xA9"
@@ -8,44 +9,44 @@ class MP4ItemsTest < Test::Unit::TestCase
     setup do
       @file = TagLib::MP4::File.new("test/data/mp4.m4a")
       @tag = @file.tag
-      @item_list_map = @file.tag.item_list_map
+      @item_map = @file.tag.item_map
       @item_keys = [
-        "cover", "#{ITUNES_LEADER}nam", "#{ITUNES_LEADER}ART", "#{ITUNES_LEADER}alb",
+        "covr", "#{ITUNES_LEADER}nam", "#{ITUNES_LEADER}ART", "#{ITUNES_LEADER}alb",
         "#{ITUNES_LEADER}cmt", "#{ITUNES_LEADER}gen", "#{ITUNES_LEADER}day",
         "trkn", "#{ITUNES_LEADER}too", "#{ITUNES_LEADER}cpy"
       ]
     end
 
-    context "item_list_map" do
+    context "item_map" do
       should "exist" do
-        assert_not_nil @item_list_map
+        assert_not_nil @item_map
       end
 
       should "not be empty" do
-        assert_equal false, @item_list_map.empty?
+        assert_equal false, @item_map.empty?
       end
 
       should "contain 10 items" do
-        assert_equal @item_keys.count, @item_list_map.size
+        assert_equal @item_keys.count, @item_map.size
       end
 
       should "have keys" do
-        assert_equal true, @item_list_map.contains("trkn")
-        assert_equal true, @item_list_map.has_key?("#{ITUNES_LEADER}too")
-        assert_equal true, @item_list_map.include?("#{ITUNES_LEADER}cpy")
-        assert_equal false, @item_list_map.include?("none such key")
+        assert_equal true, @item_map.contains("trkn")
+        assert_equal true, @item_map.has_key?("#{ITUNES_LEADER}too")
+        assert_equal true, @item_map.include?("#{ITUNES_LEADER}cpy")
+        assert_equal false, @item_map.include?("none such key")
       end
 
       should "look up keys" do
-        assert_nil @item_list_map["none such key"]
-        assert_equal ["Title"], @item_list_map["#{ITUNES_LEADER}nam"].to_string_list
+        assert_nil @item_map["none such key"]
+        assert_equal ["Title"], @item_map["#{ITUNES_LEADER}nam"].to_string_list
       end
 
       should "be clearable" do
-        assert_equal 10, @item_list_map.size
-        comment = @item_list_map["#{ITUNES_LEADER}cmt"]
-        @item_list_map.clear
-        assert_equal true, @item_list_map.empty?
+        assert_equal 10, @item_map.size
+        comment = @item_map["#{ITUNES_LEADER}cmt"]
+        @item_map.clear
+        assert_equal true, @item_map.empty?
         begin
           comment.to_string_list
           flunk("Should have raised ObjectPreviouslyDeleted.")
@@ -54,23 +55,29 @@ class MP4ItemsTest < Test::Unit::TestCase
         end
       end
 
-      should "be convertable to an array" do
-        array = @item_list_map.to_a
+      should "be convertible to an array" do
+        array = @item_map.to_a
         assert_equal 10, array.count
         array.each do |object|
           assert_equal Array, object.class
           assert_equal 2, object.count
           assert_equal String, object.first.class
           assert_equal TagLib::MP4::Item, object.last.class
+          assert_includes @item_keys, object.first
         end
       end
+
+      should "be convertible to a hash" do
+        hsh = @item_map.to_h
+        assert_equal Set.new(hsh.keys), Set.new(@item_keys)
+      end
     end
 
     should "be removable" do
-      assert_equal 10, @item_list_map.size
-      title = @item_list_map["#{ITUNES_LEADER}nam"]
-      @item_list_map.erase("#{ITUNES_LEADER}nam")
-      assert_equal 9, @item_list_map.size
+      assert_equal 10, @item_map.size
+      title = @item_map["#{ITUNES_LEADER}nam"]
+      @item_map.erase("#{ITUNES_LEADER}nam")
+      assert_equal 9, @item_map.size
       begin
         title.to_string_list
         flunk("Should have raised ObjectPreviouslyDeleted.")
@@ -79,18 +86,47 @@ class MP4ItemsTest < Test::Unit::TestCase
       end
     end
 
+    should "reflect edition of items from the tag" do
+      assert @tag.contains "trkn"
+      track = @item_map["trkn"]
+
+      @tag["trkn"] = TagLib::MP4::Item.from_int(1)
+
+      begin
+        track.to_int_pair[0]
+        flunk("Should have raised ObjectPreviouslyDeleted.")
+      rescue => e
+        assert_equal "ObjectPreviouslyDeleted", e.class.to_s
+      end
+    end
+
+    should "reflect removal of items from the tag" do
+      assert @tag.contains "trkn"
+      track = @item_map["trkn"]
+
+      @tag.remove_item("trkn")
+      refute @item_map.contains "trkn"
+
+      begin
+        track.to_int_pair[0]
+        flunk("Should have raised ObjectPreviouslyDeleted.")
+      rescue => e
+        assert_equal "ObjectPreviouslyDeleted", e.class.to_s
+      end
+    end
+
     context "inserting items" do
       should "insert a new item" do
         new_title = TagLib::MP4::Item.from_string_list(['new title'])
-        @item_list_map.insert("#{ITUNES_LEADER}nam", new_title)
+        @item_map.insert("#{ITUNES_LEADER}nam", new_title)
         new_title = nil
         GC.start
-        assert_equal ['new title'], @item_list_map["#{ITUNES_LEADER}nam"].to_string_list
+        assert_equal ['new title'], @item_map["#{ITUNES_LEADER}nam"].to_string_list
       end
 
       should "unlink items that get replaced" do
-        title = @item_list_map["#{ITUNES_LEADER}nam"]
-        @item_list_map.insert("#{ITUNES_LEADER}nam", TagLib::MP4::Item.from_int(1))
+        title = @item_map["#{ITUNES_LEADER}nam"]
+        @item_map.insert("#{ITUNES_LEADER}nam", TagLib::MP4::Item.from_int(1))
         begin
           title.to_string_list
           flunk("Should have raised ObjectPreviouslyDeleted.")
@@ -101,16 +137,34 @@ class MP4ItemsTest < Test::Unit::TestCase
     end
 
     context "TagLib::MP4::Item" do
+      should "be creatable from a boolean" do
+        item = TagLib::MP4::Item.from_bool(false)
+        assert_equal TagLib::MP4::Item, item.class
+        assert_equal false, item.to_bool
+      end
+
+      should "be creatable from a byte" do
+        item = TagLib::MP4::Item.from_byte(123)
+        assert_equal TagLib::MP4::Item, item.class
+        assert_equal 123, item.to_byte
+      end
+
+      should "be creatable from an unsigned int" do
+        item = TagLib::MP4::Item.from_int(12346)
+        assert_equal TagLib::MP4::Item, item.class
+        assert_equal 12346, item.to_uint
+      end
+
       should "be creatable from an int" do
         item = TagLib::MP4::Item.from_int(-42)
         assert_equal TagLib::MP4::Item, item.class
         assert_equal -42, item.to_int
       end
 
-      should "be creatable from a boolean" do
-        item = TagLib::MP4::Item.from_bool(false)
+      should "be creatable from a long long" do
+        item = TagLib::MP4::Item.from_long_long(1234567890)
         assert_equal TagLib::MP4::Item, item.class
-        assert_equal false, item.to_bool
+        assert_equal 1234567890, item.to_long_long
       end
 
       context ".from_int_pair" do