bindata 2.4.14 → 2.5.0

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)
-      _ { 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 } )
-      _ { 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 }
-      _ { 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)
-      _ { obj.read(io) }.must_raise BinData::ValidityError
-    end
-  end
-end