ruby-ogginfo 0.6.6 → 0.6.8

data/History.txt

@@ -1,3 +1,12 @@
+=== 0.6.8 / 2012-02-28
+
+* removed :encoding parameter on OggInfo#new
+* utf8 strings are correctly written now in ruby > 1.9
+
+=== 0.6.7 / 2012-02-27
+
+* fixes for ruby 1.9 (again)
+
 === 0.6.6 / 2011-12-23
 
 * fixes for ruby 1.9 (thanks to gwolf)

data/README.txt

@@ -11,8 +11,7 @@ It is written in pure ruby.
 
 == FEATURES/PROBLEMS
 
-* writing tags is not pure ruby yet, need to have "vorbiscomment"
-  command
+* writing tags is now pure ruby 
 
 == SYNOPSIS:
 

data/Rakefile

@@ -5,9 +5,10 @@ require 'hoe'
 Hoe.plugin :yard
 Hoe.plugin :git
 Hoe.plugin :rcov
+Hoe.plugin :gemspec
 
 Hoe.spec('ruby-ogginfo') do 
-  developer('Guillaume Pierronnet','moumar@rubyforge.org')
+  developer('Guillaume Pierronnet','guillaume.pierronnet@gmail.com')
   developer('Grant Gardner','grant@lastweekend.com.au')
   #summary = 'ruby-ogginfo is a pure-ruby library that gives low level informations on ogg files'
   remote_rdoc_dir = ''

data/lib/ogg/codecs/comments.rb

@@ -20,6 +20,9 @@ module Ogg::Codecs
       tag_size.times do |i|
         size = pio.read(4).unpack("V")[0]
         comment = pio.read(size)
+        unless RUBY_VERSION[0..2] == "1.8"
+          comment.force_encoding("UTF-8")
+        end
         key, val = comment.split(/=/, 2)
         tag[key.downcase] = val
       end
@@ -39,12 +42,20 @@ module Ogg::Codecs
       packet_data << [tag.size].pack("V")
       tag.each do |k,v|
         tag_data = "#{ k }=#{ v }"
-        packet_data << [ tag_data.length ].pack("V")
+        packet_data << [ binary_size(tag_data) ].pack("V")
         packet_data << tag_data
       end
       
       packet_data << "\001"
       packet_data
     end
+
+    def binary_size(s)
+      if RUBY_VERSION[0..2] == "1.8"
+        s.size
+      else
+        s.bytes.to_a.size
+      end
+    end
   end
 end

data/lib/ogginfo.rb

@@ -4,9 +4,8 @@
 # 
 # License: ruby
 
-require "iconv"
 require 'forwardable'
-require "tempfile"
+require "tmpdir"
 require File.join(File.dirname(__FILE__), 'ogg.rb')
 
 class Hash 
@@ -26,7 +25,7 @@ end
 class OggInfoError < StandardError ; end
 
 class OggInfo
-  VERSION = "0.6.6"
+  VERSION = "0.6.8"
   extend Forwardable
   include Ogg
   
@@ -35,10 +34,13 @@ class OggInfo
   # +tag+ is a hash containing the vorbis tag like "Artist", "Title", and the like
   attr_reader :tag
   		
-  # create new instance of OggInfo, using +charset+ to convert tags
-  def initialize(filename, charset = "utf-8")
+  # create new instance of OggInfo
+  # use of charset is deprecated! please use utf-8 encoded strings and leave +charset+ to nil")
+  def initialize(filename, charset = nil)
+    if charset
+      warn("use of charset is deprecated! please use utf-8 encoded tags")
+    end
     @filename = filename
-    @charset = charset
     @length = nil
     @bitrate = nil
     filesize = File.size(@filename)
@@ -57,7 +59,6 @@ class OggInfo
       end
     end
 
-    convert_tag_charset("utf-8", @charset)
     @original_tag = @tag.dup
   end
 
@@ -98,18 +99,14 @@ class OggInfo
   # commits any tags to file
   def close
     if tag != @original_tag
-      convert_tag_charset(@charset, "utf-8")
-      
-      tempfile = Tempfile.new("ruby-ogginfo")
-      begin
-        File.open(@filename, "rb") do | input |
-          replace_tags(input, tempfile, tag)
-        end
-        tempfile.close
-        FileUtils.cp(tempfile.path, @filename)
-      ensure
-        tempfile.close!
+      path = File.join(Dir.tmpdir, "ruby-ogginfo_#{$$}.ogg") 
+      tempfile = File.new(path, "wb")
+
+      File.open(@filename, "rb") do | input |
+        replace_tags(input, tempfile, tag)
       end
+      tempfile.close
+      FileUtils.mv(path, @filename)
     end
   end
 
@@ -172,13 +169,4 @@ private
       FileUtils.copy_stream(reader.input, writer.output)
     end
   end
-
-  def convert_tag_charset(from_charset, to_charset)
-    return if from_charset == to_charset
-    Iconv.open(to_charset, from_charset) do |ic|
-      tag.each do |k, v|
-        tag[k] = ic.iconv(v)
-      end
-    end
-  end
 end

data/test/test_ruby-ogginfo.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/ruby -w
+# encoding: utf-8
 
 $:.unshift("lib/")
 
@@ -130,31 +131,34 @@ class OggInfoTest < Test::Unit::TestCase
     end
   end
 
-  def test_tag_writing
-    tag_test("title" => generate_random_string, "artist" => generate_random_string )
+  def test_writing_to_spedial_filenames
+    tf = generate_ogg
+    filename = "fichier éé.ogg"
+    FileUtils.cp(tf.path, filename)
+    begin
+      OggInfo.open(tf.path) do |ogg|
+        ogg.tag.title = "a"*200
+      end
+      #system("ls", "-l", filename)
+    ensure
+      FileUtils.rm_f(filename) 
+    end
   end
 
-  def test_big_tags
-    tag_test("title" => generate_random_string(60000), "artist" => generate_random_string(60000) )
+  def test_good_writing_of_utf8_strings
+    tag = { "title" => "this is a éé utf8 string",
+            "artist" => "and è another one à"}
+    tag_test("tag_writing", tag)
   end
-  
 
-  def test_charset
-    tf = generate_ogg
-    OggInfo.open(tf.path, "utf-8") do |ogg|
-      ogg.tag["title"] = "hello\303\251"
-    end
+  def test_tag_writing
+    data = "a"*256
+    tag_test("tag_writing", "title" => data, "artist" => data )
+  end
 
-    OggInfo.open(tf.path, "iso-8859-1") do |ogg|
-      if RUBY_VERSION[0..2] == '1.8'
-        assert_equal "hello\xe9", ogg.tag["title"] 
-      else
-        string = ''
-        string.force_encoding 'iso-8859-1'
-        [104, 101, 108, 108, 111, 233].each {|chr| string << chr}
-        assert_equal string, ogg.tag["title"] 
-      end
-    end
+  def test_big_tags
+    data = "a"*60000
+    tag_test("big_tags", "title" => data, "artist" => data )
   end
 
   def test_should_not_fail_when_input_is_truncated
@@ -189,7 +193,6 @@ class OggInfoTest < Test::Unit::TestCase
 
   protected
 
-
   def generate_ogg
     generated_ogg_file_path = File.join(File.dirname(__FILE__), "test.ogg")
     unless test(?f, generated_ogg_file_path)
@@ -202,10 +205,6 @@ class OggInfoTest < Test::Unit::TestCase
     tf
   end
 
-  def generate_random_string(size = 256)
-    File.read("/dev/urandom", size)
-  end
-
   def generate_truncated_ogg
     valid_ogg = generate_ogg
     tf = Tempfile.new("ruby-ogginfo")
@@ -215,7 +214,7 @@ class OggInfoTest < Test::Unit::TestCase
     tf
   end
 
-  def tag_test(tag) 
+  def tag_test(test_name, tag) 
     tf = generate_ogg
 
     OggInfo.open(tf.path) do |ogg|
@@ -225,6 +224,14 @@ class OggInfoTest < Test::Unit::TestCase
     OggInfo.open(tf.path) do |ogg|
       assert_equal tag, ogg.tag
     end
+    system("cp #{tf.path} /tmp/test_#{RUBY_VERSION}_#{test_name}.ogg")
     test_length
+    assert_nothing_raised do
+      io = open(tf.path)
+      reader = Ogg::Reader.new(io)
+      reader.each_pages do |page|
+        page
+      end
+    end
   end
 end

data/test/test_ruby-spxinfo.rb

@@ -87,40 +87,6 @@ class SpxInfoTest < Test::Unit::TestCase
     end
   end
 
-
-  def test_charset
-    generate_spx
-    FileUtils.cp("test.spx",GEN_FILE)
-    if RUBY_VERSION[0..2] == '1.8'
-      OggInfo.open(GEN_FILE, "utf-8") do |spx|
-    	assert_equal "hello\303\251",spx.tag["test"] 
-      end
-
-      OggInfo.open(GEN_FILE, "iso-8859-1") do |spx|
-        assert_equal "hello\xe9", spx.tag["test"] 
-      end
-
-    else
-      # In Ruby >= 1.9, all strings are UTF-8, and are made up by
-      # characters (and not anymore bytes). So, we hand-craft it in a
-      # dumb-enough encoding.
-      OggInfo.open(GEN_FILE, "utf-8") do |spx|
-        string = ''
-        string.force_encoding 'ascii-8bit'
-        [104, 101, 108, 108, 111, 195, 169].each {|chr| string << chr}
-        assert_equal string, spx.tag["test"]
-      end
-
-      OggInfo.open(GEN_FILE, "iso-8859-1") do |spx|
-        string = ''
-        string.force_encoding 'iso-8859-1'
-        [104, 101, 108, 108, 111, 233].each {|chr| string << chr}
-        assert_equal string, spx.tag["test"]
-      end
-
-    end
-  end
-  
   def test_tag_writing
     generate_spx
     FileUtils.cp("test.spx",GEN_FILE)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-ogginfo
 version: !ruby/object:Gem::Version
-  version: 0.6.6
+  version: 0.6.8
   prerelease: 
 platform: ruby
 authors:
@@ -10,12 +10,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-23 00:00:00.000000000 +01:00
+date: 2012-02-28 00:00:00.000000000 +01:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &2156269120 !ruby/object:Gem::Requirement
+  requirement: &71330730 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -23,10 +23,10 @@ dependencies:
         version: '3.10'
   type: :development
   prerelease: false
-  version_requirements: *2156269120
+  version_requirements: *71330730
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &2156268300 !ruby/object:Gem::Requirement
+  requirement: &71330390 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -34,14 +34,14 @@ dependencies:
         version: '2.12'
   type: :development
   prerelease: false
-  version_requirements: *2156268300
+  version_requirements: *71330390
 description: ! 'ruby-ogginfo gives you access to low level information on ogg files
 
   (bitrate, length, samplerate, encoder, etc... ), as well as tag.
 
   It is written in pure ruby.'
 email:
-- moumar@rubyforge.org
+- guillaume.pierronnet@gmail.com
 - grant@lastweekend.com.au
 executables: []
 extensions: []
@@ -95,5 +95,5 @@ specification_version: 3
 summary: ruby-ogginfo gives you access to low level information on ogg files (bitrate,
   length, samplerate, encoder, etc..
 test_files:
-- test/test_ruby-ogginfo.rb
 - test/test_ruby-spxinfo.rb
+- test/test_ruby-ogginfo.rb