nbt_utils 0.0.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c47cdd430f8c7666f68f40f505c7644efbad37aa
-  data.tar.gz: 75efc43db2901b025bd1ff8e834e235abd9fb0a7
+SHA256:
+  metadata.gz: 2cd4381d03d4fbcfe77b3be94f2d52d66899f8e89d1095cfbb359f3455f153d2
+  data.tar.gz: 1b9f9ccbaf59dc071093bc5f3d50035a54717f8fffc0cd7cc5d45e51027577e4
 SHA512:
-  metadata.gz: 743f9440efcf013105f404653893f85e26fbb5f81705077e3df36a32276b9cdfd04447dbf633b2dbc53714af0639ff95681c908fb0537bea7cb160c618ec6bd9
-  data.tar.gz: 4fd80a295519ec8d825f9b091d0d0c785a83f2d3029f4ac5de464ba2dacddc7ee5a6db552aa54b1a535b21435c4d4cae3254e52e311061920aa0584aaf192f15
+  metadata.gz: 2b9422f9cf06b75d5b85483857a96dd1a674888fd353e25305c6182c83997ca2685c401b08977eca36725f62af353a2b3fe1f0649219b77a9c9066397efd2624
+  data.tar.gz: 58a8fe25760a2bb28655d4f11b66ffa6ef8ae0f6e450f49d768a3fa54db81f95a1c3f238c964add962a94b49e087758b9b163045d7213bceaf05aefb29659481

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: /
+    schedule:
+      interval: daily

data/.github/workflows/ci.yml

@@ -0,0 +1,24 @@
+name: CI
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+      - name: Run Rubocop
+        run: bundle exec rubocop
+      - name: Run Specs
+        run: rake spec

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,37 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: '2.7.0'
+  NewCops: enable
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.1.2

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'http://rubygems.org'
 
 gemspec

data/Gemfile.lock

@@ -1,17 +1,62 @@
 PATH
   remote: .
   specs:
-    nbt_utils (0.0.3)
-      bindata (~> 1.3)
+    nbt_utils (0.5.0)
+      bindata (~> 2)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    bindata (1.3.1)
+    ast (2.4.2)
+    bindata (2.4.10)
+    diff-lcs (1.5.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.30.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.14.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (2.11.1)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (>= 1.0.0)
   nbt_utils!
+  rspec (~> 3)
+  rubocop (~> 1)
+  rubocop-performance (~> 1)
+  rubocop-rspec (~> 2)
+
+BUNDLED WITH
+   2.3.15

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2021 Michael Dungan
+
+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

@@ -1,32 +1,28 @@
-nbt_utils
-=========
+# nbt_utils
 
-Some classes for handling [Minecraft](http://minecraft.net) .nbt files.
+Some classes for handling [Minecraft](http://minecraft.net) `.nbt` files.
 
-See the spec (NBT.txt in doc directory) for more info.
+See the spec (`NBT.txt` in doc directory) for more info.
 
-Installation
-============
+## Installation
 
-Requires ruby 1.9 minimum. Tested with 1.9.2+
+Requires Ruby 2.7 minimum.
 
     gem install nbt_utils
 
-No sudo. You *are* using [rvm](http://rvm.beginrescueend.com/), right?
+## Use
 
-Use
-===
+```ruby
+require 'nbt_utils'
 
-    require 'nbt_utils'
+@file = NBTUtils::File.new
+@tag = @file.read('some_nbt_file.nbt')
+puts @tag.to_s
+@file.write('some_new_path.nbt', @tag, true) # true / false to gzip automatically
+```
 
-    @file = NBTUtils::File.new
-    @tag = @file.read('some_nbt_file.nbt')
-    puts @tag.to_s
-    @file.write('some_path.nbt', @tag, <compress? true/false>)
+### Copyright
 
-Copyright
-=========
-
-Copyright (c) 2010-2015 Michael Dungan, mpd@jesters-court.net, released under the MIT license.
+Copyright Michael Dungan, mpd@jesters-court.net, released under the MIT license.
 
 The files `NBT.txt`, `test.nbt`, `test_uncompressed.nbt`, `bigtest.nbt`, and `bigtest_uncompressed.nbt` in the doc directory are mirrored from the Minecraft website and not covered under the above license.

data/Rakefile

@@ -1,2 +1,10 @@
+# frozen_string_literal: true
+
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError # rubocop:disable Lint/SuppressedException
+end

data/lib/nbt_utils/file.rb

@@ -1,41 +1,40 @@
+# frozen_string_literal: true
+
 module NBTUtils
   class File
+    attr_reader :path, :content, :compressed, :tag
+
     def initialize(path = nil)
       @path = path
     end
 
-    def read(path = @path)
+    def read(read_path = path)
       # Zlib does not provide a way to test a file for compressed, and I'm
       # not going to tool around with magic numbers, so I guess we use
       # exceptions for flow control.
       begin
-        Zlib::GzipReader.open(path) do |f|
+        Zlib::GzipReader.open(read_path) do |f|
           @content = StringIO.new(f.read)
         end
         @compressed = true
       rescue Zlib::GzipFile::Error
-        ::File.open(path) do |f|
-          @content = StringIO.new(f.read)
-        end
+        @content = StringIO.new(::File.read(read_path))
         @compressed = false
       end
 
-
-      last_byte = @content.read(1).bytes.first
+      last_byte = content.read(1).bytes.first
       klass = NBTUtils::Tag.tag_type_to_class(last_byte)
 
-      @tag = klass.new(@content, true)
+      @tag = klass.new(content, named: true)
     end
 
-    def write(path = @path, tag = @tag, compressed = @compressed)
-      if compressed
-        Zlib::GzipWriter.open(path) do |gz|
-          gz.write tag.to_nbt_string
+    def write(write_path = path, write_tag = tag, write_compressed = compressed)
+      if write_compressed
+        Zlib::GzipWriter.open(write_path) do |gz|
+          gz.write write_tag.to_nbt_string
         end
       else
-        ::File.open(path, 'w') do |f|
-          f.write tag.to_nbt_string
-        end
+        ::File.write(write_path, write_tag.to_nbt_string)
       end
     end
   end

data/lib/nbt_utils/tag/byte.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 module NBTUtils
   module Tag
-    class Byte # signed, per spec
+    # signed, per spec
+    class Byte
       include NBTUtils::Tag
 
       type_id 1

data/lib/nbt_utils/tag/byte_array.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module NBTUtils
   module Tag
     class ByteArray
@@ -5,31 +7,31 @@ module NBTUtils
 
       type_id 7
 
-      def initialize(io, named = true)
+      def initialize(io, named: true)
         read_name(io) if named
 
         len = ::BinData::Int32be.new.read(io).value
         # use single string for the payload because an array means each byte is a
         # separate object which is incredibly SLOW
-        @payload = ::BinData::String.new(:read_length => len).read(io)
+        @payload = ::BinData::String.new(read_length: len).read(io)
       end
 
       def to_s(indent = 0)
-        (' ' * indent) + "TAG_Byte_Array#{@name ? "(\"#{@name}\")" : ''}: [#{@payload.length} bytes]"
+        (' ' * indent) + "TAG_Byte_Array#{name ? "(\"#{name}\")" : ''}: [#{payload.length} bytes]"
       end
 
-      def to_nbt_string(named = true)
+      def to_nbt_string(named: true)
         result = named ? binary_type_id + name_to_nbt_string : ''
         len = ::BinData::Int32be.new
-        len.value = @payload.length
+        len.value = payload.length
         result << len.to_binary_s
-        result + @payload.to_binary_s
+        result + payload.to_binary_s
       end
 
       def set_value(new_value, index)
         b = ::BinData::Uint8.new
         b.value = new_value
-        @payload[index] = b.to_binary_s
+        payload[index] = b.to_binary_s
       end
     end
   end

data/lib/nbt_utils/tag/compound.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module NBTUtils
   module Tag
     class Compound
@@ -5,55 +7,58 @@ module NBTUtils
 
       type_id 10
 
-      def initialize(io, named = true)
+      attr_reader :tag_names
+
+      def initialize(io, named: true)
         @payload = []
         @tag_names = []
         read_name(io) if named
 
         until (last_byte = io.read(1).bytes.first) == NBTUtils::Tag::End.type_id
           klass = tag_type_to_class(last_byte)
-          add_tag klass.new(io, true)
+          add_tag klass.new(io, named: true)
         end
       end
 
       def to_s(indent = 0)
-        ret = (' ' * indent) + "TAG_Compound#{@name ? "(\"#{@name}\")" : ''}: #{@payload.length} entries\n"
-        ret << (' ' * indent) + "{\n"
-        @payload.each do |load|
+        ret = (' ' * indent) + "TAG_Compound#{name ? "(\"#{name}\")" : ''}: #{payload.length} entries\n"
+        ret << ("#{' ' * indent}{\n")
+        payload.each do |load|
           ret << "#{load.to_s(indent + 2)}\n"
         end
-        ret << (' ' * indent) + "}"
+        ret << ("#{' ' * indent}}")
 
         ret
       end
 
-      def to_nbt_string(named = true)
+      def to_nbt_string(named: true)
         result = named ? binary_type_id + name_to_nbt_string : ''
 
-        result = @payload.inject(result) do |r, load|
-          r + load.to_nbt_string(true)
+        result = payload.inject(result) do |r, load|
+          r + load.to_nbt_string(named: true)
         end
 
         result + NBTUtils::Tag::End.new(nil).to_nbt_string
       end
 
       def find_tag(name)
-        if name.kind_of?(Regexp)
-          @payload.detect { |tag| tag.name.to_s =~ /#{name}/ }
+        if name.is_a?(Regexp)
+          payload.detect { |tag| tag.name.to_s =~ /#{name}/ }
         else
-          @payload.detect { |tag| tag.name.to_s == name }
+          payload.detect { |tag| tag.name.to_s == name }
         end
       end
 
       def find_tags(name)
-        @payload.select { |tag| tag.name.to_s =~ /#{name}/ }
+        payload.select { |tag| tag.name.to_s =~ /#{name}/ }
       end
 
       def add_tag(tag)
         raise MissingCompoundPayloadTagNameError if tag.name.nil?
-        raise DuplicateCompoundPayloadTagNameError if @tag_names.include?(tag.name)
-        @tag_names << tag.name
-        @payload << tag
+        raise DuplicateCompoundPayloadTagNameError if tag_names.include?(tag.name)
+
+        tag_names << tag.name
+        payload << tag
       end
 
       # update one of my tags indirectly
@@ -68,7 +73,7 @@ module NBTUtils
       end
 
       def remove_tag(name)
-        @payload.delete find_tag(name)
+        payload.delete find_tag(name)
       end
     end
   end

data/lib/nbt_utils/tag/double.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 module NBTUtils
   module Tag
-    class Double # signed, per spec
+    # signed, per spec
+    class Double
       include NBTUtils::Tag
 
       type_id 6

data/lib/nbt_utils/tag/end.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module NBTUtils
   module Tag
     class End
@@ -5,17 +7,17 @@ module NBTUtils
 
       type_id 0
 
-      def initialize(input, named = false)
+      def initialize(...)
         @name = ''
       end
 
-      def to_s(indent = 0)
+      def to_s(...)
         ''
       end
 
-      def to_nbt_string(named = false)
+      def to_nbt_string(...)
         binary_type_id
       end
     end
   end
-end
+end

data/lib/nbt_utils/tag/exceptions.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 class DuplicateCompoundPayloadTagNameError < StandardError; end
-class MissingCompoundPayloadTagNameError < StandardError; end
+class MissingCompoundPayloadTagNameError < StandardError; end

data/lib/nbt_utils/tag/float.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 module NBTUtils
   module Tag
-    class Float # signed, per spec
+    # signed, per spec
+    class Float
       include NBTUtils::Tag
 
       type_id 5

data/lib/nbt_utils/tag/int.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 module NBTUtils
   module Tag
-    class Int # signed, per spec
+    # signed, per spec
+    class Int
       include NBTUtils::Tag
 
       type_id 3

data/lib/nbt_utils/tag/int_array.rb

@@ -1,34 +1,36 @@
+# frozen_string_literal: true
+
 module NBTUtils
   module Tag
     class IntArray
       include NBTUtils::Tag
 
-      type_id 11 
+      type_id 11
 
-      def initialize(io, named = true)
+      def initialize(io, named: true)
         read_name(io) if named
 
         len = ::BinData::Int32be.new.read(io).value
 
-        @payload = ::BinData::Array.new(:type => :int32be, :initial_length => len).read(io)
+        @payload = ::BinData::Array.new(type: :int32be, initial_length: len).read(io)
       end
 
       def to_s(indent = 0)
-        (' ' * indent) + "TAG_Int_Array#{@name ? "(\"#{@name}\")" : ''}: [#{@payload.length} bytes]"
+        (' ' * indent) + "TAG_Int_Array#{name ? "(\"#{name}\")" : ''}: [#{payload.length} bytes]"
       end
 
-      def to_nbt_string(named = true)
+      def to_nbt_string(named: true)
         result = named ? binary_type_id + name_to_nbt_string : ''
         len = ::BinData::Int32be.new
-        len.value = @payload.length
+        len.value = payload.length
         result << len.to_binary_s
-        result + @payload.to_binary_s
+        result + payload.to_binary_s
       end
 
       def set_value(new_value, index)
         b = ::BinData::Int32be.new
         b.value = new_value
-        @payload[index] = b.to_binary_s
+        payload[index] = b.to_binary_s
       end
     end
   end

data/lib/nbt_utils/tag/list.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module NBTUtils
   module Tag
     class List
@@ -5,7 +7,9 @@ module NBTUtils
 
       type_id 9
 
-      def initialize(io, named = true)
+      attr_reader :tag_type
+
+      def initialize(io, named: true)
         @payload = []
         read_name(io) if named
 
@@ -13,41 +17,42 @@ module NBTUtils
         @tag_type = NBTUtils::Tag.tag_type_to_class(tag_id)
         len = ::BinData::Int32be.new.read(io).value
         len.times do
-          @payload << @tag_type.new(io, false)
+          payload << tag_type.new(io, named: false)
         end
       end
 
       def to_s(indent = 0)
-        ret = (' ' * indent) + "TAG_List#{@name ? "(\"#{@name}\")" : ''}: #{@payload.length} entries of type TAG_#{@tag_type.to_s.split('::').last}\n"
-        ret << (' ' * indent) + "{\n"
-        @payload.each do |load|
+        ret = "#{' ' * indent}TAG_List#{name ? "(\"#{name}\")" : ''}: #{payload.length} entries of "\
+              "type TAG_#{tag_type.to_s.split('::').last}\n"
+        ret << ("#{' ' * indent}{\n")
+        payload.each do |load|
           ret << "#{load.to_s(indent + 2)}\n"
         end
-        ret << (' ' * indent) + "}"
+        ret << ("#{' ' * indent}}")
         ret
       end
 
-      def to_nbt_string(named = true)
+      def to_nbt_string(named: true)
         result = named ? binary_type_id + name_to_nbt_string : ''
         type = ::BinData::Int8be.new
-        type.value = @tag_type.type_id
+        type.value = tag_type.type_id
         result << type.to_binary_s
         len = ::BinData::Int32be.new
-        len.value = @payload.length
+        len.value = payload.length
         result << len.to_binary_s
-        @payload.inject(result) do |r, load|
-          r + load.to_nbt_string(false)
+        payload.inject(result) do |r, load|
+          r + load.to_nbt_string(named: false)
         end
       end
 
       def set_value(new_value, index)
-        unless new_value.kind_of?(NBTUtils::Tag)
-          t = @tag_type.new
+        unless new_value.is_a?(NBTUtils::Tag)
+          t = tag_type.new
           t.value = new_value
           new_value = t
         end
-        
-        @payload[index] = new_value
+
+        payload[index] = new_value
       end
     end
   end

data/lib/nbt_utils/tag/long.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 module NBTUtils
   module Tag
-    class Long # signed, per spec
+    # signed, per spec
+    class Long
       include NBTUtils::Tag
 
       type_id 4

data/lib/nbt_utils/tag/short.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 module NBTUtils
   module Tag
-    class Short # signed, per spec
+    # signed, per spec
+    class Short
       include NBTUtils::Tag
 
       type_id 2

data/lib/nbt_utils/tag/string.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module NBTUtils
   module Tag
     class String