easy_postgis 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b65ba19ced7e796800213e32ddb5f02efb3fdfbc
-  data.tar.gz: 4d95e9569baa4700a1d27dcc31a82e5024397341
+  metadata.gz: 16cb8dd649020b96b5673cbbc75a15d31bb81e95
+  data.tar.gz: 99c08a8ea53b3ae5f0ca417f7884b3cf0b4c8c24
 SHA512:
-  metadata.gz: b898a4b807458e2caa02e3b3da3584820e0ee9961401b35284e7f382a6b01c2df5aa68866ebb90760b48c8caf853e21ebd7b0666785f7ca0fe62244a2ccb99b6
-  data.tar.gz: 20c22c099fcdc1a2453eea974db9663be24818a91a35aa767e667f99a0d81926a588c94e3f41bb9370ab3d1facfb90fdfa43453ce06c3a2308a5ce7edbad242b
+  metadata.gz: a71995dd7de2c90891791714794133c86f79b8415a4171e4ed2363e22feb50d4c6bfa906e07cab2e41c9a9bc229eabf36d5b6701d0cbfbfabcb62ebed934675a
+  data.tar.gz: 6840cdb099997d71bf179712dbbc9c64eaf314526ddc9c8bcd252afa64e2ff78df4756a8a01037bc65b56719abf398a5030b8bf8e3b6d4ec266de944a987f8b6

data/README.md

@@ -5,7 +5,7 @@ EasyPostgis is a gemification of the code described in Nick Gauthier's 2013 blog
 
 [1]: http://ngauthier.com/2013/08/postgis-and-rails-a-simple-approach.html
 
-It adds 2 scopes to your model: 
+It creates 2 scopes for use by your model: 
 
 * near(point, distance_in_meters)
 * with_distance(point)
@@ -13,6 +13,16 @@ It adds 2 scopes to your model:
 *near* filters the rows based on distance from the point.
 *with_distance* adds a distance column to the result.
 
+```ruby
+# find the node closest to a lat lon
+def self.nearest_node(lat, lng)
+  point = OpenStruct.new(:lat => lat, :lng => lng)
+  Node.with_distance(point).order("distance").first # use quoted string rather than symbol for 
+                                                    # distance so that rails does not append 
+                                                    # a table name
+end
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -31,6 +41,29 @@ Or install it yourself as:
 
 ## Usage
 
+Add the postgis extension and create the index for your table in a migration:
+
+```ruby
+class AddPostgis < ActiveRecord::Migration
+  def up
+    execute 'create extension postgis'
+    execute %{
+      create index index_on_node_location on nodes using gist (
+        ST_GeographyFromText(
+          'SRID=4326;POINT(' || nodes.lng || ' ' || nodes.lat || ')'
+        )
+      )
+    }
+  end
+
+  def down
+    execute %{drop index index_on_node_location}
+  end
+end
+```
+
+Include EasyPostgis in your model:
+
 ```ruby
   class Address
     # has lat and lng attributes 
@@ -45,8 +78,10 @@ Or install it yourself as:
 
 TODO:
   
-  * you must create the test database: psql> create database easy_postgis_test;
+  * you must create the test database to run the tests: psql> create database easy_postgis_test;
   * you must add gis: psql> create extension postgis;
+  * we should allow for customization of the lat/lng column names
+  * we should provide a generator to create a migration that adds the index
   
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 

data/lib/easy_postgis.rb

@@ -10,19 +10,19 @@ module EasyPostgis
 
   class_methods do
     def near_sql(other, distance_in_meters)
-      "ST_DWithin(#{geography_from_table}, #{geography_from_point(other.lng, other.lat)}, %d )" % [distance_in_meters]
+      "ST_DWithin(#{geography_from_table},#{geography_from_point(other.lng,other.lat)},%d)" % [distance_in_meters]
     end
 
     def distance_select_sql(other)
-      "ST_Distance(#{geography_from_table}, #{geography_from_point(other.lng, other.lat)}) as distance"
+      "ST_Distance(#{geography_from_table},#{geography_from_point(other.lng,other.lat)}) as distance"
     end
 
     def geography_from_table
-      "ST_GeographyFromText(' SRID=4326; POINT(' || #{table_name}.lng || ' ' || #{table_name}.lat || ') ')"
+      "ST_GeographyFromText('SRID=4326;POINT(' || #{table_name}.lng || ' ' || #{table_name}.lat || ')')"
     end
 
     def geography_from_point(lon, lat)
-      "ST_GeographyFromText( 'SRID=4326; POINT(%f %f)' )" % [lon, lat]
+      "ST_GeographyFromText('SRID=4326;POINT(%f %f)')" % [lon, lat]
     end
   end
 end

data/lib/easy_postgis/version.rb

@@ -1,3 +1,3 @@
 module EasyPostgis
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_postgis
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kelly Felkins
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-10 00:00:00.000000000 Z
+date: 2017-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -146,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Adds simple distance scopes that utilize PostGIS indexes to your Rails models.