geohex-gen 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36fb49b5596bf347fba3edc3edfcb183759bbb4a
-  data.tar.gz: 7decc79f1a4e899b4b83215dd7cfa1c85e981383
+  metadata.gz: 750137fe1a67937f1af70ac82b622081630a898a
+  data.tar.gz: 5c9218d9ae4b48795ed2e5d2433ce249e3ec3b4b
 SHA512:
-  metadata.gz: 2bc791fecc85ed41423694adc9553de8f4c929248e709d829e55a49c3d15d4aad6282bacde824931740c9df257e407eb1d2e26ccf9e9489876f56b9dcd53de21
-  data.tar.gz: 3d57642cb60b466703a6b930e0a057915d0dcb36f7da5ded0136dcfc2414af3430f511df6a285d43db8e39364c6b4d909c8b59db4a4252dbbe94e9e0aa8bef51
+  metadata.gz: caa57f82894d4aedc1dcb47a06dc6a68aeb4204e688239ab822e6a3473be72b96af2b0eb44f6c4d66d5e47d6f032354670839aef00e8f193379e2d0cb40030ea
+  data.tar.gz: b316c5aae1fed2e3fa290832810ee6298fb29a5266d7444d38bc63f680da7287adbcc5eaeb1a879027784657707e1798abb692a6a784fab21c7f53b1760561c8

data/README.md

@@ -1,31 +1,91 @@
 geohex-gen
 ==========
 
-Command line utility to create geohexes
+Geohex command line utility
+
 =======
 # Geohex::Gen
 
-Docs are WIP!  Sorry 'bout that
+## Installation
 
-TODO: Write a gem description
+    $ gem install geohex-gen
 
-## Installation
+## Usage
 
-Add this line to your application's Gemfile:
+This gem installs a command line tool named ghgen that:
+ 
+* Given lat, lon return geohex level 10 code.
+* Given a GH (any size), display center lat/lon and show GH4/5/6 that contains this location
+* Given a GH (any size) and a ring size, display geohex codes that form the ring(s). 
 
-    gem 'geohex-gen'
+    Usage: ghgen [options]
+        -a LAT                           Latitude. If used, must have longitude also
+        -o LON                           Longitude. If used, must have latitude also
+        -g GH                            Specify center geohex directly
+        -r [RING]                        Number of rings around center
 
-And then execute:
 
-    $ bundle
+### Return geohex 4-6 that includes a geohex
 
-Or install it yourself as:
+    $shell> ghgen -g PC22713455
+    
+    Center GH is PC22713455, located at 32.91066810490208, -117.21383935375704
+    
+    This location is included in
+    
+    GH4: PC2271
+    GH5: PC22713
+    GH6: PC227134
+    
+Note that you can't always truncate a GH string to get to larger size.  
+Geohexes that are on apex ending with 2 or 6 ends up on parent with different code system. ghgen handles this properly.
 
-    $ gem install geohex-gen
+    $shell> ghgen -g PC2266666
 
-## Usage
+    Center GH is PC2266666, located at 32.70505659484853, -115.56470050297207
+    
+    This location is included in
+    
+    GH4: PC2500
+    GH5: PC25000
+    GH6: PC218888
+
+
+### Get geohex from lat lon
+
+    $shell> ghgen -a 32.90475787738992 -o -117.20164609053498
+
+    Center GH is PC2271344444, located at 32.90475787738992, -117.20164609053498
+    
+    This location is included in
+    
+    GH4: PC2271
+    GH5: PC22713
+    GH6: PC227134
+
+
+### Get a list of Geohexes that form one or more ring around the center GH
+
+    $shell> ghgen -g PC22751 -r 1
+    
+    Center GH is PC22751, located at 33.14380613603259, -117.3662551440329
+    
+    This location is included in
+    
+    GH4: PC2275
+    GH5: PC22751
+    GH6: PC227514
+    
+    Center PC22751, Ring(s) 1:
+    PC22727
+    PC22754
+    PC22752
+    PC22726
+    PC22755
+    PC22750
+
+You can specify ring size with lat/lon, but the ring is always in GH10.
 
-TODO: Write usage instructions here
 
 ## Contributing
 

data/geohex-gen.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.executables   = 'ghgen'
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 

data/lib/geohex/gen.rb

@@ -6,17 +6,54 @@ require 'geo_hex'
 module Geohex
   module Gen
     class Process
+
+      def self.gh_to_ll gh
+        zone = GeoHex.decode(gh)
+        [zone.lat, zone.lon]
+      end
+
+      def self.convert_gh gh, level
+        lat, lon = self.gh_to_ll gh
+        GeoHex.encode(lat, lon, level)
+      end
+
       def self.process
         opt = OptionParser.new
         opts={}
-        opt.on('-g GH') {|v| opts[:g]=v}
-        opt.on('-r [RING]', Integer) {|v| opts[:r]=v}
+        opt.on('-a LAT', Float, "Latitude. If used, must have longitude also") { |v| opts[:a]=v }
+        opt.on('-o LON', Float, "Longitude. If used, must have latitude also") { |v| opts[:o]=v }
+        opt.on('-g GH', String, "Specify center geohex directly") { |v| opts[:g]=v }
+        opt.on('-r [RING]', Integer, "Number of rings around center") { |v| opts[:r]=v }
 
         opt.parse!(ARGV)
-        gh = opts[:g]
-        ring = opts[:r] ? opts[:r] : 1
+        centergh = opts[:g]
+        ring     = opts[:r] ? opts[:r] : nil
+
+        if !centergh
+          lat = opts[:a]
+          lon = opts[:o]
+          centergh = GeoHex.encode(lat, lon, 10).code if lat and lon
+        end
+
+
+        if centergh
+          gh_lat, gh_lon = self.gh_to_ll centergh
+          puts ""
+          puts "Center GH is #{centergh}, located at #{gh_lat}, #{gh_lon}"
+          puts ""
+          puts "This location is included in"
+          puts ""
+          puts "GH4: #{self.convert_gh centergh, 4}"
+          puts "GH5: #{self.convert_gh centergh, 5}"
+          puts "GH6: #{self.convert_gh centergh, 6}"
 
-        puts GeoHex.decode(gh).neighbours(ring)
+          if ring
+            puts ""
+            puts "Center #{centergh}, Ring(s) #{ring}:"
+            puts GeoHex.decode(centergh).neighbours(ring)
+            puts ""
+          end
+        end
       end
     end
   end

data/lib/geohex/gen/version.rb

@@ -1,5 +1,5 @@
 module Geohex
   module Gen
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geohex-gen
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Aki Atoji