nwn-lib 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6039060ff0d0c726c6b7fa44dd7be8c624c3cf98
-  data.tar.gz: 82b2a9eea724b7d9b5b52a254d3b672b126affe8
+  metadata.gz: 2a2d93809edde689509fb37cdfaf410acc03ea31
+  data.tar.gz: 57caf59003fb680ec38e3f91034d95d027967ab5
 SHA512:
-  metadata.gz: 2288b34809225b00cb6b95c26a4d2360c31c8360d045ef8cbf5b69341cff2936d7f01aeeced4fa6e9ebbfad313578cfad7459da4f4896b4d0d6b042d888c66b5
-  data.tar.gz: 69c551f0f7e19d64a2bbed798d10f75a8c8b6c78df91b7103a6759cd1fb34cc47fd22020042883e655c9eb283bb24aabef57848d694ab1e72e5481d6a178dd95
+  metadata.gz: 6bd0bca589892c6036d41ff70b5dd08c65f91dce64673f9051cbc57325bca2a2fb74e927e560b6bf0a84fe464b67bd44f30764f09b0328f5e70f02423a92c696
+  data.tar.gz: 3da9bcb5475aa8cb696b4f776dd66663a3ef0e50f48edba223909925cd2fc87c081cdd2eddba9c6bf5ec19cd53b73fa3b6c188a464200585255dd10278f8bb5e

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.3.0
+  - 2.2.4
+  - 2.1.8
+script: bundle exec rspec spec

data/bin/nwn-erf

@@ -7,6 +7,8 @@ $action = nil
 $verbose = false
 $type = 'ERF'
 $allow_duplicates = false
+$day_of_year = nil
+$year = nil
 $descriptions = {}
 $version = "V1.0"
 $file = nil
@@ -33,7 +35,7 @@ begin OptionParser.new do |o|
   o.on "-x", "--extract", "Extract FILEs (or all) to current directory." do
     $action = :x
   end
-  o.on "-a", "--add", "Add files to the given archive.",
+  o.on "-a", "--add", "Add (or replace) files to the given archive.",
       "This is an expensive operation, a full archive rebuild is required." do
     $action = :a
   end
@@ -71,6 +73,12 @@ begin OptionParser.new do |o|
   o.on "-1", "Create (only -c) V1.1 ERF, 32 byte resrefs. (NWN2)." do
     $version = "V1.1"
   end
+  o.on "--day DAY", "Set the day_of_year header field when doing write operations" do |x|
+    $day_of_year = x
+  end
+  o.on "--year YEAR", "Set the year header field when doing write operations" do |x|
+    $year = x
+  end
 
   o.separator " "
   o.separator "Hacks:"
@@ -155,6 +163,8 @@ case $action
     erf = NWN::Erf::Erf.new
     erf.file_type = $type if $type
     erf.file_version = $version
+    erf.year = $year if $year
+    erf.day_of_year = $day_of_year if $day_of_year
 
     if $descriptions
       erf.localized_strings.merge! $descriptions
@@ -171,22 +181,23 @@ case $action
   when :a, :r
     input do |infile|
       erf = NWN::Erf::Erf.new(infile)
+      erf.year = $year if $year
+      erf.day_of_year = $day_of_year if $day_of_year
 
       if $descriptions
         erf.localized_strings.merge! $descriptions
       end
 
       ARGV.each {|arg|
+        # Remove all (old) files.
+        erf.remove_file(arg) if erf.has?(arg)
+
         case $action
           when :a
-            raise ArgumentError, "#{File.basename(arg)} already present in erf." if
-              !$allow_duplicates && erf.has?(arg)
             erf.add_file File.basename(arg), File.open(arg, "r")
 
           when :r
-            erf.content.reject! {|con|
-              con.filename.downcase == arg.downcase
-            }
+            # Nothing to do.
         end
       }
 

data/lib/nwn/erf.rb

@@ -105,19 +105,21 @@ module NWN
         @io.seek(offset_to_keys)
         keylist = @io.e_read(keylist_entry_size * entry_count, "keylist")
         keylist = keylist.unpack("A#{fnlen} V v v" * entry_count)
-        keylist.each_slice(4) {|resref, res_id, res_type, unused|
-          @content << NWN::Resources::ContentObject.new(resref, res_type, @io)
-        }
 
         resourcelist_entry_size = 4 + 4
         @io.seek(offset_to_res)
         resourcelist = @io.e_read(resourcelist_entry_size * entry_count, "reslist")
         resourcelist = resourcelist.unpack("I I" * entry_count)
-        _index = -1
-        resourcelist.each_slice(2) {|offset, size|
+
+        _index = 0
+        keylist.each_slice(4) {|resref, res_id, res_type, unused|
+          co = NWN::Resources::ContentObject.new(resref, res_type, @io)
+          offset, size = resourcelist[_index * 2], resourcelist[_index * 2 + 1]
+          co.offset = offset
+          co.size_override = size
+          add co
+
           _index += 1
-          @content[_index].offset = offset
-          @content[_index].size_override = size
         }
       end
 

data/lib/nwn/gff.rb

@@ -116,7 +116,7 @@ module NWN
     OutputFormats = {}
     FileFormatGuesses = {}
 
-    Handler.register :gff, /^(ut[cdeimpstw]|git|are|gic|mod|ifo|fac|ssf|dlg|itp|bic)$/, NWN::Gff::Handler::Gff
+    Handler.register :gff, /^(ut[cdeimpstw]|git|are|gic|mod|ifo|fac|ssf|dlg|itp|bic|jrl)$/, NWN::Gff::Handler::Gff
     Handler.register :marshal, /^marshal$/, NWN::Gff::Handler::Marshal
     Handler.register :pretty, /^$/, NWN::Gff::Handler::Pretty, false, true
 

data/lib/nwn/gff/field.rb

@@ -150,7 +150,7 @@ module NWN::Gff::Field
         value.is_a?(Integer) && value >= 0 && value <= 0xffffffffffffffff
 
       when :float, :double
-        value.is_a?(Float)
+        value.is_a?(Float) || value.is_a?(Integer)
 
       when :resref
         if !NWN.setting(:resref32) && value.is_a?(String) && value.size > 16
@@ -169,7 +169,7 @@ module NWN::Gff::Field
 
       when :cexolocstr
         value.is_a?(Hash) &&
-          value.keys.reject {|x| x.is_a?(Fixnum) && x >= 0 }.size == 0 &&
+          value.keys.reject {|x| x.is_a?(Integer) && x >= 0 }.size == 0 &&
           value.values.reject {|x| x.is_a?(String) }.size == 0
 
       when :struct

data/lib/nwn/key.rb

@@ -116,11 +116,11 @@ module NWN
           o = NWN::Resources::ContentObject.new(resref, res_type, bif.io, ofs, sz)
           if @fn_to_co[o.filename] && @fn_to_co[o.filename][2] < bif_index
             oo, biff = @fn_to_co[o.filename]
-            NWN.log_debug "#{o.filename} in #{biff.io.inspect} shadowed by file of same name in #{bif.io.inspect}"
-            @content.delete(oo)
+            # NWN.log_debug "#{o.filename} in #{biff.io.inspect} shadowed by file of same name in #{bif.io.inspect}"
+            remove oo
           end
           @fn_to_co[o.filename] = [o, bif, bif_index]
-          @content << o
+          add o
         }
       end
     end

data/lib/nwn/res.rb

@@ -33,7 +33,7 @@ module NWN
 
       # Get the size in bytes of this object.
       def size
-        @size_override || (@io.is_a?(IO) ? @io.stat.size : File.stat(@io).size)
+        @size ||= (@size_override || (@io.is_a?(IO) ? @io.stat.size : File.stat(@io).size))
       end
 
       # Get the contents of this object. This is a costly operation, loading
@@ -50,12 +50,12 @@ module NWN
 
       # Get the canonical filename of this object.
       def filename
-        @resref + "." + (self.extension || "unknown-#{@res_type}")
+        @filename ||= (@resref + "." + (self.extension || "unknown-#{@res_type}"))
       end
 
       # Get the extension of this object.
       def extension
-        NWN::Resources::Extensions.key(@res_type)
+        @extension ||= NWN::Resources::Extensions.key(@res_type)
       end
     end
 
@@ -63,43 +63,62 @@ module NWN
     class Container
 
       # An array of all ContentObjects indexed by this Container.
+      # Do not modify, use add/remove instead.
       attr_reader :content
 
+      # A hash containing filename.downcase => ContentObject.
+      # Do not modify, use add/remove instead.
+      attr_reader :content_by_filename
+
       def initialize
         @content = []
+        @content_by_filename = {}
       end
 
       # Returns true if the given filename is contained herein.
       # Case-insensitive.
       def has?(filename)
-        filenames.index(filename.downcase) != nil
+        @content_by_filename[filename.downcase] != nil
       end
 
       # Add a content object giving a +filename+ and a optional
       # +io+.
       def add_file filename, io = nil
-        @content << ContentObject.new_from(filename, io)
+        add ContentObject.new_from(filename, io)
       end
 
       # Add a content object giving the ContentObject
       def add o
         @content << o
+        @content_by_filename[o.filename.downcase] = o
+        @filenames = nil
+      end
+
+      # Removes a content object by filename.
+      # Raises ENOENT if no object by that name is contained.
+      def remove_file filename
+        @content_by_filename[filename.downcase] or raise Errno::ENOENT,
+          "No ContentObject with the given filename #{filename.inspect} found."
+
+        remove @content_by_filename[filename.downcase]
+      end
+
+      def remove o
+        @content.delete(o)
+        @content_by_filename.delete(o.filename)
+        @filenames = nil
       end
 
       # Returns a list of filenames, all lowercase.
       def filenames
-        @content.map {|x| x.filename.downcase }
+        @filenames ||= @content_by_filename.keys
       end
 
       # Get the ContentObject pointing to the given filename.
       # Raises ENOENT if not mapped.
       def get_content_object filename
-        filename = filename.downcase
-        ret = @content.select {|x| filename == x.filename }
-        raise Errno::ENOENT,
-          "No ContentObject with the given filename #{filename.inspect} found." if
-            ret.size == 0
-        ret[0]
+        @content_by_filename[filename.downcase] or raise Errno::ENOENT,
+          "No ContentObject with the given filename #{filename.inspect} found."
       end
 
       # Get the contents of the given filename.

data/lib/nwn/scripting.rb

@@ -70,7 +70,7 @@ module NWN::Gff::Scripting
     end
     $stop_output = true
   end
-  
+
   def will_output?
     !$stop_output
   end
@@ -177,7 +177,7 @@ module NWN::Gff::Scripting
       when Array
         i = 0 ; Hash[match.map {|x| [i+=1, x]}]
 
-      when Hash, Regexp, Fixnum, Float
+      when Hash, Regexp, Integer, Float
         match
 
       else
@@ -201,7 +201,7 @@ module NWN::Gff::Scripting
           end
         when Regexp
           ret =~ match
-        when Fixnum
+        when Integer
           ret =~ /^\d+$/
         when Float
           ret =~ /^\d+(.\d+)?$/
@@ -210,7 +210,7 @@ module NWN::Gff::Scripting
 
     case match
       when Float; ret.to_f
-      when Fixnum; ret.to_i
+      when Integer; ret.to_i
       else; ret
     end
   end

data/lib/nwn/tlk.rb

@@ -21,7 +21,7 @@ module NWN
       DATA_ELEMENT_SIZE = 4 + 16 + 4 + 4 + 4 + 4 + 4
 
       # The number of strings this Tlk holds.
-      # attr_reader :size
+      attr_reader :size
 
       # The language_id of this Tlk.
       attr_reader :language
@@ -59,7 +59,7 @@ module NWN
 
         return @cache[id] if @cache[id]
 
-        raise ArgumentError, "No such string ID: #{id.inspect}" if id > self.highest_id || id < 0
+        raise ArgumentError, "No such string ID: #{id.inspect} (size: #{@size})" if id > (self.size-1) || id < 0
         seek_to = HEADER_SIZE + (id) * DATA_ELEMENT_SIZE
         @io.seek(seek_to)
         data = @io.e_read(DATA_ELEMENT_SIZE, "tlk entry = #{id}")
@@ -84,55 +84,58 @@ module NWN
       # Add a new entry to this Tlk and return the strref given to it.
       # To override existing entries, use tlk[][:text] = ".."
       def add text, sound = "", sound_length = 0.0, v_variance = 0, p_variance = 0
-        next_id = self.highest_id + 1
+        next_id = self.size + 1
         $stderr.puts "put in cache: #{next_id}"
         @cache[next_id] = {:text => text, :sound => sound, :sound_length => 0.0, :volume_variance => v_variance, :pitch_variance => p_variance}
+        @size += 1
         next_id
       end
 
-      # Return the highest ID in this Tlk table.
-      def highest_id
-        highest_cached = @cache.keys.sort[-1] || 0
-        @size - 1 > highest_cached ? @size - 1 : highest_cached
-      end
-
       # Write this Tlk to +io+.
       # Take care not to write it to the same IO object you are reading from.
       def write_to io
-        text_block = []
+        header = [
+          @file_type,
+          @file_version,
+          @language,
+          self.size,
+          HEADER_SIZE + (self.size) * DATA_ELEMENT_SIZE
+        ].pack("A4 A4 I I I")
+        io.write(header)
+
         offsets = []
         offset = 0
-        for i in 0..self.highest_id do
+        for i in 0...@size do
           entry = self[i]
           offsets[i] = offset
-          text_block << entry[:text]
           offset += entry[:text].size
         end
-        text_block = text_block.join("")
-
-        header = [
-          @file_type, @file_version,
-          @language,
-          self.highest_id + 1, HEADER_SIZE + (self.highest_id + 1) * DATA_ELEMENT_SIZE
-        ].pack("A4 A4 I I I")
 
         entries = []
-        for i in 0..self.highest_id do
+        for i in 0...@size do
           entry = self[i]
           text, sound, sound_length = entry[:text], entry[:sound], entry[:sound_length]
           flags = 0
           flags |= 0x01 if text.size > 0
           flags |= 0x02 if sound.size > 0
           flags |= 0x04 if sound_length > 0.0
-          entries << [
-            flags, sound, entry[:volume_variance], entry[:pitch_variance], offsets[i], text.size, sound_length
+
+          ev_s = [
+            flags,
+            sound, #resref
+            entry[:volume_variance],
+            entry[:pitch_variance],
+            offsets[i],
+            text.size,
+            sound_length
           ].pack("I a16 I I I I f")
+
+          io.write(ev_s)
         end
-        entries = entries.join("")
 
-        io.write(header)
-        io.write(entries)
-        io.write(text_block)
+        for i in 0...@size do
+          io.write(self[i][:text])
+        end
       end
     end
 

data/lib/nwn/twoda.rb

@@ -47,8 +47,7 @@ module NWN
           false
         end
 
-        if idx = @table.columns.index(col.downcase) ||
-            idx = @table.columns.index(col)
+        if idx = @table.column_name_to_id(col)
           if assignment
             self[idx] = args.shift or raise ArgumentError,
               "Need a paramenter for assignments .."
@@ -65,7 +64,11 @@ module NWN
       CELL_PAD_SPACES = 4
 
       # An array of all column names present in this 2da table.
-      attr_accessor :columns
+      def columns; @columns; end
+      def columns=(c)
+        @columns = c
+        @columns_lookup = @columns.map(&:downcase)
+      end
 
       # An array of row arrays, without headers.
       attr_accessor :rows
@@ -82,6 +85,7 @@ module NWN
       # Create a new, empty 2da table.
       def initialize
         @columns = []
+        @columns_lookup = []
         @rows = []
         @newline = "\r\n"
       end
@@ -180,7 +184,7 @@ module NWN
           k_row.pop while k_row.size > header.size
         }
 
-        @columns = header
+        self.columns = header
         @rows = new_row_data
       end
 
@@ -242,9 +246,10 @@ module NWN
       # or the column cannot be resolved.
       def column_name_to_id column
          case column
-          when String
-            @columns.index(column) or raise ArgumentError, "Not a valid column name: #{column}"
-          when Fixnum
+          when String, Symbol
+            @columns_lookup.index(column.to_s.downcase) or raise ArgumentError,
+              "Not a valid column name: #{column}"
+          when Integer
             column
           when NilClass
             nil
@@ -282,6 +287,7 @@ module NWN
           rv = []
           rv << row_idx.to_s + " " * (id_cell_size - row_idx.to_s.size)
           row.each_with_index {|cell, column_idx|
+            cell = cell ? 1 : 0 if cell.is_a?(TrueClass) || cell.is_a?(FalseClass)
             cell = "****" if cell == ""
             cell = '"%s"' % cell if cell =~ /\s/
             cell = cell.to_s

data/nwn-lib.gemspec

@@ -12,6 +12,7 @@ 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       = "0.6.0"
+  gem.version       = "0.6.1"
   gem.required_ruby_version = '>= 1.9.3'
+  gem.license       = 'MIT'
 end

data/spec/res_spec.rb

@@ -5,7 +5,7 @@ class StubContainer < Resources::Container
     super()
     files.each {|fn, content|
       io = StringIO.new(content)
-      @content << Resources::ContentObject.new_from(fn, io)
+      self.add_file fn, io
     }
   end
 end
@@ -34,6 +34,11 @@ describe "Resources::Container" do
     subject.get('CASE.txt').should == "case"
     subject.get('CASE.tXt').should == "case"
   end
+
+  it "returns proper values for has?" do
+    subject.has?('case.txt').should == true
+    subject.has?('invalid').should == false
+  end
 end
 
 describe Resources::Manager do

data/spec/spec_helper.rb

@@ -1,5 +1,11 @@
 Bundler.setup(:default, :test)
 
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = [:should, :expect]
+  end
+end
+
 require 'tempfile'
 require 'fileutils'
 require 'open3'
@@ -21,10 +27,10 @@ GffFieldValidations = {
   :byte => [[0, 255], [256, -1]],
   :char => [[0, 255], [256, -1]],
   :resref => [["", "a" * 16], ["a" * 17]],
-  :double => [[0.0], ["x"]],
+  :double => [[0.0, 0], ["x"]],
   :dword => [[0, 0xffffffff], [-1, 0xffffffff + 1]],
   :dword64 => [[0, 0xffffffffffffffff], [-1, 0xffffffffffffffff + 1]],
-  :float => [[0.0], ["x"]],
+  :float => [[0.0, 0], ["x"]],
   :int => [[-0x80000000, 0x7fffffff], [0x80000001, 0x7fffffff + 1]],
   :int64 => [[-0x8000000000000000, 0x7fffffffffffffff], [-0x8000000000000000 - 1, 0x7fffffffffffffff + 1]],
   :short => [[-0x8000, 0x7fff], [-0x8001, 0x7fff + 1]],
@@ -219,11 +225,11 @@ module BinHelper
 
   def run *va
     stdout_str, ret = run_bin *va
-    ret.should == 0
+    raise "Error running command #{va.inspect}: #{stdout_str}" if ret != 0
   end
 
   def run_fail *va
     stdout_str, ret = run_bin *va
-    ret.should_not == 0
+    raise "No error running command #{va.inspect} (expected failure): #{stdout_str}" if ret == 0
   end
 end

data/spec/tlk_spec.rb

@@ -6,7 +6,7 @@ describe "Tlk::Tlk" do
     t = Tlk::Tlk.new(StringIO.new binary)
 
     t.language.should == 0
-    t.highest_id.should == 4
+    t.size.should == 5
     t[0].should == {:pitch_variance=>0, :text=>"1",     :sound=>"", :sound_length=>0.0, :volume_variance=>0}
     t[1].should == {:pitch_variance=>0, :text=>"22",    :sound=>"textsnd", :sound_length=>0.0, :volume_variance=>0}
     t[2].should == {:pitch_variance=>0, :text=>"333",   :sound=>"textsndlen", :sound_length=>2.0, :volume_variance=>0}

data/spec/twoda_spec.rb

@@ -2,7 +2,7 @@ require File.join(File.dirname(__FILE__), 'spec_helper')
 
 describe TwoDA::Table do
   it "parses wellformed files" do
-    proc { subject.parse(TWODA_WELLFORMED) }.should_not raise_error ArgumentError
+    proc { subject.parse(TWODA_WELLFORMED) }.should_not raise_error
   end
 
   it "parses misnumbered IDs as NWN does" do
@@ -74,4 +74,18 @@ describe TwoDA::Table do
     ENV['NWN_LIB_2DA_NEWLINE'] = "2"
     subject.to_2da.should =~ /^2DA V2.0\r\r +C/
   end
+
+  it "should treat columns case-insensitive" do
+    subject.parse(TWODA_WELLFORMED)
+    subject[0].Col1.should == subject[0].col1
+    subject.column_name_to_id("Col2").should == 1
+    subject.column_name_to_id("Col1").should == 0
+    subject.column_name_to_id("COL2").should == 1
+    subject.column_name_to_id("COL1").should == 0
+  end
+
+  it "should allow column lookups with symbols" do
+    subject.parse(TWODA_WELLFORMED)
+    subject.column_name_to_id(:Col2).should == 1
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nwn-lib
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Bernhard Stoeckner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-16 00:00:00.000000000 Z
+date: 2017-05-06 00:00:00.000000000 Z
 dependencies: []
 description: Neverwinter Nights 1/2 file formats ruby library
 email:
@@ -21,8 +21,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .yardopts
+- ".gitignore"
+- ".travis.yml"
+- ".yardopts"
 - BINARIES.rdoc
 - CHEATSHEET.rdoc
 - Gemfile
@@ -85,7 +86,8 @@ files:
 - tools/migrate_03x_to_04x.sh
 - tools/verify.sh
 homepage: https://github.com/niv/nwn-lib
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -93,17 +95,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Neverwinter Nights 1/2 file formats ruby library
@@ -128,4 +130,3 @@ test_files:
 - spec/tlk_spec.rb
 - spec/twoda_spec.rb
 - spec/wellformed_gff.bic
-has_rdoc: