id3lib-ruby 0.6.0-x86-mswin32-60

data/test/test_reading.rb

@@ -0,0 +1,82 @@
+
+require 'test/unit'
+require 'id3lib'
+
+
+class TestReading < Test::Unit::TestCase
+
+  def setup
+    @tag = ID3Lib::Tag.new('test/data/sample.mp3')
+  end
+
+  def test_array
+    assert_equal 'Dummy Title',     @tag[0][:text]
+    assert_equal 'Dummy Artist',    @tag[1][:text]
+    assert_equal 'Dummy Album',     @tag[2][:text]
+    assert_equal '1/10',            @tag[3][:text]
+    assert_equal '2000',            @tag[4][:text]
+    assert_equal 'Dummy Comment',   @tag[5][:text]
+    assert_equal 'Dummy Comment 2', @tag[6][:text]
+    assert_equal 'Pop',             @tag[7][:text]
+  end
+
+  def test_direct_access
+    assert_equal 'Dummy Title',   @tag.title
+    assert_equal 'Dummy Artist',  @tag.artist
+    assert_equal 'Dummy Artist',  @tag.performer
+    assert_equal 'Dummy Album',   @tag.album
+    assert_equal '1/10',          @tag.track
+    assert_equal '2000',          @tag.year
+    assert_equal 'Dummy Comment', @tag.comment
+    assert_equal 'Pop',           @tag.genre
+  end
+
+  def test_frame_text
+    assert_equal 'Dummy Title',   @tag.frame_text(:TIT2)
+    assert_equal 'Dummy Artist',  @tag.frame_text(:TPE1)
+    assert_equal 'Dummy Album',   @tag.frame_text(:TALB)
+    assert_equal '1/10',          @tag.frame_text(:TRCK)
+    assert_equal '2000',          @tag.frame_text(:TYER)
+    assert_equal 'Dummy Comment', @tag.frame_text(:COMM)
+    assert_equal 'Pop',           @tag.frame_text(:TCON)
+    assert_equal nil,             @tag.frame_text(:AENC)
+  end
+
+  def test_user_frame_text
+    album_id = @tag.user_frame_text('MusicBrainz Album Id')
+    assert_equal '992dc19a-5631-40f5-b252-fbfedbc328a9', album_id
+    assert_equal nil, @tag.user_frame_text('Inexistent')
+  end
+
+  def test_comments
+    one, two = @tag.comment_frames
+    assert_not_nil one
+    assert_not_nil two
+    assert_equal 'Dummy Comment',   one[:text]
+    assert_equal 'Dummy Comment 2', two[:text]
+  end
+
+  def test_has_tag
+    assert @tag.has_tag?(ID3Lib::V1)
+    assert @tag.has_tag?(ID3Lib::V2)
+  end
+
+  def test_size
+    assert_equal 2038, @tag.size
+  end
+
+  def test_invalid_frames
+    assert_nil @tag.invalid_frames
+
+    @tag << { :id => :TITS }
+    assert_equal [[:TITS]], @tag.invalid_frames
+
+    @tag << { :id => :TALB, :invalid => 'text' }
+    assert_equal [[:TITS], [:TALB, :invalid]], @tag.invalid_frames
+
+    @tag << { :id => :APIC, :text => 'invalid' }
+    assert_equal [[:TITS], [:TALB, :invalid], [:APIC, :text]],
+      @tag.invalid_frames
+  end
+
+end

data/test/test_unicode.rb

@@ -0,0 +1,85 @@
+
+require 'test/unit'
+require 'fileutils'
+require 'id3lib'
+
+
+class TestUnicode < Test::Unit::TestCase
+
+  Sample = 'test/data/sample.mp3'
+  Temp   = 'test/data/tmp.sample.mp3'
+
+  def setup
+    FileUtils.cp Sample, Temp
+    @tag = ID3Lib::Tag.new(Temp)
+  end
+
+  def teardown
+    FileUtils.rm Temp
+  end
+
+  # Failing because of id3lib.
+  def dont_test_UTF16BE
+    do_unicode_test :text => "\x4f\x60\x59\x7d", :textenc => 2
+  end
+
+  def test_UTF16LE
+    do_unicode_test :text => "\x60\x4f\x7d\x59", :textenc => 1
+  end
+
+  # Failing because of id3lib.
+  def dont_test_UTF16BE_with_BOM
+    do_unicode_test :text => "\xfe\xff\x4f\x60\x59\x7d", :textenc => 1
+  end
+
+  def test_UTF16LE_with_BOM
+    do_unicode_test :text => "\xff\xfe\x60\x4f\x7d\x59", :textenc => 1
+  end
+
+  # Failing because of id3lib.
+  def dont_test_UTF16BE_above_127
+    do_unicode_test :text => "\xfe\xffC\346", :textenc => 1
+  end
+
+  def test_UTF16LE_above_127
+    do_unicode_test :text => "\xe6C", :textenc => 1
+  end
+
+  def test_UTF16LE_above_127_with_BOM
+    do_unicode_test :text => "\xff\xfe\xe6C", :textenc => 1
+  end
+
+  def test_reading
+    @tag = ID3Lib::Tag.new('test/data/unicode.mp3', ID3Lib::V2)
+    assert_equal "\x4f\x60\x59\x7d", @tag.title
+  end
+
+  def test_reading_lyrics
+    @tag = ID3Lib::Tag.new('test/data/unicode.mp3', ID3Lib::V2)
+    lyrics = @tag.find{ |f| f[:id] == :USLT }
+    assert_equal 1, lyrics[:textenc]
+    assert_equal "zho", lyrics[:language]
+    # This is "U+6771 U+4EAC" (Tokyo) in UTF-16BE
+    tokyo = "\x67\x71\x4e\xac"
+    assert_equal tokyo, lyrics[:text]
+  end
+
+  def test_invalid_data
+    nonstr = 1
+    @tag.reject!{ |f| f[:id] == :TIT2 }
+    @tag << {:id => :TIT2, :text => nonstr, :textenc => 1}
+    assert_raise(TypeError) { @tag.update!(ID3Lib::V2) }
+  end
+
+  def do_unicode_test(opts)
+    frame = {:id => :TIT2}
+    frame.update(opts)
+    @tag.title = nil
+    @tag << frame
+    @tag.update!(ID3Lib::V2)
+    assert_equal frame, @tag.frame(:TIT2)
+    @tag = ID3Lib::Tag.new(Temp, ID3Lib::V2)
+    assert_equal frame, @tag.frame(:TIT2)
+  end
+
+end

data/test/test_writing.rb

@@ -0,0 +1,221 @@
+
+require 'test/unit'
+require 'fileutils'
+require 'id3lib'
+
+
+class TestWriting < Test::Unit::TestCase
+
+  Sample = 'test/data/sample.mp3'
+  Temp   = 'test/data/tmp.sample.mp3'
+
+  def setup
+    FileUtils.cp Sample, Temp
+    reload!
+  end
+
+  def teardown
+    FileUtils.rm Temp
+  end
+
+  def reload!(*args)
+    @tag = ID3Lib::Tag.new(Temp, *args)
+  end
+
+  # Test the title direct access. The others like performer or album
+  # work alike
+  def test_title
+    @tag.title = 'New Title'
+    assert_equal 'New Title', @tag.title
+    @tag.update!
+    assert_equal 'New Title', @tag.title
+    reload!
+    assert_equal 'New Title', @tag.title
+  end
+
+  def test_genre
+    @tag.genre = 'Rock'
+    assert_equal 'Rock', @tag.genre
+    @tag.update!
+    assert_equal 'Rock', @tag.genre
+    reload!
+    assert_equal 'Rock', @tag.genre
+  end
+
+  def test_id3v1_genre
+    @tag.strip!(ID3Lib::V2)
+    genre_id = '(' + ID3Lib::Info::Genres.index('Rock').to_s + ')'
+    @tag.genre = genre_id
+    assert_equal genre_id, @tag.genre
+    @tag.update!(ID3Lib::V1)
+    assert_equal genre_id, @tag.genre
+    reload!(ID3Lib::V1)
+    assert_equal genre_id, @tag.genre
+  end
+
+  def test_track
+    @tag.track = '4'
+    assert_equal '4', @tag.track
+    @tag.update!
+    assert_equal '4', @tag.track
+    reload!
+    assert_equal '4', @tag.track
+
+    @tag.track = '5/12'
+    assert_equal '5/12', @tag.track
+    @tag.update!
+    assert_equal '5/12', @tag.track
+    reload!
+    assert_equal '5/12', @tag.track
+
+    @tag.track = 6
+    assert_equal '6', @tag.track
+    @tag.update!
+    assert_equal '6', @tag.track
+    reload!
+    assert_equal '6', @tag.track
+  end
+
+  def test_year
+    @tag.year = '2001'
+    assert_equal '2001', @tag.year
+    @tag.update!
+    assert_equal '2001', @tag.year
+    reload!
+    assert_equal '2001', @tag.year
+
+    @tag.year = 2002
+    assert_equal '2002', @tag.year
+    @tag.update!
+    assert_equal '2002', @tag.year
+    reload!
+    assert_equal '2002', @tag.year
+  end
+
+  def test_comments
+    @tag.comment = 'New Comment'
+    assert_equal 'New Comment', @tag.comment
+    assert_equal 1, @tag.comment_frames.length
+    one = @tag.comment_frames.first
+    assert_equal 'New Comment', one[:text]
+    
+    @tag.update!
+    assert_equal 'New Comment', @tag.comment
+    
+    reload!
+    assert_equal 'New Comment', @tag.comment
+  end
+
+  def test_manual_frame
+    @tag << {:id => :TLAN, :text => 'zho'}
+    assert_equal 'zho', @tag.frame_text(:TLAN)
+    @tag.update!
+    assert_equal 'zho', @tag.frame_text(:TLAN)
+    reload!
+    assert_equal 'zho', @tag.frame_text(:TLAN)
+  end
+
+  def test_apic
+    pic = {
+      :id           => :APIC,
+      :mimetype     => 'image/jpeg',
+      :imageformat  => '',
+      :picturetype  => 3,
+      :description  => 'A pretty picture.',
+      :textenc      => 0,
+      :data         => File.read('test/data/cover.jpg')
+    }
+    @tag << pic
+    @tag.update!
+    assert_equal pic, @tag.frame(:APIC)
+    reload!
+    assert_equal pic, @tag.frame(:APIC)
+  end
+
+  def test_remove_frame
+    @tag.remove_frame(:TIT2)
+    assert_nil @tag.frame(:TIT2)
+  end
+
+  def test_remove_frame_with_direct_access
+    @tag.title = nil
+    assert_nil @tag.frame(:TIT2)
+  end
+
+  def test_wrong_frame
+    l = @tag.length
+    @tag << {:id => :WRONG, :text => "Test"}
+    @tag.update!
+    assert_equal l, @tag.length
+    reload!
+    assert_equal l, @tag.length
+  end
+
+  def test_strip
+    @tag.strip!
+    assert @tag.empty?
+    reload!
+    assert @tag.empty?
+  end
+
+  def test_tagtype
+    @tag.strip!(ID3Lib::V1)
+    reload!(ID3Lib::V1)
+    assert @tag.empty?
+    reload!
+    assert !@tag.empty?
+    @tag.strip!(ID3Lib::V2)
+    reload!(ID3Lib::V2)
+    assert @tag.empty?
+    reload!
+    assert @tag.empty?
+  end
+
+  def test_padding
+    assert_equal 2176, File.size(Temp)
+    @tag.padding = false
+    @tag.update!
+    assert_equal 416, File.size(Temp)
+  end
+
+  def test_failing_update
+    # Note filename which is a directory -> update! should fail
+    @tag = ID3Lib::Tag.new("test/data/")
+    @tag.performer = "Nobody"
+    assert_equal nil, @tag.update!
+  end
+
+  def test_accessors
+    accessors = %w[
+      title performer album genre year track part_of_set comment composer
+      grouping bpm subtitle date time language lyrics lyricist band
+      conductor interpreted_by publisher encoded_by
+    ]
+    do_tests_for_accessors(accessors)
+  end
+
+  def test_accessor_aliases
+    aliases = %w[ artist content_type disc remixed_by ]
+    do_tests_for_accessors(aliases)
+  end
+
+  def do_tests_for_accessors(accessors)
+    accessors.each do |m|
+      @tag.send("#{m}=", "#{m} test")
+      assert_equal "#{m} test", @tag.send(m)
+    end
+
+    @tag.update!
+
+    accessors.each do |m|
+      assert_equal "#{m} test", @tag.send(m)
+    end
+
+    reload!
+
+    accessors.each do |m|
+      assert_equal "#{m} test", @tag.send(m)
+    end
+  end
+
+end

data/usage.rb

@@ -0,0 +1,40 @@
+
+require 'rubygems'
+require 'id3lib'
+
+# Load a tag from a file
+tag = ID3Lib::Tag.new('talk.mp3')
+
+# Get and set text frames with convenience methods
+tag.title  #=> "Talk"
+tag.album = 'X&Y'
+tag.track = '5/13'
+
+# Tag is a subclass of Array and each frame is a Hash
+tag[0]
+#=> { :id => :TPE1, :textenc => 0, :text => "Coldplay" }
+
+# Get the number of frames
+tag.length  #=> 7
+
+# Remove all comment frames
+tag.delete_if{ |frame| frame[:id] == :COMM }
+
+# Get info about APIC frame to see which fields are allowed
+ID3Lib::Info.frame(:APIC)
+#=> [ 2, :APIC, "Attached picture",
+#=>   [:textenc, :mimetype, :picturetype, :description, :data] ]
+
+# Add an attached picture frame
+cover = {
+  :id          => :APIC,
+  :mimetype    => 'image/jpeg',
+  :picturetype => 3,
+  :description => 'A pretty picture',
+  :textenc     => 0,
+  :data        => File.read('cover.jpg')
+}
+tag << cover
+
+# Last but not least, apply changes
+tag.update!

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification 
+name: id3lib-ruby
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 6
+  - 0
+  version: 0.6.0
+platform: x86-mswin32-60
+authors: 
+- Robin Stocker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-16 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: |
+  = id3lib-ruby
+  
+  id3lib-ruby provides a Ruby interface to the id3lib C++ library for easily
+  editing ID3 tags (v1 and v2) of MP3 audio files.
+  
+  The class documentation starts at ID3Lib::Tag.
+  
+  
+  == Features
+  
+  * Read and write ID3v1 and ID3v2 tags
+  * Simple interface for adding, changing and removing frames
+  * Quick access to common text frames like title and performer
+  * Custom data frames like attached picture (APIC)
+  * Pretty complete coverage of id3lib's features
+  * UTF-16 support (warning: id3lib writes broken UTF-16 frames)
+  * Windows binary gem available
+  
+  The CHANGES file contains a list of changes between versions.
+  
+  
+  == Installation
+  
+  See INSTALL.
+  
+  
+  == Online Information
+  
+  The home of id3lib-ruby is http://id3lib-ruby.rubyforge.org
+  
+  
+  == Usage
+  
+    require 'rubygems'
+    require 'id3lib'
+    
+    # Load a tag from a file
+    tag = ID3Lib::Tag.new('talk.mp3')
+    
+    # Get and set text frames with convenience methods
+    tag.title  #=> "Talk"
+    tag.album = 'X&Y'
+    tag.track = '5/13'
+    
+    # Tag is a subclass of Array and each frame is a Hash
+    tag[0]
+    #=> { :id => :TPE1, :textenc => 0, :text => "Coldplay" }
+    
+    # Get the number of frames
+    tag.length  #=> 7
+    
+    # Remove all comment frames
+    tag.delete_if{ |frame| frame[:id] == :COMM }
+    
+    # Get info about APIC frame to see which fields are allowed
+    ID3Lib::Info.frame(:APIC)
+    #=> [ 2, :APIC, "Attached picture",
+    #=>   [:textenc, :mimetype, :picturetype, :description, :data] ]
+    
+    # Add an attached picture frame
+    cover = {
+      :id          => :APIC,
+      :mimetype    => 'image/jpeg',
+      :picturetype => 3,
+      :description => 'A pretty picture',
+      :textenc     => 0,
+      :data        => File.read('cover.jpg')
+    }
+    tag << cover
+    
+    # Last but not least, apply changes
+    tag.update!
+  
+  
+  == Licence
+  
+  This library has Ruby's licence:
+  
+  http://www.ruby-lang.org/en/LICENSE.txt
+  
+  
+  == Author
+  
+  Robin Stocker <robinstocker at rubyforge.org>
+
+email: robinstocker@rubyforge.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- INSTALL
+- TODO
+- CHANGES
+files: 
+- lib/id3lib/accessors.rb
+- lib/id3lib/info.rb
+- lib/id3lib.rb
+- test/test_unicode.rb
+- test/test_writing.rb
+- test/test_reading.rb
+- test/data/sample.mp3
+- test/data/unicode.mp3
+- test/data/cover.jpg
+- Rakefile
+- usage.rb
+- setup.rb
+- ext/id3lib_api/extconf.rb
+- ext/id3lib_api/id3lib_api_wrap.cxx
+- ext/id3lib_api/id3lib_api.i
+- ext/id3lib_api/Rakefile
+- README
+- INSTALL
+- TODO
+- CHANGES
+- lib/id3lib_api.so
+has_rdoc: true
+homepage: http://id3lib-ruby.rubyforge.org
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --line-numbers
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: 
+- id3lib C++ library
+rubyforge_project: id3lib-ruby
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: id3lib-ruby provides a Ruby interface to the id3lib C++ library for easily editing ID3 tags (v1 and v2) of MP3 audio files.
+test_files: 
+- test/test_unicode.rb
+- test/test_writing.rb
+- test/test_reading.rb