ruby-mp3info 0.8.4 → 0.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e73d57ec360910c42245abd65123968dc3a12c3
-  data.tar.gz: 41a47932af670ac092a1929ae18b796dc4b3a514
+  metadata.gz: 969aa771d7ae3b0b47648d6e21ee285cfe238713
+  data.tar.gz: e51dac8cf99fdbcd015fc497d88d239316d0f5ab
 SHA512:
-  metadata.gz: fc2a8e453af0620cc2159d8dd7b960df38196a3abceaa5716b845920b8f444feac7fbf99bbbb6e79038d2b9346c9934cc35d517ef8e22607f198f20284836db7
-  data.tar.gz: 4c89f8648c5075417f2d21199516037dfe09acccbca2f88de865aaf7077e1d8ccafef7ea5fdbb94e4666db4a5bf0bef07b3169e38732bf5dc5f6253915255aea
+  metadata.gz: ac0b6fcbb6acfaed1e5b975f309a26ae0caf8a2179fb5de86268128349216b654535d7e57fb9f93e7af8c32c07d83abb5f2e8b78b4e46395a525d577ee04d495
+  data.tar.gz: f027fa0a62c2ebf1c31120ce827b047133f98595a59f702b5ab1a239ef0ecc2dc9e8163bc7107283a5c9a0c547a72044aab4d7f3a7e1d5c1952f211a41842843

data/History.txt

@@ -1,3 +1,8 @@
+=== 0.8.5 / 2014-09-17
+
+* lyrics support (USLT tag) (thanks to ipmsteven)
+* fixed travis CI tests (thanks to ipmsteven)
+
 === 0.8.4 / 2014-04-26
 
 * more robust frame scanning when unsynced (thanks to emonsqueeze for the bug report)

data/README.md

@@ -2,13 +2,15 @@
 
 * http://github.com/moumar/ruby-mp3info
 
+[![Build Status](https://travis-ci.org/moumar/ruby-mp3info.png?branch=master)](https://travis-ci.org/moumar/ruby-mp3info)
+
 ## Description
 
 ruby-mp3info read low-level informations and manipulate tags on mp3 files.
 
 ## Features/Problems
 
-* Written in pure ruby 
+* Written in pure ruby
 * Read low-level informations like bitrate, length, samplerate, etc...
 * Read, write, remove id3v1 and id3v2 tags
 * Correctly read VBR files (with or without Xing header)
@@ -31,8 +33,8 @@ end
 # when writing, each tag is written.
 
 Mp3Info.open("myfile.mp3") do |mp3|
-  puts mp3.tag.title   
-  puts mp3.tag.artist   
+  puts mp3.tag.title
+  puts mp3.tag.artist
   puts mp3.tag.album
   puts mp3.tag.tracknum
   mp3.tag.title = "track title"
@@ -61,18 +63,18 @@ file = File.new('input_img','rb')
 Mp3Info.open '1.mp3' do |m|
    pictures = m.tag2.pictures # array of images :
    pictures.each do |description, data|
-      # description ends with (.jpg / .png) for easy writing to file     
-      File.binwrite(description, data) 
+      # description ends with (.jpg / .png) for easy writing to file
+      File.binwrite(description, data)
   end
   m.tag2.remove_pictures # remove all images
-  
+
   m.tag2.add_picture(file.read) # add a single image to APIC tag
   # **optionally**, you may include options for the image tag to add_picture():
   # options = { mime: 'jpeg|gif|png', description: "description",
   #             pic_type: 0 }
   # There is no need to specify mime or options because the mime is guessed based on the input image
   # Only one image is permitted in the mp3 for compatibility. add_picture() overwrites all previous images.
-  # Please note: 
+  # Please note:
   # If supplying :mime option just supply the mime 'jpeg', 'gif' or 'png', the code adds the "image/.." for you!
   # e.g. m.tag2.add_picture(file.read, mime: 'jpeg', pic_type: 3) gets a mime "image/jpeg"
 end

data/lib/mp3info.rb

@@ -17,7 +17,7 @@ end
 
 class Mp3Info
 
-  VERSION = "0.8.4"
+  VERSION = "0.8.5"
 
   LAYER = [ nil, 3, 2, 1]
   BITRATE = {

data/lib/mp3info/id3v2.rb

@@ -345,8 +345,8 @@ class ID3v2 < DelegateClass(Hash)
   end
   
   def remove_pictures
-    self.APIC = ""
-    self.PIC = ""
+    self["APIC"] = ""
+    self["PIC"]  = ""
   end
 
   ### gets id3v2 tag information from io object (must support #seek() method)
@@ -391,13 +391,13 @@ class ID3v2 < DelegateClass(Hash)
     @hash.each do |k, v|
       next unless v
       next if v.respond_to?("empty?") and v.empty?
-      
+
       # Automagically translate V2 to V3 tags
       k = TAG_MAPPING_2_2_to_2_3[k] if TAG_MAPPING_2_2_to_2_3.has_key?(k)
 
       # doesn't encode id3v2.2 tags, which have 3 characters
-      next if k.size != 4 
-      
+      next if k.size != 4
+
       # Output one flag for each array element, or one only if it's not an array
       [v].flatten.each do |value|
         data = encode_tag(k, value.to_s)
@@ -416,7 +416,7 @@ class ID3v2 < DelegateClass(Hash)
     end
 
     tag_str = "ID3"
-    #version_maj, version_min, unsync, ext_header, experimental, footer 
+    #version_maj, version_min, unsync, ext_header, experimental, footer
     tag_str << [ 3, 0, "0000" ].pack("CCB4")
     tag_str << [to_syncsafe(tag.size)].pack("N")
     tag_str << tag
@@ -430,18 +430,18 @@ class ID3v2 < DelegateClass(Hash)
     puts "encode_tag(#{name.inspect}, #{value.inspect})" if $DEBUG
     name = name.to_s
 
-    if name =~ /^(COM|T)/
+    if name =~ /^(COM|T|USLT)/
       transcoded_value = Mp3Info::EncodingHelper.convert_to(value, "utf-8", "utf-16")
     end
     case name
-      when "COMM"
-        puts "encode COMM: lang: #{@options[:lang]}, value #{transcoded_value.inspect}" if $DEBUG
-	s = [ 1, @options[:lang], "\xFE\xFF\x00\x00", transcoded_value].pack("ca3a*a*")
-	return s
-      when /^T/
-        unless RUBY_1_8
-          transcoded_value.force_encoding("BINARY")
-        end
+    when "COMM", "USLT"
+      puts "encode #{name} lang: #{@options[:lang]}, value #{transcoded_value.inspect}" if $DEBUG
+      s = [ 1, @options[:lang], "\xFE\xFF\x00\x00", transcoded_value].pack("ca3a*a*")
+      return s
+    when /^T/
+      unless RUBY_1_8
+        transcoded_value.force_encoding("BINARY")
+      end
 	return "\x01" + transcoded_value
       else
         return value
@@ -451,8 +451,8 @@ class ID3v2 < DelegateClass(Hash)
   ### Read a tag from file and perform UNICODE translation if needed
   def decode_tag(name, raw_value)
     puts("decode_tag(#{name.inspect}, #{raw_value.inspect})") if $DEBUG
-    if name =~ /^(T|COM)/
-      if name =~ /^COM/
+    if name =~ /^(T|COM|USLT)/
+      if name =~ /^(COM|USLT)/
         #FIXME improve this
         encoding_index, lang, raw_tag = raw_value.unpack("ca3a*")
         if encoding_index == 1
@@ -470,7 +470,7 @@ class ID3v2 < DelegateClass(Hash)
         end
         puts "COM tag found. encoding: #{encoding_index} lang: #{lang} str: #{out.inspect}" if $DEBUG
       else
-        encoding_index = raw_value.getbyte(0) # language encoding (see TEXT_ENCODINGS constant)   
+        encoding_index = raw_value.getbyte(0) # language encoding (see TEXT_ENCODINGS constant)
         out = raw_value[1..-1]
       end
       # we need to convert the string in order to match

data/test/test_ruby-mp3info.rb

@@ -1,9 +1,11 @@
 #!/usr/bin/env ruby
 # encoding: utf-8
 
-$:.unshift("lib/")
+dir = File.dirname(__FILE__)
+$:.unshift("#{dir}/../lib/")
+$:.unshift("#{dir}/../test")
 
-require "test/unit"
+require "helper"
 require "mp3info"
 require "fileutils"
 require "tempfile"
@@ -12,23 +14,23 @@ require "yaml"
 
 GOT_ID3V2 = system("which id3v2 > /dev/null")
 
-class Mp3InfoTest < Test::Unit::TestCase
-
+class Mp3InfoTest < TestCase
   TEMP_FILE = File.join(File.dirname(__FILE__), "test_mp3info.mp3")
 
   DUMMY_TAG2 = {
     "COMM" => "comments",
-    #"TCON" => "genre_s" 
+    #"TCON" => "genre_s"
     "TIT2" => "title",
     "TPE1" => "artist",
     "TALB" => "album",
     "TYER" => "year",
-    "TRCK" => "tracknum"
+    "TRCK" => "tracknum",
+    "USLT" => "lyrics test 123456789"
   }
 
   DUMMY_TAG1 = {
     "title"    => "toto",
-    "artist"   => "artist 123", 
+    "artist"   => "artist 123",
     "album"    => "ALBUMM",
     "year"     => 1934,
     "tracknum" => 14,
@@ -69,17 +71,15 @@ class Mp3InfoTest < Test::Unit::TestCase
   end
 
   def test_is_an_mp3
-    assert_nothing_raised do
-      Mp3Info.new(TEMP_FILE).close
-    end
+    Mp3Info.new(TEMP_FILE).close
   end
-  
+
   def test_detected_info
     Mp3Info.open(TEMP_FILE) do |mp3|
       assert_mp3_info_are_ok(mp3)
     end
   end
-  
+
   def test_vbr_mp3_length
     load_fixture_to_temp_file("vbr")
 
@@ -115,7 +115,7 @@ class Mp3InfoTest < Test::Unit::TestCase
     }
     id3_test(tag, valid_tag)
   end
-  
+
   def test_valid_tag1_0
     tag = [ "title", "artist", "album", "1921", "comments", 0].pack('A30A30A30A4A30C')
     valid_tag = {
@@ -150,7 +150,7 @@ class Mp3InfoTest < Test::Unit::TestCase
   end
 
   def test_hastags
-    Mp3Info.open(TEMP_FILE) do |info| 
+    Mp3Info.open(TEMP_FILE) do |info|
       info.tag1 = @tag
     end
     assert(Mp3Info.hastag1?(TEMP_FILE))
@@ -160,10 +160,10 @@ class Mp3InfoTest < Test::Unit::TestCase
   end
 
   def test_universal_tag
-    2.times do 
+    2.times do
       tag = {"title" => "title"}
       Mp3Info.open(TEMP_FILE) do |mp3|
-	tag.each { |k,v| mp3.tag[k] = v }
+        tag.each { |k,v| mp3.tag[k] = v }
       end
       w = Mp3Info.open(TEMP_FILE) { |m| m.tag }
       assert_equal(tag, w)
@@ -181,7 +181,7 @@ class Mp3InfoTest < Test::Unit::TestCase
     w.delete("genre")
     w.delete("genre_s")
     assert_equal(tag, w)
-#    id3v2_prog_test(tag, w)
+    #    id3v2_prog_test(tag, w)
   end
 
   def test_id3v2_version
@@ -198,17 +198,17 @@ class Mp3InfoTest < Test::Unit::TestCase
     end
   end
 =end
- 
+
   # test for good output of APIC tag inspect (escaped and snipped)
   def test_id3v2_to_inspect_hash
     Mp3Info.open(TEMP_FILE) do |mp3|
-      mp3.tag2.APIC =  "\x00testing.jpg\x00" * 20
+      mp3.tag2["APIC"] =  "\x00testing.jpg\x00" * 20
       assert_match(/^((\\x00|\\u0000)testing.jpg(\\x00|\\u0000))+.*<<<\.\.\.snip\.\.\.>>>$/, mp3.tag2.to_inspect_hash["APIC"])
     end
   end
 
   def test_id3v2_get_pictures
-    img = "\x89PNG".force_encoding('BINARY') + 
+    img = "\x89PNG".force_encoding('BINARY') +
       random_string(120).force_encoding('BINARY')
     Mp3Info.open(TEMP_FILE) do |mp3|
       mp3.tag2.add_picture(img, :description => 'example image.png')
@@ -217,9 +217,9 @@ class Mp3InfoTest < Test::Unit::TestCase
       assert_equal(["01_example image.png", img], mp3.tag2.pictures[0])
     end
   end
-  
+
   def test_id3v2_remove_pictures
-    jpg_data = "\xFF".force_encoding('BINARY') + 
+    jpg_data = "\xFF".force_encoding('BINARY') +
       random_string(123).force_encoding('BINARY')
     Mp3Info.open(TEMP_FILE) do |mp|
       mp.tag2.add_picture(jpg_data)
@@ -234,16 +234,16 @@ class Mp3InfoTest < Test::Unit::TestCase
     tag = { "TIT2" => "tit2", "TPE1" => "tpe1" }
     Mp3Info.open(TEMP_FILE) do |mp3|
       tag.each do |k, v|
-        mp3.tag2.send("#{k}=".to_sym, v)
+        mp3.tag2.tap { |h| h[k.to_s] = v }
       end
-      assert_equal(tag, mp3.tag2)
+      assert_equal tag, mp3.tag2.to_hash
     end
   end
 
   def test_id3v2_basic
     written_tag = write_tag2_to_temp_file(DUMMY_TAG2)
-    assert_equal(DUMMY_TAG2, written_tag)
-    id3v2_prog_test(DUMMY_TAG2, written_tag)
+    assert_equal(DUMMY_TAG2, written_tag.to_hash)
+    id3v2_prog_test(DUMMY_TAG2, written_tag.to_hash)
   end
 
   #test the tag with the "id3v2" program
@@ -253,44 +253,43 @@ class Mp3InfoTest < Test::Unit::TestCase
     id3v2_output = {}
 =begin
     id3v2 tag info for test/test_mp3info.mp3:
-      COMM (Comments): (~)[ENG]: 
+      COMM (Comments): (~)[ENG]:
       test/test_mp3info.mp3: No ID3v1 tag
 =end
     raw_output = `id3v2 -l #{TEMP_FILE}`
     raw_output.split(/\n/).each do |line|
       if line =~ /^id3v2 tag info/
-        start = true 
-	next    
+        start = true
+        next
       end
       next unless start
       if match = /^(.{4}) \(.+\): (.+)$/.match(line)
         k, v = match[1, 2]
         case k
-          #COMM (Comments): ()[spa]: fmg
-          when "COMM"
-            v.sub!(/\(\)\[.{3}\]: (.+)/, '\1')
+        #COMM (Comments): ()[spa]: fmg
+        when "COMM", "USLT"
+          v.sub!(/\(\)\[.{3}\]: (.+)/, '\1')
         end
         id3v2_output[k] = v
       end
     end
 
-    assert_equal( id3v2_output, written_tag, "id3v2 program output doesn't match")
+    assert_equal( id3v2_output, written_tag.to_hash, "id3v2 program output doesn't match")
   end
 
   def test_id3v2_complex
     tag = {}
-    #ID3v2::TAGS.keys.each do |k|
     ["PRIV", "APIC"].each do |k|
       tag[k] = random_string(50)
     end
 
     got_tag = write_tag2_to_temp_file(tag)
-    assert_equal(tag, got_tag)
+    assert_equal(tag, got_tag.to_hash)
   end
 
   def test_id3v2_bigtag
     tag = {"APIC" => random_string(1024) }
-    assert_equal(tag, write_tag2_to_temp_file(tag))
+    assert_equal(tag, write_tag2_to_temp_file(tag).to_hash)
   end
 
   def test_leading_char_gets_chopped
@@ -312,7 +311,7 @@ class Mp3InfoTest < Test::Unit::TestCase
 
     Mp3Info.open(TEMP_FILE) do |mp3|
       assert_equal "2.2.0", mp3.tag2.version
-      expected_tag = { 
+      expected_tag = {
         "TCO" => "Hip Hop/Rap",
         "TP1" => "Grems Aka Supermicro",
         "TT2" => "Intro",
@@ -324,9 +323,9 @@ class Mp3InfoTest < Test::Unit::TestCase
       tag = mp3.tag2.dup
       assert_equal 4, tag["COM"].size
       tag.delete("COM")
-      assert_equal expected_tag, tag
+      assert_equal expected_tag, tag.to_hash
 
-      expected_tag = { 
+      expected_tag = {
         "genre_s"       => "Hip Hop/Rap",
         "title"         => "Intro",
         #"comments"      => "\000engiTunPGAP\0000\000\000",
@@ -336,7 +335,7 @@ class Mp3InfoTest < Test::Unit::TestCase
         "artist"        => "Grems Aka Supermicro",
         "tracknum"      => 1 }
       # test universal tag
-      assert_equal expected_tag, mp3.tag
+      assert_equal expected_tag, mp3.tag.to_hash
     end
   end
 
@@ -471,7 +470,7 @@ class Mp3InfoTest < Test::Unit::TestCase
   end
 
   def test_hastag_class_methods_with_a_stringio
-    Mp3Info.open(TEMP_FILE) do |info| 
+    Mp3Info.open(TEMP_FILE) do |info|
       info.tag1 = @tag
     end
     io = load_string_io
@@ -490,7 +489,7 @@ class Mp3InfoTest < Test::Unit::TestCase
 
   def test_modifying_an_io
     io = open(TEMP_FILE, "r")
-    Mp3Info.open(io) do |mp3| 
+    Mp3Info.open(io) do |mp3|
       mp3.tag.artist = "test_artist"
     end
   end
@@ -504,9 +503,7 @@ class Mp3InfoTest < Test::Unit::TestCase
     end
 
     Mp3Info.open("/tmp/test.mp3") do |info|
-      assert_nothing_raised do
-        info.each_frame { |frame| frame }
-      end
+      info.each_frame { |frame| frame }
       assert(info.vbr)
       assert_in_delta(174.210612, info.length, 0.000001)
     end
@@ -526,7 +523,6 @@ class Mp3InfoTest < Test::Unit::TestCase
       mp3.tag2.update(tag)
     end
     return Mp3Info.open(TEMP_FILE) { |m| m.tag2 }
-    #system("cp -v #{TEMP_FILE} #{TEMP_FILE}.test")
   end
 
   def random_string(size)
@@ -558,7 +554,7 @@ class Mp3InfoTest < Test::Unit::TestCase
       :emphasis=>0,
       :channel_num=>1,
       :channel_mode=>"JStereo"
-      }, mp3.header)
+    }, mp3.header)
   end
 
   def load_string_io(filename = TEMP_FILE)
@@ -588,26 +584,8 @@ class Mp3InfoTest < Test::Unit::TestCase
       content = Zlib::Inflate.inflate(content)
     end
 
-    File.open(TEMP_FILE, "w") do |f| 
+    File.open(TEMP_FILE, "w") do |f|
       f.write(content)
     end
   end
-=begin
-
-  def test_encoder
-    write_to_temp
-    info = Mp3Info.new(TEMP_FILE)
-    assert(info.encoder == "Lame 3.93")
-  end
-
-  def test_vbr
-    mp3_vbr = Base64.decode64 <<EOF
-
-EOF
-    File.open(TEMP_FILE, "w") { |f| f.write(mp3_vbr) }
-    info = Mp3Info.new(TEMP_FILE)
-    assert_equal(info.vbr, true)
-    assert_equal(info.bitrate, 128)
-  end
-=end
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: ruby-mp3info
 version: !ruby/object:Gem::Version
-  version: 0.8.4
+  version: 0.8.5
 platform: ruby
 authors:
 - Guillaume Pierronnet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-26 00:00:00.000000000 Z
+date: 2014-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.12'
 description: ruby-mp3info read low-level informations and manipulate tags on mp3 files.
 email:
 - guillaume.pierronnet@gmail.com
@@ -48,6 +48,7 @@ extra_rdoc_files:
 - Manifest.txt
 - README.md
 files:
+- ".gemtest"
 - History.txt
 - Manifest.txt
 - README.md
@@ -55,32 +56,31 @@ files:
 - lib/mp3info.rb
 - lib/mp3info/extension_modules.rb
 - lib/mp3info/id3v2.rb
-- test/test_ruby-mp3info.rb
 - test/fixtures.yml
-- .gemtest
+- test/test_ruby-mp3info.rb
 homepage: http://github.com/moumar/ruby-mp3info
 licenses:
 - MIT
 metadata: {}
 post_install_message: 
 rdoc_options:
-- --main
+- "--main"
 - README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: ruby-mp3info
-rubygems_version: 2.1.5
+rubyforge_project: 
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: ruby-mp3info read low-level informations and manipulate tags on mp3 files.