nbt_utils 0.0.2 → 0.5.0

data/lib/nbt_utils/tag.rb

@@ -1,36 +1,34 @@
+# frozen_string_literal: true
+
 module NBTUtils
   module Tag
-    attr_reader :name
-    attr_reader :payload
+    attr_reader :name, :payload
 
     def self.included(base)
       base.extend ClassMethods
     end
 
-    def initialize(io, named = true)
+    def initialize(io, named: true)
       read_name(io) if named
       @payload = self.class.payload_class.new.read(io)
     end
-    
+
     def type_id
       self.class.type_id
     end
 
     def binary_type_id
-      # I hope i'm doing this wrong.
-      byte = ::BinData::Int8be.new
-      byte.value = type_id
-      byte.to_binary_s
+      type_id.chr
     end
 
     def to_s(indent = 0)
       klass = self.class.to_s.split('::').last
-      (' ' * indent) + "TAG_#{klass}#{@name ? "(\"#{@name}\")" : ''}: #{@payload.value}"
+      (' ' * indent) + "TAG_#{klass}#{name ? "(\"#{name}\")" : ''}: #{payload.value}"
     end
 
-    def to_nbt_string(named = true)
+    def to_nbt_string(named: true)
       result = named ? binary_type_id + name_to_nbt_string : ''
-      result + @payload.to_binary_s
+      result + payload.to_binary_s
     end
 
     def read_name(io)
@@ -39,7 +37,7 @@ module NBTUtils
 
     def name_to_nbt_string
       nm = NBTUtils::TagName.new
-      nm.data = @name
+      nm.data = name
       nm.to_binary_s
     end
 
@@ -47,8 +45,8 @@ module NBTUtils
       NBTUtils::Tag.tag_type_to_class(tag_type)
     end
 
-    def set_value(new_value, index = nil)
-      @payload.value = new_value
+    def set_value(new_value, _index = nil)
+      payload.value = new_value
     end
 
     module ClassMethods
@@ -71,11 +69,9 @@ module NBTUtils
       @tag_types[tag_type.to_i]
     end
 
-    protected
-
     def self.add_tag_type(index, tag_type)
       @tag_types ||= []
       @tag_types[index] = tag_type
     end
   end
-end
+end

data/lib/nbt_utils/tag_name.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module NBTUtils
   class TagName < ::BinData::Record
     # Spec says this is a TAG_Short, which is signed. Staying strict
     # though this may really be unsigned in practice.
-    int16be :len, :value => Proc.new { data.length }
-    string :data, :read_length => :len
+    int16be :len, value: proc { data.length }
+    string :data, read_length: :len
 
     # things break for some reason if you just call the string :value
     def value
@@ -14,4 +16,4 @@ module NBTUtils
       self.data = (other_value)
     end
   end
-end
+end

data/lib/nbt_utils/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module NBTUtils
-  VERSION = "0.0.2"
+  VERSION = '0.5.0'
 end

data/lib/nbt_utils.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'zlib'
 require 'bindata'
 
@@ -17,3 +19,4 @@ require File.expand_path('nbt_utils/tag/byte_array', File.dirname(__FILE__))
 require File.expand_path('nbt_utils/tag/string', File.dirname(__FILE__))
 require File.expand_path('nbt_utils/tag/list', File.dirname(__FILE__))
 require File.expand_path('nbt_utils/tag/compound', File.dirname(__FILE__))
+require File.expand_path('nbt_utils/tag/int_array', File.dirname(__FILE__))

data/nbt_utils.gemspec

@@ -1,24 +1,30 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path("../lib/nbt_utils/version", __FILE__)
+# frozen_string_literal: true
+
+require File.expand_path('lib/nbt_utils/version', __dir__)
 
 Gem::Specification.new do |s|
-  s.name        = "nbt_utils"
+  s.name        = 'nbt_utils'
   s.version     = NBTUtils::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Michael Dungan']
   s.email       = ['mpd@jesters-court.net']
-  s.homepage    = "http://rubygems.org/gems/nbt_utils"
-  s.summary     = "Set of classes to read and write Minecraft .nbt files"
-  s.description = "Some classes to read and write Minecraft .nbt files. See http://www.minecraft.net/docs/NBT.txt for format description."
+  s.homepage    = 'https://github.com/xxx/nbt_utils'
+  s.summary     = 'Set of classes to read and write Minecraft .nbt files'
+  s.description = 'Some classes to read and write Minecraft .nbt files. '\
+                  'See NBT.txt in the /doc directory for format description.'
 
-  s.required_rubygems_version = ">= 1.3.6"
+  s.required_rubygems_version = '>= 1.3.6'
 
-  s.add_dependency "bindata", "~> 1.2"
-  s.add_development_dependency "bundler", ">= 1.0.0"
+  s.add_dependency 'bindata', '~> 2'
+  s.add_development_dependency 'rspec', '~> 3'
+  s.add_development_dependency 'rubocop', '~> 1'
+  s.add_development_dependency 'rubocop-performance', '~> 1'
+  s.add_development_dependency 'rubocop-rspec', '~> 2'
 
-  s.required_ruby_version = "~> 1.9"
+  s.required_ruby_version = '>= 2.7'
 
   s.files        = `git ls-files`.split("\n")
-  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.executables  = `git ls-files`.split("\n").filter_map { |f| f =~ %r{^bin/(.*)} ? Regexp.last_match(1) : nil }
   s.require_path = 'lib'
+  s.metadata['rubygems_mfa_required'] = 'true'
 end

data/script.rb

@@ -1,4 +1,7 @@
+#!/usr/bin/env ruby
+
 # encoding: UTF-8
+# frozen_string_literal: true
 
 require 'bundler'
 Bundler.require :default
@@ -8,32 +11,31 @@ require 'zlib'
 
 @compound = nil
 
-#file = NBTUtils::File.new('doc/test.nbt')
-#@compound = file.read
+# file = NBTUtils::File.new('doc/test.nbt')
+# @compound = file.read
 #
-#puts @compound.to_s
+# puts @compound.to_s
 #
-#@compound.update_tag('name', 'asdf')
-#puts @compound.to_s
+# @compound.update_tag('name', 'asdf')
+# puts @compound.to_s
 #
-#@compound.remove_tag('name')
-#puts @compound.to_s
-
-#puts @compound.to_nbt_string
-#NBTUtils::File.new.write('biglolwut.nbt', @compound)
+# @compound.remove_tag('name')
+# puts @compound.to_s
 
-#@compound = NBTUtils::File.new.read('doc/bigtest.nbt')
-#puts @compound.to_s
+# puts @compound.to_nbt_string
+# NBTUtils::File.new.write('biglolwut.nbt', @compound)
 
+# @compound = NBTUtils::File.new.read('doc/bigtest.nbt')
+# puts @compound.to_s
 
 @compound = NBTUtils::File.new.read('doc/test.mclevel')
 puts @compound.to_s
 
-#puts @compound.to_nbt_string
-#NBTUtils::File.new.write('biglolwut.nbt', @compound)
+# puts @compound.to_nbt_string
+# NBTUtils::File.new.write('biglolwut.nbt', @compound)
 
-#p @compound.find_tag(/Test/)
-#p @compound.find_tag('Test')
-#p @compound.find_tag('intTest')
-#p @compound.find_tags(/(?:byte|int)Test/)
-#p @compound.find_tags 'intasdf'
+# p @compound.find_tag(/Test/)
+# p @compound.find_tag('Test')
+# p @compound.find_tag('intTest')
+# p @compound.find_tags(/(?:byte|int)Test/)
+# p @compound.find_tags 'intasdf'

data/spec/nbt_utils/file_spec.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+RSpec.describe NBTUtils::File do
+  let(:file) { described_class.new(File.expand_path("../../../doc/#{fixture}", __FILE__)) }
+  let(:fixture) { 'test_uncompressed.nbt' }
+
+  describe '#read' do
+    subject(:call) { file.read }
+
+    shared_examples 'reads the file' do
+      it 'reads the file and returns the root tag', :aggregate_failures do
+        expect(call.name).to eq('hello world')
+        expect(call.payload.first.payload.value).to eq('Bananrama')
+      end
+    end
+
+    context 'when the file is not compressed' do
+      let(:fixture) { 'test_uncompressed.nbt' }
+
+      include_examples 'reads the file'
+    end
+
+    context 'when the file is compressed' do
+      let(:fixture) { 'test.nbt' }
+
+      include_examples 'reads the file'
+    end
+  end
+
+  describe '#write' do
+    let(:root) { file.read }
+
+    let(:out_path) { "#{__dir__}/write-test.nbt" }
+
+    shared_examples 'writes the file' do
+      it 'writes the file out' do
+        tag = root.payload.first
+
+        file.write(out_path, tag, compressed)
+
+        read_in = described_class.new(out_path).read
+        expect(read_in.payload.value).to eq 'Bananrama'
+      ensure
+        File.delete(out_path) if File.exist?(out_path)
+      end
+    end
+
+    context 'when the file is not compressed' do
+      let(:compressed) { false }
+
+      include_examples 'writes the file'
+    end
+
+    context 'when the file is compressed' do
+      let(:compressed) { true }
+
+      include_examples 'writes the file'
+    end
+  end
+end

data/spec/nbt_utils/tag/byte_array_spec.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+RSpec.describe NBTUtils::Tag::ByteArray do
+  it_behaves_like 'a tag', 7, nil
+end

data/spec/nbt_utils/tag/byte_spec.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+RSpec.describe NBTUtils::Tag::Byte do
+  it_behaves_like 'a tag', 1, BinData::Int8be
+end

data/spec/nbt_utils/tag/compound_spec.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+RSpec.describe NBTUtils::Tag::Compound do
+  it_behaves_like 'a tag', 10, nil
+end

data/spec/nbt_utils/tag/double_spec.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+RSpec.describe NBTUtils::Tag::Double do
+  it_behaves_like 'a tag', 6, BinData::DoubleBe
+end

data/spec/nbt_utils/tag/end_spec.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+RSpec.describe NBTUtils::Tag::End do
+  it_behaves_like 'a tag', 0, nil
+end

data/spec/nbt_utils/tag/float_spec.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+RSpec.describe NBTUtils::Tag::Float do
+  it_behaves_like 'a tag', 5, BinData::FloatBe
+end

data/spec/nbt_utils/tag/int_array_spec.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+RSpec.describe NBTUtils::Tag::IntArray do
+  it_behaves_like 'a tag', 11, nil
+end

data/spec/nbt_utils/tag/int_spec.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+RSpec.describe NBTUtils::Tag::Int do
+  it_behaves_like 'a tag', 3, BinData::Int32be
+end

data/spec/nbt_utils/tag/list_spec.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+RSpec.describe NBTUtils::Tag::List do
+  it_behaves_like 'a tag', 9, nil
+end

data/spec/nbt_utils/tag/long_spec.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+RSpec.describe NBTUtils::Tag::Long do
+  it_behaves_like 'a tag', 4, BinData::Int64be
+end

data/spec/nbt_utils/tag/short_spec.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+RSpec.describe NBTUtils::Tag::Short do
+  it_behaves_like 'a tag', 2, BinData::Int16be
+end

data/spec/nbt_utils/tag/string_spec.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+RSpec.describe NBTUtils::Tag::String do
+  it_behaves_like 'a tag', 8, NBTUtils::TagName
+end

data/spec/nbt_utils/tag_name_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+RSpec.describe NBTUtils::TagName do
+  subject(:tag_name) { described_class.new }
+
+  describe '#value' do
+    it 'returns the data value' do
+      expect(tag_name.value).to eq('')
+      tag_name.data = 'foo'
+      expect(tag_name.value).to eq('foo')
+    end
+  end
+
+  describe '#value=' do
+    it 'returns the data value' do
+      tag_name.value = 'marf'
+      expect(tag_name.data).to eq('marf')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require 'nbt_utils'
+
+require 'support/shared_examples/a_tag'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See https://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  #  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  # https://relishapp.com/rspec/rspec-core/docs/configuration/zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

data/spec/support/shared_examples/a_tag.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples_for 'a tag' do |type_id, payload_class|
+  it 'has the type_id and payload_class', :aggregate_failures do
+    expect(described_class.type_id).to eq(type_id)
+    expect(described_class.payload_class).to eq(payload_class)
+  end
+end