id3lib-ruby 0.4.0 → 0.4.1

data/CHANGES

@@ -1,10 +1,15 @@
 = id3lib-ruby changes
 
+=== 0.4.1 (r53)
+
+* Added :description to the allowed fields of :TXXX frames (patch 5484).
+* Added more tests and a warning in README for writing of UTF-16 frames.
+
 === 0.4.0 (r41)
 
 * Fixed Unicode problems (bug 4768).
 * Renamed ID3Lib::API methods to be more like the id3lib method names.
-  For example, the GetType() method is now named get_type instead of type.
+  E.g. the GetType() method is now named get_type instead of type.
 
 === 0.3.1 (r32)
 

data/README

@@ -1,4 +1,3 @@
-
 = id3lib-ruby
 
 id3lib-ruby provides a Ruby interface to the id3lib C++ library for easily
@@ -9,12 +8,12 @@ The class documentation starts at ID3Lib::Tag.
 
 == Features
 
-* Read and write ID3v1 or ID3v2 tags
+* 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
+* UTF-16 support (warning: id3lib writes broken UTF-16 frames)
 * Windows binary gem available
 
 See TODO for planned features.
@@ -40,6 +39,7 @@ Manual installation:
 
   ruby setup.rb
 
+
 == Usage
 
   require 'rubygems'

data/Rakefile

@@ -10,7 +10,7 @@ require 'rake/testtask'
 require 'rake/rdoctask'
 
 
-PKG_VERSION = '0.4.0'
+PKG_VERSION = '0.4.1'
 
 FILES_COMMON = FileList[
   'lib/**/*.rb',
@@ -109,7 +109,7 @@ task :web => [:web_doc] do
   puts "scp -r web/doc robinstocker@rubyforge.org:/var/www/gforge-projects/id3lib-ruby/"
 end
 
-desc "Generate RDOC documentation on web."
+desc "Generate RDOC documentation for web."
 Rake::RDocTask.new :web_doc do |rdoc|
   rdoc.rdoc_dir = 'web/doc'
   rdoc.title = 'id3lib-ruby'

data/TODO

@@ -1,4 +1,6 @@
 = id3lib-ruby to-do list
 
-* Evaluate a more object-oriented way to handle frames, instead of hashes.
+* Evaluate an object-oriented way to handle frames, instead of with hashes.
+* Make the update! method intelligent, because the call of strip each time
+  is very slow and stupid.
 * Add UTF-8 support if id3lib can handle it.

data/ext/id3lib_api.i

@@ -112,16 +112,16 @@ public:
 
 		VALUE get_unicode()
 		{
-			const char *string = (const char *)self->GetRawUnicodeText();
-			if (string == NULL) return rb_str_new("", 0);
+			const char *str = (const char *)self->GetRawUnicodeText();
+			if (str == NULL) return rb_str_new("", 0);
 			long size = self->Size();
-			if (size >= 2 && string[size-2] == '\0' && string[size-1] == '\0') {
+			if (size >= 2 && str[size-2] == '\0' && str[size-1] == '\0') {
 				// id3lib seems to be inconsistent: the Unicode strings
 				// don't always end in 0x0000. If they do, we don't want these
 				// trailing bytes.
 				size -= 2;
 			}
-			return rb_str_new(string, size);
+			return rb_str_new(str, size);
 		}
 	}
 

data/ext/id3lib_api_wrap.cxx

@@ -1808,16 +1808,16 @@ SWIGINTERN VALUE ID3_Field_get_binary(ID3_Field *self){
 			return rb_str_new((const char *)self->GetRawBinary(), self->Size());
 		}
 SWIGINTERN VALUE ID3_Field_get_unicode(ID3_Field *self){
-			const char *string = (const char *)self->GetRawUnicodeText();
-			if (string == NULL) return rb_str_new("", 0);
+			const char *str = (const char *)self->GetRawUnicodeText();
+			if (str == NULL) return rb_str_new("", 0);
 			long size = self->Size();
-			if (size >= 2 && string[size-2] == '\0' && string[size-1] == '\0') {
+			if (size >= 2 && str[size-2] == '\0' && str[size-1] == '\0') {
 				// id3lib seems to be inconsistent: the Unicode strings
 				// don't always end in 0x0000. If they do, we don't want these
 				// trailing bytes.
 				size -= 2;
 			}
-			return rb_str_new(string, size);
+			return rb_str_new(str, size);
 		}
 SWIGINTERN size_t ID3_Field_set_binary(ID3_Field *self,VALUE data){
 			StringValue(data);

data/lib/id3lib/info.rb

@@ -142,7 +142,7 @@ module ID3Lib
       [76, :TSRC, "ISRC (international standard recording code)", [:textenc, :text]],
       [77, :TSSE, "Software/Hardware and settings used for encoding", [:textenc, :text]],
       [78, :TSST, "Set subtitle", [:textenc, :text]],
-      [79, :TXXX, "User defined text information", [:textenc, :text]],
+      [79, :TXXX, "User defined text information", [:textenc, :description, :text]],
       [80, :TYER, "Year", [:textenc, :text]],
       # Special frames again
       [81, :UFID, "Unique file identifier", [:owner, :data]],

data/test/test_reading.rb

@@ -39,11 +39,6 @@ class TestReading < Test::Unit::TestCase
     assert_equal 'Dummy Comment 2', two[:text]
   end
 
-  def test_unicode
-    @tag = ID3Lib::Tag.new('test/data/unicode.mp3', ID3Lib::V2)
-    assert_equal "\x4f\x60\x59\x7d", @tag.title
-  end
-
   def test_has_tag
     assert @tag.has_tag?(ID3Lib::V1)
     assert @tag.has_tag?(ID3Lib::V2)

data/test/test_unicode.rb

@@ -0,0 +1,75 @@
+
+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_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

@@ -32,7 +32,7 @@ class TestWriting < Test::Unit::TestCase
     reload!
     assert_equal 'New Title', @tag.title
   end
-  
+
   def test_genre
     @tag.genre = 'Rock'
     assert_equal 'Rock', @tag.genre
@@ -41,7 +41,7 @@ class TestWriting < Test::Unit::TestCase
     reload!
     assert_equal 'Rock', @tag.genre
   end
-  
+
   def test_id3v1_genre
     @tag.strip!(ID3Lib::V2)
     genre_id = '(' + ID3Lib::Info::Genres.index('Rock').to_s + ')'
@@ -75,7 +75,7 @@ class TestWriting < Test::Unit::TestCase
     reload!
     assert_equal '6', @tag.track
   end
-  
+
   def test_year
     @tag.year = '2001'
     assert_equal '2001', @tag.year
@@ -105,7 +105,7 @@ class TestWriting < Test::Unit::TestCase
     reload!
     assert_equal 'New Comment', @tag.comment
   end
-  
+
   def test_manual_frame
     @tag << {:id => :TLAN, :text => 'zho'}
     assert_equal 'zho', @tag.frame_text(:TLAN)
@@ -114,7 +114,7 @@ class TestWriting < Test::Unit::TestCase
     reload!
     assert_equal 'zho', @tag.frame_text(:TLAN)
   end
-  
+
   def test_apic
     pic = {
       :id           => :APIC,
@@ -130,17 +130,17 @@ class TestWriting < Test::Unit::TestCase
     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"}
@@ -149,14 +149,14 @@ class TestWriting < Test::Unit::TestCase
     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)
@@ -169,30 +169,6 @@ class TestWriting < Test::Unit::TestCase
     reload!
     assert @tag.empty?
   end
-  
-  def test_unicode
-    nihao = "\x4f\x60\x59\x7d"
-    frame = {
-      :id          => :COMM,
-      :text        => nihao,
-      :description => nihao,
-      :language    => "zho",
-      :textenc     => 1
-    }
-    @tag.comment = nil
-    @tag << frame
-    @tag.update!(ID3Lib::V2)
-    assert_equal frame, @tag.frame(:COMM)
-    reload!(ID3Lib::V2)
-    assert_equal frame, @tag.frame(:COMM)
-  end
-
-  def test_unicode_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 test_padding
     assert_equal 2176, File.size(Temp)

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.99
+rubygems_version: 0.9.0
 specification_version: 1
 name: id3lib-ruby
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
-date: 2006-06-27 00:00:00 +02:00
+  version: 0.4.1
+date: 2006-08-24 00:00:00 +02:00
 summary: id3lib-ruby provides a Ruby interface to the id3lib C++ library for easily editing ID3 tags (v1 and v2) like with pyid3lib.
 require_paths: 
 - lib
@@ -32,6 +32,7 @@ files:
 - lib/id3lib.rb
 - lib/id3lib/accessors.rb
 - lib/id3lib/info.rb
+- test/test_unicode.rb
 - test/test_writing.rb
 - test/test_reading.rb
 - test/data/sample.mp3
@@ -49,6 +50,7 @@ files:
 - CHANGES
 - TODO
 test_files: 
+- test/test_unicode.rb
 - test/test_writing.rb
 - test/test_reading.rb
 rdoc_options: