geohex 1.0.0

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2009-11-19
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,6 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/geohex.rb
+spec/geohex_spec.rb

data/README.txt

@@ -0,0 +1,69 @@
+= geohex
+
+* http://geohex.rubyforge.org/
+
+## GEOHEX DESCRIPTION
+GeoHex Gem for Ruby (c) 2009 Haruyuki Seki
+http://twitter.com/hal_sk_e  (en)
+http://twitter.com/hal_sk  (ja)
+
+  * The GeoHex is a latitude/longitude encoding system invented by sa2da.
+  * GeoHex divides geometry regions into hexagonal grid and set an unique identifier to each grid. It supports only Japan region so far. 
+  * The coding idea is opened under the Creative Commons Attribution 2.1 Japan Lisence. 
+  * GeoHex Documentation: http://github.com/geohex/geohex-docs
+  * GeoHex Original Wiki(Japanese): http://geogames.net/labs/geohex
+  * GeoHex Demo: http://geogames.net/hex/
+  * Various GeoHex Libraries: http://github.com/geohex/
+  
+## GEOHEX GEM DESCRIPTION
+   
+  This GeoHex Ruby gem can convert latitude/longitude to GeoHex code each others.
+  * Encode from latitude/longitude to GeoHex code to an arbitrary level of precision
+  * Decode from GeoHex code to latitude/longitude and level of precision
+
+## INSTALL
+
+   sudo gem install geohex
+
+## QUICK START
+
+   require 'geohex'
+   GeoHex.encode(35.647401,139.716911,1)
+   => '132KpuG' 
+   GeoHex.decode('0dMV')
+   => [24.338279000000004,124.1577708779443,7]
+
+## FEATURES
+
+   require 'geohex'
+   geohex = GeoHex.new(35.647401,139.716911,1)
+   geohex.code
+   => '132KpuG' 
+   geohex = GeoHex.decode('0dMV')
+   geohex.lat
+   => 24.338279000000004
+
+## LICENSE
+
+(The MIT License)
+
+Copyright (c) 2008 David Troy, Roundhouse Technologies LLC
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,12 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.spec 'geohex' do
+  developer('hal_sk', 'hal.marsellus@gmail.com')
+
+  # self.rubyforge_name = 'geohexx' # if different than 'geohex'
+end
+
+# vim: syntax=ruby

data/lib/geohex.rb

@@ -0,0 +1,142 @@
+#
+# ported from perl libraries http://svn.coderepos.org/share/lang/perl/Geo-Hex/trunk/lib/Geo/Hex.pm
+# author Haruyuki Seki 
+#
+class GeoHex
+  VERSION = '1.0.0'
+
+  H_KEY       = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWX'
+
+  MIN_X_LON   = 122930.0 #与那国島
+  MIN_X_LAT   = 24448.0
+  MIN_Y_LON   = 141470.0 ##南硫黄島
+  MIN_Y_LAT   = 24228.0
+  H_GRID      = 1000
+  H_SIZE      = 0.5
+  
+  attr_accessor :code, :lat, :lon, :level
+
+  def initialize(*params)
+    if params.first.is_a?(Float)
+      @lat,@lon = params[0],params[1]
+      @level= params[2]||7 
+      @code = GeoHex.encode(@lat,@lon,@level)
+    else
+      @code = params.first
+      @lat,@lon,@level=GeoHex.decode(@code)
+    end
+    #@center_lat = 
+  end
+
+  # latlon to geohex
+  def self.encode(lat,lon,level=7)
+    raise ArgumentError, "latitude must be between -90 and 90" if (lat < -90 || lat > 90)
+    raise ArgumentError, "longitude must be between -180 and 180" if (lon < -180 || lon > 180)
+    raise ArgumentError, "level must be between 1 and 60" if (level < 1 || level > 60)
+    
+    lon_grid = lon * H_GRID
+    lat_grid = lat * H_GRID
+    unit_x   = 6.0  * level * H_SIZE
+    unit_y   = 2.8  * level * H_SIZE
+    h_k      = (( (1.4 / 3) * H_GRID).round.to_f / H_GRID)
+
+    base_x   = ( (MIN_X_LON + MIN_X_LAT / h_k      ) / unit_x).floor.to_f
+    base_y   = ( (MIN_Y_LAT - h_k      * MIN_Y_LON) / unit_y).floor.to_f
+    h_pos_x  = ( lon_grid + lat_grid / h_k     ) / unit_x - base_x
+    h_pos_y  = ( lat_grid - h_k      * lon_grid) / unit_y - base_y
+    h_x_0    = h_pos_x.floor
+    h_y_0    = h_pos_y.floor
+    h_x_q    = ((h_pos_x - h_x_0) * 100).floor.to_f / 100
+    h_y_q    = ((h_pos_y - h_y_0) * 100).floor.to_f / 100
+    h_x      = h_pos_x.round
+    h_y      = h_pos_y.round
+
+      
+    if ( h_y_q > -h_x_q + 1 ) 
+      
+      if ( h_y_q < (2 * h_x_q ) and  h_y_q > (0.5 * h_x_q ) )
+        h_x = h_x_0 + 1
+        h_y = h_y_0 + 1
+      end
+    elsif ( h_y_q < -h_x_q + 1 ) 
+      if( (h_y_q > (2 * h_x_q ) - 1 ) && ( h_y_q < ( 0.5 * h_x_q ) + 0.5 ) ) 
+        h_x = h_x_0
+        h_y = h_y_0
+      end
+    end
+    return self.__hyhx2geohex( h_y, h_x, level )
+  end
+  
+  # geohex to latlon
+  def self.decode(code)
+    h_y, h_x, level, unit_x, unit_y, h_k, base_x, base_y = self.__geohex2hyhx( code )
+    
+    h_lat = ( h_k   * ( h_x + base_x ) * unit_x + ( h_y + base_y ) * unit_y ) / 2
+    h_lon = ( h_lat - ( h_y + base_y ) * unit_y ) / h_k
+    lat      = h_lat / H_GRID
+    lon      = h_lon / H_GRID
+
+    return  lat, lon, level 
+  end
+
+
+
+  private
+  def self.__hyhx2geohex(h_y,h_x,level) 
+    h_x = h_x.to_f
+    h_y = h_y.to_f
+    h_x_100 = ( h_x / 3600).floor
+    h_x_10  = ((h_x % 3600) / 60).floor
+    h_x_1   = ((h_x % 3600) % 60).floor
+    h_y_100 = ( h_y / 3600).floor
+    h_y_10  = ((h_y % 3600) / 60).floor
+    h_y_1   = ((h_y % 3600) % 60).floor
+    
+    code = nil
+
+    if ( level < 7 ) 
+      code = H_KEY[ level % 60 ,1] + H_KEY[ h_x_100 ,1] + H_KEY[ h_y_100,1 ] +
+        H_KEY[ h_x_10,1 ] + H_KEY[ h_y_10,1 ] + H_KEY[ h_x_1,1 ] + H_KEY[ h_y_1,1 ]
+    elsif ( level == 7 ) 
+      code = H_KEY[ h_x_10,1 ] + H_KEY[ h_y_10,1 ] + H_KEY[ h_x_1,1 ] + H_KEY[ h_y_1,1 ]
+    else 
+      code = H_KEY[ level % 60, 1 ] + H_KEY[ h_x_10,1 ] + H_KEY[ h_y_10,1 ] + H_KEY[ h_x_1,1 ] + H_KEY[ h_y_1,1 ]
+    end
+    return code
+  end
+
+  def self.__geohex2hyhx (hexcode)
+
+    level, c_length, code = __geohex2level( hexcode ) 
+
+    unit_x = 6.0 * level * H_SIZE
+    unit_y = 2.8 * level * H_SIZE
+    h_k    = ( ( ( 1.4 / 3 ) * H_GRID ).round.to_f ) / H_GRID
+    base_x = ( ( MIN_X_LON + MIN_X_LAT / h_k ) / unit_x ).floor.to_f
+    base_y = ( ( MIN_Y_LAT - h_k * MIN_Y_LON ) / unit_y ).floor.to_f
+
+    if ( c_length > 5 ) 
+      h_x = H_KEY.index(code[0]) * 3600 + H_KEY.index(code[2]) * 60 + H_KEY.index(code[4])
+      h_y = H_KEY.index(code[1]) * 3600 + H_KEY.index(code[3]) * 60 + H_KEY.index(code[5])
+    else 
+      h_x = H_KEY.index(code[0]) * 60   + H_KEY.index(code[2])
+      h_y = H_KEY.index(code[1]) * 60   + H_KEY.index(code[3])
+    end
+    
+    return h_y, h_x, level, unit_x, unit_y, h_k, base_x, base_y 
+  end
+
+  def self.__geohex2level(hexcode)
+    code     = hexcode.split(//)
+    c_length = code.size
+
+    if ( c_length > 4 ) 
+        level = H_KEY.index( code.shift )
+        raise 'Code format is something wrong' if ( level == -1 )
+        level = 60 if ( level == 0 )
+    else
+        level = 7
+    end
+    return level, c_length, code 
+  end
+end

data/spec/geohex_spec.rb

@@ -0,0 +1,65 @@
+require "#{File.dirname(__FILE__)}/../lib/geohex.rb"
+
+describe GeoHex do
+  before(:all) do
+    @correct_ll2hex = eval('{' + File.open("#{File.dirname(__FILE__)}/testdata_ll2hex.txt").read + '}')
+    @correct_hex2ll = eval('{' + File.open("#{File.dirname(__FILE__)}/testdata_hex2ll.txt").read + '}')
+  end  
+  
+  it "should throw error if parameters is not valid" do
+    lambda { GeoHex.encode() }.should raise_error(ArgumentError) # no parameters
+    lambda { GeoHex.encode(-91,100,1) }.should raise_error(ArgumentError) # invalid latitude
+    lambda { GeoHex.encode(91,100,1) }.should raise_error(ArgumentError) # invalid latitude
+    lambda { GeoHex.encode(90,181,1) }.should raise_error(ArgumentError) # invalid longitude
+    lambda { GeoHex.encode(-90,-181,1) }.should raise_error(ArgumentError) # invalid longitude
+    lambda { GeoHex.encode(0,180,0) }.should raise_error(ArgumentError) # invalid level
+    lambda { GeoHex.encode(0,-180,61) }.should raise_error(ArgumentError) # invalid level
+  end
+  it "should convert coordinates to geohex code" do
+    # simple test
+    GeoHex.encode(35.647401,139.716911,1).should == '132KpuG' 
+    GeoHex.encode(24.340565,124.156201,42).should == 'G028k'
+
+    # correct answers (you can obtain this test variables from jsver_test.html )
+    @correct_ll2hex.each_pair do |k,v|
+      GeoHex.encode(v[0],v[1],v[2]).should == k
+    end
+    
+  end
+  it "should convert geohex to coordinates " do
+    # simple test
+    GeoHex.decode('132KpuG').should == [35.6478085,139.7173629550321,1]
+    GeoHex.decode('70dMV').should ==  [24.338279000000004,124.1577708779443,7]
+    GeoHex.decode('0dMV').should ==  [24.338279000000004,124.1577708779443,7]
+
+    # correct answers (you can obtain this test variables from jsver_test.html )
+    @correct_hex2ll.each_pair do |k,v|
+      GeoHex.decode(k).should == v
+    end
+    
+  end
+
+  it "should return instance from coordinates " do
+    GeoHex.new(35.647401,139.716911,1).code.should == '132KpuG'
+    GeoHex.new(35.647401,139.716911,60).code.should == '032Lq'
+  end
+
+  it "should raise error if instancing with nil data " do
+    lambda { GeoHex.new }.should raise_error(ArgumentError)
+  end
+  it "should return instance from hexcode " do
+    geohex = GeoHex.new('132KpuG')
+    geohex.lat.should == 35.6478085
+    geohex.lon.should == 139.7173629550321
+    geohex.level.should == 1
+
+    geohex = GeoHex.new('0016C')
+    geohex.lat.should == 24.305370000000003
+    geohex.lon.should == 124.17423982869379
+    geohex.level.should == 60
+
+  end
+end
+
+
+

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: geohex
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- hal_sk
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-20 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.3
+    version: 
+description: |-
+  This GeoHex Ruby gem can convert latitude/longitude to GeoHex code each others.
+    * Encode from latitude/longitude to GeoHex code to an arbitrary level of precision
+    * Decode from GeoHex code to latitude/longitude and level of precision
+email: 
+- hal.marsellus@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/geohex.rb
+- spec/geohex_spec.rb
+has_rdoc: true
+homepage: http://geohex.rubyforge.org/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: geohex
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: This GeoHex Ruby gem can convert latitude/longitude to GeoHex code each others
+test_files: []
+