nwn-lib 0.3.3 → 0.3.4

data/CHANGELOG

@@ -75,3 +75,12 @@ Bernhard Stoeckner <elven@swordcoast.net> (8):
       nwn-gff-import: add support for multiple files
       0.3.3-rel
 
+=== 0.3.4
+Bernhard Stoeckner <elven@swordcoast.net> (7):
+      nwn-gff-print: -y outputs sorted hash maps
+      nwn-gff-print: fix --verbose switch
+      type :cexolocstr: do not lose empty lang ids
+      README: add encoding warning
+      struct to yaml: inline small structs
+      CHEATSHEET: add some hints for nwn-gff-import
+      0.3.4-rel

data/CHEATSHEET

@@ -2,6 +2,31 @@
 
  nwn-gff-print --type UTI -k -t creature.bic 'ItemList[12]' | gffencode.pl -o item.uti
 
+==== Convert all item files in the current directory to yaml
+
+ nwn-gff-print -v -y --postfix .yml *.uti
+
+==== Convert all yaml item files back to their gff counterpart
+
+ nwn-gff-import -y --postfix .yml *.uti.yml
+
+==== Makefile rules for building resources from yml files
+
+ postfix := uti
+
+ objects := $(basename $(wildcard *.$(postfix).yml))
+
+ all: $(objects)
+
+ $(objects) : %.$(postfix) : %.$(postfix).yml
+     nwn-gff-import -y -o $@ $<
+
+ clean:
+     -@rm $(objects)
+
+This ruleset will automatically rebuild changed ymls to their respective .uti counterparts.
+This only serves as an example on how to do it; it does not constitute a complete build environment.
+
 ==== Quick-edit a item
  
  your/prompt$ nwn-gff-irb my_item.uti

data/README

@@ -8,6 +8,11 @@ There are various things included in this distribution:
 * some binaries under bin/ (see BINARIES)
 * the actual library under lib/nwn
 
+== Attention Unicode/UTF-users
+
+ruby 1.8 does not support character sets natively, and as such nwn-gff-irb will <b>FAIL</b> to encode non-standard characters properly on non-latin1 shells.
+This will be worked around in a future release until the release of ruby 1.9, which will provide native charset support.
+
 == Quickstart
 
 It is easiest to just use the gem, which is available through rubyforge (<tt>sudo gem install nwn-lib</tt>).

data/Rakefile

@@ -9,7 +9,7 @@ include FileUtils
 # Configuration
 ##############################################################################
 NAME = "nwn-lib"
-VERS = "0.3.3"
+VERS = "0.3.4"
 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/bin/nwn-gff-print

@@ -4,6 +4,7 @@ require 'optparse'
 require 'nwn/gff'
 require 'nwn/helpers'
 require 'yaml'
+require 'nwn/yaml'
 
 format = nil
 types_too = false
@@ -65,7 +66,7 @@ OptionParser.new do |o|
     path = p
   end
 
-  o.on "-v" "--verbose", "Be verbose" do
+  o.on "-v", "--verbose", "Be verbose" do
     verbose = true
   end
 end.parse!

data/lib/nwn/gff.rb

@@ -404,6 +404,22 @@ class NWN::Gff::Struct
     [ '@struct_id', '@hash' ]
   end
 
+  def to_yaml( opts = {} )
+    YAML::quick_emit( nil, opts ) do |out|
+      out.map( taguri, to_yaml_style ) do |map|
+        # Inline certain structs that are small enough.
+        map.style = :inline if hash.size <= 1 &&
+          hash.values.select {|x|
+            NWN::Gff::Element::NonInline.index(x.type)
+          }.size == 0
+
+        to_yaml_properties.sort.each do |m|
+          map.add( m[1..-1], instance_variable_get( m ) ) # unless instance_variable_get( m ).nil?
+        end
+      end
+    end
+  end
+
   def initialize
     @struct_id = 0
     @hash = {}
@@ -469,14 +485,18 @@ class NWN::Gff::CExoLocString
   end
 
   def size
-    @languages.reject {|k,v| v == ""}.size
+    @languages.size
   end
 
   def each
-    @languages.reject {|k,v| v == ""}.each {|k,v|
+    @languages.each {|k,v|
       yield k, v
     }
   end
+
+  def compact
+    @languages.compact.reject {|k,v| "" == v}
+  end
 end
 
 # A class that parses binary GFF bytes into ruby-friendly data structures.

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: nwn-lib
 version: !ruby/object:Gem::Version 
-  version: 0.3.3
-date: 2008-08-07 00:00:00 +02:00
+  version: 0.3.4
+date: 2008-08-08 00:00:00 +02:00
 summary: a ruby library for accessing Neverwinter Nights resource files
 require_paths: 
 - lib