taglib-ruby 0.1.1 → 0.2.0

data/lib/taglib.rb

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

data/lib/taglib/id3v2.rb

@@ -2,40 +2,18 @@ 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
+
+      def inspect
+        # Overwrite inspect because Object#inspect calls to_s. In case
+        # of an unlinked frame, calling to_s would lead to calling into
+        # SWIG through to_string, which in turn would raise an exception
+        # with a message including an inspect of this object, which
+        # would call to_s -> stack overflow.
+        "#<%s:0x%x>" % [self.class.to_s, object_id << 1]
       end
     end
   end

data/lib/taglib/version.rb

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

data/taglib-ruby.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "taglib-ruby"
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Robin Stocker"]
-  s.date = "2011-09-17"
+  s.date = "2011-10-22"
   s.description = "Ruby interface for the taglib C++ library.\n\nIn contrast to other libraries, this one wraps the C++ API using SWIG,\nnot only the minimal C API. This means that all tags can be accessed.\n"
   s.email = "robin@nibor.org"
   s.extensions = ["ext/taglib_base/extconf.rb", "ext/taglib_mpeg/extconf.rb", "ext/taglib_id3v2/extconf.rb"]
@@ -18,11 +18,18 @@ Gem::Specification.new do |s|
     "README.md"
   ]
   s.files = [
+    ".yardopts",
+    "CHANGES.md",
     "Gemfile",
     "Gemfile.lock",
+    "Guardfile",
     "LICENSE.txt",
     "README.md",
     "Rakefile",
+    "docs/default/fulldoc/html/css/common.css",
+    "docs/taglib/base.rb",
+    "docs/taglib/id3v2.rb",
+    "docs/taglib/mpeg.rb",
     "ext/Rakefile",
     "ext/extconf_common.rb",
     "ext/taglib_base/extconf.rb",
@@ -30,6 +37,7 @@ Gem::Specification.new do |s|
     "ext/taglib_base/taglib_base.i",
     "ext/taglib_base/taglib_base_wrap.cxx",
     "ext/taglib_id3v2/extconf.rb",
+    "ext/taglib_id3v2/relativevolumeframe.i",
     "ext/taglib_id3v2/taglib_id3v2.i",
     "ext/taglib_id3v2/taglib_id3v2_wrap.cxx",
     "ext/taglib_mpeg/extconf.rb",
@@ -42,15 +50,22 @@ Gem::Specification.new do |s|
     "lib/taglib/mpeg.rb",
     "lib/taglib/version.rb",
     "taglib-ruby.gemspec",
+    "tasks/docs_coverage.rake",
+    "test/data/add-relative-volume.cpp",
+    "test/data/crash.mp3",
     "test/data/globe_east_540.jpg",
+    "test/data/relative-volume.mp3",
     "test/data/sample.mp3",
     "test/data/unicode.mp3",
     "test/helper.rb",
+    "test/test_fileref_properties.rb",
     "test/test_id3v2_frames.rb",
     "test/test_id3v2_memory.rb",
+    "test/test_id3v2_relative_volume.rb",
     "test/test_id3v2_tag.rb",
     "test/test_id3v2_unicode.rb",
     "test/test_id3v2_write.rb",
+    "test/test_mpeg_file.rb",
     "test/test_tag.rb"
   ]
   s.homepage = "http://github.com/robinst/taglib-ruby"
@@ -69,14 +84,18 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
-      s.add_development_dependency(%q<rdoc>, ["~> 3.9"])
+      s.add_development_dependency(%q<yard>, ["~> 0.7"])
+      s.add_development_dependency(%q<redcarpet>, [">= 0"])
+      s.add_development_dependency(%q<guard-test>, ["~> 0.4.0"])
     else
       s.add_dependency(%q<rake-compiler>, ["~> 0.7"])
       s.add_dependency(%q<shoulda>, ["~> 2.11"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_dependency(%q<rcov>, [">= 0"])
-      s.add_dependency(%q<rdoc>, ["~> 3.9"])
+      s.add_dependency(%q<yard>, ["~> 0.7"])
+      s.add_dependency(%q<redcarpet>, [">= 0"])
+      s.add_dependency(%q<guard-test>, ["~> 0.4.0"])
     end
   else
     s.add_dependency(%q<rake-compiler>, ["~> 0.7"])
@@ -84,7 +103,9 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
     s.add_dependency(%q<rcov>, [">= 0"])
-    s.add_dependency(%q<rdoc>, ["~> 3.9"])
+    s.add_dependency(%q<yard>, ["~> 0.7"])
+    s.add_dependency(%q<redcarpet>, [">= 0"])
+    s.add_dependency(%q<guard-test>, ["~> 0.4.0"])
   end
 end
 

data/tasks/docs_coverage.rake

@@ -0,0 +1,26 @@
+desc "Show the coverage of the actual API in ext/ by the API docs in docs/"
+task :docs_coverage do |t|
+  def sort(objects)
+    objects.sort_by { |obj| obj.path }
+  end
+
+  YARD.parse("ext/**/*_wrap.cxx")
+  ext_codeobjects = sort(YARD::Registry.all)
+  YARD::Registry.clear
+  YARD.parse("docs/**/*.rb")
+  docs_codeobjects = sort(YARD::Registry.all(:module, :class, :method))
+
+  only_in_ext = (ext_codeobjects - docs_codeobjects)
+  only_in_docs = (docs_codeobjects - ext_codeobjects)
+
+  unless only_in_ext.empty?
+    puts
+    puts "=== Only in ext (to document): "
+    puts only_in_ext
+  end
+  unless only_in_docs.empty?
+    puts
+    puts "=== Only in docs (typo?): "
+    puts only_in_docs
+  end
+end

data/test/data/add-relative-volume.cpp

@@ -0,0 +1,40 @@
+#include <iostream>
+#include <stdlib.h>
+
+#include <taglib/taglib.h>
+#include <taglib/mpegfile.h>
+#include <taglib/id3v2tag.h>
+#include <taglib/relativevolumeframe.h>
+
+using namespace TagLib;
+
+int main(int argc, char **argv) {
+  if (argc != 2) {
+    std::cout << "usage: " << argv[0] << " file.mp3" << std::endl;
+    exit(1);
+  }
+  char *filename = argv[1];
+
+  MPEG::File file(filename);
+  ID3v2::Tag *tag = file.ID3v2Tag(true);
+
+  ID3v2::RelativeVolumeFrame *rv = new ID3v2::RelativeVolumeFrame();
+
+  rv->setVolumeAdjustmentIndex(512);
+  rv->setVolumeAdjustmentIndex(1024, ID3v2::RelativeVolumeFrame::Subwoofer);
+
+  ID3v2::RelativeVolumeFrame::PeakVolume pv1;
+  pv1.bitsRepresentingPeak = 8;
+  pv1.peakVolume = "A"; // 0x41, 0b01000001
+  rv->setPeakVolume(pv1);
+
+  ID3v2::RelativeVolumeFrame::PeakVolume pv2;
+  pv2.bitsRepresentingPeak = 4;
+  pv2.peakVolume = "?"; // 0x3F, 0b00111111
+  rv->setPeakVolume(pv2, ID3v2::RelativeVolumeFrame::Subwoofer);
+
+  tag->addFrame(rv);
+  file.save();
+}
+
+// vim: set filetype=cpp sw=2 ts=2 expandtab:

data/test/test_fileref_properties.rb

@@ -0,0 +1,21 @@
+require 'helper'
+
+class TestFileRefProperties < Test::Unit::TestCase
+  context "The crash.mp3 file audio properties" do
+    setup do
+      @fileref = TagLib::FileRef.new("test/data/crash.mp3", true, TagLib::AudioProperties::Average)
+      @properties = @fileref.audio_properties
+    end
+
+    should "exist" do
+      assert_not_nil @properties
+    end
+
+    should "contain basic information" do
+      assert_equal 2, @properties.length
+      assert_equal 157, @properties.bitrate
+      assert_equal 44100, @properties.sample_rate
+      assert_equal 2, @properties.channels
+    end
+  end
+end

data/test/test_id3v2_frames.rb

@@ -20,8 +20,7 @@ class TestID3v2Frames < Test::Unit::TestCase
     should "be complete" do
       assert_not_nil @frames
       assert_equal 11, @frames.size
-      iterator = @frames.begin
-      frame = iterator.value
+      frame = @frames.first
       assert_equal "Dummy Title", frame.to_string
     end
 
@@ -35,9 +34,32 @@ class TestID3v2Frames < Test::Unit::TestCase
       apic = @tag.frame_list('APIC').first
       comm = @tag.frame_list('COMM').first
       tit2 = @tag.frame_list('TIT2').first
+      txxx = @tag.frame_list('TXXX').first
       assert_equal TagLib::ID3v2::AttachedPictureFrame, apic.class
       assert_equal TagLib::ID3v2::CommentsFrame, comm.class
       assert_equal TagLib::ID3v2::TextIdentificationFrame, tit2.class
+      assert_equal TagLib::ID3v2::UserTextIdentificationFrame, txxx.class
+    end
+
+    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
+      end
+    end
+
+    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
     end
 
     context "APIC frame" do
@@ -77,12 +99,7 @@ class TestID3v2Frames < Test::Unit::TestCase
 
       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
+        assert_equal expected, @txxx_frame.to_string
       end
 
       should "have field_list" do

data/test/test_id3v2_relative_volume.rb

@@ -0,0 +1,57 @@
+require 'helper'
+
+class TestID3v2RelativeVolumeFrame < Test::Unit::TestCase
+  context "The relative-volume.mp3 RVA2 frame" do
+    setup do
+      @file = TagLib::MPEG::File.new("test/data/relative-volume.mp3")
+      @tag = @file.id3v2_tag
+      @rv = @tag.frame_list('RVA2').first
+    end
+
+    should "exist" do
+      assert_not_nil @rv
+    end
+
+    should "have channels" do
+      expected = [TagLib::ID3v2::RelativeVolumeFrame::MasterVolume, TagLib::ID3v2::RelativeVolumeFrame::Subwoofer]
+      assert_equal expected, @rv.channels
+    end
+
+    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
+      master_pv = @rv.peak_volume
+      assert_equal 8, master_pv.bits_representing_peak
+      assert_equal 0b01000001.chr, master_pv.peak_volume
+
+      subwoofer_pv = @rv.peak_volume(TagLib::ID3v2::RelativeVolumeFrame::Subwoofer)
+      assert_equal 4, subwoofer_pv.bits_representing_peak
+      assert_equal 0b00111111.chr, subwoofer_pv.peak_volume
+    end
+
+    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
+      pv = TagLib::ID3v2::PeakVolume.new
+      assert_equal 0, pv.bits_representing_peak
+      assert_equal "", pv.peak_volume
+      pv.bits_representing_peak = 6
+      pv.peak_volume = 0b110111.chr
+      @rv.set_peak_volume(pv, TagLib::ID3v2::RelativeVolumeFrame::BackLeft)
+
+      pv2 = @rv.peak_volume(TagLib::ID3v2::RelativeVolumeFrame::BackLeft)
+      assert_equal 6, pv2.bits_representing_peak
+      assert_equal 0b110111.chr, pv2.peak_volume
+    end
+  end
+end

data/test/test_id3v2_tag.rb

@@ -28,4 +28,27 @@ class TestID3v2Tag < Test::Unit::TestCase
       end
     end
   end
+
+  context "A new ID3v2::Tag" do
+    setup do
+      @tag = TagLib::ID3v2::Tag.new
+    end
+
+    should "be empty" do
+      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
+    end
+
+    should "have 0 for numeric attributes" do
+      assert_equal 0, @tag.track
+      assert_equal 0, @tag.year
+    end
+  end
 end

data/test/test_mpeg_file.rb

@@ -0,0 +1,49 @@
+require 'helper'
+
+class TestMPEGFile < Test::Unit::TestCase
+  context "The crash.mp3 file" do
+    setup do
+      read_properties = true
+      @file = TagLib::MPEG::File.new("test/data/crash.mp3", read_properties)
+    end
+
+    context "audio properties" do
+      setup do
+        @properties = @file.audio_properties
+      end
+
+      should "be MPEG audio properties" do
+        assert_equal TagLib::MPEG::Properties, @properties.class
+      end
+
+      should "contain information" do
+        assert_equal 2, @properties.length
+        assert_equal 157, @properties.bitrate
+        assert_equal 44100, @properties.sample_rate
+        assert_equal 2, @properties.channels
+        assert_equal TagLib::MPEG::Header::Version1, @properties.version
+        assert_equal 3, @properties.layer
+        assert_equal false, @properties.protection_enabled
+        assert_equal TagLib::MPEG::Header::JointStereo, @properties.channel_mode
+        assert_equal false, @properties.copyrighted?
+        assert_equal true, @properties.original?
+      end
+
+      context "Xing header" do
+        setup do
+          @xing_header = @properties.xing_header
+        end
+
+        should "exist" do
+          assert_not_nil @xing_header
+        end
+
+        should "contain information" do
+          assert_true @xing_header.valid?
+          assert_equal 88, @xing_header.total_frames
+          assert_equal 45140, @xing_header.total_size
+        end
+      end
+    end
+  end
+end