nwn-lib 0.5.1 → 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6039060ff0d0c726c6b7fa44dd7be8c624c3cf98
+  data.tar.gz: 82b2a9eea724b7d9b5b52a254d3b672b126affe8
+SHA512:
+  metadata.gz: 2288b34809225b00cb6b95c26a4d2360c31c8360d045ef8cbf5b69341cff2936d7f01aeeced4fa6e9ebbfad313578cfad7459da4f4896b4d0d6b042d888c66b5
+  data.tar.gz: 69c551f0f7e19d64a2bbed798d10f75a8c8b6c78df91b7103a6759cd1fb34cc47fd22020042883e655c9eb283bb24aabef57848d694ab1e72e5481d6a178dd95

data/.gitignore

@@ -1,4 +1,4 @@
-doc
-pkg
-.yardoc
-Gemfile.lock
+/doc/
+/pkg/
+/.yardoc/
+/Gemfile.lock

data/Gemfile

@@ -1,9 +1,12 @@
-source :rubygems
+source 'https://rubygems.org/'
 
 # Specify your gem's dependencies in nwn-lib.gemspec
 gemspec
 
 gem 'rake', '>= 0.8.7'
 
+gem 'json',        :group => :json
+gem 'libxml-ruby', :group => :xml
+
 gem 'rspec', :groups => [:development, :test] 
 gem 'yard', :groups => [:development]

data/README.rdoc

@@ -1,13 +1,16 @@
 == A library for Neverwinter Nights 1/2 resource files
 
-This package provides a library for reading, changing, and writing common file formats that are found with NWN[http://nwn.bioware.com/], a Bioware game.
+This package provides a library for reading, changing, and writing common file
+formats that are found with NWN[http://nwn.bioware.com/], a Bioware game.
 
-They should work with NWN2 just as well, since the file format specifications did not change.
+They should work with NWN2 just as well, since the file format specifications
+did not change.
 
 
 === Features of nwn-lib
 
-==== nwn-lib reads and writes the following file formats (hopefully bug-free!), both with an API and useful command-line tools:
+==== nwn-lib reads and writes the following file formats (hopefully bug-free!),
+both with an API and useful command-line tools:
 
 * GFF 3.2 (are, git, gic, dlg, itp, ifo, jrl, fac, ssf, ut*, among others)
 * ERF (mod, hak, erf, among others)
@@ -31,36 +34,39 @@ They should work with NWN2 just as well, since the file format specifications di
 
 ==== Also in the box:
 
-* shell scripts and tools to simplify your life (see {file:BINARIES})
+* shell scripts and tools to simplify your life (see BINARIES)
 * extensive developer API
-* a powerful get-out-of-my-way scripting system for data transformation (see {file:SCRIPTING})
+* a powerful get-out-of-my-way scripting system for data transformation (see SCRIPTING)
 
 
 === Upgrade from 0.3.6 to 0.4.x
 
-With the release of 0.4.0, the API changed significantly. Previous yaml dumps made with 0.3.x are INCOMPATIBLE, and so are all scripts.
-I can't help you with your API bindings, but for your YAML dumps, a converter script has been provided (see {file:BINARIES}).
+With the release of 0.4.0, the API changed significantly. Previous yaml dumps
+made with 0.3.x are INCOMPATIBLE, and so are all scripts.
+I can't help you with your API bindings, but for your YAML dumps, a converter
+script has been provided (see BINARIES).
 
 
 === Upgrade from 0.4.x to 0.5.x
 
-All with version 0.4.x produced files should be compatible with 0.5.0. Your application might require some porting to ruby 1.9.
+All with version 0.4.x produced files should be compatible with 0.5.0.
+Your application might require some porting to ruby 1.9.
 
+=== Upgrade from 0.5.x to 0.6.x
 
-=== Quickstart
-
-To use it, simply install the gem:
+YAML dumps will need to be converted due to the internal parser/generator used
+by ruby being replaced (syck to psych).
+There is a converter packaged in tools/ along with the gem distribution.
 
- gem install nwn-lib
+=== Quickstart
 
-And do the following in a script of your own devising (or just use bundler):
+To use it, simply add the following to your Gemfile:
 
-  require 'rubygems'
-  require 'nwn/all'
+ gem 'nwn-lib'
 
-Also, read {file:BINARIES} and {file:HOWTO}.
+Also, read BINARIES for the packaged executable scripts, and HOWTO.
 
-For nwn-lib scripts, see {file:SCRIPTING}.
+For nwn-lib scripts, see SCRIPTING.
 
 For using the developer API, I suggest you start reading NWN::Gff::Struct.
 

data/SETTINGS.rdoc

@@ -8,8 +8,9 @@ Under linux, just add them to your shell environment (usually .bashrc), like so:
 
 == NWN_LIB_IN_ENCODING
 
-The character encoding your local data (gff) files are in. Defaults to ISO-8859-1.
-Extended dump formats like yaml, xml are always format-specific, usually UTF-8.
+The character encoding your local data (gff) files are in. Defaults to windows-1252.
+Extended dump formats like yaml, xml are always format-specific.
+YAML and json, for example, are always UTF-8.
 
 == NWN_LIB_PRETTY_JSON
 

data/lib/nwn/all.rb

@@ -1,26 +1,27 @@
 require 'stringio'
-require 'nwn/version'
-require 'nwn/io'
-require 'nwn/twoda'
-require 'nwn/settings'
-require 'nwn/res'
-require 'nwn/gff'
-require 'nwn/tlk'
-require 'nwn/key'
-require 'nwn/erf'
-require 'nwn/yaml_support'
+require_relative 'io'
+require_relative 'twoda'
+require_relative 'settings'
+require_relative 'res'
+require_relative 'gff'
+require_relative 'tlk'
+require_relative 'key'
+require_relative 'erf'
+
+require_relative 'yaml_support'
+
 begin
   require 'json'
-  require 'nwn/json_support'
+  require_relative 'json_support'
 rescue LoadError => e
-  NWN.log_debug "json support not available, install json or json_pure to enable"
+  # NWN.log_debug "json support not available, install json or json_pure to enable"
 end
-require 'nwn/kivinen_support'
+require_relative 'kivinen_support'
 begin
   require 'xml'
-  require 'nwn/xml_support'
+  require_relative 'xml_support'
 rescue LoadError => e
-  NWN.log_debug "nxml and modpacker support not available, install libxml-ruby to enable"
+  # NWN.log_debug "nxml and modpacker support not available, install libxml-ruby to enable"
 end
 
-require 'nwn/scripting'
+require_relative 'scripting'

data/lib/nwn/gff.rb

@@ -148,9 +148,9 @@ module NWN
   end
 end
 
-require 'nwn/gff/struct'
-require 'nwn/gff/cexolocstr'
-require 'nwn/gff/field'
-require 'nwn/gff/list'
-require 'nwn/gff/reader'
-require 'nwn/gff/writer'
+require_relative 'gff/struct'
+require_relative 'gff/cexolocstr'
+require_relative 'gff/field'
+require_relative 'gff/list'
+require_relative 'gff/reader'
+require_relative 'gff/writer'

data/lib/nwn/gff/reader.rb

@@ -18,9 +18,11 @@ class NWN::Gff::Reader
     read_all
   end
 
-  private
+private
 
   def read_all
+    initial_seek = @io.pos
+
     type, version,
     struct_offset, struct_count,
     field_offset, field_count,
@@ -37,27 +39,27 @@ class NWN::Gff::Reader
     field_len  = field_count * 16
     label_len  = label_count * 16
 
-    @io.seek(struct_offset)
+    @io.seek(initial_seek + struct_offset)
     @structs = @io.e_read(struct_len, "structs")
     @structs = @structs.unpack("V*")
 
-    @io.seek(field_offset)
+    @io.seek(initial_seek + field_offset)
     @fields  = @io.e_read(field_len, "fields")
     @fields  = @fields.unpack("V*")
 
-    @io.seek(label_offset)
+    @io.seek(initial_seek + label_offset)
     @labels  = @io.e_read(label_len, "labels")
     @labels = @labels.unpack("A16" * label_count)
     @labels.map! {|l| l.force_encoding("ASCII") }
 
-    @io.seek(field_data_offset)
+    @io.seek(initial_seek + field_data_offset)
     @field_data = @io.e_read(field_data_count, "field_data")
 
-    @io.seek(field_indices_offset)
+    @io.seek(initial_seek + field_indices_offset)
     @field_indices = @io.e_read(field_indices_count, "field_indices")
     @field_indices = @field_indices.unpack("V*")
 
-    @io.seek(list_indices_offset)
+    @io.seek(initial_seek + list_indices_offset)
     @list_indices = @io.e_read(list_indices_count, "list_indices")
     @list_indices = @list_indices.unpack("V*")
 

data/lib/nwn/settings.rb

@@ -1,6 +1,6 @@
 module NWN
   SETTING_DEFAULT_VALUES = {
-    'NWN_LIB_IN_ENCODING' => 'ISO-8859-1'
+    'NWN_LIB_IN_ENCODING' => 'windows-1252'
   }
 
   # This writes a internal warnings and debug messages to stderr.

data/lib/nwn/xml_support.rb

@@ -1,3 +1,5 @@
+require 'base64'
+
 class NWN::Gff::Handler::XML
 
 private
@@ -65,6 +67,9 @@ private
           e << struct_to_xml(ee)
         }
 
+      when :void
+          e['value'] = Base64::strict_encode64(field.field_value)
+
       else
         e['value'] = field.field_value.to_s
     end
@@ -128,8 +133,10 @@ private
           v.to_i
         when :float, :double
           v.to_f
-        when :void, :resref
+        when :resref
           v
+        when :void
+          Base64::strict_decode64(v)
         else
           raise ArgumentError, "Invalid field type #{type.inspect}. Bug."
       end

data/lib/nwn/yaml_support.rb

@@ -1,103 +1,61 @@
-# This file contains all YAML-specific loading and dumping code.
-require 'yaml'
-Psych::ENGINE.yamler = 'syck'
+require 'psych'
 
 module NWN::Gff::Handler::YAML
   # These field types can never be inlined in YAML.
   NonInlineableFields = [:struct, :list, :cexolocstr]
 
   # See http://www.taguri.org/ for the exact meaning of this.
-  Domain = "nwn-lib.elv.es,2008-12"
+  Domain = "nwn-lib.elv.es,2013-07"
 
   def self.load io
-    YAML.load(io)
+    Psych.load(io)
   end
+
   def self.dump data, io
-    d = data.to_yaml
-    io.puts d
-    d.size
+    str = Psych.dump(data)
+    io.write(str)
+    str.size
   end
 end
 
-#:stopdoc:
-class Array
-  attr_accessor :to_yaml_style
-end
-class Hash
-  attr_accessor :to_yaml_style
-end
-
-class Hash
-  # Replacing the to_yaml function so it'll serialize hashes sorted (by their keys)
-  # Original function is in /usr/lib/ruby/1.8/yaml/rubytypes.rb
-  def to_yaml(opts = {})
-    YAML::quick_emit(nil, opts) do |out|
-      out.map(taguri, to_yaml_style) do |map|
-        if keys.map {|v| v.class }.size > 0
-          each do |k, v|
-            map.add(k, v)
-          end
-        else
-          sort.each do |k, v|
-            map.add(k, v)
-          end
-        end
-      end
-    end
-  end
-end
+NWN::Gff::Handler.register :yaml, /^(y|yml|yaml)$/, NWN::Gff::Handler::YAML
 
 module NWN::Gff::Struct
-  def to_yaml_type
-    "!#{NWN::Gff::Handler::YAML::Domain}/struct"
-  end
-
-  def to_yaml(opts = {})
-    YAML::quick_emit(nil, opts) do |out|
-      out.map(taguri, to_yaml_style) do |map|
-        # Inline certain structs that are small enough.
-        map.style = :inline if self.size <= 1 &&
-          self.values.select {|x|
-            NWN::Gff::Handler::YAML::NonInlineableFields.index(x['type'])
-          }.size == 0
-
-        map.add('__' + 'data_type', @data_type) if @data_type
-        map.add('__' + 'data_version', @data_version) if @data_version && @data_version != DEFAULT_DATA_VERSION
-        map.add('__' + 'struct_id', @struct_id) if @struct_id
-
-        sort.each {|k,v|
-          map.add(k,v)
-        }
-      end
+  def encode_with out
+    out.map("!#{NWN::Gff::Handler::YAML::Domain}:struct") do |map|
+      # Inline certain structs that are small enough.
+      map.style = Psych::Nodes::Mapping::FLOW if self.size <= 1 &&
+        self.values.select {|x|
+          NWN::Gff::Handler::YAML::NonInlineableFields.index(x['type'])
+        }.size == 0
+
+      map.add('__' + 'data_type', @data_type) if @data_type
+      map.add('__' + 'data_version', @data_version) if
+        @data_version && @data_version != DEFAULT_DATA_VERSION
+      map.add('__' + 'struct_id', @struct_id) if @struct_id != nil
+
+      sort.each {|k, v|
+        map.add(k, v)
+      }
     end
   end
 end
 
 module NWN::Gff::Field
-
-  def to_yaml(opts = {})
-    YAML::quick_emit(nil, opts) do |out|
-      out.map(taguri, to_yaml_style) do |map|
-        map.style = :inline unless NWN::Gff::Handler::YAML::NonInlineableFields.index(self['type'])
-        map.add('type', self['type'])
-        map.add('str_ref', self['str_ref']) if has_str_ref?
-        map.add('value', case self['type']
-          when :resref, :cexostr
-            self['value'].encode('utf-8')
-          when :cexolocstr
-            Hash[self['value'].map {|lang,str|
-              [lang, str.encode('utf-8')]
-            }]
-          else
-            self['value']
-        end)
-      end
+  def encode_with out
+    out.map do |map|
+      map.tag = nil
+      map.style = Psych::Nodes::Mapping::FLOW unless
+        NWN::Gff::Handler::YAML::NonInlineableFields.index(self['type'])
+      map.add('type', self['type'].to_s)
+      map.add('str_ref', self['str_ref']) if has_str_ref?
+      map.add('value', self['value'])
     end
   end
 end
 
 # This parses the struct and extends all fields with their proper type.
-YAML.add_domain_type(NWN::Gff::Handler::YAML::Domain,'struct') {|t,hash|
+Psych.add_domain_type(NWN::Gff::Handler::YAML::Domain,'struct') {|t,hash|
   struct = {}
   struct.extend(NWN::Gff::Struct)
 
@@ -107,7 +65,8 @@ YAML.add_domain_type(NWN::Gff::Handler::YAML::Domain,'struct') {|t,hash|
   struct.data_version = hash.delete('__data_version')
   struct.data_version ||= NWN::Gff::Struct::DEFAULT_DATA_VERSION
 
-  raise NWN::Gff::GffError, "no struct_id set for struct at #{struct.path}." if struct.struct_id.nil?
+  raise NWN::Gff::GffError, "no struct_id set for struct at #{struct.path}." if
+    struct.struct_id.nil?
 
   hash.each {|label,element|
     label.freeze
@@ -115,11 +74,14 @@ YAML.add_domain_type(NWN::Gff::Handler::YAML::Domain,'struct') {|t,hash|
     element.extend(NWN::Gff::Field)
     element.field_label = label
     element.parent = struct
-    element.str_ref ||= NWN::Gff::Field::DEFAULT_STR_REF if element.respond_to?('str_ref=')
+    element.str_ref ||= NWN::Gff::Field::DEFAULT_STR_REF if
+      element.respond_to?('str_ref=')
 
     element.extend_meta_classes
 
-    element.field_value.element = element if element.field_value.is_a?(NWN::Gff::Struct)
+    element.field_value.element = element if
+      element.field_value.is_a?(NWN::Gff::Struct)
+
     element.validate
 
     struct[label] = element
@@ -128,4 +90,3 @@ YAML.add_domain_type(NWN::Gff::Handler::YAML::Domain,'struct') {|t,hash|
   struct
 }
 
-NWN::Gff::Handler.register :yaml, /^(y|yml|yaml)$/, NWN::Gff::Handler::YAML

data/nwn-lib.gemspec

@@ -1,5 +1,4 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/nwn/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Bernhard Stoeckner"]
@@ -13,6 +12,6 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "nwn-lib"
   gem.require_paths = ["lib"]
-  gem.version       = NWN::VERSION
-  gem.required_ruby_version = '>= 1.9.1'
+  gem.version       = "0.6.0"
+  gem.required_ruby_version = '>= 1.9.3'
 end

data/spec/field_spec.rb

@@ -23,10 +23,11 @@ describe "Gff::Field" do
 
   describe ":void" do
     it "stores data in binary" do
+      void = "\xde\xad\xbe\xef".force_encoding("ASCII-8BIT")
       gff = Gff::Struct.new do |root|
-        root.add_void 'Test', "\xde\xad\xbe\xef"
+        root.add_void 'Test', void
       end.to_gff
-      gff.index("\xde\xad\xbe\xef").should_not be_nil
+      gff.index(void).should_not be_nil
     end
   end
 end

data/spec/gff_spec.rb

@@ -6,6 +6,12 @@ describe "Gff.read/write API" do
     g = Gff.read(i, :gff)
   end
 
+  it "reads from IO with offsets correctly" do
+    i = StringIO.new "a" + WELLFORMED_GFF
+    i.seek(1)
+    g = Gff.read(i, :gff)
+  end
+
   it "writes correctly" do
     i = StringIO.new WELLFORMED_GFF
     gff = Gff.read(i, :gff)

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
-require 'rubygems'
+Bundler.setup(:default, :test)
+
 require 'tempfile'
 require 'fileutils'
 require 'open3'
@@ -206,29 +207,23 @@ module BinHelper
     old = Dir.pwd
     Dir.chdir(@tmpdir) if defined?(@tmpdir)
     begin
-    Open3.popen3(
-      "ruby", "-rubygems", "-I#{incl}",
-      binary,
-      *va
-    ) do |i,o,e|
-      yield i, o, e
-    end
+      return Open3.capture2e(
+        "ruby", "-rubygems", "-I#{incl}",
+        binary,
+        *va
+      )
     ensure
+      Dir.chdir(old)
     end
-    Dir.chdir(old)
   end
 
   def run *va
-    puts "run: #{va.inspect}"
-    run_bin *va do |i, o, e|
-      e = e.read
-      e.should == ""
-    end
+    stdout_str, ret = run_bin *va
+    ret.should == 0
   end
 
   def run_fail *va
-    run_bin *va do |i, o, e|
-      e.read.size.should > 0
-    end
+    stdout_str, ret = run_bin *va
+    ret.should_not == 0
   end
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nwn-lib
 version: !ruby/object:Gem::Version
-  version: 0.5.1
-  prerelease: 
+  version: 0.6.0
 platform: ruby
 authors:
 - Bernhard Stoeckner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-28 00:00:00.000000000 Z
+date: 2013-11-16 00:00:00.000000000 Z
 dependencies: []
 description: Neverwinter Nights 1/2 file formats ruby library
 email:
@@ -55,7 +54,6 @@ files:
 - lib/nwn/settings.rb
 - lib/nwn/tlk.rb
 - lib/nwn/twoda.rb
-- lib/nwn/version.rb
 - lib/nwn/xml_support.rb
 - lib/nwn/yaml_support.rb
 - nwn-lib.gemspec
@@ -88,27 +86,26 @@ files:
 - tools/verify.sh
 homepage: https://github.com/niv/nwn-lib
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.9.1
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Neverwinter Nights 1/2 file formats ruby library
 test_files:
 - spec/bin_dsl_spec.rb

data/lib/nwn/version.rb

@@ -1,3 +0,0 @@
-module NWN
-  VERSION = "0.5.1"
-end