apetag 1.1.3 → 1.1.4

data/apetag.rb

@@ -11,10 +11,8 @@
 # used on any file type and is not limited to storing just audio file metadata).
 #
 # The module is in written in pure Ruby, so it should be useable on all 
-# platforms that Ruby supports.  It is developed and tested on OpenBSD.  
-# The minimum Ruby version required should be 1.8, but it has only been tested
-# on 1.8.4+.  Modifying the code to work with previous version shouldn't be
-# difficult, though there aren't any plans to do so.
+# platforms that Ruby supports.  It is developed and tested on OpenBSD
+# with ruby 1.8 and ruby 1.9.
 #
 # General Use:
 #
@@ -44,26 +42,6 @@
 # from the latest release.
 #
 # (1) http://wiki.hydrogenaudio.org/index.php?title=APEv2_specification
-#
-# Copyright (c) 2007 Jeremy Evans
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy 
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights 
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
-# copies of the Software, and to permit persons to whom the Software is 
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in 
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 
-# SOFTWARE.
 
 require 'cicphash'
 
@@ -106,7 +84,7 @@ class ApeItem < Array
     raise ApeTagError, "Missing key-value separator at offset #{offset}" unless key_end
     raise ApeTagError, "Invalid item length at offset #{offset}" if (next_item_start=length + key_end + 1) > data.length
     begin
-      item = ApeItem.new(data[offset...key_end], data[(key_end+1)...next_item_start].split("\0"))
+      item = ApeItem.new_from_parse(data[offset...key_end], data[(key_end+1)...next_item_start].split("\0"))
     rescue ArgumentError =>e
       raise ApeTagError, "ArgumentError: #{e.message}"
     end
@@ -135,16 +113,17 @@ class ApeItem < Array
   # Set key if valid, otherwise raise ApeTagError.
   def key=(key)
     raise ApeTagError, "Invalid APE key" unless valid_key?(key)
-    @key = key
+    @key = encoded_key(key)
   end
-  
+
   # The on disk representation of the entire ApeItem.
   # Raise ApeTagError if ApeItem is invalid.
   def raw
     raise ApeTagError, "Invalid key, value, APE type, or Read-Only Flag" unless valid? 
     flags = ITEM_TYPES.index(ape_type) * 2 + (read_only ? 1 : 0)
-    sv = string_value
-    "#{[sv.length, flags].pack('VN')}#{key}\0#{sv}"
+    k = RUBY_VERSION >= '1.9' ? key.dup.force_encoding('BINARY') : key
+    sv = RUBY_VERSION >= '1.9' ? string_value.dup.force_encoding('BINARY') : string_value
+    "#{[sv.length, flags].pack('VN')}#{k}\0#{sv}"
   end
   
   # Set read only flag if valid, otherwise raise ApeTagError.
@@ -170,7 +149,9 @@ class ApeItem < Array
   
   # Check if the given key is a valid APE key (string, 2 <= length <= 255, not containing invalid characters or keys).
   def valid_key?(key)
-    key.is_a?(String) && key.length >= 2 && key.length <= 255 && (key !~ BAD_KEY_RE rescue false)
+    return false unless key.is_a?(String)
+    return false unless key = encoded_key(key)
+    key.length >= 2 && key.length <= 255 && (key !~ BAD_KEY_RE rescue false)
   end
   
   # Check if the given read only flag is valid (boolean).
@@ -181,6 +162,13 @@ class ApeItem < Array
   # Check if the string value is valid UTF-8.
   def valid_value?
     begin
+      if RUBY_VERSION >= '1.9'
+        begin
+          map!{|v| v.to_s.encode('UTF-8')}
+        rescue EncodingError
+          return false
+        end
+      end
       string_value.unpack('U*') if ape_type == 'utf8' || ape_type == 'external'
     rescue ArgumentError
       false
@@ -188,6 +176,37 @@ class ApeItem < Array
       true
     end
   end
+
+  if RUBY_VERSION >= '1.9.0'
+    def self.new_from_parse(key, value)
+      new(key.force_encoding('US-ASCII'), value.map{|v| v.to_s.force_encoding('UTF-8')})
+    end
+
+    def encoded_key(key)
+      begin
+        key.encode('US-ASCII')
+      rescue EncodingError
+        return false
+      end
+    end
+
+    def normalize_encodings
+      map!{|v| v.to_s.encode('UTF-8')}
+      self
+    end
+  else
+    def self.new_from_parse(key, value)
+      new(key, value)
+    end
+
+    def encoded_key(key)
+      key
+    end
+
+    def normalize_encodings
+      self
+    end
+  end
 end
 
 # Contains all of the ApeItems found in the filename/file given.
@@ -421,7 +440,7 @@ class ApeTag
     def normalize_fields
       new_fields = CICPHash.new
       fields.each do |key, value|
-        new_fields[key] = ApeItem.create(key, value)
+        new_fields[key] = ApeItem.create(key, value).normalize_encodings
       end
       @fields = new_fields
     end

data/test/test_apetag.rb

@@ -445,4 +445,32 @@ class ApeTagTest < Test::Unit::TestCase
     assert_equal 0, get_size(filename)
     File.delete(filename)
   end
+
+  if RUBY_VERSION > '1.9.0'
+    def test_apeitem_encoding
+      ApeTag.new(StringIO.new(EXAMPLE_APE_TAG)).fields.each do |k, vs|
+        assert_equal 'US-ASCII', k.encoding.name
+        assert_equal 'US-ASCII', vs.key.encoding.name
+        vs.each{|v| assert_equal 'UTF-8', v.encoding.name}
+      end
+    end
+
+    def test_item_and_key_encoding
+      filename = 'test.apetag'
+      File.new(filename,'wb').close
+      utf8_key = File.read('test/utf-8.key', :mode=>'rb:UTF-8')
+      utf8_values = File.read('test/utf-8.values', :mode=>'rb:UTF-8')
+      utf16_key = File.read('test/utf-16be.key', :mode=>'rb:UTF-16BE')
+      utf16_values = File.read('test/utf-16be.values', :mode=>'rb:UTF-16BE')
+      latin1_values = File.read('test/latin1.values', :mode=>'rb:ISO-8859-1')
+      ApeTag.new(filename).update do |f|
+        f[utf16_key] = utf16_values.split('\n'.force_encoding('UTF-16BE'))
+        f['foo'] = latin1_values.split('\n'.force_encoding('ISO-8859-1'))
+      end
+      f = ApeTag.new(filename).fields
+      assert_equal utf8_values.split('\n'.force_encoding('UTF-8')), f[utf8_key]
+      assert_equal utf8_values.split('\n'.force_encoding('UTF-8')), f['foo']
+      File.delete(filename)
+    end
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: apetag
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 27
   prerelease: false
   segments: 
   - 1
   - 1
-  - 3
-  version: 1.1.3
+  - 4
+  version: 1.1.4
 platform: ruby
 authors: 
 - Jeremy Evans
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-16 00:00:00 -08:00
+date: 2011-01-21 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency