geomodel 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8914e3d585af5281290b7a854cb1eec6d7a566c
-  data.tar.gz: 30b52b4cb9989bf752dbe9fb426f71607ef5858c
+  metadata.gz: 90db919642b9d8269c289645bf18195b8efeb665
+  data.tar.gz: 1278b9035c58e080d225e81aebc38ac7cf1a4b22
 SHA512:
-  metadata.gz: b170a8372a165c3bdad452588f7ffad1174996b448076f8a139bd0ee48bd83924ef1a4420734d9c98f8106239ce2fb601d0cd525350a4b692662f68847d61e80
-  data.tar.gz: 13298af29d84898c152475a74ffc11d917507224a5f2a36b5e2cd3bc0c6e4e0e18fbca99366c8c545771c0076e5daf02421d53d2200d92e2ec2d1a63e6cda41f
+  metadata.gz: 3f471cead361f81bfa870db73eb9ad372f177cf77e6dfb329be0b8fce036e3dc16020f650ae384a7a5a5c9ddeb845058016477512aa95cd368d87fb9b150c9e6
+  data.tar.gz: 17bc0e26b4f43181c3cb22cf398714fb65457bab4ddc495ae4928aba532f095eef9d8b5e6f303252ec5907283bd89ab06885dd6c7c0ffc49739aa90500831862

data/CHANGELOG.md

@@ -1,2 +1,5 @@
 ### 0.0.1 (January 2, 2014)
-  * Initial release - Straight port from Python, Java and JS implementations
+  * Initial release - Straight port from Python, Java and JS implementations
+
+### 0.0.2 (January 5, 2014)
+  * Upped the test coverage (which revealed some pretty blatant bugs)

data/README.md

@@ -68,10 +68,13 @@ indexed and filtered by either conformance to a bounding box or by proximity
 # Approach
 
 This Ruby implementation of GeoModel is based on the Python, Java and JavaScript implementations. 
-It's implemented as class level methods contained modules and a few datatype classes. So the 'model' 
-part isn't quite there and I don't really see a need for it. Since the library is meant to be use in 
-Non-Relational/Non-ORM environmets, binding the functions/methods to a model does not make much sense. 
+It's implemented as class level methods contained within modules and a few datatype classes. So the 
+'model' part isn't quite there and I don't really see a need for it. Since the library is meant to 
+be use in Non-Relational/Non-ORM environmets, binding the functions/methods to a model does not make
+much sense. 
+
 The model part was mostly implemented in the other libraries to bind directly to Google App Engine.
+The idea here is to make it backend/db independent and use callbacks to integrate with the backend.
 
 # References
 
@@ -100,7 +103,7 @@ Or install it yourself as:
 Currently, only single-point entities and two types of basic geospatial queries
 on those entities are supported.
 
-### Representing your locations
+### Representing your Locations
 
 You'll need a class to hold a geolocation. It assumes that an "entity" has a unique 
 "id" (specific field can be configure), a latitude/longitude combination stored in 
@@ -125,6 +128,21 @@ flw_spire = Entity.new
 flw_spire.id = 'Flatiron'
 flw_spire.location = Geomodel::Types::Point.new(33.633406, -111.916803)
 flw_spire.geocells = Geomodel::GeoCell.generate_geocells(flw_spire.location)
+
+puts flw_spire.geocells
+# 8
+# 8d
+# 8da
+# 8daa
+# 8daab
+# 8daab6
+# 8daab66
+# 8daab666
+# 8daab6668
+# 8daab66684
+# 8daab66684e
+# 8daab66684e4
+# 8daab66684e4d
 ```
 
 ### Bounding Box Queries
@@ -147,7 +165,7 @@ result_set = my_db.query('SELECT * WHERE location_geocells IN (?)', query_geocel
 matches = Geomodel.filter_result_set_by_bounding_box(bounding_box, result_set)
 ```
 
-### proximity (nearest-n) queries
+### Proximity (nearest-n) Queries
 
 Find nearby locations given a location (lat & lon) and a radius in meters:
 
@@ -189,4 +207,4 @@ distances = results.map(&:last)
 
 ## License
 
-MIT License
+MIT License

data/lib/geomodel.rb

@@ -84,7 +84,7 @@ module Geomodel
     while !cur_geocells.empty?
       closest_possible_next_result_dist = sorted_edge_distances[0]
       
-      next if max_distance and closest_possible_next_result_dist > max_distance
+      next if max_distance && closest_possible_next_result_dist > max_distance
   
       cur_geocells_unique = cur_geocells - searched_cells.to_a
   

data/lib/geomodel/geocell.rb

@@ -267,7 +267,7 @@ module Geomodel
       cell_adj_arr = cell.split(//)  # Split the geocell string characters into a list.
       i = cell_adj_arr.size - 1
 
-      while i >= 0 && (dx != 0 or dy != 0)
+      while i >= 0 && (dx != 0 || dy != 0)
         x, y = subdiv_xy(cell_adj_arr[i])
 
         # Horizontal adjacency.
@@ -339,24 +339,25 @@ module Geomodel
       if between_w_e
         if between_n_s
           # Inside the geocell.
-          return [Geocoder::GeoMath.distance(point, Geomodel::Types::Point.new(bbox.south, point.lon)),
-                  Geocoder::GeoMath.distance(point, Geomodel::Types::Point.new(bbox.north, point.lon)),
-                  Geocoder::GeoMath.distance(point, Geomodel::Types::Point.new(point.lat, bbox.east)),
-                  Geocoder::GeoMath.distance(point, Geomodel::Types::Point.new(point.lat, bbox.west))].min
+          
+          return [Geomodel::Math.distance(point, Geomodel::Types::Point.new(bbox.south, point.lon)),
+                  Geomodel::Math.distance(point, Geomodel::Types::Point.new(bbox.north, point.lon)),
+                  Geomodel::Math.distance(point, Geomodel::Types::Point.new(point.lat, bbox.east)),
+                  Geomodel::Math.distance(point, Geomodel::Types::Point.new(point.lat, bbox.west))].min
         else
-          return [Geocoder::GeoMath.distance(point, Geomodel::Types::Point.new(bbox.south, point.lon)),
-                  Geocoder::GeoMath.distance(point, Geomodel::Types::Point.new(bbox.north, point.lon))].min
+          return [Geomodel::Math.distance(point, Geomodel::Types::Point.new(bbox.south, point.lon)),
+                  Geomodel::Math.distance(point, Geomodel::Types::Point.new(bbox.north, point.lon))].min
         end
       else
         if between_n_s
-          return [Geocoder::GeoMath.distance(point, Geomodel::Types::Point.new(point.lat, bbox.east)),
-                  Geocoder::GeoMath.distance(point, Geomodel::Types::Point.new(point.lat, bbox.west))]
+          return [Geomodel::Math.distance(point, Geomodel::Types::Point.new(point.lat, bbox.east)),
+                  Geomodel::Math.distance(point, Geomodel::Types::Point.new(point.lat, bbox.west))].min
         else
           # TODO(romannurik): optimize
-          return [Geocoder::GeoMath.distance(point, Geomodel::Types::Point.new(bbox.south, bbox.east)),
-                  Geocoder::GeoMath.distance(point, Geomodel::Types::Point.new(bbox.north, bbox.east)),
-                  Geocoder::GeoMath.distance(point, Geomodel::Types::Point.new(bbox.south, bbox.west)),
-                  Geocoder::GeoMath.distance(point, Geomodel::Types::Point.new(bbox.north, bbox.west))]
+          return [Geomodel::Math.distance(point, Geomodel::Types::Point.new(bbox.south, bbox.east)),
+                  Geomodel::Math.distance(point, Geomodel::Types::Point.new(bbox.north, bbox.east)),
+                  Geomodel::Math.distance(point, Geomodel::Types::Point.new(bbox.south, bbox.west)),
+                  Geomodel::Math.distance(point, Geomodel::Types::Point.new(bbox.north, bbox.west))].min
         end
       end
     end
@@ -444,7 +445,7 @@ module Geomodel
     # For example, the immediate children of 'a' are 'a0', 'a1', ..., 'af'.
     # 
     def self.children(cell)
-      GEOCELL_ALPHABET.map { |chr| cell + chr }
+      GEOCELL_ALPHABET.split(//).map { |chr| cell + chr }
     end
 
     # Returns the (x, y) of the geocell character in the 4x4 alphabet grid.

data/lib/geomodel/geotypes.rb

@@ -8,7 +8,7 @@ module Geomodel::Types
   # 
   class Point
     
-    attr_reader :latitude, :longitude
+    attr_accessor :latitude, :longitude
     
     alias_method :lat, :latitude
     alias_method :lon, :longitude

data/lib/geomodel/version.rb

@@ -1,3 +1,3 @@
 module Geomodel
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/geocell_spec.rb

@@ -58,6 +58,26 @@ describe 'Geomodel::GeoCell' do
     expect(all_adjacents.size).to eq(8)
   end
   
+  it "can determine adjacency left and bottom of parent cell" do
+    cells = {
+            "8e6187fe6187fa" => ["8e6187fe618d45", "8e6187fe618d50", "8e6187fe618d51", "8e6187fe6187fb", "8e6187fe6187f9", "8e6187fe6187f8", "8e6187fe6187ed", "8e6187fe6187ef"],
+            "8e6187fe618d45" => ["8e6187fe618d46", "8e6187fe618d47", "8e6187fe618d52", "8e6187fe618d50", "8e6187fe6187fa", "8e6187fe6187ef", "8e6187fe6187ee", "8e6187fe618d44"]
+            }
+    cells.each do |cell, adjacents|
+      expect(Geomodel::GeoCell.all_adjacents(cell)).to eq(adjacents)
+    end
+  end
+  
+  it "cam calculate the immediate children of a given geocell" do
+    expect(Geomodel::GeoCell.children("8e6187fe6187f")).
+    to eq(
+    %w(8e6187fe6187f0 8e6187fe6187f1 8e6187fe6187f2 8e6187fe6187f3 
+      8e6187fe6187f4 8e6187fe6187f5 8e6187fe6187f6 8e6187fe6187f7 
+      8e6187fe6187f8 8e6187fe6187f9 8e6187fe6187fa 8e6187fe6187fb 
+      8e6187fe6187fc 8e6187fe6187fd 8e6187fe6187fe 8e6187fe6187ff)
+    )
+  end
+  
   it "can determine collinearity" do
     cell = Geomodel::GeoCell.compute(Geomodel::Types::Point.new(37, -122), 14)
     
@@ -109,6 +129,30 @@ describe 'Geomodel::GeoCell' do
     expect(geocells).to include("9aa228a8b3b00")
   end
   
+  it "can calculate that the shortest distance between a point and a geocell bounding boxfor the point is effectively zero" do
+    point = Geomodel::Types::Point.new(40.7407092, -73.9894039)
+    cell = "9ac7be064ea77"
+    expect(Geomodel::GeoCell.point_distance(cell, point)).to be_within(0.2).of(0.0)
+  end
+  
+  it "can calculate the shortest distance between a point outside a geocell and the geocell" do
+    point = Geomodel::Types::Point.new(40.7425610, -73.9922670)
+    cell = "9ac7be064ea77"
+    expect(Geomodel::GeoCell.point_distance(cell, point)).to be_within(0.2).of(317.2)
+  end
+  
+  it "can calculate the shortest distance between a point between north and south (but not between east and west) of a geocell bounding box" do
+    point = Geomodel::Types::Point.new(40.740710, -74.025537)
+    cell = "9ac7be064ea77"
+    expect(Geomodel::GeoCell.point_distance(cell, point)).to be_within(0.2).of(3047.3)
+  end
+  
+  it "can calculate the shortest distance between a point between east and west (but not between north and south) of a geocell bounding box" do
+    point = Geomodel::Types::Point.new(40.740720, -73.989403)
+    cell = "9ac7be064ea77"
+    expect(Geomodel::GeoCell.point_distance(cell, point)).to be_within(0.2).of(0.99)
+  end
+  
   # TODO implement these tests!
   
   #   @Test

data/spec/geotypes_spec.rb

@@ -54,12 +54,39 @@ describe 'Geomodel::Types' do
       expect(box_a).to eq(box_b)
     end
     
-    it "can be created with north below south" do
+    it "can't be created with north below south" do
       box = Geomodel::Types::Box.new(37, -122, 34, -125)
       
       expect { box.north = 32 }.to raise_error
       expect { box.south = 39 }.to raise_error
     end
+    
+    it "can be created with south below north" do
+      box = Geomodel::Types::Box.new(37, -122, 34, -125)
+      
+      expect { box.north = 39 }.to_not raise_error
+      expect { box.south = 32 }.to_not raise_error
+    end
+    
+    it "can be set the values for north, east, south and west" do
+      box = Geomodel::Types::Box.new(37, -122, 34, -125)
+      
+      expect { box.north = 39 }.to_not raise_error
+      expect { box.south = 32 }.to_not raise_error
+      expect { box.east = -123 }.to_not raise_error
+      expect { box.west = -126 }.to_not raise_error
+      
+      expect(box.north).to eq(39)
+      expect(box.south).to eq(32)
+      expect(box.east).to eq(-123)
+      expect(box.west).to eq(-126)
+    end
+    
+    it "returns a suitable string representation" do
+      box = Geomodel::Types::Box.new(37, -122, 34, -125)
+      
+      expect(box.to_s).to eq('(37, -122, 34, -125)')
+    end
 
   end
 end

data/spec/spec_helper.rb

@@ -7,7 +7,9 @@ SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
   SimpleCov::Formatter::HTMLFormatter,
   Coveralls::SimpleCov::Formatter
 ]
-SimpleCov.start
+SimpleCov.start do
+  add_filter "/spec/"
+end
 
 require 'rubygems'
 require 'pry'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geomodel
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Brian Sam-Bodden
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-02 00:00:00.000000000 Z
+date: 2014-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: geocoder