nbtfile 0.1.0 → 0.2.0

data/README.rdoc

@@ -13,16 +13,16 @@ http://www.minecraft.net/docs/NBT.txt
 
 The NBT data model has ten different data types:
 
- - 8-bit signed integers (Tag_Byte)
- - 16-bit signed integers (Tag_Short)
- - 32-bit signed integers (Tag_Int)
- - 64-bit signed integers (Tag_Long)
- - 32-bit floating-point numbers (Tag_Float)
- - 64-bit floating-point numbers (Tag_Double)
- - UTF-8 strings (Tag_String)
- - raw byte strings (Tag_Byte_Array)
- - homogenous lists (Tag_List)
- - compound structures (Tag_Compound)
+* 8-bit signed integers (Tag_Byte)
+* 16-bit signed integers (Tag_Short)
+* 32-bit signed integers (Tag_Int)
+* 64-bit signed integers (Tag_Long)
+* 32-bit floating-point numbers (Tag_Float)
+* 64-bit floating-point numbers (Tag_Double)
+* UTF-8 strings (Tag_String)
+* raw byte sequences (Tag_Byte_Array)
+* homogenous lists (Tag_List)
+* compound structures (Tag_Compound)
 
 Compound structures (Tag_Compound) are unordered
 collections where each item ("tag") has a name associated
@@ -44,6 +44,66 @@ Tag_End, but this is not supported in practice.
 The top level of an NBT file must be a single-element
 compound structure.
 
+== Interface
+
+== Low-level API
+
+The low-level API deals directly in NBT tokens, which are represented by eleven types:
+
+* NBTFile::Tokens::TAG_End
+* NBTFile::Tokens::TAG_Byte
+* NBTFile::Tokens::TAG_Short
+* NBTFile::Tokens::TAG_Long
+* NBTFile::Tokens::TAG_Float
+* NBTFile::Tokens::TAG_Double
+* NBTFile::Tokens::TAG_Byte_Array
+* NBTFile::Tokens::TAG_String
+* NBTFile::Tokens::TAG_List
+* NBTFile::Tokens::TAG_Compound
+
+Their constructors each take two arguments: <code>name</code> and <code>value</code>,
+which are also exposed by similarly-named accessors.  Most of these tokens represent
+simple values, but TAG_List and TAG_Compound introduce the beginning of a list and a
+compound structure, and TAG_End terminates either one.
+
+The <code>name</code> field supplies the field name when the token is part of a compound
+structure, and is ignored when it is part of a list.
+
+For most token types, <code>value</code> represents the value of the token.  For TAG_List
+it represents the type of the list.  It is ignored for compound structures.
+
+=== NBTFile.tokenize
+
+=== NBTFile.emit
+
+== High-level API
+
+Much of the high-level API deals in higher-level data types from the NBTFile::Types module.
+
+There are eight "primitive" types with <code>value</code> fields which reflect their native Ruby values:
+
+* NBTFile::Types::Byte
+* NBTFile::Types::Short
+* NBTFile::Types::Int
+* NBTFile::Types::Long
+* NBTFile::Types::Float
+* NBTFile::Types::Double
+* NBTFile::Types::ByteArray
+* NBTFile::Types::String
+
+There are also two "complex" types which reflect NBT lists and compound structures:
+
+* NBTFile::Types::List - an Array-like class corresponding to an NBT list
+* NBTFile::Types::Compound - a Hash-like class correspodning to an NBT compound structure
+
+=== NBTFile.read
+
+=== NBTFile.write
+
+=== NBTFile.load
+
+=== NBTFile.transcode_to_yaml
+
 == Syntax
 
 NBT files are gzip-compressed; the structure of the
@@ -115,18 +175,6 @@ ABNF (see RFC 5234).
  TAG-LIST = %x09
  TAG-COMPOUND = %x0a
 
-== Interface
-
-== Low-level API
-
-=== NBTFile.tokenize
-
-=== NBTFile.emit
-
-== High-level API
-
-=== NBTFile.load
-
 == Note on Patches/Pull Requests
  
 * Fork the project.
@@ -139,4 +187,4 @@ ABNF (see RFC 5234).
 
 == Copyright
 
-Copyright (c) 2010 MenTaLguY. See LICENSE for details.
+Copyright (c) 2010-2011 MenTaLguY. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/nbtfile.rb

@@ -24,7 +24,6 @@
 require 'zlib'
 require 'stringio'
 require 'yaml'
-require 'enumerator'
 
 class String #:nodoc: all
   begin
@@ -1008,7 +1007,7 @@ module Types
         @key_order.each { |k| yield k, @hash[k] }
         self
       else
-        Enumerable::Enumerator.new(self, :each)
+        @key_order.each
       end
     end
 

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: nbtfile
 version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - MenTaLguY
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-09 00:00:00 -08:00
+date: 2011-02-13 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,6 +26,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 2
         - 0
@@ -68,6 +70,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -76,6 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"