id3tag 0.10.1 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f472ca0d17fce8372d1bca854965d2d1ae862e74933e5da9cc8cf6e7614e3d59
-  data.tar.gz: 4faf983540a5f81630294fe91ca353e30a09dc378b1fb1e8377f30a293fd212d
+  metadata.gz: 667971eff7efb32a7d5b35c40bf93f66cf435c7aca6e24a6ca6c8d02cd90e783
+  data.tar.gz: ae499c107a5cf5f75b1906a6259552061e9143e4f302cfbbadd4f3e4e62436b2
 SHA512:
-  metadata.gz: fc4ec4101cca2e2b35ff722abc5d5d4a5cfd517d946d059e8f6b3775cc022335284bae1f14b868a2629765f1de94a14448ceecbee80eb6737b0ee506ca8b5a5e
-  data.tar.gz: 64fab8761e94835e3b7c05cfe4463c3f9ab1ec646ef85f6a4ced501695e8e9c73995973a00080b7d7ca284fc8810e46d9ce04617149c982eca2dbad15b7c41ee
+  metadata.gz: 93641cd6c5d2ef1febf87859bed72ec3f2aa92b79ed250f2e51dbf37373043c6bc39f07cb280e2ae171d25f6b1add950fc571706edce5bf35561d46dac5ab851
+  data.tar.gz: bb9cb24084969d9b1e3b986f2b872e534ee67cfbf72599705fac60a931952c6765be3c95dffa08619763eb013740a6a2c5e8a6a799bb373a1c9c2e4a255fcf66

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.14.0'
 ```
 
 ## How to use
@@ -58,13 +58,53 @@ 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.
 ```ruby
+# Configuration could be set using a block syntax.
 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
+
+  # In some situations, it's not possible to recognize what is the encoding of a
+  # text frame. The default behavior is to raise UnsupportedTextEncoding, but
+  # it's possible to set a fallback to avoid it.
+  # default: nil
+  c.source_encoding_fallback = Encoding::UTF_8
+
 end
+
+ID3Tag.configuration.v2_tag_read_limit # 1048576
+
+ID3Tag.configuration.v2_tag_read_limit = 1024
+
+ID3Tag.configuration.v2_tag_read_limit # 1024
+
+
+# In case you would like to set configuration temporally you could use `local_configuration` method.
+# Within this block you can read and modify configuration and it wont affect global or layers above.
+
+ID3Tag.local_configuration do
+  ID3Tag.configuration.v2_tag_read_limit # 1024
+  ID3Tag.configuration.v2_tag_read_limit = 9999
+  # ...
+  ID3Tag.configuration.v2_tag_read_limit # 9999
+end
+
+ID3Tag.configuration.v2_tag_read_limit # 1024
+
+ID3Tag.reset_configuration # Resets global configuration to defaults
+
+ID3Tag.configuration.v2_tag_read_limit # 0
 ```
 
 
@@ -85,8 +125,8 @@ end
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
 ## Code Status
-[![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)
+[![Code Climate](https://codeclimate.com/github/krists/id3tag.svg)](https://codeclimate.com/github/krists/id3tag) [![Build Status](https://travis-ci.org/krists/id3tag.svg?branch=master)](https://travis-ci.org/krists/id3tag) [![Coverage Status](https://coveralls.io/repos/krists/id3tag/badge.svg?branch=master)](https://coveralls.io/r/krists/id3tag) [![Gem Version](https://badge.fury.io/rb/id3tag.svg)](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

@@ -1,4 +1,6 @@
 require "stringio"
+require "singleton"
+require "id3tag/configuration_struct"
 require "id3tag/configuration"
 require "id3tag/synchsafe_integer"
 require "id3tag/audio_file"
@@ -41,9 +43,17 @@ module ID3Tag
     tag
   end
 
-  def self.configuration
-    @@configuration ||= ID3Tag::Configuration.new
-    yield @@configuration if block_given?
-    @@configuration
+  class << self
+    def configuration(&blk)
+      ID3Tag::Configuration.configuration(&blk)
+    end
+
+    def local_configuration(&blk)
+      ID3Tag::Configuration.local_configuration(&blk)
+    end
+
+    def reset_configuration
+      ID3Tag::Configuration.reset
+    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
@@ -19,14 +20,14 @@ module ID3Tag
     end
 
     def v2_tag_present?
-      @file.rewind
+      @file.seek(0)
       @file.read(3) == IDV2_TAG_IDENTIFIER
     end
 
     def v1_tag_body
       if v1_tag_present?
         @file.seek(-v1_tag_size, IO::SEEK_END)
-        @file.read
+        @file.read(v1_tag_size)
       else
         nil
       end
@@ -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
 
@@ -105,7 +111,7 @@ module ID3Tag
     end
 
     def get_v2_tag_header
-      @file.rewind
+      @file.seek(0)
       ID3v2TagHeader.new(@file.read(ID3V2_TAG_HEADER_SIZE))
     end
   end

data/lib/id3tag/configuration.rb

@@ -1,9 +1,50 @@
 module ID3Tag
   class Configuration
+    include Singleton
+    ResetError = Class.new(StandardError)
+    StackItem = Struct.new(:configuration)
+
+    class << self
+      def local_configuration(&blk)
+        instance.send(:local_configuration, &blk)
+      end
+
+      def configuration
+        value_from_stack = instance.instance_variable_get(:@stack).last
+        value = value_from_stack && value_from_stack.configuration
+        value ||= instance.instance_variable_get(:@global_configuration)
+        yield value if block_given?
+        value
+      end
+
+      def reset
+        instance.send(:reset)
+      end
+    end
+
+    def local_configuration
+      instance_to_copy = @stack.last && @stack.last.configuration
+      instance_to_copy ||= @global_configuration
+      stack_item = StackItem.new(instance_to_copy.dup)
+      stack_backup = @stack.dup
+      @stack << stack_item
+      begin
+        yield stack_item.configuration
+      ensure
+        @stack.replace stack_backup
+      end
+    end
+
+    private
+
     def initialize
-      @string_encode_options = {}
+      @stack = []
+      reset
     end
 
-    attr_accessor :string_encode_options
+    def reset
+      raise ResetError, "Configuration cannot be reset within local_configuration block" if @stack.size > 0
+      @global_configuration = ConfigurationStruct.new
+    end
   end
 end

data/lib/id3tag/configuration_struct.rb

@@ -0,0 +1,13 @@
+module ID3Tag
+  class ConfigurationStruct
+    def initialize
+      @string_encode_options = {}
+      @v2_tag_read_limit = 0
+      @source_encoding_fallback = nil
+    end
+
+    attr_accessor :string_encode_options
+    attr_accessor :v2_tag_read_limit
+    attr_accessor :source_encoding_fallback
+  end
+end

data/lib/id3tag/encoding_util.rb

@@ -27,7 +27,7 @@ module ID3Tag
     end
 
     def self.encode(text, source_encoding)
-      text.encode(DESTINATION_ENCODING, source_encoding, ID3Tag.configuration.string_encode_options)
+      text.encode(DESTINATION_ENCODING, source_encoding, **ID3Tag.configuration.string_encode_options)
     end
   end
 end

data/lib/id3tag/frames/v1/comments_frame.rb

@@ -15,7 +15,7 @@ module ID3Tag
         end
 
         def content
-          @content.encode(destination_encoding, source_encoding)
+          EncodingUtil.encode(@content, source_encoding)
         end
       end
     end

data/lib/id3tag/frames/v1/text_frame.rb

@@ -9,15 +9,11 @@ module ID3Tag
         end
 
         def content
-          @content.encode(destination_encoding, source_encoding)
+          EncodingUtil.encode(@content, source_encoding)
         end
 
         private
 
-        def destination_encoding
-          Encoding::UTF_8
-        end
-
         def source_encoding
           Encoding::ISO8859_1
         end

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

@@ -32,7 +32,7 @@ module  ID3Tag
         end
 
         def encoded_content
-          content_without_encoding_byte_and_language.encode(destination_encoding, source_encoding)
+          EncodingUtil.encode(content_without_encoding_byte_and_language, source_encoding)
         end
 
         def content_without_encoding_byte_and_language

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

@@ -21,15 +21,13 @@ module  ID3Tag
         private
 
         def encoded_content
-          content_without_encoding_byte.encode(destination_encoding, source_encoding, ID3Tag.configuration.string_encode_options)
+          EncodingUtil.encode(content_without_encoding_byte, source_encoding)
         end
 
         def source_encoding
-          ENCODING_MAP.fetch(get_encoding_byte) { raise UnsupportedTextEncoding }.to_s
-        end
-
-        def destination_encoding
-          Encoding::UTF_8.to_s
+          ENCODING_MAP.fetch(get_encoding_byte) do
+            ID3Tag.configuration.source_encoding_fallback || raise(UnsupportedTextEncoding)
+          end.to_s
         end
 
         def get_encoding_byte

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,11 +54,13 @@ 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
-      @input.rewind
+      @input.seek(0)
     end
 
     def padding_or_eof_reached?

data/lib/id3tag/tag.rb

@@ -38,7 +38,7 @@ module ID3Tag
 
     def first_frame_by_id(*ids)
       first_existing_id = ids.find { |id| frame_ids.include?(id) }
-      first_existing_id && get_frame(first_existing_id)
+      first_existing_id && get_frames(first_existing_id).first
     end
 
     def all_frames_by_id(*ids)

data/lib/id3tag/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: id3tag
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.14.0
 platform: ruby
 authors:
 - Krists Ozols
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-13 00:00:00.000000000 Z
+date: 2020-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,85 +30,85 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.1.0
+        version: 13.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.1.0
+        version: 13.0.1
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: 6.2.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: 6.2.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 3.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 3.9.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: 0.16.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: 0.16.1
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.21
+        version: 0.8.23
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.21
+        version: 0.8.23
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.1
+        version: 0.13.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.1
-description: Native Ruby ID3 tag reader that aims for 100% covarage of ID3v2.x and
+        version: 0.13.1
+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,18 +117,12 @@ 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
+- lib/id3tag/configuration_struct.rb
 - lib/id3tag/encoding_util.rb
 - lib/id3tag/frame_id_advisor.rb
 - lib/id3tag/frames/util/genre_names.rb
@@ -162,50 +156,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,56 +168,16 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.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: []