taglib-ruby 1.0.1 → 1.1.2

data/test/id3v2_frames_test.rb

@@ -1,3 +1,5 @@
+# frozen-string-literal: true
+
 require File.join(File.dirname(__FILE__), 'helper')
 
 class TestID3v2Frames < Test::Unit::TestCase
@@ -9,28 +11,28 @@ class TestID3v2Frames < Test::Unit::TestCase
       # itself would still be reachable. The reason is because
       # TagLib::MPEG::File owns the TagLib::ID3v2::Tag and automatically
       # deletes it in its destructor.
-      @file = TagLib::MPEG::File.new("test/data/sample.mp3", read_properties)
-      picture_file = File.open("test/data/globe_east_540.jpg", "rb") do |f|
+      @file = TagLib::MPEG::File.new('test/data/sample.mp3', read_properties)
+      _picture_file = File.open('test/data/globe_east_540.jpg', 'rb') do |f|
         @picture_data = f.read
       end
       @tag = @file.id3v2_tag
       @frames = @tag.frame_list
     end
 
-    should "be complete" do
+    should 'be complete' do
       assert_not_nil @frames
       assert_equal 11, @frames.size
       frame = @frames.first
-      assert_equal "Dummy Title", frame.to_string
+      assert_equal 'Dummy Title', frame.to_string
     end
 
-    should "be enumerable" do
-      ids = @frames.collect { |frame| frame.frame_id }
-      assert_equal ["TIT2", "TPE1", "TALB", "TRCK", "TDRC",
-                    "COMM", "COMM", "TCON", "TXXX", "COMM", "APIC"], ids
+    should 'be enumerable' do
+      ids = @frames.collect(&:frame_id)
+      assert_equal %w[TIT2 TPE1 TALB TRCK TDRC
+                      COMM COMM TCON TXXX COMM APIC], ids
     end
 
-    should "be automatically converted" do
+    should 'be automatically converted' do
       apic = @tag.frame_list('APIC').first
       comm = @tag.frame_list('COMM').first
       tit2 = @tag.frame_list('TIT2').first
@@ -41,73 +43,140 @@ class TestID3v2Frames < Test::Unit::TestCase
       assert_equal TagLib::ID3v2::UserTextIdentificationFrame, txxx.class
     end
 
-    should "not fail for nil String" do
+    should 'not fail for nil String' do
       assert_equal [], @tag.frame_list(nil)
     end
 
-    should "be removable" do
+    should 'be removable' do
       assert_equal 11, @tag.frame_list.size
       tit2 = @tag.frame_list('TIT2').first
       @tag.remove_frame(tit2)
       assert_equal 10, @tag.frame_list.size
       begin
         tit2.to_string
-        flunk("Should have raised ObjectPreviouslyDeleted.")
-      rescue => e
-        assert_equal "ObjectPreviouslyDeleted", e.class.to_s
+        flunk('Should have raised ObjectPreviouslyDeleted.')
+      rescue StandardError => e
+        assert_equal 'ObjectPreviouslyDeleted', e.class.to_s
       end
     end
 
-    should "be removable by ID" do
+    should 'be removable by ID' do
       frames = @tag.frame_list
       @tag.remove_frames('COMM')
       tit2 = frames.find { |f| f.frame_id == 'TIT2' }
       # Other frames should still be accessible
-      assert_equal "Dummy Title", tit2.to_s
+      assert_equal 'Dummy Title', tit2.to_s
     end
 
-    context "APIC frame" do
+    context 'APIC frame' do
       setup do
         @apic = @tag.frame_list('APIC').first
       end
 
-      should "have a type" do
+      should 'have a type' do
         assert_equal TagLib::ID3v2::AttachedPictureFrame::FrontCover, @apic.type
       end
 
-      should "have a description" do
-        assert_equal "Blue Marble", @apic.description
+      should 'have a description' do
+        assert_equal 'Blue Marble', @apic.description
       end
 
-      should "have a mime type" do
-        assert_equal "image/jpeg", @apic.mime_type
+      should 'have a mime type' do
+        assert_equal 'image/jpeg', @apic.mime_type
       end
 
-      should "have picture bytes" do
-        assert_equal 61649, @apic.picture.size
-        if HAVE_ENCODING
-          assert_equal @picture_data.encoding, @apic.picture.encoding
-        end
+      should 'have picture bytes' do
+        assert_equal 61_649, @apic.picture.size
+        assert_equal @picture_data.encoding, @apic.picture.encoding if HAVE_ENCODING
         assert_equal @picture_data, @apic.picture
       end
     end
 
-    context "TXXX frame" do
+    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
       end
 
-      should "exist" do
+      should 'exist' do
         assert_not_nil @txxx_frame
       end
 
-      should "have to_s" do
-        expected = "[MusicBrainz Album Id] MusicBrainz Album Id 992dc19a-5631-40f5-b252-fbfedbc328a9"
-        assert_equal expected, @txxx_frame.to_string
+      should 'have to_s' do
+        expected = /\[MusicBrainz Album Id\].* 992dc19a-5631-40f5-b252-fbfedbc328a9/
+        assert_match expected, @txxx_frame.to_string
+      end
+
+      should 'have field_list' do
+        assert_equal ['MusicBrainz Album Id', '992dc19a-5631-40f5-b252-fbfedbc328a9'], @txxx_frame.field_list
       end
 
-      should "have field_list" do
-        assert_equal ["MusicBrainz Album Id", "992dc19a-5631-40f5-b252-fbfedbc328a9"], @txxx_frame.field_list
+      should 'constructor with all arguments should work' do
+        frame = TagLib::ID3v2::UserTextIdentificationFrame.new("UserFrame", ["Some User Text"], TagLib::String::UTF8)
+        assert_equal ["UserFrame", "Some User Text"], frame.field_list
       end
     end
 

data/test/id3v2_header_test.rb

@@ -1,49 +1,50 @@
+# frozen-string-literal: true
+
 require File.join(File.dirname(__FILE__), 'helper')
 
 class TestID3v2Header < Test::Unit::TestCase
-  context "The sample.mp3 file" do
+  context 'The sample.mp3 file' do
     setup do
       read_properties = false
-      @file = TagLib::MPEG::File.new("test/data/sample.mp3", read_properties)
+      @file = TagLib::MPEG::File.new('test/data/sample.mp3', read_properties)
       @tag = @file.id3v2_tag
     end
 
-    should "have a ID3v2 header" do
+    should 'have a ID3v2 header' do
       assert_not_nil @tag.header
     end
 
-    context "header" do
+    context 'header' do
       setup do
         @header = @tag.header
       end
 
-      should "have a major version" do
+      should 'have a major version' do
         assert_equal 3, @header.major_version
       end
 
-      should "have a revision number" do
+      should 'have a revision number' do
         assert_equal 0, @header.revision_number
       end
 
-      should "have a tag size" do
-        assert_equal 63478, @header.tag_size
+      should 'have a tag size' do
+        assert_equal 63_478, @header.tag_size
       end
 
-      should "not have a footer" do
+      should 'not have a footer' do
         assert_equal false, @header.footer_present
       end
 
-      should "not have an extended header" do
+      should 'not have an extended header' do
         assert_equal false, @header.extended_header
       end
 
-      context "changing the major version" do
-
+      context 'changing the major version' do
         setup do
           @header.major_version = 4
         end
 
-        should "have a different major verson" do
+        should 'have a different major verson' do
           assert_equal 4, @header.major_version
         end
 

data/test/id3v2_memory_test.rb

@@ -1,23 +1,24 @@
+# frozen-string-literal: true
+
 require File.join(File.dirname(__FILE__), 'helper')
 
 class TestID3v2Memory < Test::Unit::TestCase
-
   N = 1000
 
-  context "TagLib::ID3v2" do
+  context 'TagLib::ID3v2' do
     setup do
-      @file = TagLib::MPEG::File.new("test/data/sample.mp3", false)
+      @file = TagLib::MPEG::File.new('test/data/sample.mp3', false)
       @tag = @file.id3v2_tag
-      @apic = @tag.frame_list("APIC").first
+      @apic = @tag.frame_list('APIC').first
     end
 
-    should "not corrupt memory with FrameList" do
+    should 'not corrupt memory with FrameList' do
       N.times do
         @tag.frame_list
       end
     end
 
-    should "not corrupt memory with ByteVector" do
+    should 'not corrupt memory with ByteVector' do
       data = nil
       N.times do
         data = @apic.picture
@@ -27,32 +28,32 @@ class TestID3v2Memory < Test::Unit::TestCase
       end
     end
 
-    should "not corrupt memory with StringList" do
+    should 'not corrupt memory with StringList' do
       txxx = @tag.frame_list('TXXX').first
       N.times do
         txxx.field_list
       end
       N.times do
-        txxx.field_list = ["one", "two", "three"]
+        txxx.field_list = %w[one two three]
       end
     end
 
-    should "not segfault when tag is deleted along with file" do
+    should 'not segfault when tag is deleted along with file' do
       @file = nil
       begin
         N.times do
           GC.start
           @tag.title
         end
-      rescue => e
-        assert_equal "ObjectPreviouslyDeleted", e.class.to_s
+      rescue StandardError => e
+        assert_equal 'ObjectPreviouslyDeleted', e.class.to_s
       else
-        raise "GC did not delete file, unsure if test was successful."
+        raise 'GC did not delete file, unsure if test was successful.'
       end
     end
 
-    should "not segfault when audio properties are deleted along with file" do
-      file = TagLib::MPEG::File.new("test/data/crash.mp3", true)
+    should 'not segfault when audio properties are deleted along with file' do
+      file = TagLib::MPEG::File.new('test/data/crash.mp3', true)
       properties = file.audio_properties
       file.close
       begin
@@ -60,20 +61,20 @@ class TestID3v2Memory < Test::Unit::TestCase
           GC.start
           properties.bitrate
         end
-      rescue => e
-        assert_equal "ObjectPreviouslyDeleted", e.class.to_s
+      rescue StandardError => e
+        assert_equal 'ObjectPreviouslyDeleted', e.class.to_s
       else
-        raise "GC did not delete file, unsure if test was successful."
+        raise 'GC did not delete file, unsure if test was successful.'
       end
     end
 
-    should "not throw when adding frame via Tag.add_frame" do
+    should 'not throw when adding frame via Tag.add_frame' do
       tcom = TagLib::ID3v2::TextIdentificationFrame.new('TCOM', TagLib::String::Latin1)
-      tcom.text = "Some composer"
+      tcom.text = 'Some composer'
       @tag.add_frame tcom
       # the following leads to an ObjectPreviouslyDeleted error (see Issue #8)
       assert_nothing_raised do
-        @tag.frame_list.find { |fr| 'TCOM' == fr.frame_id }
+        @tag.frame_list.find { |fr| fr.frame_id == 'TCOM' }
       end
     end
 

data/test/id3v2_relative_volume_test.rb

@@ -1,30 +1,32 @@
+# frozen-string-literal: true
+
 require File.join(File.dirname(__FILE__), 'helper')
 
 class TestID3v2RelativeVolumeFrame < Test::Unit::TestCase
-  context "The relative-volume.mp3 RVA2 frame" do
+  context 'The relative-volume.mp3 RVA2 frame' do
     setup do
-      @file = TagLib::MPEG::File.new("test/data/relative-volume.mp3")
+      @file = TagLib::MPEG::File.new('test/data/relative-volume.mp3')
       @tag = @file.id3v2_tag
       @rv = @tag.frame_list('RVA2').first
     end
 
-    should "exist" do
+    should 'exist' do
       assert_not_nil @rv
     end
 
-    should "have channels" do
+    should 'have channels' do
       expected = [TagLib::ID3v2::RelativeVolumeFrame::MasterVolume, TagLib::ID3v2::RelativeVolumeFrame::Subwoofer]
       assert_equal expected, @rv.channels
     end
 
-    should "have volume adjustments" do
+    should 'have volume adjustments' do
       assert_equal 512, @rv.volume_adjustment_index
       assert_equal 1.0, @rv.volume_adjustment
       assert_equal 1024, @rv.volume_adjustment_index(TagLib::ID3v2::RelativeVolumeFrame::Subwoofer)
       assert_equal 2.0, @rv.volume_adjustment(TagLib::ID3v2::RelativeVolumeFrame::Subwoofer)
     end
 
-    should "have peak volumes" do
+    should 'have peak volumes' do
       master_pv = @rv.peak_volume
       assert_equal 8, master_pv.bits_representing_peak
       assert_equal 0b01000001.chr, master_pv.peak_volume
@@ -34,17 +36,17 @@ class TestID3v2RelativeVolumeFrame < Test::Unit::TestCase
       assert_equal 0b00111111.chr, subwoofer_pv.peak_volume
     end
 
-    should "accept new volume adjustments" do
+    should 'accept new volume adjustments' do
       @rv.set_volume_adjustment_index(2048, TagLib::ID3v2::RelativeVolumeFrame::FrontCentre)
       assert_equal 2048, @rv.volume_adjustment_index(TagLib::ID3v2::RelativeVolumeFrame::FrontCentre)
       @rv.set_volume_adjustment(4.0, TagLib::ID3v2::RelativeVolumeFrame::FrontLeft)
       assert_equal 4.0, @rv.volume_adjustment(TagLib::ID3v2::RelativeVolumeFrame::FrontLeft)
     end
 
-    should "accept new peak volumes" do
+    should 'accept new peak volumes' do
       pv = TagLib::ID3v2::PeakVolume.new
       assert_equal 0, pv.bits_representing_peak
-      assert_equal "", pv.peak_volume
+      assert_equal '', pv.peak_volume
       pv.bits_representing_peak = 6
       pv.peak_volume = 0b110111.chr
       @rv.set_peak_volume(pv, TagLib::ID3v2::RelativeVolumeFrame::BackLeft)

data/test/id3v2_tag_test.rb

@@ -1,22 +1,24 @@
+# frozen-string-literal: true
+
 require File.join(File.dirname(__FILE__), 'helper')
 
 class TestID3v2Tag < Test::Unit::TestCase
-  context "The sample.mp3 file" do
+  context 'The sample.mp3 file' do
     setup do
       read_properties = false
-      @file = TagLib::MPEG::File.new("test/data/sample.mp3", read_properties)
+      @file = TagLib::MPEG::File.new('test/data/sample.mp3', read_properties)
     end
 
-    should "have an ID3v2 tag" do
+    should 'have an ID3v2 tag' do
       assert_not_nil @file.id3v2_tag
     end
 
-    context "tag" do
+    context 'tag' do
       setup do
         @tag = @file.id3v2_tag
       end
 
-      should "have basic properties" do
+      should 'have basic properties' do
         assert_equal 'Dummy Title', @tag.title
         assert_equal 'Dummy Artist', @tag.artist
         assert_equal 'Dummy Album', @tag.album
@@ -34,24 +36,24 @@ class TestID3v2Tag < Test::Unit::TestCase
     end
   end
 
-  context "A new ID3v2::Tag" do
+  context 'A new ID3v2::Tag' do
     setup do
       @tag = TagLib::ID3v2::Tag.new
     end
 
-    should "be empty" do
+    should 'be empty' do
       assert @tag.empty?
     end
 
-    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
+    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
+    should 'have 0 for numeric attributes' do
       assert_equal 0, @tag.track
       assert_equal 0, @tag.year
     end

data/test/id3v2_unicode_test.rb

@@ -1,30 +1,32 @@
+# frozen-string-literal: true
+
 require File.join(File.dirname(__FILE__), 'helper')
 
 class TestID3v2Unicode < Test::Unit::TestCase
-  context "The unicode.mp3 file" do
+  context 'The unicode.mp3 file' do
     setup do
       read_properties = false
-      @file = TagLib::MPEG::File.new("test/data/unicode.mp3", read_properties)
+      @file = TagLib::MPEG::File.new('test/data/unicode.mp3', read_properties)
     end
 
-    should "have an ID3v2 tag" do
+    should 'have an ID3v2 tag' do
       assert_not_nil @file.id3v2_tag
     end
 
     if HAVE_ENCODING
-      context "tag" do
+      context 'tag' do
         setup do
           @tag = @file.id3v2_tag
         end
 
-        should "return strings in the right encoding" do
-          assert_equal "UTF-8", @tag.title.encoding.to_s
+        should 'return strings in the right encoding' do
+          assert_equal 'UTF-8', @tag.title.encoding.to_s
         end
 
-        should "convert strings to the right encoding" do
+        should 'convert strings to the right encoding' do
           # Unicode Snowman in UTF-16
-          utf16_encoded = "\x26\x03"
-          utf16_encoded.force_encoding("UTF-16BE")
+          utf16_encoded = "\x26\x03".dup # mutable
+          utf16_encoded.force_encoding('UTF-16BE')
 
           # It should be converted here
           @tag.title = utf16_encoded
@@ -33,7 +35,7 @@ class TestID3v2Unicode < Test::Unit::TestCase
 
           # In order for == to work, they have to be in the same
           # encoding
-          utf8_encoded = utf16_encoded.encode("UTF-8")
+          utf8_encoded = utf16_encoded.encode('UTF-8')
           assert_equal utf8_encoded, result
         end
       end

data/test/id3v2_unknown_frames_test.rb

@@ -1,18 +1,20 @@
+# frozen-string-literal: true
+
 require File.join(File.dirname(__FILE__), 'helper')
 
 class TestID3v2UnknownFrames < Test::Unit::TestCase
-  context "UnknownFrame" do
+  context 'UnknownFrame' do
     setup do
       read_properties = false
-      @file = TagLib::MPEG::File.new("test/data/sample.mp3", read_properties)
+      @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")
+    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")
+      frames = @tag.frame_list('TDAT')
       tdat = frames.first
       assert_not_nil tdat
       # By looking at ID alone, it would have returned a