riffola 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2be335b138c805162b56fb07b14d589a1c90f00fa0a6fed6c1cb9dba482151f4
-  data.tar.gz: c393edd260fc4b43a94feb327449e059a25f46a4189c2b42c1516029619703a8
+  metadata.gz: 75947af5b2176ff928adee071dd95929c96c4b85f706e11d37615b5e27e32515
+  data.tar.gz: 6cc4db5122b635d032acc00f63bb092ee9584f19d56e75cd29e57ae35bbfb9cc
 SHA512:
-  metadata.gz: fc246a663893068f9c96fcdcbe842112a0c160b63f475b98ad357e8c775613f0f279eb413ad7aad135b9644d44570824c9980493390fc4821c8514a5dd9ffb14
-  data.tar.gz: dd1956dc6c17bffcb1e37e24d33abbb3c79553a600f11a6b26267434f7467bfe283034aad8b63c8f9bf55d3de60d3341500e926febaaf26c171a45fc9314ece1
+  metadata.gz: 7d2b2612fb38347063f3907d0c7833fc3cc7d4f949137fe9a674e33e9635e7fb5f4d80e17208944512be053e98834a610fcb50f132d48a6c428d17f39c2e855b
+  data.tar.gz: ca68e8a260cc1d305198d62fc3826caba13e8c7b5064a3eb9a48861ea36f108414992d6ea933a449a048090beef7cc0791c2aeba88aa9820243f67a315afa5b8

data/lib/riffola.rb

@@ -1,3 +1,5 @@
+require 'riffola/chunk'
+
 module Riffola
 
   # Return a list of Riff chunk objects stored in a file, from a given offset.
@@ -41,200 +43,4 @@ module Riffola
     chunks
   end
 
-  class Chunk
-
-    # Define default chunk format properties
-    DEFAULT_CHUNK_FORMAT = {
-      size_length: 4,
-      header_size: 0,
-      data_size_correction: 0
-    }
-
-    # Constructor
-    #
-    # Parameters::
-    # * *file_name* (String): The file name
-    # * *offset* (Integer): The offset to read the file from [default: 0]
-    # * *chunks_format* (Hash<String, Hash<Symbol,Object> >): Format of a given set of chunk names (use '*' for all chunks). For each chunk name, the following can be specified: [default = {}]
-    #   * *size_length* (Integer): Number of bytes encoding the size of the chunk [default: 4]
-    #   * *header_size* (Integer): Size of the chunk's header [default: 0]
-    #   * *data_size_correction* (Integer): Correction to apply to the data size read [default: 0]
-    #   Each property can also be a Proc taking the file handle (positioned at the beginning of the chunk) and returning the real value:
-    #     * Parameters::
-    #       * *file* (IO): The file IO, positioned at the beginning of the chunk (at the name)
-    #     * Result::
-    #       * Object: The corresponding property value
-    # * *max_size* (Integer): Maximum readable size (starting from the file's offset) to retrieve chunks, or nil to read till the end of the file [default: nil]
-    # * *parent_chunk* (Chunk or nil): Parent chunk, or nil if none [default: nil]
-    # * *warnings* (Boolean): Do we activate warnings? [default: true]
-    # * *debug* (Boolean): Do we activate debugging logs? [default: false]
-    def initialize(file_name, offset: 0, chunks_format: {}, max_size: nil, parent_chunk: nil, warnings: true, debug: false)
-      @file_name = file_name
-      @offset = offset
-      @chunks_format = chunks_format
-      # Fill the default format if not present
-      @chunks_format['*'] = {} unless @chunks_format.key?('*')
-      DEFAULT_CHUNK_FORMAT.each do |format_property, default_property_value|
-        @chunks_format['*'][format_property] = default_property_value unless @chunks_format['*'].key?(format_property)
-      end
-      @parent_chunk = parent_chunk
-      @max_size = max_size.nil? ? File.size(@file_name) - @offset : max_size
-      @warnings = warnings
-      @debug = debug
-      # Get chunk format in instance variables named after the property
-      chunk_name = self.name
-      DEFAULT_CHUNK_FORMAT.keys.each do |format_property|
-        property_value = @chunks_format.key?(chunk_name) && @chunks_format[chunk_name].key?(format_property) ? @chunks_format[chunk_name][format_property] : @chunks_format['*'][format_property]
-        if property_value.is_a?(Proc)
-          File.open(@file_name) do |file|
-            file.seek(@offset)
-            property_value = property_value.call(file)
-          end
-        end
-        instance_variable_set(:"@#{format_property}", property_value)
-      end
-      puts "[DEBUG] - Read chunk from #{@file_name}@#{@offset}/#{@max_size}: #{chunk_name} (size length: #{@size_length}, header size: #{@header_size}, data size: #{self.size}/#{@max_size})" if @debug
-      # puts "[DEBUG] - Chunks format: #{@chunks_format.inspect}" if @debug
-    end
-
-    # Return the name of this chunk
-    #
-    # Result::
-    # * String: Chunk name
-    def name
-      chunk_name = nil
-      File.open(@file_name) do |file|
-        file.seek(@offset, IO::SEEK_CUR)
-        chunk_name = file.read(4)
-      end
-      puts "[WARNING] - Doesn't look like a valid chunk name: #{chunk_name}" if @warnings && !chunk_name =~ /^[\w ]{4}$/
-      chunk_name
-    end
-
-    # Return the size of this chunk
-    #
-    # Result::
-    # * Integer: Chunk size in bytes
-    def size
-      chunk_size = nil
-      File.open(@file_name) do |file|
-        file.seek(@offset + 4, IO::SEEK_CUR)
-        case @size_length
-        when 4
-          chunk_size = file.read(@size_length).unpack('L').first
-        when 2
-          chunk_size = file.read(@size_length).unpack('S').first
-        else
-          raise "Can't decode size field of length #{@size_length}"
-        end
-      end
-      chunk_size + @data_size_correction
-    end
-
-    # Return the header of this chunk
-    #
-    # Result::
-    # * String: Header
-    def header
-      chunk_header = nil
-      File.open(@file_name) do |file|
-        file.seek(@offset + 4 + @size_length, IO::SEEK_CUR)
-        chunk_header = file.read(@header_size)
-      end
-      chunk_header
-    end
-
-    # Return the data of this chunk
-    #
-    # Result::
-    # * String: Data
-    def data
-      chunk_data = nil
-      data_size = self.size
-      complete_header_size = 4 + @size_length + @header_size
-      puts "[WARNING] - Data size is #{data_size} but the maximum readable size is #{@max_size} and the headers have #{complete_header_size}" if @warnings && complete_header_size + data_size > @max_size
-      File.open(@file_name) do |file|
-        file.seek(@offset + complete_header_size, IO::SEEK_CUR)
-        chunk_data = file.read(data_size)
-      end
-      chunk_data
-    end
-
-    # Return the parent chunk, or nil if none
-    #
-    # Result::
-    # * Chunk or nil: The parent chunk, or nil if none
-    def parent_chunk
-      @parent_chunk
-    end
-
-    # Return a string representation of this chunk
-    #
-    # Result::
-    # * String: tring representation of this chunk
-    def to_s
-      "<Riffola-Chunk #{self.name} (#{@file_name}@#{@offset})>"
-    end
-
-    # Return the next chunk
-    #
-    # Result::
-    # * Chunk or nil: The next chunk, or nil if none
-    def next
-      complete_chunk_size = 4 + @size_length + @header_size + self.size
-      remaining_size = @max_size - complete_chunk_size
-      raise "#{self} - Remaining size for next chunk: #{remaining_size}" if remaining_size < 0
-      remaining_size > 0 ? Chunk.new(@file_name,
-        offset: @offset + complete_chunk_size,
-        chunks_format: @chunks_format,
-        max_size: remaining_size,
-        parent_chunk: @parent_chunk,
-        warnings: @warnings,
-        debug: @debug
-      ) : nil
-    end
-
-    # Return this chunk's data as a list of sub-chunks
-    #
-    # Parameters::
-    # * *data_offset* (Integer): The offset to read the sub-chunks from this chunk's data [default: 0]
-    # * *sub_chunks_format* (Hash<String, Hash<Symbol,Object> >): Chunks format. See Chunk#initialize for details. [default = @chunks_format]
-    # * *warnings* (Boolean): Do we activate warnings? [default: @warnings]
-    # * *debug* (Boolean): Do we activate debugging logs? [default: @debug]
-    # * Proc: Optional code called for each chunk being decoded
-    #   * Parameters::
-    #     * *chunk* (Chunk): Chunk being decoded
-    #   * Result::
-    #     * Boolean: Do we continue decoding chunks?
-    # Result::
-    # * Array<Chunk>: List of sub-chunks
-    def sub_chunks(data_offset: 0, sub_chunk_size_length: @size_length, sub_chunk_header_size: @header_size, sub_chunks_format: @chunks_format, warnings: @warnings, debug: @debug, &callback)
-      data_size = self.size
-      data_size > 0 ? Riffola.read(@file_name,
-        offset: @offset + 4 + @size_length + @header_size + data_offset,
-        chunks_format: sub_chunks_format,
-        max_size: data_size - data_offset,
-        parent_chunk: self,
-        warnings: @warnings,
-        debug: @debug,
-        &callback
-      ) : []
-    end
-
-    # Compare Chunks
-    #
-    # Parameters::
-    # * *other* (Object): Other object
-    # Result::
-    # * Boolean: Are objects equal?
-    def ==(other)
-      other.is_a?(Chunk) &&
-        other.name == self.name &&
-        other.size == self.size &&
-        other.header == self.header &&
-        other.data == self.data
-    end
-
-  end
-
 end

data/lib/riffola/chunk.rb

@@ -0,0 +1,199 @@
+module Riffola
+
+  class Chunk
+
+    # Define default chunk format properties
+    DEFAULT_CHUNK_FORMAT = {
+      size_length: 4,
+      header_size: 0,
+      data_size_correction: 0
+    }
+
+    # Constructor
+    #
+    # Parameters::
+    # * *file_name* (String): The file name
+    # * *offset* (Integer): The offset to read the file from [default: 0]
+    # * *chunks_format* (Hash<String, Hash<Symbol,Object> >): Format of a given set of chunk names (use '*' for all chunks). For each chunk name, the following can be specified: [default = {}]
+    #   * *size_length* (Integer): Number of bytes encoding the size of the chunk [default: 4]
+    #   * *header_size* (Integer): Size of the chunk's header [default: 0]
+    #   * *data_size_correction* (Integer): Correction to apply to the data size read [default: 0]
+    #   Each property can also be a Proc taking the file handle (positioned at the beginning of the chunk) and returning the real value:
+    #     * Parameters::
+    #       * *file* (IO): The file IO, positioned at the beginning of the chunk (at the name)
+    #     * Result::
+    #       * Object: The corresponding property value
+    # * *max_size* (Integer): Maximum readable size (starting from the file's offset) to retrieve chunks, or nil to read till the end of the file [default: nil]
+    # * *parent_chunk* (Chunk or nil): Parent chunk, or nil if none [default: nil]
+    # * *warnings* (Boolean): Do we activate warnings? [default: true]
+    # * *debug* (Boolean): Do we activate debugging logs? [default: false]
+    def initialize(file_name, offset: 0, chunks_format: {}, max_size: nil, parent_chunk: nil, warnings: true, debug: false)
+      @file_name = file_name
+      @offset = offset
+      @chunks_format = chunks_format
+      # Fill the default format if not present
+      @chunks_format['*'] = {} unless @chunks_format.key?('*')
+      DEFAULT_CHUNK_FORMAT.each do |format_property, default_property_value|
+        @chunks_format['*'][format_property] = default_property_value unless @chunks_format['*'].key?(format_property)
+      end
+      @parent_chunk = parent_chunk
+      @max_size = max_size.nil? ? File.size(@file_name) - @offset : max_size
+      @warnings = warnings
+      @debug = debug
+      # Get chunk format in instance variables named after the property
+      chunk_name = self.name
+      DEFAULT_CHUNK_FORMAT.keys.each do |format_property|
+        property_value = @chunks_format.key?(chunk_name) && @chunks_format[chunk_name].key?(format_property) ? @chunks_format[chunk_name][format_property] : @chunks_format['*'][format_property]
+        if property_value.is_a?(Proc)
+          File.open(@file_name) do |file|
+            file.seek(@offset)
+            property_value = property_value.call(file)
+          end
+        end
+        instance_variable_set(:"@#{format_property}", property_value)
+      end
+      puts "[DEBUG] - Read chunk from #{@file_name}@#{@offset}/#{@max_size}: #{chunk_name} (size length: #{@size_length}, header size: #{@header_size}, data size: #{self.size}/#{@max_size})" if @debug
+      # puts "[DEBUG] - Chunks format: #{@chunks_format.inspect}" if @debug
+    end
+
+    # Return the name of this chunk
+    #
+    # Result::
+    # * String: Chunk name
+    def name
+      chunk_name = nil
+      File.open(@file_name) do |file|
+        file.seek(@offset, IO::SEEK_CUR)
+        chunk_name = file.read(4)
+      end
+      puts "[WARNING] - Doesn't look like a valid chunk name: #{chunk_name}" if @warnings && !(chunk_name =~ /^[\w ]{4}$/)
+      chunk_name
+    end
+
+    # Return the size of this chunk
+    #
+    # Result::
+    # * Integer: Chunk size in bytes
+    def size
+      chunk_size = nil
+      File.open(@file_name) do |file|
+        file.seek(@offset + 4, IO::SEEK_CUR)
+        case @size_length
+        when 4
+          chunk_size = file.read(@size_length).unpack('L').first
+        when 2
+          chunk_size = file.read(@size_length).unpack('S').first
+        else
+          raise "Can't decode size field of length #{@size_length}"
+        end
+      end
+      chunk_size + @data_size_correction
+    end
+
+    # Return the header of this chunk
+    #
+    # Result::
+    # * String: Header
+    def header
+      chunk_header = nil
+      File.open(@file_name) do |file|
+        file.seek(@offset + 4 + @size_length, IO::SEEK_CUR)
+        chunk_header = file.read(@header_size)
+      end
+      chunk_header
+    end
+
+    # Return the data of this chunk
+    #
+    # Result::
+    # * String: Data
+    def data
+      chunk_data = nil
+      data_size = self.size
+      complete_header_size = 4 + @size_length + @header_size
+      puts "[WARNING] - Data size is #{data_size} but the maximum readable size is #{@max_size} and the headers have #{complete_header_size}" if @warnings && complete_header_size + data_size > @max_size
+      File.open(@file_name) do |file|
+        file.seek(@offset + complete_header_size, IO::SEEK_CUR)
+        chunk_data = file.read(data_size)
+      end
+      chunk_data
+    end
+
+    # Return the parent chunk, or nil if none
+    #
+    # Result::
+    # * Chunk or nil: The parent chunk, or nil if none
+    def parent_chunk
+      @parent_chunk
+    end
+
+    # Return a string representation of this chunk
+    #
+    # Result::
+    # * String: tring representation of this chunk
+    def to_s
+      "<Riffola-Chunk #{self.name} (#{@file_name}@#{@offset})>"
+    end
+
+    # Return the next chunk
+    #
+    # Result::
+    # * Chunk or nil: The next chunk, or nil if none
+    def next
+      complete_chunk_size = 4 + @size_length + @header_size + self.size
+      remaining_size = @max_size - complete_chunk_size
+      raise "#{self} - Remaining size for next chunk: #{remaining_size}" if remaining_size < 0
+      remaining_size > 0 ? Chunk.new(@file_name,
+        offset: @offset + complete_chunk_size,
+        chunks_format: @chunks_format,
+        max_size: remaining_size,
+        parent_chunk: @parent_chunk,
+        warnings: @warnings,
+        debug: @debug
+      ) : nil
+    end
+
+    # Return this chunk's data as a list of sub-chunks
+    #
+    # Parameters::
+    # * *data_offset* (Integer): The offset to read the sub-chunks from this chunk's data [default: 0]
+    # * *sub_chunks_format* (Hash<String, Hash<Symbol,Object> >): Chunks format. See Chunk#initialize for details. [default = @chunks_format]
+    # * *warnings* (Boolean): Do we activate warnings? [default: @warnings]
+    # * *debug* (Boolean): Do we activate debugging logs? [default: @debug]
+    # * Proc: Optional code called for each chunk being decoded
+    #   * Parameters::
+    #     * *chunk* (Chunk): Chunk being decoded
+    #   * Result::
+    #     * Boolean: Do we continue decoding chunks?
+    # Result::
+    # * Array<Chunk>: List of sub-chunks
+    def sub_chunks(data_offset: 0, sub_chunk_size_length: @size_length, sub_chunk_header_size: @header_size, sub_chunks_format: @chunks_format, warnings: @warnings, debug: @debug, &callback)
+      data_size = self.size
+      data_size > 0 ? Riffola.read(@file_name,
+        offset: @offset + 4 + @size_length + @header_size + data_offset,
+        chunks_format: sub_chunks_format,
+        max_size: data_size - data_offset,
+        parent_chunk: self,
+        warnings: @warnings,
+        debug: @debug,
+        &callback
+      ) : []
+    end
+
+    # Compare Chunks
+    #
+    # Parameters::
+    # * *other* (Object): Other object
+    # Result::
+    # * Boolean: Are objects equal?
+    def ==(other)
+      other.is_a?(Chunk) &&
+        other.name == self.name &&
+        other.size == self.size &&
+        other.header == self.header &&
+        other.data == self.data
+    end
+
+  end
+
+end

data/lib/riffola/version.rb

@@ -1,5 +1,5 @@
 module Riffola
 
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 
 end

metadata

@@ -1,85 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: riffola
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Muriel Salvan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-11 00:00:00.000000000 Z
+date: 2021-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: hex_string
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: sem_ver_components
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  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: ruby-prof
-  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'
+        version: '0.0'
 description: Library reading an extended RIFF format, supporting huge files. RIFF
   format is composed of a list of chunks, each chunk being an identifier, an encoded
   data size, an optional header and chunk data itself. Riffola has ways to deal with
@@ -92,6 +64,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/riffola.rb
+- lib/riffola/chunk.rb
 - lib/riffola/version.rb
 - spec/riffola_spec.rb
 - spec/spec_helper.rb
@@ -114,8 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Riffola - Reading extended RIFF files