binary_plist-parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 87d5a1762931655a435d08575f31156cc2d1eb2650436bcf720416a12040f475
+  data.tar.gz: be07141444b9e3fd0a57d5c87a422dab28b282bb7cd80c1fb04f36b8ce6f2c17
+SHA512:
+  metadata.gz: e1e1636803309cd985f125b3f308624551def8117d0d23ff2ee9965f537788d59060537b71c93644439f8669e2998f980261d0f4eb8185176b889433e8b3287c
+  data.tar.gz: 99e37bed5f348bac4805918227c9cf8ae8477f1ec15292a8345c736ea33d82fa3332e729c796bcb6f39955a0d7ba24fb567a96050cf3ef117677684328aa228e

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format Fuubar
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,12 @@
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*_spec.rb
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma

data/.travis.yml

@@ -0,0 +1,20 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+- "2.6"
+- "2.7"
+before_install: gem install bundler -v 2.0.2
+
+script:
+  - bundle exec rspec
+
+deploy:
+  provider: rubygems
+  api_key:
+    secure: h7iodoUUGjFc94eGydyJcAnkACbjxNJuXXSjMPmw2OwM6x/l4+QqzEBZ52QwqYU0ly0gnSPZeNjkSzvZW6yu2ane53/gZmigrxmAiCo0ClCalpGxH0FDHh2p/8xLvLSzemHdy23yGWI31G/oUIZ5yebUAci2lFps6859Jbyyl9QiqR0ew/e26M5JQl4lG2MeTNCwnYujWBWer8+IPMNV1Jb+BZB3y2fhvCBxtQW1wVawJ1BKwF5mquqrB4stITnhLZl8m3XKQXDFIWbtf/uFKcAnM6cHq7PVUQrTWeeNAYvC359KWxkKe8nILWu14rFchsgRK6XHGmzV+dkTDzDaWTHSqsaqTSfT9reB1EjB5IgKn6Iix+NZfolariNtV70m/ZZf0Gl/Igt9F2LdkPPd5zFvkcGaNM2skp8d95yewCLY2iGrsigXFl7SGxKWvZQn+1kiN1f5wP1y6osB1iTxwXm8WpQHzD4I4rhMOdi3uAgkAJLJelYxH125IF59+iZZI1qsud30qVCLdkYm41iyL+FlSEocJ0v1/ooL5GTrusBoYhGvASMs6R9HDha50iqvfKKQqpBR9jgHijDmmZqSTyVX7y+VyK8oK91OWCxsfpxBr64iJVqNOOiXSpAiR4igpCWP3iQFHV3SNUbMw/fMI5KwYkiL8jDLLNKkTjp80Sc=
+  gem: binary_plist-parser
+  on:
+    tags: true
+    repo: telyn/binary_plist
+  skip_cleanup: 'true'

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in binary_plist_parser.gemspec
+gemspec
+
+gem "guard-rspec", "~> 4.7"
+
+gem "fuubar", "~> 2.5"

data/Gemfile.lock

@@ -0,0 +1,75 @@
+PATH
+  remote: .
+  specs:
+    binary_plist-parser (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    diff-lcs (1.3)
+    ffi (1.13.1)
+    formatador (0.2.5)
+    fuubar (2.5.0)
+      rspec-core (~> 3.0)
+      ruby-progressbar (~> 1.4)
+    guard (2.16.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.5)
+    method_source (1.0.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.0.1)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    ruby-progressbar (1.10.1)
+    shellany (0.0.1)
+    thor (1.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  binary_plist-parser!
+  bundler (~> 2.0)
+  fuubar (~> 2.5)
+  guard-rspec (~> 4.7)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/Guardfile

@@ -0,0 +1,70 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Telyn Z.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# binary_plist
+
+A parser (and maybe someday dumper) for Apple's bplist data format
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'binary_plist-parser'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+
+```ruby
+require "binary_plist/parser"
+
+BinaryPList::Parser::BPList00.new(IO.read("spec/support/test-data/0")).parse
+
+# => ["Cool Idea\n7", "abandoned\n1"]  
+```
+
+You can also pass in an IO object instead of a string:
+
+```
+require "binary_plist/parser"
+
+File.open("spec/support/test-data/0", "r") do |fh|
+  BinaryPList::Parser::BPList00.new(fh).parse
+end
+
+# => ["Cool Idea\n7", "abandoned\n1"]  
+```
+
+## Development
+
+After checking out the repo, run `bundle` to install dependencies. Then, run
+`rspec` to run the tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/telyn/binary_plist.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "binary_plist_parser"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/binary_plist-parser.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "binary_plist/parser/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "binary_plist-parser"
+  spec.version       = BinaryPlistParser::VERSION
+  spec.authors       = ["Telyn Z."]
+  spec.email         = ["175827+telyn@users.noreply.github.com"]
+
+  spec.summary       = ""
+  spec.description   = ""
+  spec.homepage      = "https://github.com/telyn/binary_plist"
+  spec.license       = "MIT"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added
+  # into git.
+  spec.files         = `git ls-files -z`.split("\x0")
+                       .reject { |f| f.match(%r{^(test|spec|features)/}) }
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/binary_plist.rb

@@ -0,0 +1,9 @@
+class BinaryPList
+  def self.load
+
+  end
+
+  def self.dump
+    raise "Sorry - I haven't implemented a dump function. Check out the binary_plist gem"
+  end
+end

data/lib/binary_plist/parser.rb

@@ -0,0 +1,8 @@
+require "binary_plist/parser/version"
+
+module BinaryPlistParser
+  class Error < StandardError; end
+  class UnsupportedMarkerError < Error; end
+end
+
+require "binary_plist/parser/bplist00"

data/lib/binary_plist/parser/bplist00.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "binary_plist/trailer"
+require "binary_plist/parser/offset_table"
+
+require "binary_plist/parser/object_readers/base"
+require "binary_plist/parser/object_readers/array"
+require "binary_plist/parser/object_readers/ascii_string"
+require "binary_plist/parser/object_readers/int"
+require "binary_plist/parser/object_readers/null"
+require "binary_plist/parser/object_readers/utf16_string"
+
+module BinaryPList
+  module Parser
+    class BPList00 < ObjectReaders::Base
+      class << self
+        def readers
+          @readers ||= [
+            ObjectReaders::ASCIIString,
+            ObjectReaders::Array,
+            ObjectReaders::Int,
+            ObjectReaders::Null,
+            ObjectReaders::UTF16String,
+          ]
+        end
+      end
+
+      MAGIC = "bplist00"
+      NotBPList00 = Class.new(StandardError)
+
+      def initialize(io)
+        io = StringIO.new(io) if io.is_a? String
+        raise NotBPList00 unless io.read(MAGIC.length).eql? MAGIC
+
+        @io = io
+        super(self.class, io, nil, nil)
+      end
+
+      def parse
+        object(trailer.top_object)
+      end
+
+      private
+
+      def offset_table
+        @offset_table ||= OffsetTable.new(@io,
+                                          trailer.offset_table_offset,
+                                          trailer.offset_int_size)
+      end
+
+      def trailer
+        @trailer ||=
+          begin
+            @io.seek(-32, File::SEEK_END)
+            Trailer.load(io)
+          end
+      end
+    end
+  end
+end

data/lib/binary_plist/parser/object_readers/array.rb

@@ -0,0 +1,40 @@
+require "binary_plist/parser/object_readers/base"
+require "binary_plist/parser/object_readers/int"
+
+module BinaryPList
+  module Parser
+    module ObjectReaders
+      class Array < Base
+        def self.reads?(marker)
+          return true if (0b1010_0000..0b1010_1111).include?(marker)
+
+          false
+        end
+
+        def read(marker)
+          raise UnsupportedMarkerError, marker unless self.class.reads?(marker)
+
+          @marker = marker
+
+          object_refs.map do |object_ref|
+            object(object_ref)
+          end
+        end
+
+        def object_refs
+          array_length.times.map do
+            read_objref
+          end
+        end
+
+        def array_length
+          if @marker == 0b1010_1111
+            Int.new(nil, io, offset_table, trailer).read(io.getbyte)
+          else
+            @marker - 0b1010_0000
+          end
+        end
+      end
+    end
+  end
+end

data/lib/binary_plist/parser/object_readers/ascii_string.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "binary_plist/parser/object_readers/base"
+require "binary_plist/parser/object_readers/int"
+
+module BinaryPList
+  module Parser
+    module ObjectReaders
+      class ASCIIString < Base
+        def self.reads?(marker)
+          (0b0101_0000..0b0101_1111).include?(marker)
+        end
+
+        def read(marker)
+          raise UnsupportedMarkerError, marker unless self.class.reads?(marker)
+
+          @marker = marker
+
+          read_bytes(string_length)
+            .force_encoding("ASCII-8BIT")
+            .encode("UTF-8")
+        end
+
+        def string_length
+          @string_length ||= if (@marker & 0xF) == 0xF
+                               Int.new(nil, io, offset_table, trailer)
+                                  .read(read_byte)
+                             else
+                               @marker & 0xF
+                             end
+        end
+      end
+    end
+  end
+end

data/lib/binary_plist/parser/object_readers/base.rb

@@ -0,0 +1,84 @@
+module BinaryPList
+  module Parser
+    module ObjectReaders
+      class UnsupportedMarkerError < StandardError; end
+
+      # In order for a subclass to be used by Base#read_object, it must do three
+      # things:
+      # 1) Be included in the main_class.readers
+      # 2) Implement .reads?(marker) - which returns true when it can read the
+      #    given marker
+      # 3) Implement #read(marker) - which reads the given marker.
+      class Base
+        def initialize(main_class, io, offset_table, trailer)
+          @main_class = main_class
+          @io = io
+          @offset_table = offset_table
+          @trailer = trailer
+        end
+
+        # called in subclasses by #read_object.
+        # at the beginning of #read,, the next byte read by any read calls to
+        # #io will be the byte immediately following the marker byte.
+        # @param [Integer] marker the marker byte
+        # @return some object
+        def read(marker)
+          raise NotImplementedError
+        end
+
+        private
+
+        def object(ref)
+          trailer.check_object_reference!(ref)
+
+          read_object(offset_table.object_offset(ref))
+        end
+
+        def read_object(offset)
+          trailer.check_object_offset!(offset)
+
+          io.seek(offset)
+          marker = io.getbyte
+
+          reader = reader_for(marker)
+          raise UnsupportedMarkerError, marker if reader.nil?
+
+          reader.read(marker)
+        end
+
+        def reader_for(marker)
+          @main_class.readers.find do |klass|
+            klass.reads? marker
+          end&.new(@main_class, io, offset_table, trailer)
+        end
+
+        def read_objref
+          read_int(trailer.object_ref_size)
+        end
+
+        def read_int(size)
+          size.times
+              .map { read_byte }
+              .reduce(0) do |acc, byte|
+            (acc << 8) | byte
+          end
+        end
+
+        def read_byte
+          trailer.check_object_offset!(io.tell)
+          io.getbyte
+        end
+
+        def read_bytes(bytes)
+          return "" if bytes.zero?
+
+          trailer.check_object_offset!(io.tell + bytes - 1)
+          io.read(bytes)
+        end
+
+
+        attr_reader :offset_table, :trailer, :io
+      end
+    end
+  end
+end

data/lib/binary_plist/parser/object_readers/int.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "binary_plist/parser/object_readers/base"
+
+module BinaryPList
+  module Parser
+    module ObjectReaders
+      class Int < Base
+        def self.reads?(marker)
+          (0b0001_0000..0b0001_1111).include?(marker)
+        end
+
+        def read(marker)
+          raise UnsupportedMarkerError, marker unless self.class.reads?(marker)
+
+          marker_length = marker & 0xF
+
+          bytes_count = (1 << marker_length)
+          # raise OffsetOutOfRangeError if outside_object_table?(io.tell + bytes_count)
+
+          read_int(bytes_count)
+        end
+      end
+    end
+  end
+end

data/lib/binary_plist/parser/object_readers/null.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "binary_plist/parser/object_readers/base"
+
+module BinaryPList
+  module Parser
+    module ObjectReaders
+      class Null < Base
+        def self.reads?(marker)
+          (0..0).include?(marker)
+        end
+
+        def read(marker)
+          raise UnsupportedMarkerError, marker unless self.class.reads?(marker)
+
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/binary_plist/parser/object_readers/utf16_string.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "binary_plist/parser/object_readers/base"
+require "binary_plist/parser/object_readers/int"
+
+module BinaryPList
+  module Parser
+    module ObjectReaders
+      class UTF16String < Base
+        def self.reads?(marker)
+          (0b0110_0000..0b0110_1111).include?(marker)
+        end
+
+        def read(marker)
+          raise UnsupportedMarkerError, marker unless self.class.reads?(marker)
+
+          @marker = marker
+
+          read_bytes(string_length * 2)
+            .force_encoding("UTF-16BE")
+            .encode("UTF-8")
+        end
+
+        def string_length
+          @string_length ||= if (@marker & 0xF) == 0xF
+                               Int.new(nil, io, offset_table, trailer)
+                                  .read(read_byte)
+                             else
+                               @marker & 0xF
+                             end
+        end
+      end
+    end
+  end
+end

data/lib/binary_plist/parser/offset_table.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module BinaryPList
+  module Parser
+    OutOfBoundsError = Class.new(StandardError)
+
+    class OffsetTable
+      def initialize(io, offset, int_size)
+        @io = io
+        @int_size = int_size
+        @offset = offset
+
+        pos = io.tell
+        io.seek(-32, File::SEEK_END)
+        @last_int_loc = io.tell - @int_size
+        io.seek(pos)
+      end
+
+      def object_offset(num)
+        seek(object_offset_location(num))
+        read_arbitrary_int(int_size)
+      end
+
+      private
+
+      attr_reader :io, :offset, :int_size
+
+      def object_offset_location(num)
+        offset + num * int_size
+      end
+
+      # TODO: refactor into helper module
+      def read_arbitrary_int(len)
+        bytes = io.read(len)
+        bytes.split("").reduce(0) do |int, byte|
+          (int << 8) | byte.unpack("C").first
+        end
+      end
+
+      def seek(pos)
+        raise OutOfBoundsError if @last_int_loc < pos
+
+        @io.seek(pos)
+      end
+    end
+  end
+end

data/lib/binary_plist/parser/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BinaryPlistParser
+  VERSION = "0.1.0"
+end

data/lib/binary_plist/trailer.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module BinaryPList
+  # Error raised when attempting to reference an object.
+  # When the reference number is larger than the number of objects specified in
+  # the trailer.
+  class ObjectOutOfRangeError < StandardError; end
+  # Error raised when attempting to read an offset from outside the range it
+  # should be in.
+  # For example, if an array object says it is 12 bytes, but there're only 6
+  # more bytes in the Object Table, then this error will be raised.
+  class OffsetOutOfRangeError < StandardError; end
+
+  Trailer = Struct.new(:sort_version,
+                       :offset_int_size,
+                       :object_ref_size,
+                       :num_objects,
+                       :top_object,
+                       :offset_table_offset) do
+    def self.load(io)
+      bytes = io.is_a?(String) ? bytes : io.read(32)
+
+      sort_version, offset_int_size, object_ref_size,
+        num_objects, top_object, offset_table_offset =
+        bytes.unpack("@5 CCC Q>3")
+
+      Trailer.new(sort_version,
+                  offset_int_size,
+                  object_ref_size,
+                  num_objects,
+                  top_object,
+                  offset_table_offset)
+    end
+
+    def pack
+      [0, 0, 0, 0, 0, sort_version, offset_int_size, object_ref_size,
+       num_objects, top_object, offset_table_offset].pack("C8Q>3")
+    end
+
+    def check_object_offset!(offset)
+      return if object_table_range.include?(offset)
+
+      raise OffsetOutOfRangeError, offset: offset, range: object_table_range
+    end
+
+    def check_object_reference!(ref)
+      return unless num_objects < ref
+
+      raise ObjectOutOfRangeError, num: num, max: trailer.num_objects
+    end
+
+    def object_table_range
+      (8...offset_table_offset)
+    end
+
+    def offset_table_range
+      (offset_table_offset..offset_table_offset + num_objects * offset_int_size)
+    end
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: binary_plist-parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Telyn Z.
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: ''
+email:
+- 175827+telyn@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- binary_plist-parser.gemspec
+- lib/binary_plist.rb
+- lib/binary_plist/parser.rb
+- lib/binary_plist/parser/bplist00.rb
+- lib/binary_plist/parser/object_readers/array.rb
+- lib/binary_plist/parser/object_readers/ascii_string.rb
+- lib/binary_plist/parser/object_readers/base.rb
+- lib/binary_plist/parser/object_readers/int.rb
+- lib/binary_plist/parser/object_readers/null.rb
+- lib/binary_plist/parser/object_readers/utf16_string.rb
+- lib/binary_plist/parser/offset_table.rb
+- lib/binary_plist/parser/version.rb
+- lib/binary_plist/trailer.rb
+homepage: https://github.com/telyn/binary_plist
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/telyn/binary_plist
+  source_code_uri: https://github.com/telyn/binary_plist
+  changelog_uri: https://github.com/telyn/binary_plist/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.4
+signing_key:
+specification_version: 4
+summary: ''
+test_files: []