nwn-lib 0.4.6 → 0.4.7

data/spec/gff_spec.rb

@@ -1,11 +1,38 @@
 require File.join(File.dirname(__FILE__), 'spec_helper')
 
-WELLFORMED_GFF = IO.read(File.dirname(__FILE__) + "/wellformed_gff.binary").freeze
+describe "Gff.read/write API" do
+  it "reads correctly" do
+    i = StringIO.new WELLFORMED_GFF
+    g = Gff.read(i, :gff)
+  end
+
+  it "writes correctly" do
+    i = StringIO.new WELLFORMED_GFF
+    gff = Gff.read(i, :gff)
+
+    out = StringIO.new
+    ret = Gff.write(out, :gff, gff)
+    ret.should == out.size
+  end
+
+  {
+    :gff => %w{utc utd ute uti utm utp uts utt utw git are gic mod ifo fac ssf dlg itp bic},
+    :yaml => %w{yml yaml},
+    :kivinen => %w{k kivinen},
+    :marshal => %w{marshal}
+  }.each {|expect, arr|
+    arr.each {|ext|
+      it "guesses the file format #{expect} for extension #{ext} correctly" do
+        Gff.guess_file_format("xxy.#{ext}").should == expect
+      end
+    }
+  }
+end
 
 describe "Gff::*" do
 
   def wellformed_verify binary
-    t = Gff::Reader.read(binary)
+    t = Gff::Reader.read(StringIO.new binary)
   end
 
   it "reads wellformed GFF data" do
@@ -13,10 +40,26 @@ describe "Gff::*" do
   end
 
   it "reproduces correct GFF binary data" do
-    t = Gff::Reader.read(WELLFORMED_GFF)
+    t = Gff::Reader.read(StringIO.new WELLFORMED_GFF)
     v = Gff::Writer.dump(t)
     t2 = wellformed_verify v
     t2.should == t
   end
 
+  it "writes to io and returns the number of written bytes" do
+    t = Gff::Reader.read(StringIO.new WELLFORMED_GFF)
+    out = StringIO.new
+    v = Gff::Writer.dump(t, out)
+    v.should == out.size
+    out.seek(0)
+    v = out.read(v)
+    t2 = wellformed_verify v
+    t2.should == t
+  end
+
+  it "fails on not enough data" do
+    proc {wellformed_verify WELLFORMED_GFF[0 .. -2] }.should
+      raise_error IOError, "cannot read list_indices"
+  end
+
 end

data/spec/spec_helper.rb

@@ -1,4 +1,6 @@
 require 'rubygems'
+require 'tempfile'
+require 'open3'
 
 Thread.abort_on_exception = true
 
@@ -22,3 +24,175 @@ GffFieldValidations = {
   :short => [[-0x8000, 0x7fff], [-0x8001, 0x7fff + 1]],
   :word => [[0, 0xffff], [-1, 0xffff + 1]],
 }.freeze
+
+WELLFORMED_GFF_PATH = File.join(File.expand_path(File.dirname(__FILE__)), "wellformed_gff.bic").freeze
+WELLFORMED_GFF = IO.read(WELLFORMED_GFF_PATH).freeze
+
+WELLFORMED_ERF = ([
+  "HAK", "V1.0",
+  locstr_count = 1, locstr_size = 14,
+  entry_count = 3,
+  offset_to_locstr = 160,
+  offset_to_keys = offset_to_locstr + locstr_size,
+  offset_to_res  = offset_to_locstr + locstr_size + entry_count * (16 + 4 + 2 + 2),
+
+  100, 126, # year, dayofyear
+  0xdeadbeef, "" #description strref, 116 bytes 0-padding
+].pack("A4 A4 VV VV VV VV V  a116") + [
+  0, 6, "abcdef" # one locstr
+].pack("V V a*") + [
+  "resref", 0, 10, 0, # keylist: resref.txt, id = 0
+  "help",   1,  1, 0, # keylist: help.bmp, id = 1
+  "yegods", 2,  4, 0, # keylist: yegods.wav, id = 2
+].pack("a16 V v v" * entry_count) + [
+  offset_to_res + entry_count * 8, 6,  # offset, size
+  offset_to_res + entry_count * 8 + 6, 4,  # offset, size
+  offset_to_res + entry_count * 8 + 6 + 4, 6,  # offset, size
+].pack("II" * entry_count) + [
+  "resref", "help", "yegods"
+].pack("a* a* a*")).freeze
+
+WELLFORMED_ERF_11 = ([
+  "HAK", "V1.1",
+  locstr_count = 1, locstr_size = 14,
+  entry_count = 3,
+  offset_to_locstr = 160,
+  offset_to_keys = offset_to_locstr + locstr_size,
+  offset_to_res  = offset_to_locstr + locstr_size + entry_count * (32 + 4 + 2 + 2),
+
+  100, 126, # year, dayofyear
+  0xdeadbeef, "" #description strref, 116 bytes 0-padding
+].pack("A4 A4 VV VV VV VV V  a116") + [
+  0, 6, "abcdef" # one locstr
+].pack("V V a*") + [
+  "resref", 0, 10, 0, # keylist: resref.txt, id = 0
+  "help",   1,  1, 0, # keylist: help.bmp, id = 1
+  "yegods", 2,  4, 0, # keylist: yegods.wav, id = 2
+].pack("a32 V v v" * entry_count) + [
+  offset_to_res + entry_count * 8, 6,  # offset, size
+  offset_to_res + entry_count * 8 + 6, 4,  # offset, size
+  offset_to_res + entry_count * 8 + 6 + 4, 6,  # offset, size
+].pack("II" * entry_count) + [
+  "resref", "help", "yegods"
+].pack("a* a* a*")).freeze
+
+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
+
+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 "bin helper", :shared => true do
+  before do
+    @tmp = Dir.tmpdir
+  end
+
+  def run_bin *va
+    binary = File.join(File.expand_path(File.dirname(__FILE__)), "..", "bin", subject.to_s)
+    incl = File.join(File.expand_path(File.dirname(__FILE__)), "..", "lib")
+    old = Dir.pwd
+    begin
+    Dir.chdir(@tmp)
+    Open3.popen3(
+      "ruby", "-I#{incl}",
+      binary,
+      *va
+    ) do |i,o,e|
+      yield i, o, e
+    end
+    ensure
+    Dir.chdir(old)
+    end
+  end
+
+  def run *va
+    run_bin *va do |i, o, e|
+      e = e.read
+      e.should == ""
+    end
+  end
+
+  def run_fail *va
+    run_bin *va do |i, o, e|
+      e.read.size.should > 0
+    end
+  end
+end

data/spec/struct_spec.rb

@@ -58,4 +58,25 @@ describe "Gff::Struct" do
     end
   }
 
+  it "returns proper fields" do
+    t = Gff::Reader.read(StringIO.new WELLFORMED_GFF)
+    t['Plot'].should respond_to :t
+    t['Plot'].should respond_to :l
+    t['Plot'].should respond_to :v
+    t['Plot'].l.should == "Plot"
+    t['Plot'].t.should == :byte
+  end
+
+  it "yields all and correct values in each_by_flat_path" do
+    t = Gff::Reader.read(StringIO.new WELLFORMED_GFF)
+    t.each_by_flat_path do |k,v|
+      k.class.should == String
+      k.should =~ %r{^/}
+    end
+  end
+
+  it "responds_to to_gff" do
+    t = Gff::Reader.read(StringIO.new WELLFORMED_GFF)
+    Gff::Reader.read(StringIO.new t.to_gff).should == t
+  end
 end

data/spec/tlk_spec.rb

@@ -1,22 +1,5 @@
 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

data/spec/twoda_spec.rb

@@ -1,73 +1,5 @@
 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: nwn-lib
 version: !ruby/object:Gem::Version 
-  version: 0.4.6
+  version: 0.4.7
 platform: ruby
 authors: 
 - Bernhard Stoeckner
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-18 00:00:00 +02:00
+date: 2009-05-26 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -39,9 +39,9 @@ files:
 - bin/nwn-gff
 - bin/nwn-irb
 - bin/nwn-erf
+- spec/wellformed_gff.bic
 - spec/gff_spec.rb
 - spec/res_spec.rb
-- spec/wellformed_gff.binary
 - spec/spec.opts
 - spec/erf_spec.rb
 - spec/field_spec.rb
@@ -49,7 +49,10 @@ files:
 - spec/struct_spec.rb
 - spec/spec_helper.rb
 - spec/tlk_spec.rb
+- spec/bin_dsl_spec.rb
+- spec/bin_gff_spec.rb
 - spec/rcov.opts
+- spec/bin_erf_spec.rb
 - spec/twoda_spec.rb
 - lib/nwn
 - lib/nwn/scripting.rb
@@ -62,7 +65,6 @@ files:
 - lib/nwn/res.rb
 - lib/nwn/kivinen.rb
 - lib/nwn/all.rb
-- lib/nwn/helpers.rb
 - lib/nwn/gff
 - lib/nwn/gff/field.rb
 - lib/nwn/gff/reader.rb

data/lib/nwn/helpers.rb

@@ -1,153 +0,0 @@
-require 'nwn/gff'
-require 'nwn/twoda'
-
-module NWN
-  module Gff
-
-    module Helpers
-      # This sets up the IPRP cache. Used internally; no need to call this yourself.
-      def self._ip_cache_setup #:nodoc:
-        return if defined? @costtables
-        @costtables = {}
-        @paramtables = {}
-        @costtable_index = NWN::TwoDA::Cache.get('iprp_costtable')
-        @paramtable_index = NWN::TwoDA::Cache.get('iprp_paramtable')
-        @costtable_index.by_col('Name').each_with_index {|p,idx|
-          next if @costtables[p.downcase]
-          @costtables[p.downcase] = @costtables[idx] = NWN::TwoDA::Cache.get(p.downcase)
-        }
-        @paramtable_index.by_col('TableResRef').each_with_index {|p,idx|
-          next if @paramtables[p.downcase]
-          @paramtables[p.downcase] = @paramtables[idx] = NWN::TwoDA::Cache.get(p.downcase)
-        }
-        @properties = NWN::TwoDA::Cache.get('itemprops')
-        @propdef = NWN::TwoDA::Cache.get('itempropdef')
-        @subtypes = []
-        @propdef.by_col('SubTypeResRef').each_with_index {|st, idx|
-          @subtypes[idx] = NWN::TwoDA::Cache.get(st.downcase) if st != "****"
-        }
-        @prop_id_to_costtable = []
-        @propdef.by_col('CostTableResRef').each_with_index {|st, idx|
-          @prop_id_to_costtable[idx] = st.to_i if st != "****"
-        }
-        @prop_id_to_param1 = []
-        @propdef.by_col('Param1ResRef').each_with_index {|st, idx|
-          @prop_id_to_param1[idx] = st.to_i if st != "****"
-        }
-      end
-
-      def self.resolve_or_match_partial name_spec, list #:nodoc:
-        name_spec = name_spec.downcase
-
-        raise ArgumentError, "?-expand: #{list.inspect}" if name_spec == '?'
-
-        list.each {|l|
-          return l if l.downcase == name_spec
-        }
-
-        substrings = list.select {|l| l.downcase.index(name_spec) }
-        if substrings.size == 1
-          return substrings[0]
-        elsif substrings.size > 1
-          raise ArgumentError, "Cannot resolve #{name_spec}. Partial matches: #{substrings.inspect}."
-        end
-
-        raise ArgumentError, "Cannot resolve #{name_spec}."
-      end
-
-      # This creates a NWN::Gff::Struct describing the item property in question.
-      #
-      # [+name+]    The iprp name to resolve, for example <tt>Damage_Bonus_vs_Racial_Group</tt>
-      # [+subtype+] The iprp subtype, for example <tt>Elf</tt>
-      # [+value+]   The iprp value, for example <tt>2d12</tt>
-      # [+param+]  The iprp param1, for example <tt>Acid</tt>
-      # [+chance+]  The iprp appearance chance (whats this?)
-      #
-      # Depends on the 2da cache set up correctly.
-      #
-      # Note that the given arguments can be resolved with partial matches as well, as long
-      # as they are unique. (<tt>Fir -> Fire</tt>)
-      #
-      # Arguments are case-insensitive.
-      def self.item_property name, subtype = nil, value = nil, param1 = nil, chance_appear = 100
-        self._ip_cache_setup
-
-        struct = NWN::Gff::Struct.new
-
-        name = resolve_or_match_partial name, @properties.by_col('Label')
-        index = @properties.by_col('Label').index(name)
-        raise ArgumentError, "Cannot find property #{name}" unless index
-
-        raise ArgumentError, "Property #{name} needs subtype of type #{NWN::TwoDA::Cache.get('itempropdef').by_col('SubTypeResRef', index)}, but none given." if
-          @subtypes[index] && !subtype
-        raise ArgumentError, "Property #{name} does not need subtype, but subtype given." if
-          !@subtypes[index] && subtype
-
-        subindex = 255
-
-        if subtype
-          subtype = resolve_or_match_partial subtype, @subtypes[index].by_col('Label')
-
-          subindex = @subtypes[index].by_col('Label').index(subtype)
-          raise ArgumentError, "Cannot find subtype #{subtype} for property #{name}" unless
-            subindex
-
-          raise ArgumentError, "Property #{name} requires a cost value of type #{@costtable_index.by_row(@prop_id_to_costtable[index], 'Name')}, but none given" if
-            !value && @prop_id_to_costtable[index]
-          raise ArgumentError, "Property #{name} does not require a cost value, but value given" if
-            value && !@prop_id_to_costtable[index]
-        end
-
-        _cost = 255
-        _cost_value = 0
-
-        if value
-          ct = @prop_id_to_costtable[index]
-          value = resolve_or_match_partial value, @costtables[ct.to_i].by_col('Label')
-
-          costvalue = @costtables[ct.to_i].by_col('Label').index(value)
-          raise ArgumentError, "Cannot find CostValue for #{value}" unless costvalue
-          _cost = ct
-          _cost_value = costvalue
-        end
-        struct.merge!({
-          'CostTable' => Element.new('CostTable', :byte, _cost),
-          'CostValue' => Element.new('CostValue', :word, _cost_value)
-        })
-
-
-        raise ArgumentError, "Property #{name} requires a param1 value of type #{@paramtable_index.by_row(@prop_id_to_param1[index], 'TableResRef')}, but none given" if
-          !param1 && @prop_id_to_param1[index]
-        raise ArgumentError, "Property #{name} does not require a param1 value, but value given" if
-          param1 && !@prop_id_to_param1[index]
-
-        _param1 = 255
-        _param1_value = 0
-
-        if param1
-          pt = @prop_id_to_param1[index]
-          param1 = resolve_or_match_partial param1, @paramtables[pt.to_i].by_col('Label')
-
-          param1value = @paramtables[pt.to_i].by_col('Label').index(param1)
-          raise ArgumentError, "Cannot find Param1 for #{param1}" unless param1value
-          _param1 = pt
-          _param1_value = param1value
-        end
-        struct.merge!({
-          'Param1' => Element.new('Param1', :byte, _param1),
-          'Param1Value' => Element.new('Param1Value', :byte, _param1_value)
-        })
-
-        struct.merge!({
-          'PropertyName' => Element.new('PropertyName', :word, index),
-          'Subtype' => Element.new('Subtype', :word, subindex),
-          'ChanceAppear' => Element.new('ChanceAppear', :byte, chance_appear)
-        })
-
-        struct.struct_id = 0
-        struct
-      end
-
-    end
-  end
-end