geohash 1.0.0 → 1.0.1

data/History.txt

@@ -2,4 +2,9 @@
 
   * Released by David Troy (C) Under the MIT License
 
+=== 1.0.1 / 2008-06-11
+
+  * Added decode_bbox functionality for decoding a geohash into a bounding box
+  * Cleaned up test environment
+
 

data/README.txt

@@ -15,6 +15,7 @@ removing characters from the end of the code to reduce its size (and gradually l
 See these resources online:
 http://geohash.org
 http://en.wikipedia.org/wiki/Geohash
+http://openlocation.org/geohash/geohash-js (javascript implementation and demo)
 
 == FEATURES/PROBLEMS:
 
@@ -29,7 +30,6 @@ GeoHash is very easy to use (and fast) because it's written in C with Ruby bindi
 
   require 'rubygems'
   require 'geohash'
-  include GeoHash
 
   GeoHash.decode('f77')
   => [63.98438, -73.82813]
@@ -37,6 +37,10 @@ GeoHash is very easy to use (and fast) because it's written in C with Ruby bindi
   GeoHash.encode(39.51, -76.24)
   => "dr1bc0edrj"
   
+  # Decode a geohash to a bounding box
+  decode_bbox('dqcw4')
+  => [39.0234375, -76.552734375], [39.0673828125, -76.5087890625]]
+  
 You can encode or decode to an arbitrary level of precision:
 
 # Encode latitude and longitude to a geohash with precision digits

data/bin/geohash

@@ -0,0 +1 @@
+#!/usr/bin/env ruby

data/geohash_native.c

@@ -26,21 +26,22 @@
 // SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 #include "ruby.h"
+#include <ctype.h>
 
 static VALUE rb_mGeoHash;
 
 #define BASE32	"0123456789bcdefghjkmnpqrstuvwxyz"
 
-void refine_interval(double *interval, char cd, char mask) {
+static void refine_interval(double *interval, char cd, char mask) {
 	if (cd&mask)
 		interval[0] = (interval[0] + interval[1])/2;
-  else
+	else
 		interval[1] = (interval[0] + interval[1])/2;
 }
 
-float *decode_geohash(char *geohash, double *point) {
+static void decode_geohash_bbox(char *geohash, double *lat, double *lon) {
 	int i, j, hashlen, is_even=1;
-	double lat[2], lon[2], lat_err, lon_err;
+	double lat_err, lon_err;
 	char c, cd, mask;
 	char bits[] = {16,8,4,2,1};
 	
@@ -64,46 +65,51 @@ float *decode_geohash(char *geohash, double *point) {
 			is_even = !is_even;
 		}
 	}
+}
+
+static void decode_geohash(char *geohash, double *point) {
+	double lat[2], lon[2];
+
+	decode_geohash_bbox(geohash, lat, lon);
 
 	point[0] = (lat[0] + lat[1]) / 2;
 	point[1] = (lon[0] + lon[1]) / 2;
-	
-	return 0;
 }
 
-void *encode_geohash(double latitude, double longitude, int precision, char *geohash) {
+static void encode_geohash(double latitude, double longitude, int precision, char *geohash) {
 	int is_even=1, i=0;
 	double lat[2], lon[2], mid;
-	char bits[] = {16,8,4,2,1}, bit=0, ch=0;
+	char bits[] = {16,8,4,2,1};
+	int bit=0, ch=0;
 
 	lat[0] = -90.0;  lat[1] = 90.0;
 	lon[0] = -180.0; lon[1] = 180.0;
 	
 	while (i < precision) {
-	  if (is_even) {
+		if (is_even) {
 			mid = (lon[0] + lon[1]) / 2;
-	    if (longitude > mid) {
+			if (longitude > mid) {
 				ch |= bits[bit];
 				lon[0] = mid;
-	    } else
+			} else
 				lon[1] = mid;
-	  } else {
+		} else {
 			mid = (lat[0] + lat[1]) / 2;
-	    if (latitude > mid) {
+			if (latitude > mid) {
 				ch |= bits[bit];
 				lat[0] = mid;
-	    } else
+			} else
 				lat[1] = mid;
-	  }
-
+		}
+		
 		is_even = !is_even;
-	  if (bit < 4)
+		if (bit < 4)
 			bit++;
-	  else {
+		else {
 			geohash[i++] = BASE32[ch];
 			bit = 0;
 			ch = 0;
-	  }
+		}
 	}
 	geohash[i] = 0;
 }
@@ -124,27 +130,50 @@ static VALUE encode(VALUE self, VALUE lat, VALUE lon, VALUE precision)
 	encode_geohash(RFLOAT(lat)->value, RFLOAT(lon)->value, digits, str);
 
 	geohash = rb_str_new2(str);
-  return geohash;
+	return geohash;
 }
 
+static VALUE decode_bbox(VALUE self, VALUE str)
+{
+	VALUE ary, ret;
+	double lat[2], lon[2];
+	Check_Type(str, T_STRING);
+
+	decode_geohash_bbox(RSTRING(str)->ptr, lat, lon);
+
+	ret = rb_ary_new2(2); /* [[lat[0], lon[0]], [lat[1], lon[1]]] */
+
+	ary = rb_ary_new2(2); /* [lat[0], lon[0]] */
+	rb_ary_store(ary, 0, rb_float_new(lat[0]));
+	rb_ary_store(ary, 1, rb_float_new(lon[0]));
+	rb_ary_store(ret, 0, ary);
+
+	ary = rb_ary_new2(2); /* [lat[1], lon[1]] */
+	rb_ary_store(ary, 0, rb_float_new(lat[1]));
+	rb_ary_store(ary, 1, rb_float_new(lon[1]));
+	rb_ary_store(ret, 1, ary);
+
+	return ret;
+}
 
 static VALUE decode(VALUE self, VALUE str)
 {
 	VALUE ary;
 	double point[2];
-  Check_Type(str, T_STRING);
-
+	Check_Type(str, T_STRING);
+	
 	decode_geohash(RSTRING(str)->ptr, point);
-
-  ary = rb_ary_new2(2);
+	
+	ary = rb_ary_new2(2);
 	rb_ary_store(ary, 0, rb_float_new(point[0]));
 	rb_ary_store(ary, 1, rb_float_new(point[1]));
-  return ary;
+	return ary;
 }
 
 void Init_geohash_native()
 {
 	rb_mGeoHash = rb_define_module("GeoHash");
+	rb_define_method(rb_mGeoHash, "decode_bbox_base", decode_bbox, 1);
 	rb_define_method(rb_mGeoHash, "decode_base", decode, 1);
 	rb_define_method(rb_mGeoHash, "encode_base", encode, 3);
 }

data/lib/geohash.rb

@@ -9,16 +9,21 @@ end
 
 module GeoHash
   
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
   
   # Encode latitude and longitude to a geohash with precision digits
   def encode(lat, lon, precision=10)
     encode_base(lat, lon, precision)
   end
-  
+
   # Decode a geohash to a latitude and longitude with decimals digits
   def decode(geohash, decimals=5)
     lat, lon = decode_base(geohash)
     [lat.decimals(decimals), lon.decimals(decimals)]
   end
+
+  # Decode a geohash to a bounding box
+  def decode_bbox(geohash)
+    decode_bbox_base(geohash)
+  end
 end

data/test/test_geohash.rb

@@ -1,4 +1,5 @@
-require 'rubygems'
+#!/usr/bin/env ruby
+$LOAD_PATH << "#{File.dirname(__FILE__)}/.."
 require "#{File.dirname(__FILE__)}/../lib/geohash"
 require 'test/unit'
 
@@ -21,6 +22,34 @@ class GeoHashTest < Test::Unit::TestCase
     assert_equal "6gkzmg1u", encode(-25.427, -49.315, 8)
     assert_equal "ezs42", encode(42.60498046875, -5.60302734375, 5)
   end
+
+  def check_decoding(gh)
+    exact = decode(gh, 20)
+    bbox = decode_bbox(gh)
+
+    # check that the bbox is centered on the decoded point
+    bbox_center = [(bbox[0][0] + bbox[1][0]) / 2, (bbox[0][1] + bbox[1][1]) / 2]
+    assert_equal exact, bbox_center
+
+    # check that the bounding box is the expected size
+    bits = gh.size * 5
+    lon_bits = (bits.to_f/2).ceil
+    lat_bits = (bits.to_f/2).floor
+    correct_size = [180.0/2**lat_bits, 360.0/2**lon_bits]
+    bbox_size = [bbox[1][0] - bbox[0][0], bbox[1][1] - bbox[0][1]]
+    assert_equal bbox_size, correct_size
+  end
+
+  def test_decoding_bbox
+    s = "dqcw4bnrs6s7"
+    (s.length-1).downto(0) do |l|
+      check_decoding(s[0..l])
+    end
+  end
+  
+  def test_specific_bbox
+    assert_equal [[39.0234375, -76.552734375], [39.0673828125, -76.5087890625]], decode_bbox('dqcw4')
+  end
   
   # require 'benchmark'
   # def test_multiple

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: geohash
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - David Troy
@@ -30,7 +30,7 @@ cert_chain:
   K80lsu167t5ZwbXh+Day+g==
   -----END CERTIFICATE-----
 
-date: 2008-04-24 00:00:00 -04:00
+date: 2008-06-11 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,9 +40,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.5.1
+        version: 1.5.3
     version: 
-description: "GeoHash Gem for Ruby (c) 2008 David Troy dave@roundhousetech.com  Geohash is a latitude/longitude encoding system invented by Gustavo Niemeyer when writing the web service at geohash.org, and put into the public domain. Geohashes offer properties like arbitrary precision, similar prefixes for nearby positions, and the possibility of gradually removing characters from the end of the code to reduce its size (and gradually lose precision).  See these resources online: http://geohash.org http://en.wikipedia.org/wiki/Geohash"
+description: "GeoHash Gem for Ruby (c) 2008 David Troy dave@roundhousetech.com  Geohash is a latitude/longitude encoding system invented by Gustavo Niemeyer when writing the web service at geohash.org, and put into the public domain. Geohashes offer properties like arbitrary precision, similar prefixes for nearby positions, and the possibility of gradually removing characters from the end of the code to reduce its size (and gradually lose precision).  See these resources online: http://geohash.org http://en.wikipedia.org/wiki/Geohash http://openlocation.org/geohash/geohash-js (javascript implementation and demo)"
 email: 
 - dave@roundhousetech.com
 executables: