nwn-lib 0.4.12 → 0.5.0

data/.gitignore

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

data/.yardopts

@@ -0,0 +1 @@
+--no-private lib/**/*.rb - *.rdoc LICENCE

data/Gemfile

@@ -0,0 +1,9 @@
+source :rubygems
+
+# Specify your gem's dependencies in nwn-lib.gemspec
+gemspec
+
+gem 'rake', '>= 0.8.7'
+
+gem 'rspec', :groups => [:development, :test] 
+gem 'yard', :groups => [:development]

data/LICENCE

@@ -0,0 +1,15 @@
+Copyright Bernhard Stoeckner <le@e-ix.net> and contributors. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are
+permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice, this list of
+      conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright notice, this list
+      of conditions and the following disclaimer in the documentation and/or other materials
+      provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+FOR A PARTICULAR PURPOSE.

data/{README → README.rdoc}

@@ -31,15 +31,15 @@ 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 BINARIES)
+* shell scripts and tools to simplify your life (see {file:BINARIES})
 * extensive developer API
-* a powerful get-out-of-my-way scripting system for data transformation (see SCRIPTING)
+* a powerful get-out-of-my-way scripting system for data transformation (see {file: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 BINARIES).
+I can't help you with your API bindings, but for your YAML dumps, a converter script has been provided (see {file:BINARIES}).
 
 
 === Attention Unicode/UTF-users
@@ -50,25 +50,19 @@ This will be worked around in a future release until the release of ruby 1.9, wh
 
 === Quickstart
 
-To use it, simply install the gem (available on rubyforge):
+To use it, simply install the gem:
 
- gem1.8 install nwn-lib
+ gem install nwn-lib
 
-And do the following in a script of your own devising:
+And do the following in a script of your own devising (or just use bundler):
 
   require 'rubygems'
   require 'nwn/all'
 
-Also, read BINARIES and HOWTO.
+Also, read {file:BINARIES} and {file:HOWTO}.
 
-For nwn-lib scripts, see SCRIPTING.
+For nwn-lib scripts, see {file:SCRIPTING}.
 
 For using the developer API, I suggest you start reading NWN::Gff::Struct.
 
-=== Latest code & developer contact
-
-The latest source is available through git[http://git.swordcoast.net/?p=nwn/nwn-lib.git;a=summary].
-
-All stable releases are tagged properly.
-
-You can reach me via email[mailto:elven@swordcoast.net].
+The latest source is available through git[https://github.com/niv/nwn-lib].

data/Rakefile

@@ -1,97 +1,8 @@
-require "rake"
-require "rake/clean"
-require "rake/gempackagetask"
-require "hanna/rdoctask" rescue require "rake/rdoctask"
-require "fileutils"
-include FileUtils
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'yard'
 
-##############################################################################
-# Configuration
-##############################################################################
-NAME = "nwn-lib"
-VERS = "0.4.12"
-CLEAN.include ["**/.*.sw?", "pkg", ".config", "rdoc", "coverage"]
-RDOC_OPTS = ["--quiet", "--line-numbers", "--inline-source", '--title', \
-  'nwn-lib: a ruby library for accessing NWN resource files', \
-  '--main', 'README']
+YARD::Rake::YardocTask.new
 
-DOCS = ["README", "BINARIES", "HOWTO", "SCRIPTING", "SETTINGS", "CHEATSHEET", "CHANGELOG", "COPYING"]
-
-Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_dir = "rdoc"
-  rdoc.options += RDOC_OPTS
-  rdoc.rdoc_files.add DOCS + ["doc/*.rdoc", "lib/**/*.rb"]
-end
-
-desc "Packages up nwn-lib"
-task :package => [:clean]
-
-spec = Gem::Specification.new do |s|
-  s.name = NAME
-  s.rubyforge_project = 'nwn-lib'
-  s.version = VERS
-  s.platform = Gem::Platform::RUBY
-  s.has_rdoc = true
-  s.extra_rdoc_files = DOCS + Dir["doc/*.rdoc"]
-  s.rdoc_options += RDOC_OPTS + ["--exclude", "^(examples|extras)\/"]
-  s.summary = "a ruby library for accessing Neverwinter Nights resource files"
-  s.description = s.summary
-  s.author = "Bernhard Stoeckner"
-  s.email = "elven@swordcoast.net"
-  s.homepage = "http://nwn-lib.elv.es"
-  s.executables = ["nwn-gff", "nwn-erf", "nwn-dsl", "nwn-irb"]
-  s.required_ruby_version = ">= 1.8.4"
-  s.files = %w(COPYING CHANGELOG README Rakefile) + Dir.glob("{bin,doc,spec,lib,tools,scripts,data}/**/*")
-  s.require_path = "lib"
-  s.bindir = "bin"
-end
-
-Rake::GemPackageTask.new(spec) do |p|
-  p.need_tar = true
-  p.gem_spec = spec
-end
-
-desc "Install nwn-lib gem"
-task :install do
-  sh %{rake package}
-  sh %{sudo gem1.8 install pkg/#{NAME}-#{VERS}}
-end
-
-desc "Install nwn-lib gem without docs"
-task :install_no_docs do
-  sh %{rake package}
-  sh %{sudo gem1.8 install pkg/#{NAME}-#{VERS} --no-rdoc --no-ri}
-end
-
-desc "Uninstall nwn-lib gem"
-task :uninstall => [:clean] do
-  sh %{sudo gem1.8 uninstall #{NAME}}
-end
-
-require "spec/rake/spectask"
-
-desc "Run specs with coverage"
-Spec::Rake::SpecTask.new("spec") do |t|
-  t.spec_files = FileList["spec/*_spec.rb"]
-  t.spec_opts = ["--format s"]
-  t.rcov = true
-end
-
-desc "Run specs without coverage"
-task :default => [:spec_no_cov]
-Spec::Rake::SpecTask.new("spec_no_cov") do |t|
-  t.spec_files = FileList["spec/*_spec.rb"]
-  t.spec_opts = ["--format s"]
-end
-
-desc "Run rcov only"
-Spec::Rake::SpecTask.new("rcov") do |t|
-  t.spec_files = FileList["spec/*_spec.rb"]
-  t.spec_opts = ["--format s"]
-  t.rcov = true
-end
-
-desc "check documentation coverage"
-task :dcov do
-  sh "find lib -name '*.rb' | xargs dcov"
-end
+RSpec::Core::RakeTask.new(:spec)

data/bin/nwn-erf

@@ -164,7 +164,7 @@ case $action
       puts File.basename(a) if $verbose
       raise ArgumentError, "#{File.basename(a)} already present in erf." if
         !$allow_duplicates && erf.has?(a)
-      erf.add_file a
+      erf.add_file File.basename(a), File.open(a, "r")
     }
     output {|f| erf.write_to(f) }
 
@@ -181,7 +181,7 @@ case $action
           when :a
             raise ArgumentError, "#{File.basename(arg)} already present in erf." if
               !$allow_duplicates && erf.has?(arg)
-            erf.add_file arg
+            erf.add_file File.basename(arg), File.open(arg, "r")
 
           when :r
             erf.content.reject! {|con|

data/lib/nwn/all.rb

@@ -1,4 +1,5 @@
 require 'stringio'
+require 'nwn/version'
 require 'nwn/io'
 require 'nwn/twoda'
 require 'nwn/settings'

data/lib/nwn/erf.rb

@@ -133,12 +133,12 @@ module NWN
           [c.resref, @content.index(c), c.res_type, 0].pack("a#{fnlen} V v v")
         }.join("")
 
-        pre_offset = 160 + locstr.size + keylist.size + 8 * @content.size
+        offset = 160 + locstr.size + keylist.size + 8 * @content.size
 
         reslist = @content.map {|c|
-          offset = pre_offset +
-            @content[0, @content.index(c)].inject(0) {|sum,x| sum + x.size }
-          [offset, c.size].pack("V V")
+          r = [offset, c.size].pack("V V")
+          offset += c.size
+          r
         }.join("")
 
         offset_to_locstr = 160

data/lib/nwn/gff.rb

@@ -124,7 +124,7 @@ module NWN
       extension = File.extname(filename.downcase)[1..-1]
       matches = FileFormatGuesses.select {|fmt,rx| extension =~ rx }
       if matches.size == 1
-        matches[0][0]
+        matches.keys[0]
       else
         nil
       end

data/lib/nwn/gff/field.rb

@@ -103,10 +103,11 @@ module NWN::Gff::Field
     return if field_type == :struct
 
     field_klass_name = field_type.to_s.capitalize
-    field_klass = NWN::Gff.const_defined?(field_klass_name) ?
-      NWN::Gff.const_get(field_klass_name) : nil
-    field_value_klass = NWN::Gff.const_defined?(field_klass_name + 'Value') ?
-      NWN::Gff.const_get(field_klass_name + 'Value') : nil
+
+    field_klass = NWN::Gff.const_defined?(field_klass_name, false) ?
+      NWN::Gff.const_get(field_klass_name, false) : nil
+    field_value_klass = NWN::Gff.const_defined?(field_klass_name + 'Value', false) ?
+      NWN::Gff.const_get(field_klass_name + 'Value', false) : nil
 
     self.extend(field_klass) unless field_klass.nil? ||
       self.is_a?(field_klass)
@@ -227,15 +228,24 @@ module NWN::Gff::Field
     element.extend_meta_classes
     case element.field_type
       when :cexolocstr
+        mod = {}
         element.field_value.each {|x,y|
-          element.field_value[x.to_i] = NWN.iconv_native_to_gff(element.field_value.delete(x))
+          mod[x] = NWN.iconv_native_to_gff(y)
+        }
+        mod.each {|x,y|
+          element.field_value.delete(x)
+          element.field_value[x.to_i] = y
         }
       when :cexostr
         element.field_value = NWN.iconv_native_to_gff(element.field_value)
 
       when :list
+        mod = {}
         element.field_value.each_with_index {|x,idx|
-          element.field_value[idx] = NWN::Gff::Struct.unbox!(x, element)
+          mod[idx] = NWN::Gff::Struct.unbox!(x, element)
+        }
+        mod.each {|x,y|
+          element.field_value[x] = y
         }
       when :struct
         element.field_value = NWN::Gff::Struct.unbox!(element.field_value, element)

data/lib/nwn/gff/reader.rb

@@ -47,6 +47,7 @@ class NWN::Gff::Reader
     @io.seek(label_offset)
     @labels  = @io.e_read(label_len, "labels")
     @labels = @labels.unpack("A16" * label_count)
+    @labels.map! {|l| l.encode("ASCII") }
 
     @io.seek(field_data_offset)
     @field_data = @io.e_read(field_data_count, "field_data")
@@ -74,6 +75,9 @@ class NWN::Gff::Reader
     raise GffError, "struct index #{index} outside of struct_array" if
       index * 3 + 3 > @structs.size + 1
 
+    file_type = file_type.encode('ASCII') if file_type
+    file_version = file_version.encode('ASCII') if file_version
+
     struct.struct_id = type
     struct.data_type = file_type
     struct.data_version = file_version
@@ -155,11 +159,11 @@ class NWN::Gff::Reader
 
       when :cexostr
         len = @field_data[data_or_offset, 4].unpack("V")[0]
-        @field_data[data_or_offset + 4, len]
+        @field_data[data_or_offset + 4, len].encode(NWN.setting :in_encoding)
 
       when :resref
         len = @field_data[data_or_offset, 1].unpack("C")[0]
-        @field_data[data_or_offset + 1, len]
+        @field_data[data_or_offset + 1, len].encode(NWN.setting :in_encoding)
 
       when :cexolocstr
         exostr = {}
@@ -172,7 +176,7 @@ class NWN::Gff::Reader
 
         str_count.times {
           id, len = all.unpack("VV")
-          str = all[8, len].unpack("a*")[0]
+          str = all[8, len].unpack("a*")[0].encode(NWN.setting :in_encoding)
           all = all[(8 + len)..-1]
           exostr[id] = str
         }
@@ -181,7 +185,7 @@ class NWN::Gff::Reader
 
       when :void
         len = @field_data[data_or_offset, 4].unpack("V")[0]
-        @field_data[data_or_offset + 4, len].unpack("H*")[0]
+        @field_data[data_or_offset + 4, len].unpack("a*")[0]
 
       when :struct
         read_struct data_or_offset, nil, field.parent.data_version

data/lib/nwn/gff/struct.rb

@@ -19,7 +19,7 @@ module NWN::Gff::Struct
   attr_reader :element
 
   def path
-    if @element
+    if defined?(@element) && !@element.nil?
       @element.path
     else
       "/"
@@ -41,13 +41,15 @@ module NWN::Gff::Struct
   # Overrides the data type (used by the built-in file format readers).
   def data_type= k
     k = nil if k == ""
-    NWN.log_debug("Setting explicit data_type for parented element") if k && @element
+    NWN.log_debug("Setting explicit data_type for parented element") if k &&
+      defined?(@element) && !@element.nil?
     @data_type = k
   end
 
   def element= e #:nodoc:
     @element = e
-    NWN.log_debug("Re-parenting a struct with explicit data_type #{@data_type.inspect}") if e && @data_type
+    NWN.log_debug("Re-parenting a struct with explicit data_type #{@data_type.inspect}") if !e.nil? &&
+      defined?(@data_type) && !@data_type.nil?
   end
 
   # Dump this struct as GFF binary data.
@@ -106,7 +108,7 @@ module NWN::Gff::Struct
 
   def method_missing meth, *av, &block # :nodoc:
     if meth.to_s =~ /^add_(.+)$/
-      if NWN::Gff::Types.index($1.to_sym)
+      if NWN::Gff::Types.key($1.to_sym)
         av.size >= 1 || av.size <= 2 or raise(NoMethodError,
           "undefined method #{meth} (requires two arguments to infer add_any)")
         t = $1.to_sym

data/lib/nwn/gff/writer.rb

@@ -42,7 +42,7 @@ private
 
   def add_data_field type, label, content
     label_id = get_label_id_for_label label
-    @fields.push Types.index(type), label_id, content
+    @fields.push Types.key(type), label_id, content
     (@fields.size - 1) / 3
   end
 
@@ -129,7 +129,7 @@ private
                 v.field_value % (2**32)
               ].pack("II")
             when :void
-              [ v.field_value.size / 2, v.field_value ].pack("VH*")
+              [ v.field_value.size, v.field_value ].pack("Va*")
             else
               [v.field_value].pack(format)
           end

data/lib/nwn/key.rb

@@ -87,8 +87,8 @@ module NWN
           size, name_offset, name_size, drives = x.unpack("VVvv")
           io.seek(name_offset)
           name = io.e_read(name_size, "name table").unpack("A*")[0]
-          name.gsub!("\\", "/")
-          name = File.expand_path(@root + "/" + name)
+          name.gsub!("\\", File::SEPARATOR)
+          name = File.expand_path(@root + File::SEPARATOR + name)
 
           _io = File.new(name, "r")
           @bif << Bif.new(self, _io)

data/lib/nwn/kivinen_support.rb

@@ -50,6 +50,8 @@ module NWN::Gff::Handler::Kivinen
               yield(path + "/", path)
               yield(path + "/ ____struct_type", field.field_value.struct_id)
             when :cexolocstr
+            when :void
+              yield(path, field.field_value.unpack("H*")[0])
             else
               yield(path, field.field_value)
           end
@@ -57,7 +59,7 @@ module NWN::Gff::Handler::Kivinen
           yield(path + ". ____string_ref",field.str_ref) if
             field.has_str_ref? || field.field_type == :cexolocstr
 
-          yield(path + ". ____type", NWN::Gff::Types.index(field.field_type)) if
+          yield(path + ". ____type", NWN::Gff::Types.key(field.field_type)) if
             types_too
 
       end

data/lib/nwn/res.rb

@@ -55,7 +55,7 @@ module NWN
 
       # Get the extension of this object.
       def extension
-        NWN::Resources::Extensions.index(@res_type)
+        NWN::Resources::Extensions.key(@res_type)
       end
     end
 
@@ -115,7 +115,7 @@ module NWN
       def initialize path
         super()
         @path = path
-        Dir[path + "/*.*"].each {|x|
+        Dir[path + File::SEPARATOR + "*.*"].each {|x|
           begin add_file x
           rescue ArgumentError => e
             NWN.log_debug e.to_s