nwn-lib 0.4.5 → 0.4.6

data/spec/field_spec.rb

@@ -0,0 +1,21 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe "Gff::Field" do
+  GffFieldValidations.each do |t, values|
+    valid, invalid = *values
+    # No field type ever accepts nil as valid
+    invalid << nil
+
+    it "accepts good values for type '#{t.inspect}'" do
+      valid.each do |v|
+        Gff::Field.valid_for?(v, t).should == true
+      end
+    end
+
+    it "rejects bad values for type '#{t.inspect}'" do
+      invalid.each do |v|
+        Gff::Field.valid_for?(v, t).should == false
+      end
+    end
+  end
+end

data/spec/gff_spec.rb

@@ -0,0 +1,22 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+WELLFORMED_GFF = IO.read(File.dirname(__FILE__) + "/wellformed_gff.binary").freeze
+
+describe "Gff::*" do
+
+  def wellformed_verify binary
+    t = Gff::Reader.read(binary)
+  end
+
+  it "reads wellformed GFF data" do
+    wellformed_verify WELLFORMED_GFF
+  end
+
+  it "reproduces correct GFF binary data" do
+    t = Gff::Reader.read(WELLFORMED_GFF)
+    v = Gff::Writer.dump(t)
+    t2 = wellformed_verify v
+    t2.should == t
+  end
+
+end

data/spec/res_spec.rb

@@ -0,0 +1,59 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+class StubContainer < Resources::Container
+  def initialize files
+    super()
+    files.each {|fn, content|
+      io = StringIO.new(content)
+      @content << Resources::ContentObject.new_from(fn, io)
+    }
+  end
+end
+
+describe "ContentObject" do
+  subject do
+    Resources::ContentObject.new_from("case.txt", StringIO.new("test"))
+  end
+
+  it "returns filenames lowercase" do
+    subject.filename.should == "case.txt"
+  end
+
+  it "returns the proper size for StringIO" do
+    subject.size.should == 4
+  end
+end
+
+describe "Resources::Container" do
+  subject do
+    StubContainer.new('a_1.txt' => 'a', 'CASE.tXt' => 'case', 't_1.txt' => 'a')
+  end
+
+  it "disregards case" do
+    subject.get('case.txt').should == "case"
+    subject.get('CASE.txt').should == "case"
+    subject.get('CASE.tXt').should == "case"
+  end
+end
+
+describe Resources::Manager do
+  before do
+    subject.add_container StubContainer.new('a_1.txt' => 'a', 'CASE.tXt' => 'case', 't_1.txt' => 'a')
+    subject.add_container StubContainer.new('b_1.txt' => 'b', 't_1.txt' => 'b')
+  end
+
+  it "observes ordering of added containers" do
+    subject.get('a_1.txt').should == "a"
+    subject.get('t_1.txt').should == "b"
+  end
+
+  it "fails on invalid filenames" do
+    proc {subject.get('invalid')}.should raise_error Errno::ENOENT
+  end
+
+  it "disregards case" do
+    subject.get('case.txt').should == "case"
+    subject.get('CASE.txt').should == "case"
+    subject.get('CASE.tXt').should == "case"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+
+Thread.abort_on_exception = true
+
+unless Object.const_defined?('NWN')
+  $:.unshift(File.join(File.dirname(__FILE__), "../lib/"))
+  require 'nwn/all'
+  include NWN
+end
+
+GffFieldValidations = {
+  :void => [[""], []],
+  :byte => [[0, 255], [256, -1]],
+  :char => [[0, 255], [256, -1]],
+  :resref => [["", "a" * 16], ["a" * 17]],
+  :double => [[0.0], ["x"]],
+  :dword => [[0, 0xffffffff], [-1, 0xffffffff + 1]],
+  :dword64 => [[0, 0xffffffffffff], [-1, 0xffffffffffff + 1]],
+  :float => [[0.0], ["x"]],
+  :int => [[-0x80000000, 0x7fffffff], [0x80000001, 0x7fffffff + 1]],
+  :int64 => [[-0x800000000000, 0x7fffffffffff], [0x800000000001, 0x7fffffffffff + 1]],
+  :short => [[-0x8000, 0x7fff], [-0x8001, 0x7fff + 1]],
+  :word => [[0, 0xffff], [-1, 0xffff + 1]],
+}.freeze

data/spec/struct_spec.rb

@@ -0,0 +1,61 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe "Gff::Struct" do
+
+  it "accepts a block and yields the resulting struct" do
+    ret = Gff::Struct.new(0xdeadbeef) do |s|
+      s.add_byte 'Halp', 0xff
+    end
+    ret.should == {"Halp"=>{"label"=>"Halp", "value"=>255, "type"=>:byte}}
+    ret.struct_id.should == 0xdeadbeef
+  end
+
+  it "can retrieve list entries by_path" do
+    ret = Gff::Struct.new
+    ret.add_list 'Path', [] do |list|
+      list.v << Gff::Struct.new do |s|
+        s.add_byte 'Val', 0xff
+      end
+    end
+
+    ret.by_path('Path[0]/Val').should == {"label"=>"Val", "value"=>255, "type"=>:byte}
+    proc {
+      ret.by_path('Path[1]/Val')
+    }.should raise_error Gff::GffPathInvalidError
+    proc {
+      ret.by_path('PathWTF/$55?')
+    }.should raise_error Gff::GffPathInvalidError
+
+    ret.by_path('Path[0]/Val').should equal ret.by_path('/Path[0]/Val')
+  end
+
+  it "sets proper parent/child tree links" do
+    ret = Gff::Struct.new
+    list = ret.add_list 'Path', []
+    list.add_struct 1 do |l|
+      l.add_byte 'Val', 0xff
+    end
+
+    list = ret.by_path('/Path')
+    list.parent.should == ret
+
+    struct = ret.by_path('/Path[0]')
+    struct.element.should == list
+
+    byte = ret.by_path('/Path[0]/Val')
+    byte.parent.should == struct
+
+    ret.by_path('/Path[0]/Val').path.should == '/Path[0]/Val'
+  end
+
+  GffFieldValidations.each {|type, values|
+    valid, invalid = * values
+
+    it "can create #{type.inspect} fields dynamically" do
+      ret = Gff::Struct.new
+      ret.send('add_' + type.to_s, 'Test', valid[0])
+      ret.should == {"Test"=>{"label"=>"Test", "value"=>valid[0], "type"=>type}}
+    end
+  }
+
+end

data/spec/tlk_spec.rb

@@ -0,0 +1,47 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+WELLFORMED_TLK = ([
+  "TLK", "V3.0",
+  language_id = 0,
+  string_count = 5,
+  offset_to_str = 21,
+].pack("a4 a4 I I I") + [ # string data table
+  # flags, soundresref, volvariance, pitchvariance, offset_to_str, sz, soundlen
+  0x1, "", 0, 0, -1 + 40 * string_count, 1, 0.0,
+  0x3, "textsnd", 0, 0, -1 + 40 * string_count + 1, 2, 0.0,
+  0x7, "textsndlen", 0, 0, -1 + 40 * string_count + 3, 3, 2.0,
+  0x1, "", 0, 0, -1 + 40 * string_count + 6, 4, 0.0,
+  0x2, "justsnd", 0, 0, -1 + 40 * string_count + 10, 0, 0.0,
+].pack("I A16 I I I I f" * string_count) + [
+  "1", "22", "333", "4444"
+].join("")).freeze
+
+
+describe "Tlk::Tlk" do
+
+  def wellformed_verify binary
+    t = Tlk::Tlk.new(StringIO.new binary)
+
+    t.language.should == 0
+    t.highest_id.should == 4
+    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}
+    t[3].should == {:pitch_variance=>0, :text=>"4444",  :sound=>"", :sound_length=>0.0, :volume_variance=>0}
+    t[4].should == {:pitch_variance=>0, :text=>"",      :sound=>"justsnd", :sound_length=>0.0, :volume_variance=>0}
+    proc { t[5] }.should raise_error ArgumentError
+  end
+
+  it "reads wellformed TalkTables" do
+    wellformed_verify WELLFORMED_TLK
+  end
+
+  it "reproduces correct TalkTable binary data" do
+    t = Tlk::Tlk.new(StringIO.new WELLFORMED_TLK)
+    io = StringIO.new
+    t.write_to(io)
+    io.seek(0)
+    wellformed_verify io.read
+  end
+
+end

data/spec/twoda_spec.rb

@@ -0,0 +1,146 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+TWODA_WELLFORMED = <<-EOT
+2DA V2.0
+
+    Col1  Col2
+0   a     b
+1   c     d
+EOT
+
+TWODA_MISALIGNED = <<-EOT
+2DA V2.0
+
+   Col1
+0  a
+1  b
+2  c
+3  d
+4  e
+6  f
+2  g
+7  h
+EOT
+
+TWODA_WHITESPACE = <<-EOT
+2DA   V2.0  
+
+
+       Col1
+0   4
+EOT
+
+TWODA_MISSING_COLUMN = <<-EOT
+2DA V2.0
+
+    Col1   Col2  Col3
+0   a1     b1    c1
+1   a2     b2
+EOT
+
+TWODA_TOO_MANY_CELLS = <<-EOT
+2DA V2.0
+
+    Col1
+0   a1     b1    c1
+1   a2     b2
+2   "a2     b2    c1"
+EOT
+
+
+TWODA_EMPTY_AND_QUOTES = <<-EOT
+2DA V2.0
+
+    Col1  Col2
+0   ****  b
+1   c     d
+2   ""    f
+3   "g g" h
+EOT
+
+TWODA_MISSING_ID = <<-EOT
+2DA V2.0
+
+   Col1
+   a
+0  b
+1  c
+2  d
+EOT
+
+describe TwoDA::Table do
+
+  it "parses wellformed files" do
+    proc { subject.parse(TWODA_WELLFORMED) }.should_not raise_error ArgumentError
+  end
+
+  it "parses misnumbered IDs as NWN does" do
+    subject.parse(TWODA_MISALIGNED)
+    subject.rows.map {|v| v.Col1 }.should == %w{a b c d e f g h}
+  end
+  
+  it "skips rows with missing IDs as NWN does" do
+    subject.parse(TWODA_MISSING_ID)
+    subject.rows.map {|v| v.Col1 }.should == ["", "b", "c", "d"]
+  end
+
+  it "parses whitespace in tables correctly" do
+    proc { subject.parse(TWODA_WHITESPACE) }.should_not raise_error
+  end
+
+  it "fills in missing columns correctly" do
+    subject.parse(TWODA_MISSING_COLUMN)
+    subject.rows[1].Col3.should == ""
+  end
+
+  it "ignores superflous cell values" do
+    subject.parse(TWODA_TOO_MANY_CELLS)
+    subject.rows[0].size.should == 1
+    subject.rows[1].size.should == 1
+  end
+
+  it "parses non-quoted and quoted trailing cells with whitespaces correctly" do
+    subject.parse(TWODA_TOO_MANY_CELLS)
+    subject.rows[0].Col1.should == "a1"
+    subject.rows[1].Col1.should == "a2"
+    subject.rows[2].Col1.should == "a2     b2    c1"
+  end
+
+  it "parses starred values correctly" do
+    subject.parse(TWODA_EMPTY_AND_QUOTES)
+    subject.rows[0].Col1.should == ""
+  end
+
+  it "parses quoted cells correctly" do
+    subject.parse(TWODA_EMPTY_AND_QUOTES)
+    subject.rows[2].Col1.should == ""
+    subject.rows[3].Col1.should == "g g"
+    subject.rows[3].Col2.should == "h"
+  end
+
+  it "allows setting a whole row by column id, and cast arguments" do
+    subject.parse(TWODA_WELLFORMED)
+    subject[0] = [1, 2]
+    subject[0].should == ["1", "2"]
+    proc { subject[0] = [1, 2, 3] }.should raise_error ArgumentError
+  end
+
+  it "allows setting a cell by id and column name, and cast arguments" do
+    subject.parse(TWODA_WELLFORMED)
+    subject[0, 'Col1'] = "a"
+    subject[0, 'Col1'].should == "a"
+    proc { subject['Col1', 0] = "a" }.should raise_error TypeError
+  end
+
+  it "should print newlines as specified in NWN_LIB_2DA_NEWLINE" do
+    subject.parse(TWODA_WELLFORMED)
+    ENV['NWN_LIB_2DA_NEWLINE'] = nil
+    subject.to_2da.should =~ /^2DA V2.0\r\n\r\n +C/
+    ENV['NWN_LIB_2DA_NEWLINE'] = "0"
+    subject.to_2da.should =~ /^2DA V2.0\r\n\r\n +C/
+    ENV['NWN_LIB_2DA_NEWLINE'] = "1"
+    subject.to_2da.should =~ /^2DA V2.0\n\n +C/
+    ENV['NWN_LIB_2DA_NEWLINE'] = "2"
+    subject.to_2da.should =~ /^2DA V2.0\r\r +C/
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: nwn-lib
 version: !ruby/object:Gem::Version 
-  version: 0.4.5
+  version: 0.4.6
 platform: ruby
 authors: 
 - Bernhard Stoeckner
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-16 00:00:00 +01:00
+date: 2009-05-18 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -25,10 +25,8 @@ extensions: []
 extra_rdoc_files: 
 - README
 - BINARIES
-- DATA_STRUCTURES
 - SCRIPTING
 - SETTINGS
-- TYPE_VALUE_INFERRING
 - CHEATSHEET
 - CHANGELOG
 - COPYING
@@ -41,8 +39,18 @@ files:
 - bin/nwn-gff
 - bin/nwn-irb
 - bin/nwn-erf
+- spec/gff_spec.rb
+- spec/res_spec.rb
+- spec/wellformed_gff.binary
 - spec/spec.opts
+- spec/erf_spec.rb
+- spec/field_spec.rb
+- spec/cexolocstr_spec.rb
+- spec/struct_spec.rb
+- spec/spec_helper.rb
+- spec/tlk_spec.rb
 - spec/rcov.opts
+- spec/twoda_spec.rb
 - lib/nwn
 - lib/nwn/scripting.rb
 - lib/nwn/yaml.rb
@@ -51,7 +59,7 @@ files:
 - lib/nwn/settings.rb
 - lib/nwn/gff.rb
 - lib/nwn/tlk.rb
-- lib/nwn/infer.rb
+- lib/nwn/res.rb
 - lib/nwn/kivinen.rb
 - lib/nwn/all.rb
 - lib/nwn/helpers.rb
@@ -70,12 +78,9 @@ files:
 - scripts/clean_locstrs.rb
 - scripts/extract_all_items.rb
 - scripts/debug_check_objid.rb
-- data/gff-common-nwn1.yaml
 - BINARIES
-- DATA_STRUCTURES
 - SCRIPTING
 - SETTINGS
-- TYPE_VALUE_INFERRING
 - CHEATSHEET
 has_rdoc: true
 homepage: http://nwn-lib.elv.es