id3tag 0.10.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f472ca0d17fce8372d1bca854965d2d1ae862e74933e5da9cc8cf6e7614e3d59
-  data.tar.gz: 4faf983540a5f81630294fe91ca353e30a09dc378b1fb1e8377f30a293fd212d
+  metadata.gz: 03c00ecdfdd2c6e53e5664831502753b5210a67098223bcfdb2805b9ab7958cd
+  data.tar.gz: aba76b6019b3be742ddd51a2a024b90fefc59dfd1f645589f5f4a18b4da0dc60
 SHA512:
-  metadata.gz: fc4ec4101cca2e2b35ff722abc5d5d4a5cfd517d946d059e8f6b3775cc022335284bae1f14b868a2629765f1de94a14448ceecbee80eb6737b0ee506ca8b5a5e
-  data.tar.gz: 64fab8761e94835e3b7c05cfe4463c3f9ab1ec646ef85f6a4ced501695e8e9c73995973a00080b7d7ca284fc8810e46d9ce04617149c982eca2dbad15b7c41ee
+  metadata.gz: 85af215ef04e69deac371b5e9dea9c1bf401f01763794ae3f319be55ce09b6aa7fd67228fca0d62bfd956d4e8a445d173d985eecd4177462fa0b7a8aeae6aa3e
+  data.tar.gz: d3fdb4e68b97b3dfffb013d544b6feeeb56b1d9277d5ec6407fa3327837e1e8b5148c849e419ab0b18bccd8b003e5e2d01b0cca437a6216b8c3f55b88634d559

data/README.md

@@ -1,5 +1,5 @@
 # ID3Tag
-Native Ruby ID3 tag reader that aims for 100% covarage of ID3v2.x and ID3v1.x standards
+Native Ruby ID3 tag reader that aims for 100% coverage of ID3v2.x and ID3v1.x standards
 
 ## Install
 
@@ -12,7 +12,7 @@ gem install id3tag
 
 Or add the gem to your Gemfile:
 ```
-gem 'id3tag', '~> 0.10.0'
+gem 'id3tag', '~> 0.11.0'
 ```
 
 ## How to use
@@ -58,12 +58,23 @@ ID3Tag.read(file,:v2) # Reads only v2.x tag
 
 You can inspect tag by calling `frame_ids` to see available frame ids or `frames` to return all frames
 
-It is also possible to provide configuration and overwrite default behaviour. Currently only for String#encode which is used in TextFrames.
+## Configuration
 
-This way you can avoid Encoding::InvalidByteSequenceError when tag contains invalid data.
+It is also possible to provide configuration and overwrite default behaviour.
+ 
 ```ruby
 ID3Tag.configuration do |c|
+
+  # This way you can avoid Encoding::InvalidByteSequenceError when tag contains invalid data.
+  # Currently only for String#encode which is used in TextFrames.
+  # default: {} 
   c.string_encode_options = { :invalid => :replace, :undef => :replace }
+  
+  # You might want to set v2.x tag read limit in bytes to avoid reading too much data into memory
+  # v2 tags will be extracted until end of tag or limit is reached.
+  # default: 0 (There are no limit) 
+  c.v2_tag_read_limit = 1048576 # 1 megabyte
+  
 end
 ```
 
@@ -88,5 +99,5 @@ end
 [![Code Climate](https://codeclimate.com/github/krists/id3tag.png)](https://codeclimate.com/github/krists/id3tag) [![Build Status](https://travis-ci.org/krists/id3tag.png?branch=master)](https://travis-ci.org/krists/id3tag) [![Coverage Status](https://coveralls.io/repos/krists/id3tag/badge.png?branch=master)](https://coveralls.io/r/krists/id3tag) [![Gem Version](https://badge.fury.io/rb/id3tag.png)](http://badge.fury.io/rb/id3tag)
 ## Copyright
 
-Copyright (c) 2017 Krists Ozols. See LICENSE.txt for
+Copyright (c) 2018 Krists Ozols. See LICENSE.txt for
 further details.

data/lib/id3tag.rb

@@ -41,9 +41,16 @@ module ID3Tag
     tag
   end
 
-  def self.configuration
-    @@configuration ||= ID3Tag::Configuration.new
-    yield @@configuration if block_given?
-    @@configuration
+  class << self
+    def configuration
+      @configuration ||= reset_configuration
+      yield @configuration if block_given?
+      @configuration
+    end
+
+    def reset_configuration(configuration = ID3Tag::Configuration.new)
+      raise ArgumentError, "Passed argument must be a ID3Tag::Configuration class object" unless configuration.is_a?(ID3Tag::Configuration)
+      @configuration = configuration
+    end
   end
 end

data/lib/id3tag/audio_file.rb

@@ -4,6 +4,7 @@ module ID3Tag
     ID3V2_TAG_HEADER_SIZE = 10
     IDV1_TAG_IDENTIFIER = "TAG"
     IDV2_TAG_IDENTIFIER = "ID3"
+    BLANK_STRING = ""
 
     def initialize(file)
       @file = file
@@ -43,7 +44,12 @@ module ID3Tag
     def v2_tag_body
       if v2_tag_size > 0
         @file.seek(v2_tag_frame_and_padding_position)
-        @file.read(v2_tag_frame_and_padding_size)
+        bytes_to_read = v2_tag_frame_and_padding_size
+        limit = ID3Tag.configuration.v2_tag_read_limit
+        if (limit > 0) && (bytes_to_read > limit)
+          bytes_to_read = limit
+        end
+        @file.read(bytes_to_read) || BLANK_STRING
       end
     end
 

data/lib/id3tag/configuration.rb

@@ -2,8 +2,10 @@ module ID3Tag
   class Configuration
     def initialize
       @string_encode_options = {}
+      @v2_tag_read_limit = 0
     end
 
     attr_accessor :string_encode_options
+    attr_accessor :v2_tag_read_limit
   end
 end

data/lib/id3tag/id3_v2_frame_parser.rb

@@ -13,13 +13,15 @@ module ID3Tag
     def get_frames
       frames = []
       rewind_input
-      loop do
-        frame_id = read_next_frame_id
-        frame_size = read_next_frame_size
-        frame_flags = read_next_frame_flags
-        frame_content = read_next_bytes(frame_size)
-        frames << Frames::V2::FrameFabricator.fabricate(frame_id, frame_content, frame_flags, @major_version_number)
-        break if padding_or_eof_reached?
+      catch(:unexpected_eof) do
+        loop do
+          frame_id = read_next_frame_id
+          frame_size = read_next_frame_size
+          frame_flags = read_next_frame_flags
+          frame_content = read_next_bytes(frame_size)
+          frames << Frames::V2::FrameFabricator.fabricate(frame_id, frame_content, frame_flags, @major_version_number)
+          break if padding_or_eof_reached?
+        end
       end
       frames
     end
@@ -52,7 +54,9 @@ module ID3Tag
     end
 
     def read_next_bytes(limit)
-      @input.read(limit)
+      bytes = @input.read(limit)
+      throw(:unexpected_eof) unless bytes && bytes.bytesize == limit
+      bytes
     end
 
     def rewind_input

data/lib/id3tag/version.rb

@@ -1,3 +1,3 @@
 module ID3Tag
-  VERSION = "0.10.1"
+  VERSION = "0.11.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: id3tag
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.11.0
 platform: ruby
 authors:
 - Krists Ozols
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-13 00:00:00.000000000 Z
+date: 2018-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,7 +108,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.11.1
-description: Native Ruby ID3 tag reader that aims for 100% covarage of ID3v2.x and
+description: Native Ruby ID3 tag reader that aims for 100% coverage of ID3v2.x and
   ID3v1.x standards
 email: krists.ozols@gmail.com
 executables: []
@@ -117,15 +117,8 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
-- ".document"
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- id3tag.gemspec
 - lib/id3tag.rb
 - lib/id3tag/audio_file.rb
 - lib/id3tag/configuration.rb
@@ -162,50 +155,7 @@ files:
 - lib/id3tag/tag.rb
 - lib/id3tag/unsynchronization.rb
 - lib/id3tag/version.rb
-- spec/features/can_read_non_audio_files_spec.rb
-- spec/features/can_read_tag_v1_spec.rb
-- spec/fixtures/id3v1_and_v2.mp3
-- spec/fixtures/id3v1_with_track_nr.mp3
-- spec/fixtures/id3v1_without_track_nr.mp3
-- spec/fixtures/id3v2.mp3
-- spec/fixtures/pov_20131018-2100a.mp3.v1_tag_body
-- spec/fixtures/pov_20131018-2100a.mp3.v2_3_tag_body
-- spec/fixtures/signals_1.mp3.v2_3_tag_body
-- spec/id3tag_extract_tags
-- spec/lib/id3tag/audio_file_spec.rb
-- spec/lib/id3tag/frames/util/genre_name_by_id_finder_spec.rb
-- spec/lib/id3tag/frames/v1/comments_frame_spec.rb
-- spec/lib/id3tag/frames/v1/genre_frame_spec.rb
-- spec/lib/id3tag/frames/v1/text_frame_spec.rb
-- spec/lib/id3tag/frames/v1/track_nr_frame_spec.rb
-- spec/lib/id3tag/frames/v2/basic_frame_spec.rb
-- spec/lib/id3tag/frames/v2/comments_frame_spec.rb
-- spec/lib/id3tag/frames/v2/frame_fabricator_spec.rb
-- spec/lib/id3tag/frames/v2/frame_flags_spec.rb
-- spec/lib/id3tag/frames/v2/genre_frame/genre_parser_24_spec.rb
-- 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
-- spec/lib/id3tag/id3_v1_frame_parser_spec.rb
-- 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
-- spec/lib/id3tag/tag_spec.rb
-- spec/spec_helper.rb
-- spec/support/mp3_fixtures.rb
-- standard_documents/id3v2-00.txt
-- standard_documents/id3v2.3.0.txt
-- standard_documents/id3v2.4.0-frames.txt
-- standard_documents/id3v2.4.0-structure.txt
-homepage: http://github.com/krists/id3tag
+homepage: https://github.com/krists/id3tag
 licenses:
 - MIT
 metadata: {}
@@ -217,7 +167,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -228,45 +178,6 @@ rubyforge_project:
 rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
-summary: Native Ruby ID3 tag reader that aims for 100% covarage of ID3v2.x and ID3v1.x
+summary: Native Ruby ID3 tag reader that aims for 100% coverage of ID3v2.x and ID3v1.x
   standards
-test_files:
-- spec/features/can_read_non_audio_files_spec.rb
-- spec/features/can_read_tag_v1_spec.rb
-- spec/fixtures/id3v1_and_v2.mp3
-- spec/fixtures/id3v1_with_track_nr.mp3
-- spec/fixtures/id3v1_without_track_nr.mp3
-- spec/fixtures/id3v2.mp3
-- spec/fixtures/pov_20131018-2100a.mp3.v1_tag_body
-- spec/fixtures/pov_20131018-2100a.mp3.v2_3_tag_body
-- spec/fixtures/signals_1.mp3.v2_3_tag_body
-- spec/id3tag_extract_tags
-- spec/lib/id3tag/audio_file_spec.rb
-- spec/lib/id3tag/frames/util/genre_name_by_id_finder_spec.rb
-- spec/lib/id3tag/frames/v1/comments_frame_spec.rb
-- spec/lib/id3tag/frames/v1/genre_frame_spec.rb
-- spec/lib/id3tag/frames/v1/text_frame_spec.rb
-- spec/lib/id3tag/frames/v1/track_nr_frame_spec.rb
-- spec/lib/id3tag/frames/v2/basic_frame_spec.rb
-- spec/lib/id3tag/frames/v2/comments_frame_spec.rb
-- spec/lib/id3tag/frames/v2/frame_fabricator_spec.rb
-- spec/lib/id3tag/frames/v2/frame_flags_spec.rb
-- spec/lib/id3tag/frames/v2/genre_frame/genre_parser_24_spec.rb
-- 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
-- spec/lib/id3tag/id3_v1_frame_parser_spec.rb
-- 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
-- spec/lib/id3tag/tag_spec.rb
-- spec/spec_helper.rb
-- spec/support/mp3_fixtures.rb
+test_files: []

data/.document

@@ -1,5 +0,0 @@
-lib/**/*.rb
-bin/*
-- 
-features/**/*.feature
-LICENSE.txt

data/.gitignore

@@ -1,8 +0,0 @@
-coverage
-Gemfile.lock
-.bundle
-tags
-vendor/bundle
-bin
-doc
-pkg

data/.rspec

@@ -1 +0,0 @@
---color

data/.travis.yml

@@ -1,15 +0,0 @@
-language: ruby
-before_install:
-  - gem install bundler
-rvm:
-  - ruby-head
-  - jruby-head
-  - 2.5.1
-  - 2.4.4
-  - 2.3.7
-  - 2.2.10
-  - jruby-9.1.13.0
-matrix:
-  allow_failures:
-    - rvm: jruby-head
-    - rvm: ruby-head

data/Gemfile

@@ -1,4 +0,0 @@
-source "http://rubygems.org"
-
-# Specify your gem's dependencies in id3tag.gemspec
-gemspec

data/Rakefile

@@ -1,24 +0,0 @@
-#!/usr/bin/env rake
-require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
-
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-task :default => :spec
-
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "id3tag #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/id3tag.gemspec

@@ -1,28 +0,0 @@
-# coding: utf-8
-require File.expand_path('../lib/id3tag/version', __FILE__)
-
-Gem::Specification.new do |s|
-  s.name = "id3tag"
-  s.version = ID3Tag::VERSION
-  s.authors = ["Krists Ozols"]
-  s.email = "krists.ozols@gmail.com"
-  s.description = "Native Ruby ID3 tag reader that aims for 100% covarage of ID3v2.x and ID3v1.x standards"
-  s.summary = "Native Ruby ID3 tag reader that aims for 100% covarage of ID3v2.x and ID3v1.x standards"
-  s.homepage = "http://github.com/krists/id3tag"
-  s.license = "MIT"
-
-  s.files = `git ls-files`.split($/)
-  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
-  s.extra_rdoc_files = ["LICENSE.txt", "README.md"]
-  s.require_paths = ["lib"]
-  s.required_ruby_version = Gem::Requirement.new(">= 1.9.2")
-
-  s.add_development_dependency "bundler"
-  s.add_development_dependency "rake", "~> 12.1.0"
-  s.add_development_dependency "rdoc", "~> 5.1.0"
-  s.add_development_dependency "rspec", "~> 3.6.0"
-  s.add_development_dependency "simplecov", "~> 0.14.1"
-  s.add_development_dependency 'coveralls', "~> 0.8.21"
-  s.add_development_dependency 'pry', "~> 0.11.1"
-end

data/spec/features/can_read_non_audio_files_spec.rb

@@ -1,17 +0,0 @@
-require 'spec_helper'
-require 'tempfile'
-
-describe 'can read any file and does not raise errors if no tag found' do
-  subject { ID3Tag.read(Tempfile.new('fake_mp3')) }
-
-  it 'should return blanks' do
-    expect(subject.title).to eq(nil)
-    expect(subject.artist).to eq(nil)
-    expect(subject.album).to eq(nil)
-    expect(subject.genre).to eq(nil)
-    expect(subject.year).to eq(nil)
-    expect(subject.track_nr).to eq(nil)
-    expect(subject.frames).to eq([])
-    expect(subject.frame_ids).to eq([])
-  end
-end

data/spec/features/can_read_tag_v1_spec.rb

@@ -1,15 +0,0 @@
-require 'spec_helper'
-
-describe 'can read v1 info from file' do
-  let(:mp3_with_v1_1_tag) { mp3_fixture('id3v1_with_track_nr.mp3') }
-  subject { ID3Tag.read(mp3_with_v1_1_tag) }
-
-  it 'reading file with only v1 tag' do
-    expect(subject.title).to eq("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaA")
-    expect(subject.artist).to eq("bbbbbbbbbbbbbbbbbbbbbbbbbbbbbB")
-    expect(subject.album).to eq("cccccccccccccccccccccccccccccC")
-    expect(subject.genre).to eq("Blues")
-    expect(subject.year).to eq("2003")
-    expect(subject.track_nr).to eq("1")
-  end
-end