bindata 2.4.10 → 2.5.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bindata
 version: !ruby/object:Gem::Version
-  version: 2.4.10
+  version: 2.5.0
 platform: ruby
 authors:
 - Dion Mendel
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-18 00:00:00.000000000 Z
+date: 1980-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -31,9 +31,6 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: 5.0.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 5.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -41,11 +38,8 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: 5.0.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 5.12.0
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -71,13 +65,9 @@ extensions: []
 extra_rdoc_files:
 - NEWS.rdoc
 files:
-- ".gitignore"
-- ".travis.yml"
-- BSDL
-- COPYING
 - ChangeLog.rdoc
 - Gemfile
-- INSTALL
+- LICENSE
 - NEWS.rdoc
 - README.md
 - Rakefile
@@ -105,18 +95,25 @@ files:
 - lib/bindata/io.rb
 - lib/bindata/lazy.rb
 - lib/bindata/name.rb
-- lib/bindata/offset.rb
 - lib/bindata/params.rb
 - lib/bindata/primitive.rb
 - lib/bindata/record.rb
 - lib/bindata/registry.rb
 - lib/bindata/rest.rb
 - lib/bindata/sanitize.rb
+- lib/bindata/section.rb
 - lib/bindata/skip.rb
 - lib/bindata/string.rb
 - lib/bindata/stringz.rb
 - lib/bindata/struct.rb
 - lib/bindata/trace.rb
+- lib/bindata/transform/brotli.rb
+- lib/bindata/transform/lz4.rb
+- lib/bindata/transform/lzma.rb
+- lib/bindata/transform/xor.rb
+- lib/bindata/transform/xz.rb
+- lib/bindata/transform/zlib.rb
+- lib/bindata/transform/zstd.rb
 - lib/bindata/uint8_array.rb
 - lib/bindata/version.rb
 - lib/bindata/virtual.rb
@@ -134,12 +131,12 @@ files:
 - test/int_test.rb
 - test/io_test.rb
 - test/lazy_test.rb
-- test/offset_test.rb
 - test/params_test.rb
 - test/primitive_test.rb
 - test/record_test.rb
 - test/registry_test.rb
 - test/rest_test.rb
+- test/section_test.rb
 - test/skip_test.rb
 - test/string_test.rb
 - test/stringz_test.rb
@@ -151,9 +148,9 @@ files:
 - test/warnings_test.rb
 homepage: https://github.com/dmendel/bindata
 licenses:
-- Ruby
+- BSD-2-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--main"
 - NEWS.rdoc
@@ -163,15 +160,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.4.22
+signing_key:
 specification_version: 4
 summary: A declarative way to read and write binary file formats
 test_files: []

data/.gitignore

@@ -1,2 +0,0 @@
-Gemfile.lock
-wiki

data/.travis.yml

@@ -1,15 +0,0 @@
-language: ruby
-rvm:
-  - 2.2
-  - 2.3
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7
-  - jruby
-  - ruby-head
-
-matrix:
-  allow_failures:
-    - rvm: jruby
-    - rvm: ruby-head

data/BSDL

@@ -1,22 +0,0 @@
-Copyright (C) 2007-2012 Dion Mendel. All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions
-are met:
-1. Redistributions of source code must retain the above copyright
-notice, this list of conditions and the following disclaimer.
-2. Redistributions in binary form must reproduce the above copyright
-notice, this list of conditions and the following disclaimer in the
-documentation and/or other materials provided with the distribution.
-
-THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
-OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
-HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
-LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
-OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGE.

data/COPYING

@@ -1,52 +0,0 @@
-BinData is copyrighted free software by Dion Mendel <bindata@dm9.info>.
-You can redistribute it and/or modify it under either the terms of the
-2-clause BSDL (see the file BSDL), or the conditions below:
-
-  1. You may make and give away verbatim copies of the source form of the
-     software without restriction, provided that you duplicate all of the
-     original copyright notices and associated disclaimers.
-
-  2. You may modify your copy of the software in any way, provided that
-     you do at least ONE of the following:
-
-       a) place your modifications in the Public Domain or otherwise
-          make them Freely Available, such as by posting said
-	  modifications to Usenet or an equivalent medium, or by allowing
-	  the author to include your modifications in the software.
-
-       b) use the modified software only within your corporation or
-          organization.
-
-       c) give non-standard binaries non-standard names, with
-          instructions on where to get the original software distribution.
-
-       d) make other distribution arrangements with the author.
-
-  3. You may distribute the software in object code or binary form,
-     provided that you do at least ONE of the following:
-
-       a) distribute the binaries and library files of the software,
-	  together with instructions (in the manual page or equivalent)
-	  on where to get the original distribution.
-
-       b) accompany the distribution with the machine-readable source of
-	  the software.
-
-       c) give non-standard binaries non-standard names, with
-          instructions on where to get the original software distribution.
-
-       d) make other distribution arrangements with the author.
-
-  4. You may modify and include the part of the software into any other
-     software (possibly commercial).
-
-  5. The scripts and library files supplied as input to or produced as 
-     output from the software do not automatically fall under the
-     copyright of the software, but belong to whomever generated them, 
-     and may be sold commercially, and may be aggregated with this
-     software.
-
-  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
-     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
-     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-     PURPOSE.

data/INSTALL

@@ -1,12 +0,0 @@
-This package is designed to be installed with rubygems.
-
-    $ gem install bindata
-
-If you are using ruby 1.8
-
-    $ gem install bindata -v '~> 1.8.0'
-
-If you are not using rubygems, you may like to install BinData with
-Minero Aoki's setup.rb found at:
-
-    https://github.com/rubyworks/setup

data/lib/bindata/offset.rb

@@ -1,94 +0,0 @@
-module BinData
-  # WARNING: THIS IS UNSUPPORTED!!
-  #
-  # This was a (failed) experimental feature that allowed seeking within the
-  # input stream.  It remains here for backwards compatability for the few
-  # people that used it.
-  #
-  # The official way to skip around the stream is to use BinData::Skip with
-  # the `:to_abs_offset` parameter.
-  #
-  # == Parameters
-  #
-  # Parameters may be provided at initialisation to control the behaviour of
-  # an object.  These parameters are:
-  #
-  # [<tt>:check_offset</tt>]  Raise an error if the current IO offset doesn't
-  #                           meet this criteria.  A boolean return indicates
-  #                           success or failure.  Any other return is compared
-  #                           to the current offset.  The variable +offset+
-  #                           is made available to any lambda assigned to
-  #                           this parameter.  This parameter is only checked
-  #                           before reading.
-  # [<tt>:adjust_offset</tt>] Ensures that the current IO offset is at this
-  #                           position before reading.  This is like
-  #                           <tt>:check_offset</tt>, except that it will
-  #                           adjust the IO offset instead of raising an error.
-  module CheckOrAdjustOffsetPlugin
-
-    def self.included(base) #:nodoc:
-      base.optional_parameters :check_offset, :adjust_offset
-      base.mutually_exclusive_parameters :check_offset, :adjust_offset
-    end
-
-    def initialize_shared_instance
-      extend CheckOffsetMixin  if has_parameter?(:check_offset)
-      extend AdjustOffsetMixin if has_parameter?(:adjust_offset)
-      super
-    end
-
-    module CheckOffsetMixin
-      def do_read(io) #:nodoc:
-        check_offset(io)
-        super(io)
-      end
-
-      #---------------
-      private
-
-      def check_offset(io)
-        actual_offset = io.offset
-        expected = eval_parameter(:check_offset, offset: actual_offset)
-
-        if !expected
-          raise ValidityError, "offset not as expected for #{debug_name}"
-        elsif actual_offset != expected && expected != true
-          raise ValidityError,
-                "offset is '#{actual_offset}' but " +
-                "expected '#{expected}' for #{debug_name}"
-        end
-      end
-    end
-
-    module AdjustOffsetMixin
-      def do_read(io) #:nodoc:
-        adjust_offset(io)
-        super(io)
-      end
-
-      #---------------
-      private
-
-      def adjust_offset(io)
-        actual_offset = io.offset
-        expected = eval_parameter(:adjust_offset)
-        if actual_offset != expected
-          begin
-            seek = expected - actual_offset
-            io.seekbytes(seek)
-            warn "adjusting stream position by #{seek} bytes" if $VERBOSE
-          rescue
-            raise ValidityError,
-                  "offset is '#{actual_offset}' but couldn't seek to " +
-                  "expected '#{expected}' for #{debug_name}"
-          end
-        end
-      end
-    end
-  end
-
-  # Add these offset options to Base
-  class Base
-    include CheckOrAdjustOffsetPlugin
-  end
-end

data/test/offset_test.rb

@@ -1,100 +0,0 @@
-#!/usr/bin/env ruby
-
-require File.expand_path(File.join(File.dirname(__FILE__), "test_helper"))
-require 'bindata/offset'
-
-describe BinData::Base, "offsets" do
-  class ThreeByteReader < BinData::Base
-    def do_read(io)
-      @val = io.readbytes(3)
-    end
-
-    def snapshot
-      @val
-    end
-  end
-
-  class TenByteOffsetBase < BinData::Base
-    def self.create(params)
-      obj = self.new
-      obj.initialize_child(params)
-      obj
-    end
-
-    def initialize_child(params)
-      @child = ThreeByteReader.new(params, self)
-    end
-
-    def snapshot
-      @child.snapshot
-    end
-
-    def do_read(io)
-      io.seekbytes(10)
-      @child.do_read(io)
-    end
-
-    def clear
-    end
-  end
-
-  let(:data) { "0123456789abcdefghijk" }
-  let(:io) { StringIO.new(data) }
-
-  describe "with :check_offset" do
-    it "fails when offset is incorrect" do
-      io.seek(2)
-      obj = TenByteOffsetBase.create(check_offset: 10 - 4)
-      lambda { obj.read(io) }.must_raise BinData::ValidityError
-    end
-
-    it "succeeds when offset is correct" do
-      io.seek(3)
-      obj = TenByteOffsetBase.create(check_offset: 10)
-      obj.read(io).snapshot.must_equal data[3 + 10, 3]
-    end
-
-    it "fails when :check_offset fails" do
-      io.seek(4)
-      obj = TenByteOffsetBase.create(check_offset: -> { offset == 10 + 1 } )
-      lambda { obj.read(io) }.must_raise BinData::ValidityError
-    end
-
-    it "succeeds when :check_offset succeeds" do
-      io.seek(5)
-      obj = TenByteOffsetBase.create(check_offset: -> { offset == 10 } )
-      obj.read(io).snapshot.must_equal data[5 + 10, 3]
-    end
-  end
-
-  describe "with :adjust_offset" do
-    it "is mutually exclusive with :check_offset" do
-      params = { check_offset: 8, adjust_offset: 8 }
-      lambda { TenByteOffsetBase.create(params) }.must_raise ArgumentError
-    end
-
-    it "adjust offset when incorrect" do
-      w, $-w = $-w, false
-
-      begin
-        io.seek(2)
-        obj = TenByteOffsetBase.create(adjust_offset: 13)
-        obj.read(io).snapshot.must_equal data[2 + 13, 3]
-      ensure
-        $-w = w
-      end
-    end
-
-    it "succeeds when offset is correct" do
-      io.seek(3)
-      obj = TenByteOffsetBase.create(adjust_offset: 10)
-      obj.read(io).snapshot.must_equal data[3 + 10, 3]
-    end
-
-    it "fails if cannot adjust offset" do
-      io.seek(4)
-      obj = TenByteOffsetBase.create(adjust_offset: -5)
-      lambda { obj.read(io) }.must_raise BinData::ValidityError
-    end
-  end
-end