id3tag 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 520a63e5917a644637384f486a1e142a30df2089
-  data.tar.gz: 7475177d8f920f5fc05db1a12b0d74bbaeeb964f
+  metadata.gz: ae0e8d8a654a808950dc260c139c134a92553d15
+  data.tar.gz: cfcae0b936e24c4fb733987b2fc492d2e02d5064
 SHA512:
-  metadata.gz: c51ffcecb546f642557fdf31e4c1f0a1a2d79cbf74fb20271b1a492b64ee51e1cb4596ac7d1e45c989cadd7561f989c0d478c659b48d2275139f7e645161fdfe
-  data.tar.gz: e5a00fe77748a311c1d4a6d5514a2dac9eb54d7f16fb0891af3fc3bfd7b66b89b1a7312e313108dce27bc5b770451a9e898a1dbea1f5cd175b050216b1b2746d
+  metadata.gz: 0964ce3767d4637b84450e6420017b9035994f9b9b28e86839d6ebea65cbb79c5be1dc932688b2cd7bea700553a7c833f1b2f3ce01a0d8e989b5860711f4adf6
+  data.tar.gz: ca5440480c9b10ed97fa33d2ca34dd78e1b67c8b1e95e7ea3cc710c21af50e3b6161895812ab9ade5c51bfda1470de94a5789ed723ebe77a55473466b2f42948

data/.travis.yml

@@ -6,3 +6,4 @@ rvm:
   - jruby-19mode
   - jruby-head
   - rbx-19mode 
+  - rbx-2.1.1

data/Gemfile.lock

@@ -13,11 +13,11 @@ GEM
       term-ansicolor
       thor
     diff-lcs (1.2.5)
-    docile (1.1.1)
+    docile (1.1.2)
     json (1.8.1)
     json (1.8.1-java)
     mime-types (2.0)
-    multi_json (1.8.2)
+    multi_json (1.8.4)
     rake (10.1.1)
     rdoc (3.12.2)
       json (~> 1.4)

data/lib/id3tag.rb

@@ -6,6 +6,8 @@ require "id3tag/id3_v2_tag_header"
 require "id3tag/unsynchronization"
 require "id3tag/number_util"
 require "id3tag/string_util"
+require "id3tag/encoding_util"
+require "id3tag/io_util"
 require "id3tag/id3_v1_frame_parser"
 require "id3tag/id3_v2_frame_parser"
 require "id3tag/frame_id_advisor"
@@ -24,6 +26,7 @@ require "id3tag/frames/v2/unique_file_id_frame"
 require "id3tag/frames/v2/private_frame"
 require "id3tag/frames/v2/comments_frame"
 require "id3tag/frames/v2/unsychronized_transcription_frame"
+require "id3tag/frames/v2/picture_frame"
 require "id3tag/frames/v2/genre_frame"
 require "id3tag/frames/v2/genre_frame/genre_parser"
 require "id3tag/frames/v2/genre_frame/genre_parser_pre_24"

data/lib/id3tag/encoding_util.rb

@@ -0,0 +1,33 @@
+module ID3Tag
+  module EncodingUtil
+    UnsupportedTextEncoding = Class.new(StandardError)
+    UnsupportedEncoding = Class.new(StandardError)
+    DESTINATION_ENCODING = Encoding::UTF_8.to_s
+
+    ENCODING_MAP = {
+      0b0 => Encoding::ISO8859_1,
+      0b1 => Encoding::UTF_16,
+      0b10 => Encoding::UTF_16BE,
+      0b11 => Encoding::UTF_8
+    }
+
+    TERMINATOR_MAP = {
+      0b0 => 1,
+      0b1 => 2,
+      0b10 => 2,
+      0b11 => 1
+    }
+
+    def self.find_encoding(byte)
+      ENCODING_MAP.fetch(byte) { raise UnsupportedTextEncoding }.to_s
+    end
+
+    def self.terminator_size(byte)
+      TERMINATOR_MAP.fetch(byte) { raise UnsupportedEncoding.new("Can not find terminator for encoding byte: #{byte.inspect}") }
+    end
+
+    def self.encode(text, source_encoding)
+      text.encode(DESTINATION_ENCODING, source_encoding, ID3Tag.configuration.string_encode_options)
+    end
+  end
+end

data/lib/id3tag/frame_id_advisor.rb

@@ -20,7 +20,8 @@ module ID3Tag
         :comments => :COM,
         :genre => :TCO,
         :track_nr => :TRK,
-        :unsychronized_transcription => :ULT
+        :unsychronized_transcription => :ULT,
+        :image => :PIC
       },
       'v2.3' => {
         :artist => :TPE1,
@@ -30,7 +31,8 @@ module ID3Tag
         :comments => :COMM,
         :genre => :TCON,
         :track_nr => :TRCK,
-        :unsychronized_transcription => :USLT
+        :unsychronized_transcription => :USLT,
+        :image => :APIC
       },
       'v2.4' => {
         :artist => :TPE1,
@@ -40,7 +42,8 @@ module ID3Tag
         :comments => :COMM,
         :genre => :TCON,
         :track_nr => :TRCK,
-        :unsychronized_transcription => :USLT
+        :unsychronized_transcription => :USLT,
+        :image => :APIC
       }
     }
 

data/lib/id3tag/frames/v2/frame_fabricator.rb

@@ -32,6 +32,8 @@ module  ID3Tag
             UniqueFileIdFrame
           when /^(IPL|IPLS)$/
             InvolvedPeopleListFrame
+          when /^(PIC|APIC)$/
+            PictureFrame
           when /^PRIV$/
             PrivateFrame
           else

data/lib/id3tag/frames/v2/picture_frame.rb

@@ -0,0 +1,101 @@
+module  ID3Tag
+  module Frames
+    module  V2
+      class PictureFrame < BasicFrame
+        LINK_SYMBOL = '-->'
+        IMPLIED_MIME_TYPE = 'image/'
+        TYPES = {
+          0x00 => :other, # Other
+          0x01 => :file_icon_png32, # 32x32 pixels 'file icon' (PNG only)
+          0x02 => :file_icon, # Other file icon
+          0x03 => :cover_front, # Cover (front)
+          0x04 => :cover_back, # Cover (back)
+          0x05 => :leaflet_page, # Leaflet page
+          0x06 => :media, # Media (e.g. lable side of CD)
+          0x07 => :lead_artist, # Lead artist/lead performer/soloist
+          0x08 => :artist, # Artist/performer
+          0x09 => :conductor, # Conductor
+          0x0a => :band, # Band/Orchestra
+          0x0b => :composer, # Composer
+          0x0c => :lyricist, # Lyricist/text writer
+          0x0d => :recording_location, # Recording Location
+          0x0e => :during_recording, # During recording
+          0x0f => :during_performance, # During performance
+          0x10 => :movie_screen_capture, # Movie/video screen capture
+          0x11 => :fish, # A bright coloured fish
+          0x12 => :illustration, # Illustration
+          0x13 => :band_logotype, # Band/artist logotype
+          0x14 => :publisher_logotype # Publisher/Studio logotype
+        }
+
+        def mime_type
+          if @major_version_number > 2
+            result = parts[:mime_type]
+            if StringUtil.blank?(result.strip)
+              IMPLIED_MIME_TYPE
+            else
+              result
+            end
+          else
+            image_format = parts[:mime_type].downcase
+            if StringUtil.blank?(image_format.strip)
+              IMPLIED_MIME_TYPE
+            else
+              IMPLIED_MIME_TYPE + image_format
+            end
+          end
+        end
+
+        def link?
+          mime_type == LINK_SYMBOL
+        end
+
+        def type
+          TYPES[parts[:picture_type_byte]]
+        end
+
+        def description
+          encoding = get_encoding
+          EncodingUtil.encode(parts[:description], encoding)
+        end
+
+        def content
+          data
+        end
+
+        def data
+          parts[:data]
+        end
+
+        private
+
+        def parts
+          @parts ||= read_parts!
+        end
+
+        def read_parts!
+          usable_content_io.rewind
+          parts = {}
+          parts[:encoding_byte] = usable_content_io.getbyte
+          if @major_version_number > 2
+            parts[:mime_type] = ID3Tag::IOUtil.read_until_terminator(usable_content_io, 1)
+          else
+            parts[:mime_type] = usable_content_io.read(3)
+          end
+          parts[:picture_type_byte] = usable_content_io.getbyte
+          parts[:description] = ID3Tag::IOUtil.read_until_terminator(usable_content_io, EncodingUtil.terminator_size(parts[:encoding_byte]))
+          parts[:data] = usable_content_io.read
+          parts
+        end
+
+        def usable_content_io
+          @usable_content_io ||= StringIO.new(usable_content)
+        end
+
+        def get_encoding
+          EncodingUtil.find_encoding(parts[:encoding_byte])
+        end
+      end
+    end
+  end
+end

data/lib/id3tag/io_util.rb

@@ -0,0 +1,17 @@
+module ID3Tag
+  module IOUtil
+
+    def self.read_until_terminator(io, group_size)
+      result = []
+      bytes = io.each_byte
+      current_group = bytes.take(group_size)
+      while current_group.size == group_size do
+        break if current_group.all? { |byte| byte == 0 }
+        result += current_group
+        current_group = bytes.take(group_size)
+      end
+      result.pack("C*")
+    end
+
+  end
+end

data/lib/id3tag/version.rb

@@ -1,3 +1,3 @@
 module ID3Tag
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/spec/lib/id3tag/frames/v2/picture_frame_spec.rb

@@ -0,0 +1,107 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe ID3Tag::Frames::V2::PictureFrame do
+  let(:separator) { "\x00".force_encoding(target_encoding) }
+  let(:encoding) { encoding_byte.force_encoding(target_encoding) }
+  let(:flags) { nil }
+  let(:target_encoding) { Encoding::UTF_8 }
+  let(:encoding_byte) { "\x03" }
+  let(:description) { "picture description" }
+  let(:picture_type) { "\x03" } # cover_front
+  let(:frame) { described_class.new(id, raw_content, flags, major_version_number) }
+  let(:data) { "picture data" }
+
+  context "when PIC frame" do
+    let(:id) { "PIC" }
+    let(:major_version_number) { 2 }
+    let(:format) { "png" }
+    let(:raw_content) do
+      encoding_byte + format + picture_type + description + separator + data
+    end
+
+    describe '#id' do
+      subject { frame.id }
+      it { should == :PIC }
+    end
+
+    describe "mime_type" do
+      subject { frame.mime_type }
+      it { should eq('image/png') }
+      context "when mime type is blank" do
+        let(:format) { "\x00\x00\x00" }
+        it { should eq('image/') }
+      end
+    end
+
+    describe "#data" do
+      subject { frame.data }
+      it { should == "picture data" }
+    end
+
+    describe "#type" do
+      subject { frame.type }
+      it { should == :cover_front }
+    end
+
+    describe "#description" do
+      subject { frame.description }
+      it { should == "picture description" }
+    end
+
+    describe "#content" do
+      subject { frame.content }
+      it { should == "picture data" }
+    end
+  end
+
+  context "when APIC frame" do
+    let(:id) { "APIC" }
+    let(:major_version_number) { 3 }
+    let(:mime_type) { "image/png" }
+    let(:raw_content) do
+      # mime_type is iso 8859-1 so alawys terminated with \x00
+      encoding_byte + mime_type + "\x00" + picture_type + description + separator + data
+    end
+
+    describe '#id' do
+      subject { frame.id }
+      it { should == :APIC }
+    end
+
+    describe "#data" do
+      subject { frame.data }
+      it { should == "picture data" }
+    end
+
+    describe "#type" do
+      subject { frame.type }
+      it { should == :cover_front }
+    end
+
+    describe "#mime_type" do
+      subject { frame.mime_type }
+      it { should == "image/png" }
+    end
+
+    describe "#description" do
+      subject { frame.description }
+      it { should == "picture description" }
+    end
+
+    describe "#content" do
+      subject { frame.content }
+      it { should == "picture data" }
+    end
+
+    context "when frame contains link not actual image data" do
+      let(:raw_content) { "\x02-->\x00\x08\u0000a\u0000b\u0000c" }
+      subject { frame }
+
+      its(:link?) { should be_true }
+      its(:mime_type) { should eq("-->") }
+      its(:description) { should eq("abc") }
+      its(:type) { should eq(:artist) }
+    end
+  end
+end

data/spec/lib/id3tag/frames/v2/text_frame_spec.rb

@@ -69,6 +69,11 @@ describe ID3Tag::Frames::V2::TextFrame do
             c.string_encode_options = { :invalid => :replace, :undef => :replace }
           end
         end
+        after(:each) do
+          ID3Tag.configuration do |c|
+            c.string_encode_options = {}
+          end
+        end
         it "does not raise error" do
           expect { subject }.not_to raise_error
         end

data/spec/lib/id3tag/io_util_spec.rb

@@ -0,0 +1,30 @@
+require "spec_helper"
+
+describe ID3Tag::IOUtil do
+
+  describe "#read_until_terminator" do
+    subject { ID3Tag::IOUtil.read_until_terminator(io, group_size) }
+    context "when reading IO and looking for UTF-8 terminator - 1 null byte" do
+      let(:group_size) { 1 }
+      context "when only 1 null byte present" do
+        let(:io) { StringIO.new("abcd\x00ef") }
+        it { should eq("abcd") }
+      end
+      context "when no null bytes are present" do
+        let(:io) { StringIO.new("abcdef") }
+        it { should eq("abcdef") }
+      end
+    end
+    context "when reading IO and looking for UTF-16 terminator - 2 null bytes" do
+      let(:group_size) { 2 }
+      context "when only 1 null byte present" do
+        let(:io) { StringIO.new("a\x00b\x00\x00\x00c\x00") }
+        it "should return content until terminator and leave cursor just right after" do
+          subject.should eq("a\x00b\x00")
+          io.read.should eq("c\x00")
+        end
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,9 +1,11 @@
-if ENV['CI']
-  require 'coveralls'
-  Coveralls.wear!
-else
-  require 'simplecov'
-  SimpleCov.start
+unless ENV['RUBY_VERSION'] =~ /rbx/
+  if ENV['CI']
+    require 'coveralls'
+    Coveralls.wear!
+  else
+    require 'simplecov'
+    SimpleCov.start
+  end
 end
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
@@ -16,5 +18,5 @@ require 'id3tag'
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
 RSpec.configure do |config|
-  
+
 end

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: id3tag
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Krists Ozols
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-01 00:00:00.000000000 Z
+date: 2014-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.12'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.13.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Native Ruby ID3 tag reader that aims for 100% covarage of ID3v2.x and
@@ -103,10 +103,10 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
-- .document
-- .gitignore
-- .rspec
-- .travis.yml
+- ".document"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -116,6 +116,7 @@ files:
 - lib/id3tag.rb
 - lib/id3tag/audio_file.rb
 - lib/id3tag/configuration.rb
+- lib/id3tag/encoding_util.rb
 - lib/id3tag/frame_id_advisor.rb
 - lib/id3tag/frames/util/genre_names.rb
 - lib/id3tag/frames/v1/comments_frame.rb
@@ -131,6 +132,7 @@ files:
 - lib/id3tag/frames/v2/genre_frame/genre_parser_24.rb
 - lib/id3tag/frames/v2/genre_frame/genre_parser_pre_24.rb
 - lib/id3tag/frames/v2/involved_people_list_frame.rb
+- lib/id3tag/frames/v2/picture_frame.rb
 - lib/id3tag/frames/v2/private_frame.rb
 - lib/id3tag/frames/v2/text_frame.rb
 - lib/id3tag/frames/v2/unique_file_id_frame.rb
@@ -139,6 +141,7 @@ files:
 - lib/id3tag/id3_v1_frame_parser.rb
 - lib/id3tag/id3_v2_frame_parser.rb
 - lib/id3tag/id3_v2_tag_header.rb
+- lib/id3tag/io_util.rb
 - lib/id3tag/number_util.rb
 - lib/id3tag/scope.rb
 - lib/id3tag/string_util.rb
@@ -170,6 +173,7 @@ files:
 - spec/lib/id3tag/frames/v2/genre_frame/genre_parser_pre_24_spec.rb
 - spec/lib/id3tag/frames/v2/genre_frame/genre_parser_spec.rb
 - spec/lib/id3tag/frames/v2/genre_frame_spec.rb
+- spec/lib/id3tag/frames/v2/picture_frame_spec.rb
 - spec/lib/id3tag/frames/v2/text_frame_spec.rb
 - spec/lib/id3tag/frames/v2/unique_file_id_frame_spec.rb
 - spec/lib/id3tag/frames/v2/user_text_frame_spec.rb
@@ -177,6 +181,7 @@ files:
 - spec/lib/id3tag/id3_v2_frame_parser_spec.rb
 - spec/lib/id3tag/id3_v2_tag_header_spec.rb
 - spec/lib/id3tag/id3tag_spec.rb
+- spec/lib/id3tag/io_util_spec.rb
 - spec/lib/id3tag/number_util_spec.rb
 - spec/lib/id3tag/string_util_spec.rb
 - spec/lib/id3tag/synchsafe_integer_spec.rb
@@ -197,12 +202,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -237,6 +242,7 @@ test_files:
 - spec/lib/id3tag/frames/v2/genre_frame/genre_parser_pre_24_spec.rb
 - spec/lib/id3tag/frames/v2/genre_frame/genre_parser_spec.rb
 - spec/lib/id3tag/frames/v2/genre_frame_spec.rb
+- spec/lib/id3tag/frames/v2/picture_frame_spec.rb
 - spec/lib/id3tag/frames/v2/text_frame_spec.rb
 - spec/lib/id3tag/frames/v2/unique_file_id_frame_spec.rb
 - spec/lib/id3tag/frames/v2/user_text_frame_spec.rb
@@ -244,6 +250,7 @@ test_files:
 - spec/lib/id3tag/id3_v2_frame_parser_spec.rb
 - spec/lib/id3tag/id3_v2_tag_header_spec.rb
 - spec/lib/id3tag/id3tag_spec.rb
+- spec/lib/id3tag/io_util_spec.rb
 - spec/lib/id3tag/number_util_spec.rb
 - spec/lib/id3tag/string_util_spec.rb
 - spec/lib/id3tag/synchsafe_integer_spec.rb