geohash_ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c296b6b794f2ebd0d80215369312c35348695c76
+  data.tar.gz: 52883d58d3830f0f6d5f56166c03b26770337625
+SHA512:
+  metadata.gz: 5ec20fd3cc83f39101238d476b43929d718cd3b0bf1563258131e21d35c7a531b59b1400f681ca44af673f650485840aea6446d60d08fd113151ca10d1bc600f
+  data.tar.gz: 239410dc6459bd9439471b89b85394efcc98e0df32b69c66609a7ea4380e102513a36de5b840d44d502e377afb6b2c27c4994c288807a7bd06ac475bb0146516

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Yuki Iwanaga
+
+MIT License
+
+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/README.md

@@ -0,0 +1,80 @@
+GeoHash
+=======
+
+GeoHash en/decode library written in ruby.
+
+Based on [masuidrive/pr_geohash](https://github.com/masuidrive/pr_geohash), which isn't good implementation.
+
+
+Install
+-------
+
+```ruby
+gem 'geohash_ruby'
+```
+
+
+Usage
+-----
+
+### Encode latitude and longitude into geohash
+
+```ruby
+GeoHash.encode 47.6062095, -122.3320708
+#=> "c23nb62w20st"
+
+GeoHash.encode 47.6062095, -122.3320708, 6
+#=> "c23nb6"
+```
+
+### Decode from geohash
+
+```ruby
+GeoHash.decode 'c23nb6'
+#=> [[47.603759765625, -122.332763671875], [47.6092529296875, -122.32177734375]]
+```
+
+### Adjacents
+
+```ruby
+GeoHash.adjacent 'c23nb6', :top
+#=> "c23nb7"
+```
+
+### Neighbors
+
+```ruby
+GeoHash.neighbors 'xn774c'
+#=> ["xn774f", "xn7754", "xn7751", "xn7750", "xn774b", "xn7748", "xn7749", "xn774d"]
+
+=begin
++--------+--------+--------+
+| xn774d | xn774f | xn7754 |
++--------+--------+--------+
+| xn7749 | xn774c | xn7751 |
++--------+--------+--------+
+| xn7748 | xn774b | xn7750 |
++--------+--------+--------+
+=end
+```
+
+### Walk
+
+```ruby
+GeoHash.walk 'xn774c', [
+  :top,
+  :right,
+  :bottom, :bottom,
+  :left, :left,
+  :top, :top
+]
+#=> ["xn774f", "xn7754", "xn7751", "xn7750", "xn774b", "xn7748", "xn7749", "xn774d"]
+# implementation of `neighbors`
+```
+
+
+License
+-------
+
+This project is copyright by [Creasty](http://www.creasty.com), released under the MIT lisence.  
+See `LICENSE` file for details.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+

data/geohash_ruby.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'geohash'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'geohash_ruby'
+  spec.version       = GeoHash::VERSION
+  spec.authors       = ['Yuki Iwanaga']
+  spec.email         = ['yuki@creasty.com']
+  spec.summary       = 'GeoHash en/decode library written in ruby'
+  spec.description   = 'GeoHash en/decode library written in ruby'
+  spec.homepage      = 'https://github.com/creasty/geohash_ruby'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.3'
+end

data/lib/geohash.rb

@@ -0,0 +1,173 @@
+module GeoHash
+
+  VERSION = '1.0.0'
+
+  BASE32 = '0123456789bcdefghjkmnpqrstuvwxyz'
+
+  NEIGHBORS = {
+    right: {
+      even: 'bc01fg45238967deuvhjyznpkmstqrwx',
+      odd:  'p0r21436x8zb9dcf5h7kjnmqesgutwvy',
+    },
+    left: {
+      even: '238967debc01fg45kmstqrwxuvhjyznp',
+      odd:  '14365h7k9dcfesgujnmqp0r2twvyx8zb',
+    },
+    top: {
+      even: 'p0r21436x8zb9dcf5h7kjnmqesgutwvy',
+      odd:  'bc01fg45238967deuvhjyznpkmstqrwx',
+    },
+    bottom: {
+      even: '14365h7k9dcfesgujnmqp0r2twvyx8zb',
+      odd:  '238967debc01fg45kmstqrwxuvhjyznp',
+    }
+  }
+
+  BORDERS = {
+    right:  { even: 'bcfguvyz', odd: 'prxz' },
+    left:   { even: '0145hjnp', odd: '028b' },
+    top:    { even: 'prxz',     odd: 'bcfguvyz' },
+    bottom: { even: '028b',     odd: '0145hjnp' },
+  }
+
+  @@neighbors_cache = {}
+
+  @@adjacent_cache = {
+    right: {}, left: {}, top: {}, bottom: {}
+  }
+
+
+module_function
+
+  ###
+  # Decode geohash into bounding box of latitudes and longitudes
+  #
+  # @params {String} geohash - geohash code
+  #
+  # @return {[[Float]]} decoded bounding box
+  #   [
+  #     [north_latitude, west_longitude],
+  #     [south_latitude, east_longitude]
+  #   ]
+  ###
+  def decode(geohash)
+    bounds = [[-90.0, +90.0], [-180.0, +180.0]]
+
+    geohash.downcase.each_char.with_index do |c, i|
+      d = BASE32.index c
+
+      5.times do |j|
+        bit = (d & (1 << (4 - j))) >> (4 - j)
+        k = (~i & 1) ^ (j & 1)
+        bounds[k][bit ^ 1] = (bounds[k][0] + bounds[k][1]) / 2
+      end
+    end
+
+    bounds.transpose
+  end
+
+  ###
+  # Encode latitude and longitude into geohash
+  #
+  # @params {Float} latitude
+  # @params {Float} longitude
+  # @params {Integer} precision - scale from 1 to 12
+  #
+  # @return {String} geohash string
+  ###
+  def encode(latitude, longitude, precision = 12)
+    mids = [latitude, longitude]
+    bounds = [[-90.0, +90.0], [-180.0, +180.0]]
+
+    geohash = []
+
+    precision.times do |i|
+      d = 0
+
+      5.times do |j|
+        k = (~i & 1) ^ (j & 1)
+        mid = (bounds[k][0] + bounds[k][1]) / 2
+        bit = mids[k] > mid ? 1 : 0
+        bounds[k][bit ^ 1] = mid
+        d |= bit << (4 - j)
+      end
+
+      geohash << BASE32[d]
+    end
+
+    geohash.join
+  end
+
+  ###
+  # Calculate neighbors geohash
+  #
+  # @params {String} geohash
+  #
+  # @return {[String]} neighbors array
+  ###
+  def neighbors(geohash)
+    return @@neighbors_cache[geohash] if @@neighbors_cache[geohash]
+
+    # walk path:
+    #
+    # 8   1 - 2
+    # |   |   |
+    # 7   B   3
+    # |       |
+    # 6 - 5 - 4
+    #
+    @@neighbors_cache[geohash] = walk geohash, [
+      :top,
+      :right,
+      :bottom, :bottom,
+      :left, :left,
+      :top, :top
+    ]
+  end
+
+  ###
+  # Calculate adjacent geohashes
+  #
+  # @params {String} geohash
+  # @params {Symbol} dir - one of :right, :left, :top, :bottom
+  #
+  # @return {String} adjacent geohash
+  ###
+  def adjacent(geohash, dir)
+    return @@adjacent_cache[dir][geohash] if @@adjacent_cache[dir][geohash]
+
+    head, last = geohash[0..-2], geohash[-1]
+    type = [:even, :odd][geohash.length % 2]
+
+    head = adjacent(head, dir) if BORDERS[dir][type].include?(last)
+
+    # NOTICE:
+    # do not use append `<<` instead of `+`
+    # head possibly be cached so that mustn't be mutated,
+    # just create new String instance with it
+    head = head + BASE32[NEIGHBORS[dir][type].index(last)]
+
+    @@adjacent_cache[dir][geohash] = head
+  end
+
+  ###
+  # Walk down
+  #
+  # @params {String} base - base geohash to begin walk
+  # @params {[Symbol]} path - directions to walk with
+  #
+  # @return {[String]} result geohashes of the walk
+  ###
+  def walk(base, path)
+    hashes = []
+
+    h = base
+
+    path.each do |dir|
+      hashes << (h = adjacent(h, dir))
+    end
+
+    hashes
+  end
+
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: geohash_ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Yuki Iwanaga
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+description: GeoHash en/decode library written in ruby
+email:
+- yuki@creasty.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- geohash_ruby.gemspec
+- lib/geohash.rb
+homepage: https://github.com/creasty/geohash_ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: GeoHash en/decode library written in ruby
+test_files: []