taglib-ruby 0.1.0

data/ext/valgrind-suppressions.txt

@@ -0,0 +1,170 @@
+{
+   taglib_base SWIG_InitializeModule
+   exp-ptrcheck:SorG
+   fun:Init_taglib_base
+   fun:dln_load
+}
+{
+   taglib_id3v2 SWIG_InitializeModule
+   exp-ptrcheck:SorG
+   fun:Init_taglib_id3v2
+   fun:dln_load
+}
+{
+   taglib_mpeg SWIG_InitializeModule
+   exp-ptrcheck:SorG
+   fun:Init_taglib_mpeg
+   fun:dln_load
+}
+# Ruby 1.9 VM supressions
+{
+   r1
+   Memcheck:Cond
+   fun:gc_mark
+}
+{
+   r2
+   Memcheck:Cond
+   fun:gc_mark_children
+}
+{
+   r3
+   Memcheck:Cond
+   fun:mark_current_machine_context
+}
+{
+   r4
+   Memcheck:Value8
+   fun:gc_mark
+}
+{
+   r5
+   Memcheck:Value8
+   fun:gc_mark_children
+}
+{
+   r6
+   Memcheck:Value8
+   fun:mark_current_machine_context
+}
+{
+   r7
+   Memcheck:Value8
+   fun:vm_exec_core
+}
+{
+   r8
+   Memcheck:Value4
+   fun:find_derivation
+}
+{
+   r9
+   Memcheck:Value8
+   fun:__gconv_read_conf
+}
+{
+   r10
+   Memcheck:Leak
+   fun:malloc
+   fun:vm_xmalloc
+   fun:ruby_strdup
+}
+{
+   r11
+   Memcheck:Leak
+   fun:malloc
+   fun:vm_xmalloc
+   fun:rb_include_module
+}
+{
+   r12
+   Memcheck:Leak
+   ...
+   fun:ruby_init
+   fun:main
+}
+{
+   r20
+   exp-ptrcheck:SorG
+   fun:insert_module
+}
+{
+   r21
+   exp-ptrcheck:SorG
+   fun:find_derivation
+}
+{
+   r22
+   exp-ptrcheck:SorG
+   fun:vm_exec_core
+}
+{
+   r23
+   exp-ptrcheck:SorG
+   fun:__gconv_read_conf
+}
+{
+   r24
+   exp-ptrcheck:SorG
+   fun:mark_current_machine_context
+}
+# Ruby 1.8 suppressions
+{
+   r18_1
+   Memcheck:Cond
+   fun:mark_locations_array
+   ...
+   fun:yycompile
+}
+{
+   r18_2
+   Memcheck:Cond
+   fun:mark_locations_array
+   ...
+   fun:rb_eval
+}
+{
+   r18_3
+   Memcheck:Leak
+   fun:malloc
+   fun:ruby_xmalloc
+   fun:scope_dup
+}
+{
+   r18_4
+   Memcheck:Leak
+   fun:malloc
+   ...
+   fun:yycompile
+}
+{
+   r18_5
+   exp-ptrcheck:SorG
+   fun:mark_locations_array
+   fun:garbage_collect
+   ...
+   fun:yycompile
+}
+{
+   r18_6
+   exp-ptrcheck:Heap
+   ...
+   fun:rb_intern
+   fun:rb_str_intern
+   fun:rb_to_id
+   fun:rb_mod_alias_method
+}
+{
+   r18_7
+   exp-ptrcheck:SorG
+   fun:ruby_yyparse
+   fun:yycompile
+}
+{
+   r18_8
+   exp-ptrcheck:SorG
+   fun:ruby_re_compile_pattern
+   fun:rb_reg_initialize
+   ...
+   fun:rb_class_new_instance
+}

data/lib/taglib.rb

@@ -0,0 +1,3 @@
+require 'taglib/base'
+require 'taglib/mpeg'
+require 'taglib/id3v2'

data/lib/taglib/base.rb

@@ -0,0 +1 @@
+require 'taglib_base'

data/lib/taglib/id3v2.rb

@@ -0,0 +1,42 @@
+require 'taglib_id3v2'
+
+module TagLib
+  module ID3v2
+    class FrameList
+      include Enumerable
+
+      def each
+        it = self.begin
+        it_end = self.end
+        while it != it_end
+          frame = it.value
+          casted_frame = frame.cast
+          yield casted_frame
+          it = it.next
+        end
+      end
+    end
+    class Frame
+      def to_s
+        to_string
+      end
+      def cast
+        case frame_id
+        when "APIC" then to_attached_picture_frame
+        when "COMM" then to_comments_frame
+        when "GEOB" then to_general_encapsulated_object_frame
+        when "POPM" then to_popularimeter_frame
+        when "PRIV" then to_private_frame
+        when "RVAD" then to_relative_volume_frame
+        when "TXXX" then to_user_text_identification_frame
+        when /T.../ then to_text_identification_frame
+        when "UFID" then to_unique_file_identifier_frame
+        when "USLT" then to_unsynchronized_lyrics_frame
+        when "WXXX" then to_user_url_link_frame
+        when /W.../ then to_url_link_frame
+        else self
+        end
+      end
+    end
+  end
+end

data/lib/taglib/mpeg.rb

@@ -0,0 +1 @@
+require 'taglib_mpeg'

data/lib/taglib/version.rb

@@ -0,0 +1,10 @@
+module TagLib
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+    BUILD = nil
+
+    STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
+  end
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'taglib'
+
+HAVE_ENCODING = !RUBY_VERSION.start_with?("1.8")

data/test/test_id3v2_frames.rb

@@ -0,0 +1,93 @@
+require 'helper'
+
+class TestID3v2Frames < Test::Unit::TestCase
+  context "The sample.mp3 file's frames" do
+    setup do
+      read_properties = false
+      # It's important that file is an instance variable, otherwise the
+      # tag would get garbage collected along with the file, even if tag
+      # 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|
+        @picture_data = f.read
+      end
+      @tag = @file.id3v2_tag
+      @frames = @tag.frame_list
+    end
+
+    should "be complete" do
+      assert_not_nil @frames
+      assert_equal 11, @frames.size
+      iterator = @frames.begin
+      frame = iterator.value
+      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
+    end
+
+    should "be automatically converted" do
+      apic = @tag.frame_list('APIC').first
+      comm = @tag.frame_list('COMM').first
+      tit2 = @tag.frame_list('TIT2').first
+      assert_equal TagLib::ID3v2::AttachedPictureFrame, apic.class
+      assert_equal TagLib::ID3v2::CommentsFrame, comm.class
+      assert_equal TagLib::ID3v2::TextIdentificationFrame, tit2.class
+    end
+
+    context "APIC frame" do
+      setup do
+        @apic = @tag.frame_list('APIC').first
+      end
+
+      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
+      end
+
+      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
+        assert_equal @picture_data, @apic.picture
+      end
+    end
+
+    context "TXXX frame" do
+      setup do
+        @txxx_frame = @tag.frame_list('TXXX').first
+      end
+
+      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_s
+      end
+
+      should "be convertable to its concrete type" do
+        txxx = @txxx_frame.to_user_text_identification_frame
+        assert_equal TagLib::ID3v2::UserTextIdentificationFrame, txxx.class
+      end
+
+      should "have field_list" do
+        assert_equal ["MusicBrainz Album Id", "992dc19a-5631-40f5-b252-fbfedbc328a9"], @txxx_frame.field_list
+      end
+    end
+  end
+end

data/test/test_id3v2_memory.rb

@@ -0,0 +1,54 @@
+require 'helper'
+
+class TestID3v2Memory < Test::Unit::TestCase
+
+  N = 1000
+
+  context "TagLib::ID3v2" do
+    setup do
+      @file = TagLib::MPEG::File.new("test/data/sample.mp3", false)
+      @tag = @file.id3v2_tag
+      @apic = @tag.frame_list("APIC").first
+    end
+
+    should "not corrupt memory with FrameList" do
+      N.times do
+        @tag.frame_list
+      end
+    end
+
+    should "not corrupt memory with ByteVector" do
+      data = nil
+      N.times do
+        data = @apic.picture
+      end
+      N.times do
+        @apic.picture = data
+      end
+    end
+
+    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"]
+      end
+    end
+
+    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
+      else
+        raise "GC did not delete file, unsure if test was successful."
+      end
+    end
+  end
+end

data/test/test_id3v2_tag.rb

@@ -0,0 +1,31 @@
+require 'helper'
+
+class TestID3v2Tag < Test::Unit::TestCase
+  context "The sample.mp3 file" do
+    setup do
+      read_properties = false
+      @file = TagLib::MPEG::File.new("test/data/sample.mp3", read_properties)
+    end
+
+    should "have an ID3v2 tag" do
+      assert_not_nil @file.id3v2_tag
+    end
+
+    context "tag" do
+      setup do
+        @tag = @file.id3v2_tag
+      end
+
+      should "have basic properties" do
+        assert_equal 'Dummy Title', @tag.title
+        assert_equal 'Dummy Artist', @tag.artist
+        assert_equal 'Dummy Album', @tag.album
+        assert_equal 'Dummy Comment', @tag.comment
+        assert_equal 'Pop', @tag.genre
+        assert_equal 2000, @tag.year
+        assert_equal 1, @tag.track
+        assert_equal false, @tag.empty?
+      end
+    end
+  end
+end

data/test/test_id3v2_unicode.rb

@@ -0,0 +1,42 @@
+require 'helper'
+
+class TestID3v2Unicode < Test::Unit::TestCase
+  context "The unicode.mp3 file" do
+    setup do
+      read_properties = false
+      @file = TagLib::MPEG::File.new("test/data/unicode.mp3", read_properties)
+    end
+
+    should "have an ID3v2 tag" do
+      assert_not_nil @file.id3v2_tag
+    end
+
+    if HAVE_ENCODING
+      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
+        end
+
+        should "convert strings to the right encoding" do
+          # Unicode Snowman in UTF-16
+          utf16_encoded = "\x26\x03"
+          utf16_encoded.force_encoding("UTF-16BE")
+
+          # It should be converted here
+          @tag.title = utf16_encoded
+
+          result = @tag.title
+
+          # In order for == to work, they have to be in the same
+          # encoding
+          utf8_encoded = utf16_encoded.encode("UTF-8")
+          assert_equal utf8_encoded, result
+        end
+      end
+    end
+  end
+end