nwn-lib 0.4.4 → 0.4.5

data/CHANGELOG

@@ -147,3 +147,21 @@ Bernhard Stoeckner (7):
       bin/nwn-erf: -vt: move column type before filename
       erf: fix loctable reading breaking on more than one locstr
       0.4.4-rel
+
+=== 0.4.5
+Bernhard Stoeckner (14):
+      bin/nwn-irb: fix help scriptname
+      nwn-dsl: $SCRIPT is the currently-running script
+      TwoDA: add .get alias
+      Scripting/log: provide #progress to indicate progress within scripts
+      guess_file_name: consider non-lowercase extensions
+      nwn-gff: $SCRIPT fix
+      nwn-irb: include NWN namespace
+      Namespace clobbering: Integer provides xp_to_level, level_to_xp
+      Gff::Struct: add #to_s
+      scripting: satisfy: return object as-is when no conditions are given (fix)
+      Scripting: add support to .#save files that were loaded with satisfy/need/want
+      Scripting: ask: fix return value of hash and arrays
+      TwoDA: add disclaimer for Cache references
+      TwoDA: add Table#[], Table#[]=
+

data/Rakefile

@@ -9,7 +9,7 @@ include FileUtils
 # Configuration
 ##############################################################################
 NAME = "nwn-lib"
-VERS = "0.4.4"
+VERS = "0.4.5"
 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', \

data/SCRIPTING

@@ -34,6 +34,9 @@ way, simply call them with nwn-dsl.
 DSL stands for domain-specific-language by the way, and this is quite
 a stretch, considering your scripts will be written in plain old ruby.
 
+The currently-running script name is in $SCRIPT - you can override this
+to print a custom name in, for example, +log+.
+
 === API
 
 There are various helpers available to scripts. See NWN::Gff::Scripting

data/bin/nwn-dsl

@@ -13,10 +13,10 @@ end.parse!
 
 fail "Not enough arguments (try -h)." unless ARGV.size > 0
 
-$base_script = ARGV.shift
+$SCRIPT = ARGV.shift
 
 begin
-  NWN::Gff::Scripting.run_script(IO.read($base_script), nil, ARGV)
+  NWN::Gff::Scripting.run_script(IO.read($SCRIPT), nil, ARGV)
 rescue => e
   $stderr.puts e.message
   if $backtrace

data/bin/nwn-gff

@@ -102,7 +102,7 @@ $options[:informat] or fail "No input format specified."
 $options[:outformat] or fail "No output format specified."
 
 if :auto == $options[:informat]
-  $options[:informat] = NWN::Gff.guess_file_format($options[:infile])
+  $options[:informat] = NWN::Gff.guess_file_format($options[:infile].downcase)
   fail "Cannot guess infile format from filename, specify with -l." unless
     $options[:informat]
 end
@@ -110,7 +110,7 @@ end
 if $options[:outfile] == "-"
   $options[:outformat] = $options[:informat] if :in == $options[:outformat]
 elsif :in == $options[:outformat]
-  $options[:outformat] = NWN::Gff.guess_file_format($options[:outfile])
+  $options[:outformat] = NWN::Gff.guess_file_format($options[:outfile].downcase)
   fail "Cannot guess outfile format from filename, specify with -k." unless
     $options[:outformat]
 end
@@ -138,7 +138,7 @@ $options[:run].each {|file|
   vputs "Running script file: #{file}"
   FileTest.exists?(file) or file = file + ".rb"
   $script = File.expand_path(file)
-  $base_script = File.basename($script)
+  $SCRIPT = File.basename($script)
   include NWN
   include NWN::Gff::Scripting
   NWN::Gff::Scripting.run_script(IO.read(file), data_in)

data/bin/nwn-irb

@@ -6,7 +6,7 @@ require 'irb'
 require 'irb/completion'
 
 OptionParser.new do |o|
-  o.banner = "Usage: nwn-gff-irb [file]"
+  o.banner = "Usage: nwn-irb [file]"
 end.parse!
 
 $file = ARGV.shift
@@ -38,8 +38,7 @@ def read file
   nil
 end
 
-include NWN::Gff
-include NWN::TwoDA
+include NWN
 
 if $file
   read($file)

data/lib/nwn/gff.rb

@@ -72,7 +72,7 @@ module NWN
     }
 
     def self.guess_file_format(filename)
-      extension = File.extname(filename)[1..-1]
+      extension = File.extname(filename.downcase)[1..-1]
       FileFormatGuesses[FileFormatGuesses.keys.select {|key| extension =~ key}[0]]
     end
 

data/lib/nwn/gff/struct.rb

@@ -82,4 +82,8 @@ module NWN::Gff::Struct
 
     super
   end
+
+  def to_s
+    "<NWN::Gff::Struct #{self.data_type}/#{self.data_version}, #{self.keys.size} fields>"
+  end
 end

data/lib/nwn/scripting.rb

@@ -14,6 +14,7 @@ module NWN::Gff::Scripting
     $code = code
     $argv = arguments
     $standalone = run_on.nil?
+    $satisfy_loaded = {}
     run_on ||= Sandbox.new
 
     $script_obj_hash = run_on.hash
@@ -27,6 +28,24 @@ module NWN::Gff::Scripting
     $script_obj_hash != run_on.hash
   end
 
+  # Save the given object if it was loaded via want/need
+  def save object
+    fn, hash = $satisfy_loaded[object.object_id]
+    if fn
+      if hash != object.hash
+        File.open(fn, "w") {|f|
+          NWN::Gff.write(f, NWN::Gff.guess_file_format(fn), object)
+        }
+        log "saved #{object.to_s} -> #{fn}"
+      else
+        log "not saving #{fn}: not modified"
+      end
+    else
+      raise ArgumentError,
+        "#save: object #{object.to_s} was not loaded via want/need/satisfy, cannot save"
+    end
+  end
+
   # This script only runs for the following conditions (see #satisfy).
   def want *what
     obj = satisfy(*what)
@@ -47,7 +66,7 @@ module NWN::Gff::Scripting
     if $standalone
       log "warn: no need to stop_output on standalone scripts"
     else
-      log "#{$base_script}: not emitting any data."
+      log "#{$SCRIPT}: not emitting any data."
     end
     $stop_output = true
   end
@@ -94,12 +113,14 @@ module NWN::Gff::Scripting
           #  "object to read from (usually the first script argument)."
       end
       obj = NWN::Gff.read(io, NWN::Gff.guess_file_format(fn))
+      log "satisfied #{fn} -> #{obj.to_s}"
+      $satisfy_loaded[obj.object_id] = [fn, obj.hash]
+
+      return obj if what.size == 1
     else
       obj = self
     end
 
-    return obj if what.size == 1
-
     what.each {|w|
       case w
         when Class, Module
@@ -118,15 +139,25 @@ module NWN::Gff::Scripting
     return nil
   end
 
+  # You can call this to provide a progress indicator, if your script is long-running.
+  # the calculated percentage will be prefixed before each log message.
+  #
+  # +position+   The number of items in the work queue finished.
+  # +total_size+ The total size of the work queue, defaults to ARGV.size.
+  def progress position, total_size = nil
+    total_size ||= ARGV.size
+    $PERCENTAGE_DONE = position.to_f / total_size.to_f * 100
+  end
 
   # Log a friendly message to stderr.
   # Use this instead of puts, since SAFE levels greater than 0
   # will prevent you from doing logging yourself.
   def log *args
+    perc = $PERCENTAGE_DONE.nil? ? "" : " (%d%%)" % [ $PERCENTAGE_DONE.to_i ]
     if $options
-      $stderr.puts [$base_script, " on ", $options[:infile], ": ", *args].join("")
+      $stderr.puts [$SCRIPT, perc, " on ", $options[:infile], ": ", *args].join("")
     else
-      $stderr.puts [$base_script, ": ", *args].join("")
+      $stderr.puts [$SCRIPT, perc, ": ", *args].join("")
     end
   end
 
@@ -150,13 +181,17 @@ module NWN::Gff::Scripting
     ret = nil
     while true
       y object
-      $stderr.print File.basename($base_script) + ": " + question + " "
+      $stderr.print File.basename($SCRIPT) + ": " + question + " "
       ret = $stdin.gets
       ret = ret.rstrip
 
       break if object.nil? || case object
         when Hash
-          object.keys.index(ret) || (ret != "" && object.keys.index(ret.to_i))
+          if object.keys.index(ret) || (ret != "" && object.keys.index(ret.to_i))
+            ret = object[ret] || (ret != "" && object[ret.to_i])
+          else
+            nil
+          end
         when Regexp
           ret =~ match
         when Fixnum

data/lib/nwn/twoda.rb

@@ -1,5 +1,19 @@
 require 'shellwords'
 
+class Integer
+  def xp_to_level
+    NWN::TwoDA.get('exptable').rows.each {|row|
+      level, exp = row.Level.to_i, row.XP.to_i
+      return level - 1 if exp > self
+    }
+    return nil
+  end
+
+  def level_to_xp
+    NWN::TwoDA.get('exptable').by_col("XP", self - 1).to_i
+  end
+end
+
 module NWN
   module TwoDA
 
@@ -156,6 +170,37 @@ module NWN
         column = column_name_to_id column
         column.nil? ? @rows[row.to_i] : (@rows[row.to_i].nil? ? nil : @rows[row.to_i][column])
       end
+      alias_method :[], :by_row
+
+
+      # Set a cell or row value.
+      #
+      # [+row+]     The row to operate on (starts at 0)
+      # [+column+]  Optional column name or index.
+      # [+value+]   New value, either a full row, or a single value.
+      #
+      # Examples:
+      #  TwoDA.get('portraits')[1, "BaseResRef"] = "hi"
+      #  TwoDA.get('portraits')[1] = %w{1 2 3 4 5 6}
+      def []= row, column = nil, value = nil
+        if value.nil?
+          value = column
+          raise ArgumentError, "Expected array for setting a whole row" unless value.is_a?(Array)
+        end
+
+        if value.is_a?(Array)
+          raise ArgumentError, "Given array size does not match table columns (got: #{value.size}, want: #{self.columns.size})" unless value.size == self.columns.size
+          new_row = Row.new
+          new_row.concat(value.map {|x| x.to_s})
+
+          @rows[row] = new_row
+
+        else
+          col = column_name_to_id column
+          @rows[row][col] = value
+
+        end
+      end
 
 
       # Retrieve data by column.
@@ -237,6 +282,11 @@ module NWN
       end
     end
 
+    # An alias for TwoDA::Cache.get
+    def self.get name
+      NWN::TwoDA::Cache.get(name)
+    end
+
     # This is a simple 2da cache.
     module Cache
       @_cache = {}
@@ -250,6 +300,8 @@ module NWN
       end
 
       # Get the 2da file with the given name. +name+ is without extension.
+      # This being a cache, modifications to the returned Table will be reflected
+      # in further calls to Cache.get.
       def self.get(name)
         raise Exception,
           "You need to set up the cache first through the environment variable NWN_LIB_2DA_LOCATION." unless

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: nwn-lib
 version: !ruby/object:Gem::Version 
-  version: 0.4.4
+  version: 0.4.5
 platform: ruby
 authors: 
 - Bernhard Stoeckner
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-09 00:00:00 +01:00
+date: 2009-03-16 00:00:00 +01:00
 default_executable: 
 dependencies: []