craftbook-nbt 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9cad7e3254d4754df3cf22a84b955032ddfb3b6fab4d068f63e43cfcd1ea5ba5
+  data.tar.gz: 9d2cd43e217df4de8d71930b1801812c54fe3751494e6d8c36e96860a02ccf3a
+SHA512:
+  metadata.gz: 42f0580120ce0a95c12e7d6017aed4854635b21cf7016c51bf527850c4e51d8853dbb5b16de1468629a3ccde4168019aba59c7164600d37aa2c6d757c53980dd
+  data.tar.gz: f9dd45cb4b60e3ed3f4f67b40c8286a9e5231967c31a0bec6f35405465d4980ff6aae2fd47e2d835877410f7ba940dfd66d72d4ddd2da9bf33f155cd98611365

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/

data/.yardopts

@@ -0,0 +1,5 @@
+--readme README.md
+--title 'CraftBook NBT'
+--charset utf-8
+--markup markdown
+lib/**/*.rb

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-08-27
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at Zvezda2013!Svitlana. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in craftbook-nbt.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 ForeverZer0
+
+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,420 @@
+# CraftBook::NBT
+
+A feature-rich and complete Ruby implementation of the Named Binary Tag (NBT) format. While it is an integral part of
+the broader CraftBook API, it is an independent module with no dependencies, and can be used for any purpose where
+reading/writing/converting the NBT format is required.
+
+# Features
+
+* Intuitive and simple to use, with a user-friendly API surface
+* Reads from any IO-like object
+* `TagBuilder` class for easily building complete NBT documents from scratch (see example below)
+* Conversion to and from JSON
+* Conversion to and from SNBT (aka _stringified_ NBT), performed properly with a grammar and a lexical parser with `racc` (standard library)
+* Custom formatted output in a tree structure for simple viewing NBT, or debugging for correctness
+* Automatic compression detection
+* Well-structured and logical inheritance tree
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'craftbook-nbt'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install craftbook-nbt
+
+## Usage
+
+### Require
+
+After installing the gem, everything can be made available by requiring one file:
+
+```ruby
+require 'craftbook/nbt'
+```
+
+### Reading
+
+For the purpose of example, we will use the de-facto [bigtest.nbt](https://raw.github.com/Dav1dde/nbd/master/test/bigtest.nbt) 
+for NBT as recommended by https://wiki.vg/NBT where the specification is outlined.
+
+To load a file (GZip and ZLib compressed files will be detected and handled automatically.):
+```ruby
+tag = CraftBook::NBT.read_file('/path/to/bigtest.nbt')
+```
+
+The resulting object is a `CompoundTag` instance, which is the implicit top-level container of all files. This tag
+(among others) implements the `Enumerable` mixin, and exhibits typical array-like behavior, including accessing by
+index for inserting/removing/fetching child elements.
+
+If you need to read from an existing IO-like object other than a file, use the following:
+```ruby
+tag = CraftBook::NBT.read(io)
+```
+
+Unlike a file, compression cannot be detected from a stream, as not all streams support seeking (i.e. network). 
+Furthermore, compression algorithms typically cannot start from an unknown position in a stream, and it is unsafe to
+assume the position for each use. For this reason, it is up to users to apply any needed decompression wrappers over the
+IO object before passing to this method. Any object that responds to `#read` and returns a String is a viable
+parameter that can be used.
+
+### Writing
+
+Writing is just as simple:
+```ruby
+CraftBook::NBT.write_file('/path/to/file.nbt', compression: :gzip, level: :optimal)
+```
+
+...or if writing directly to an `IO` object or one that implements `#write`:
+```ruby
+compound_tag = CompoundTag.new("My First NBT Tag!")
+compound_tag.push(StringTag.new("Hello", "World"))
+
+bytes_written = CraftBook::NBT.write(STDOUT, compound_tag, compression: :zlib, level: :fastest)
+```
+
+Compression is optional, but defaults to GZip with "default" level when not specified. 
+
+### Creating Tags
+
+Tag creation can be done manually by creating individual tags and building the document manually, or you can use the
+included `TagBuilder` class to ease in their creation.
+
+For a complete example, we will re-create the "bigtest.nbt" mentioned above from scratch, which uses all tag types:
+
+```ruby
+include CraftBook::NBT
+
+tb = TagBuilder.new("Level")
+tb.compound('nested compound test') do
+
+  tb.compound('egg') do
+    tb.string('name', 'Eggburt')
+    tb.float('value', 0.5)
+  end
+
+  tb.compound("ham") do
+    tb.string('name', 'Hampus')
+    tb.float('value', 0.75)
+  end
+
+  tb.int('intTest', 2147483647)
+  tb.byte('byteTest', 127)
+  tb.string('stringTest', "HELLO WORLD THIS IS A TEST STRING \u{c5}\u{c4}\u{d6}!")
+
+  tb.list('listTest (long)', Tag::TYPE_LONG) do
+    tb.long(nil, 11)
+    tb.long(nil, 12)
+    tb.long(nil, 13)
+    tb.long(nil, 14)
+    tb.long(nil, 15)
+  end
+
+  tb.double('doubleTest', 0.49312871321823148)
+  tb.float('floatTest', 0.49823147058486938)
+  tb.long('longTest', 9223372036854775807)
+
+  tb.list('listTest (compound', Tag::TYPE_COMPOUND) do
+    tb.compound(nil) do
+      tb.long('created-on', 1264099775885)
+      tb.string('name', 'Compound tag #0')
+    end
+    tb.compound(nil) do
+      tb.long('created-on', 1264099775885)
+      tb.string('name', 'Compound tag #1')
+    end
+  end
+
+  name = 'byteArrayTest (the first 1000 values of (n*n*255+n*7)%100, starting with n=0 (0, 62, 34, 16, 8, ...))'
+  array = (0...1000).map { |n| (n * n * 255 + n * 7) % 100 }
+  tb.byte_array(name, *array)
+  tb.short('shortTest', 32767)
+end
+
+tag = tb.root
+```
+
+We can then compare the output:
+
+```ruby
+tag.pretty_print(STDOUT)
+```
+
+<details>
+<summary>Click to Expand Output</summary>
+
+```
+TAG_Compound("Level"): 1 child
+{
+    TAG_Compound("nested compound test"): 12 children
+    {
+        TAG_Compound("egg"): 2 children
+        {
+            TAG_String("name"): "Eggburt"
+            TAG_Float("value"): 0.5
+        }
+        TAG_Compound("ham"): 2 children
+        {
+            TAG_String("name"): "Hampus"
+            TAG_Float("value"): 0.75
+        }
+        TAG_Int("intTest"): 2147483647
+        TAG_Byte("byteTest"): 127
+        TAG_String("stringTest"): "HELLO WORLD THIS IS A TEST STRING ÅÄÖ!"
+        TAG_List("listTest (long)"): 5 children
+        {
+            TAG_Long(None): 11
+            TAG_Long(None): 12
+            TAG_Long(None): 13
+            TAG_Long(None): 14
+            TAG_Long(None): 15
+        }
+        TAG_Double("doubleTest"): 0.4931287132182315
+        TAG_Float("floatTest"): 0.4982314705848694
+        TAG_Long("longTest"): 9223372036854775807
+        TAG_List("listTest (compound"): 2 children
+        {
+            TAG_Compound(None): 2 children
+            {
+                TAG_Long("created-on"): 1264099775885
+                TAG_String("name"): "Compound tag #0"
+            }
+            TAG_Compound(None): 2 children
+            {
+                TAG_Long("created-on"): 1264099775885
+                TAG_String("name"): "Compound tag #1"
+            }
+        }
+        TAG_Byte_Array("byteArrayTest (the first 1000 values of (n*n*255+n*7)%100, starting with n=0 (0, 62, 34, 16, 8, ...))"): 1 item
+        TAG_Short("shortTest"): 32767
+    }
+}
+```
+
+</details>
+
+Or if you prefer JSON...
+
+```ruby
+pretty = true
+tag.to_json(pretty, indent: '  ')
+```
+
+<details>
+<summary>Click to expand JSON output</summary>
+
+```json
+
+{
+  "name": "Level",
+  "type": 10,
+  "values": [
+    {
+      "name": "nested compound test",
+      "type": 10,
+      "values": [
+        {
+          "name": "egg",
+          "type": 10,
+          "values": [
+            {
+              "name": "name",
+              "type": 8,
+              "value": "Eggburt"
+            },
+            {
+              "name": "value",
+              "type": 5,
+              "value": 0.5
+            }
+          ]
+        },
+        {
+          "name": "ham",
+          "type": 10,
+          "values": [
+            {
+              "name": "name",
+              "type": 8,
+              "value": "Hampus"
+            },
+            {
+              "name": "value",
+              "type": 5,
+              "value": 0.75
+            }
+          ]
+        },
+        {
+          "name": "intTest",
+          "type": 3,
+          "value": 2147483647
+        },
+        {
+          "name": "byteTest",
+          "type": 1,
+          "value": 127
+        },
+        {
+          "name": "stringTest",
+          "type": 8,
+          "value": "HELLO WORLD THIS IS A TEST STRING ÅÄÖ!"
+        },
+        {
+          "name": "listTest (long)",
+          "type": 9,
+          "child_type": 4,
+          "values": [
+            {
+              "value": 11
+            },
+            {
+              "value": 12
+            },
+            {
+              "value": 13
+            },
+            {
+              "value": 14
+            },
+            {
+              "value": 15
+            }
+          ]
+        },
+        {
+          "name": "doubleTest",
+          "type": 6,
+          "value": 0.4931287132182315
+        },
+        {
+          "name": "floatTest",
+          "type": 5,
+          "value": 0.4982314705848694
+        },
+        {
+          "name": "longTest",
+          "type": 4,
+          "value": 9223372036854775807
+        },
+        {
+          "name": "listTest (compound",
+          "type": 9,
+          "child_type": 10,
+          "values": [
+            {
+              "values": [
+                {
+                  "name": "created-on",
+                  "type": 4,
+                  "value": 1264099775885
+                },
+                {
+                  "name": "name",
+                  "type": 8,
+                  "value": "Compound tag #0"
+                }
+              ]
+            },
+            {
+              "values": [
+                {
+                  "name": "created-on",
+                  "type": 4,
+                  "value": 1264099775885
+                },
+                {
+                  "name": "name",
+                  "type": 8,
+                  "value": "Compound tag #1"
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "name": "byteArrayTest (the first 1000 values of (n*n*255+n*7)%100, starting with n=0 (0, 62, 34, 16, 8, ...))",
+          "type": 7,
+          "values": [
+            [
+              0,
+              62,
+              34,
+              "Removed for the sake of brevity..."
+            ]
+          ]
+        },
+        {
+          "name": "shortTest",
+          "type": 2,
+          "value": 32767
+        }
+      ]
+    }
+  ]
+}
+```
+
+</details>
+
+...or perhaps you need to stringify it into SNBT format...
+
+```ruby
+tag.stringify
+```
+
+```
+{Level:{{nested compound test:{{egg:{name:"Eggburt",value:0.5F},{ham:{name:"Hampus",value:0.75F},intTest:2147483647,byteTest:127B,stringTest:"HELLO WORLD THIS IS A TEST STRING ÅÄÖ!",listTest (long):[11L,12L,13L,14L,15L],doubleTest:0.4931287132182315,floatTest:0.4982314705848694F,longTest:9223372036854775807L,listTest (compound:[{{created-on:1264099775885L,name:"Compound tag #0"},{{created-on:1264099775885L,name:"Compound tag #1"}],byteArrayTest (the first 1000 values of (n*n*255+n*7)%100, starting with n=0 (0, 62, 34, 16, 8, ...)):[B;0,62,...,74,6,48],shortTest:32767S}}
+```
+
+### Parsing Stringified NBT (SNBT)
+
+For parsing SNBT, this library uses a proper lexer with a grammar file approach, taking advantage of the Racc gem, which
+is part of Ruby's standard library. This allows scanning over input and tokenizing it into logical pieces to parse,
+opposed to using monstrous and difficult-to-debug regular expressions.
+
+There is only a single method call involved with parsing an arbitrary string of SNBT code: `NBT.parse_snbt`.
+
+```ruby
+snbt_string = '{name1:123,name2:"sometext1",name3:{subname1:456,subname2:"sometext2"}}'
+compound = NBT.parse_snbt(snbt_string)
+compound.pretty_print
+```
+
+**Output:**
+```
+TAG_Compound(None): 3 children
+{
+    TAG_Int("name1"): 123
+    TAG_String("name2"): "sometext1"
+    TAG_Compound("name3"): 2 children
+    {
+        TAG_Int("subname1"): 456
+        TAG_String("subname2"): "sometext2"
+    }
+}
+```
+## Documentation
+
+Code is fully documented using [YARD](https://yardoc.org/), which is supported by modern linters for inline documentation
+in your editor, and is always available [in full at RubyDoc.info](https://www.rubydoc.info/gems/craftbook-nbt).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ForeverZer0/craftbook-nbt. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ForeverZer0/craftbook-nbt/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Craftbook::Nbt project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ForeverZer0/craftbook-nbt/blob/master/CODE_OF_CONDUCT.md).