geotree 1.1.4 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e27ac7237a87748973d68e8e8ab42fa3fd3de713
-  data.tar.gz: 2d3c2f8fe96472d903d0779b2f998af147c92b3e
+  metadata.gz: 85af00a89ad99ed45458d35e01dccd40130f1425
+  data.tar.gz: f09de405c3d93b22b4ad09433a145ca5f55178fc
 SHA512:
-  metadata.gz: bd5d7194460709171d65219dbdf19686d24d2b8cf768c3aa5ac5fc4a010157654b4ad3cc44dea7c250ff578cab3b6484a40da57d9f7784740ef998599453ec1a
-  data.tar.gz: 26cc87072057131efa87568e1990a8fd8aa8f2fed43b4f3424bfed117a81eb69d3b0958c7894d03b7a9bee130a0e2d826b35d4d2aeaba8e9466f6f2d8b5556ae
+  metadata.gz: d4391cce4097615644b4fa91925528e571ce5f0820aaefba2c7724f6d99d080fc0d400aa1e7f2f5775402a85944d206f1dae7cb1a772c2cdc1338c5e00031372
+  data.tar.gz: cdfff7ccafcb22a97141ae2b19addb6f3031e38d0e1f8ff110adce39c8337b3a302a1fdce2345f850b8bd9188d2afc74fe72e16a6bb8a0f5ae00cd00a1191557

data/CHANGELOG.txt

@@ -15,3 +15,5 @@
   * Placed on github
   * Moved some documentation out of class headers and into README file
 
+2013-04-15
+  * No longer updating CHANGELOG.txt; consult git commit summaries instead.

data/lib/geotree/tools.rb

@@ -1,13 +1,23 @@
 require 'set'
 require 'fileutils'
 
+###############################################################
+#
 # Various utility and debug convenience functions.
 #
+###############################################################
+
+# Exception class for objects in illegal states
+#
+class IllegalStateException < Exception
+end
 
 # A string containing a single zero, with ASCII 8-bit encoding (i.e., plain old bytes)
 ZERO_CHAR = "\0".force_encoding("ASCII-8BIT")
 
-
+# Construct a string of zeros
+# @param count number of zeros
+#
 def zero_bytes(count)
   ZERO_CHAR * count
 end
@@ -28,20 +38,16 @@ def req(fileListStr,subdir = nil)
 end
 
 # Shorthand for printf(...)
-# @param args passed to printf
-def pr(*args)
-  printf(*args)
-end
-
+#
+alias :pr :printf
 
 # Convert an object to a human-readable string,
-# or <nil>
+# or <nil>; should be considered a debug-only feature
 # 
 def d(arg)
   arg.nil? ? "<nil>" : arg.inspect
 end
 
-
 # Convert an object to a human-readable string,
 # by calling a type-appropriate function: da, dh, or just d.
 # @param arg object
@@ -120,8 +126,6 @@ def df(flag, label=nil)
   s
 end
 
-
-
 # Assert that a value is true.  Should be considered a 
 # very temporary, debug-only option; it is slow and
 # generates a warning that it is being called.
@@ -134,6 +138,9 @@ def assert!(cond, *msg)
     raise Exception, str
   end
 end
+
+# Abort with message about unimplemented code
+#
 def unimp!(msg = nil)
   msg2 = "Unimplemented code"
   if msg
@@ -142,7 +149,27 @@ def unimp!(msg = nil)
   raise Exception, msg2
 end
 
-
+# Extensions to the Enumerable module
+#
+module Enumerable
+  # Calculate a value for each item, and return the item with the
+  # highest value, its index, and the value.
+  # @yieldparam function to calculate value of an object, given that object as a parameter
+  # @return the triple [object, index, value] reflecting the maximum value, or
+  #   nil if there were no items
+  def max_with_index 
+    
+    best = nil
+    
+    each_with_index do |obj,ind|
+      sc = yield(obj)
+      if !best || best[2] < sc
+        best = [obj,ind,sc]
+      end
+    end
+    best
+  end
+end
 
 # Get a nice, concise description of the file and line
 # of some caller within the stack.
@@ -211,6 +238,19 @@ def warn(*args)
   one_time_alert("warning",0, *args)
 end
 
+# Convenience method for setting 'db' true within methods,
+# and to print a one-time warning if so.
+# @param val value to set db to; it is convenient to disable
+#    debug printing quickly by adding a zero, e.g., 'warndb 0'
+#
+def warndb(val = true)
+  if !val || val == 0
+    return false
+  end
+  one_time_alert("warning",1,"Debug printing enabled")
+  true
+end
+
 # Print an 'unimplemented' alert, one time only 
 # @param args if present, calls printf() with these
 def unimp(*args)
@@ -242,22 +282,30 @@ def block
   yield
 end
 
-# Exception class for objects in illegal states
+# Construct hex representation of value
+# @param value integer value
+# @param num_digits number of hex digits
 #
-class IllegalStateException < Exception
-end
-
-
 def to_hex(value, num_digits=4) 
   s = sprintf("%x", value)
   s.rjust(num_digits,'0')
 end
 
+# Hex dump a string or byte array
+# @param byte_array_or_string
+# @param title
+# @param offset offset to first value within array
+# @param length number of values to dump
+# @param bytes_per_row 
+# @param with_text if true, displays ASCII values to right of hex dump
+#
 def hex_dump(byte_array_or_string, title=nil, offset=0, length= -1, bytes_per_row=16, with_text=true) 
   ss = hex_dump_to_string(byte_array_or_string, title, offset, length, bytes_per_row, with_text)
   puts ss
 end
 
+# Hex dump a string or byte array to a string; see hex_dump for parameter descriptions
+#
 def hex_dump_to_string(byte_array_or_string, title=nil, offset=0, length= -1, bytes_per_row=16, with_text=true)
   
   byte_array = byte_array_or_string
@@ -300,10 +348,8 @@ def hex_dump_to_string(byte_array_or_string, title=nil, offset=0, length= -1, by
       else
         ss << '   '
       end
-  
     end
         
-        
     if with_text 
       ss << '  |'
       bytes_per_row.times do |i|
@@ -327,6 +373,7 @@ $prevTime = nil
 
 # Calculate time elapsed, in seconds, from last call to this function;
 # if it's never been called, returns zero
+#
 def elapsed 
   curr = Time.now.to_f
   elap = 0
@@ -337,74 +384,9 @@ def elapsed
   elap
 end
 
-# Construct a string from an array of bytes 
-# @param byte_array array of bytes, or string (in which case it
-#   returns it unchanged)
-#
-def bytes_to_str(byte_array)
-  return byte_array if byte_array.is_a? String
-  
-  byte_array.pack('C*')
-end
-
-# Construct an array of bytes from a string  
-# @param str string, or array of bytes (in which case it
-#   returns it unchanged)
-#
-def str_to_bytes(str)
-  return str if str.is_a? Array
-  str.bytes
-end
-
-# Get directory entries, excluding '.' and '..'
-#
-def dir_entries(path)
-  ents = Dir.entries(path)
-  ents.reject!{|entry| entry == '.' || entry == '..'}
-end
-
-# Convenience method for setting 'db' true within methods,
-# and to print a one-time warning if so.
-# @param val value to set db to; it is convenient to disable
-#    debug printing quickly by adding a zero, e.g., 'warndb 0'
-#
-def warndb(val = true)
-  if !val || val == 0
-    return false
-  end
-  one_time_alert("warning",1, "Debug printing enabled")
-  true
-end
-
-
-def int_to_bytes(x)
-  [(x >> 24) & 0xff, (x >> 16) & 0xff, (x >> 8) & 0xff, x & 0xff]
-end
-  
-def short_to_bytes(x) 
-  [(x >> 8) & 0xff, x & 0xff]
-end
- 
-# Decode a short from an array of bytes (big-endian).
-# @param ba array of bytes
-# @param offset offset of first (most significant) byte
-#
-def short_from_bytes(ba, offset=0) 
-  (ba[offset] << 8) | ba[offset + 1] 
-end
-    
-# Decode an int from an array of bytes (big-endian).
-# @param ba array of bytes
-# @param offset offset of first (most significant) byte
-#
-def int_from_bytes(ba, offset=0) 
-  (((((ba[offset] << 8) | ba[offset + 1]) << 8) | \
-      ba[offset + 2]) << 8) | ba[offset + 3]
-end
-
-
 # Delete a file or directory, if it exists.
 # Caution!  If directory, deletes all files and subdirectories.
+#
 def remove_file_or_dir(pth)
   if File.directory?(pth)
     FileUtils.remove_dir(pth)
@@ -413,46 +395,101 @@ def remove_file_or_dir(pth)
   end
 end  
 
-# Transform string to 8-bit ASCII (i.e., just treat each byte as-is)
+require 'stringio'
+
+$IODest = nil
+$OldStdOut = nil
+
+# Redirect standard output to an internal string
 #
-def to_ascii8(str)
-  str.force_encoding("ASCII-8BIT")
+def capture_begin
+    raise IllegalStateException if $IODest
+    $IODest = StringIO.new
+    $OldStdOut, $stdout = $stdout, $IODest
 end
 
-# Verify that a string is encoded as ASCII-8BIT
-def simple_str(s)
-  if s.encoding.name != 'ASCII-8BIT' && s.encoding.name != 'UTF-8'
-    pr("string [%s]\n encoding is %s,\n expected ASCII-8BIT\n",s,s.encoding.name)
-    assert!(false)
-  end
+# Restore standard output; return captured text
+# @return text that was redirected
+#
+def capture_end
+  raise IllegalStateException if !$IODest
+  $stdout = $OldStdOut  
+  ret = $IODest.string
+  $IODest = nil
+  ret
 end
 
-# Truncate or pad string so it has a particular size
+# Compare a string with disk file; abort if different.  Disk filename is derived
+# from caller function name; e.g., test_xxx produces filename _output_xxx
 #
-# @param s input string
-# @param size 
-# @param pad padding character to use if string needs to grow
-# @return modified string
+# @param str if not nil, string to compare; if nil, calls capture_end to get string
 #
-def str_sized(s, size, pad="\0")
-  s[0...size].ljust(size,pad)
-end
+def match_expected_output(str = nil)
 
-# Determine if running on the Windows operating system.
-# Note: there is some debate about the best way to do this.
-#
-def windows?
-  if !defined? $__windows__
-    $__windows__ = (RUBY_PLATFORM =~ /mswin/)
+  if !str
+    str = capture_end
   end
-  $__windows__
-end
 
+  cl_method = caller[0][/`.*'/][1..-2]
+  if (cl_method.start_with?("test_"))
+    cl_method = cl_method[5..-1]
+  end
+  path = "_output_" + cl_method + ".txt"
+
+  if !File.file?(path)
+    printf("no such file #{path} exists, writing it...\n")
+    write_text_file(path,str)
+  else
+    exp_cont = read_text_file(path)
+    if str != exp_cont
+      d1 = str
+      d2 = exp_cont
+
+      # Find location where they differ
+      lines1 = d1.split("\n")
+      lines2 = d2.split("\n")
+      j = [lines1.size, lines2.size].max
+
+      s = "???"
+      found_diff = false
+      hist = []
+
+      found_count = 0
+      j.times do |i|
+        found_diff ||= (i >= lines1.size || i >= lines2.size || lines1[i] != lines2[i])
+        s = sprintf("%3d:",i)
+        if !found_diff
+          hist << "#{s}  #{lines1[i]}\n      #{lines2[i]}\n"
+        else
+          if found_count < 3
+            if i < lines1.size
+              s << "  #{lines1[i]}\n"
+            else
+              s << "  ---END---\n"
+            end
+            if i < lines2.size
+              s << "      #{lines2[i]}\n"
+            else
+              s << "      ---END---\n"
+            end
+            hist << s
+          end
+          found_count += 1
+        end
+        while hist.size > 6
+          hist.shift
+        end
+      end
+      dash = "-" * 95 + "\n"
+      raise IllegalStateException,"output did not match expected:\n#{dash}#{hist.join('')}#{dash}"
+    end
+  end
+end
 
 # Convenience method to detect if a script is being run
 # e.g. as a 'main' method (for debug purposes only).
 # If so, it changes the current directory to the 
-# directory containing the script.
+# directory containing the script (if such a directory exists).
 #
 # @param file pass __FILE__ in here
 # @return true if so
@@ -469,7 +506,10 @@ def main?(file)
   end
 
   if (ret = (file == scr))
-    Dir.chdir(File.dirname(file))
+    dr = File.dirname(file)
+    if File.directory?(dr)
+      Dir.chdir(dr)
+    end
   end
   ret
 end
@@ -577,6 +617,92 @@ if defined? Test::Unit
   end
 end
 
+# Construct a string from an array of bytes 
+# @param byte_array array of bytes, or string (in which case it
+#   returns it unchanged)
+#
+def bytes_to_str(byte_array)
+  return byte_array if byte_array.is_a? String
+  
+  byte_array.pack('C*')
+end
+
+# Construct an array of bytes from a string  
+# @param str string, or array of bytes (in which case it
+#   returns it unchanged)
+#
+def str_to_bytes(str)
+  return str if str.is_a? Array
+  str.bytes
+end
+
+# Get directory entries, excluding '.' and '..'
+#
+def dir_entries(path)
+  ents = Dir.entries(path)
+  ents.reject!{|entry| entry == '.' || entry == '..'}
+end
+
+def int_to_bytes(x)
+  [(x >> 24) & 0xff, (x >> 16) & 0xff, (x >> 8) & 0xff, x & 0xff]
+end
+  
+def short_to_bytes(x) 
+  [(x >> 8) & 0xff, x & 0xff]
+end
+ 
+# Decode a short from an array of bytes (big-endian).
+# @param ba array of bytes
+# @param offset offset of first (most significant) byte
+#
+def short_from_bytes(ba, offset=0) 
+  (ba[offset] << 8) | ba[offset + 1] 
+end
+    
+# Decode an int from an array of bytes (big-endian).
+# @param ba array of bytes
+# @param offset offset of first (most significant) byte
+#
+def int_from_bytes(ba, offset=0) 
+  (((((ba[offset] << 8) | ba[offset + 1]) << 8) | \
+      ba[offset + 2]) << 8) | ba[offset + 3]
+end
+
+# Transform string to 8-bit ASCII (i.e., just treat each byte as-is)
+#
+def to_ascii8(str)
+  str.force_encoding("ASCII-8BIT")
+end
+
+# Verify that a string is encoded as ASCII-8BIT
+def simple_str(s)
+  if s.encoding.name != 'ASCII-8BIT' && s.encoding.name != 'UTF-8'
+    pr("string [%s]\n encoding is %s,\n expected ASCII-8BIT\n",s,s.encoding.name)
+    assert!(false)
+  end
+end
+
+# Truncate or pad string so it has a particular size
+#
+# @param s input string
+# @param size 
+# @param pad padding character to use if string needs to grow
+# @return modified string
+#
+def str_sized(s, size, pad="\0")
+  s[0...size].ljust(size,pad)
+end
+
+# Determine if running on the Windows operating system.
+# Note: there is some debate about the best way to do this.
+#
+def windows?
+  if !defined? $__windows__
+    $__windows__ = (RUBY_PLATFORM =~ /mswin/)
+  end
+  $__windows__
+end
+
 # Mark all constants ending with '_' as private constants
 #
 # @param entity the class to examine
@@ -624,4 +750,3 @@ def privatize(entity, add_non_suffix_versions = false)
      eval(cmd2)
   end
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geotree
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.1.5
 platform: ruby
 authors:
 - Jeff Sember
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-09 00:00:00.000000000 Z
+date: 2013-04-15 00:00:00.000000000 Z
 dependencies: []
 description: "  \nA GeoTree  is a variant of a k-d tree, and stores data points that
   have a latitude and longitude, \na unique integer identifier, and an optional 'weight'