activerecord-postgres-earthdistance 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c055653d6b3f2dd1175e0a366c93db6e0ec9399f
-  data.tar.gz: 4eda09c2594bd9bc93bbf8b0ca12c6871931391f
+  metadata.gz: f9458af5bee1a6c5416b450109d62aa9888f37d7
+  data.tar.gz: 52a8f7eb26951d8c77f3b1332b630ed5978f560f
 SHA512:
-  metadata.gz: ecb1b7bc206b06d3b576d85ad2b68df5314a42ab6e83841e2ae75bc30f6a05d19c634af18d0d9a96fbce4bddd6bfd7593d0279b62623c1a475e7502d899655a3
-  data.tar.gz: b41cf665cc0fc78ebe6cd4e763fd3291c069b12c89531f160cf79b17f8097d9b64c95f3229cc77f1e49c6baec6f7a89f49570026bce0411475bb5d29ccd77a11
+  metadata.gz: 7e53a9aa32535c9ffd538d28221f99618f7497add3a8b6f4f63b38c4fee66e05feb6d0ae420c0ecec8bf8f4dbb7271564b586751a139c49be7f39d06e9e7642c
+  data.tar.gz: 895a6791fdd7d3a6ed3b73b70254a136cb119517f0dc5ba341c0e7a1f02aee61aa34d3915ee68412cfeaa06cc42a2c192d9bded4600e2fdb6edf2a12d2c382d5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    activerecord-postgres-earthdistance (0.3.2)
+    activerecord-postgres-earthdistance (0.4.0)
       pg
       rails (>= 3.1)
       rake
@@ -9,88 +9,88 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    actionmailer (4.0.4)
-      actionpack (= 4.0.4)
-      mail (~> 2.5.4)
-    actionpack (4.0.4)
-      activesupport (= 4.0.4)
-      builder (~> 3.1.0)
-      erubis (~> 2.7.0)
+    actionmailer (4.1.8)
+      actionpack (= 4.1.8)
+      actionview (= 4.1.8)
+      mail (~> 2.5, >= 2.5.4)
+    actionpack (4.1.8)
+      actionview (= 4.1.8)
+      activesupport (= 4.1.8)
       rack (~> 1.5.2)
       rack-test (~> 0.6.2)
-    activemodel (4.0.4)
-      activesupport (= 4.0.4)
-      builder (~> 3.1.0)
-    activerecord (4.0.4)
-      activemodel (= 4.0.4)
-      activerecord-deprecated_finders (~> 1.0.2)
-      activesupport (= 4.0.4)
-      arel (~> 4.0.0)
-    activerecord-deprecated_finders (1.0.3)
-    activesupport (4.0.4)
+    actionview (4.1.8)
+      activesupport (= 4.1.8)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.8)
+      activesupport (= 4.1.8)
+      builder (~> 3.1)
+    activerecord (4.1.8)
+      activemodel (= 4.1.8)
+      activesupport (= 4.1.8)
+      arel (~> 5.0.0)
+    activesupport (4.1.8)
       i18n (~> 0.6, >= 0.6.9)
-      minitest (~> 4.2)
-      multi_json (~> 1.3)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
       thread_safe (~> 0.1)
-      tzinfo (~> 0.3.37)
-    arel (4.0.2)
-    builder (3.1.4)
-    diff-lcs (1.1.3)
+      tzinfo (~> 1.1)
+    arel (5.0.1.20140414130214)
+    builder (3.2.2)
+    diff-lcs (1.2.5)
     erubis (2.7.0)
     hike (1.2.3)
-    i18n (0.6.9)
-    json (1.7.6)
-    mail (2.5.4)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    mime-types (1.25.1)
-    minitest (4.7.5)
-    multi_json (1.9.2)
+    i18n (0.6.11)
+    json (1.8.1)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    mime-types (2.4.3)
+    minitest (5.4.3)
+    multi_json (1.10.1)
     pg (0.17.1)
-    polyglot (0.3.4)
     rack (1.5.2)
     rack-test (0.6.2)
       rack (>= 1.0)
-    rails (4.0.4)
-      actionmailer (= 4.0.4)
-      actionpack (= 4.0.4)
-      activerecord (= 4.0.4)
-      activesupport (= 4.0.4)
+    rails (4.1.8)
+      actionmailer (= 4.1.8)
+      actionpack (= 4.1.8)
+      actionview (= 4.1.8)
+      activemodel (= 4.1.8)
+      activerecord (= 4.1.8)
+      activesupport (= 4.1.8)
       bundler (>= 1.3.0, < 2.0)
-      railties (= 4.0.4)
-      sprockets-rails (~> 2.0.0)
-    railties (4.0.4)
-      actionpack (= 4.0.4)
-      activesupport (= 4.0.4)
+      railties (= 4.1.8)
+      sprockets-rails (~> 2.0)
+    railties (4.1.8)
+      actionpack (= 4.1.8)
+      activesupport (= 4.1.8)
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
-    rake (10.2.2)
-    rdoc (3.12)
+    rake (10.4.2)
+    rdoc (4.2.0)
       json (~> 1.4)
-    rspec (2.12.0)
-      rspec-core (~> 2.12.0)
-      rspec-expectations (~> 2.12.0)
-      rspec-mocks (~> 2.12.0)
-    rspec-core (2.12.2)
-    rspec-expectations (2.12.1)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.12.2)
-    sprockets (2.12.0)
+    rspec (2.99.0)
+      rspec-core (~> 2.99.0)
+      rspec-expectations (~> 2.99.0)
+      rspec-mocks (~> 2.99.0)
+    rspec-core (2.99.2)
+    rspec-expectations (2.99.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.99.2)
+    sprockets (2.12.3)
       hike (~> 1.2)
       multi_json (~> 1.0)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
-    sprockets-rails (2.0.1)
+    sprockets-rails (2.2.2)
       actionpack (>= 3.0)
       activesupport (>= 3.0)
-      sprockets (~> 2.8)
+      sprockets (>= 2.8, < 4.0)
     thor (0.19.1)
-    thread_safe (0.3.3)
+    thread_safe (0.3.4)
     tilt (1.4.1)
-    treetop (1.4.15)
-      polyglot
-      polyglot (>= 0.3.1)
-    tzinfo (0.3.39)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,7 +1,7 @@
 #ActiveRecord + PostgreSQL Earthdistance [![Build Status](https://travis-ci.org/diogob/activerecord-postgres-earthdistance.png?branch=master)](https://travis-ci.org/diogob/activerecord-postgres-earthdistance)
 
 Check distances with latitude and longitude using PostgreSQL special indexes.
-This gem enables your model to query the database using the earthdistance extension. This should be much faster than using trigonometry functions over standart indexs.
+This gem enables your model to query the database using the earthdistance extension. This should be much faster than using trigonometry functions over standard indexes.
 
 ##Requirements
 
@@ -30,7 +30,7 @@ And run your bundler:
 Now you need to create a migration that adds earthdistance support for your
 PostgreSQL database:
 
-`rails g earthdistance:setup`
+`rails g earth_distance:setup`
 
 Run it:
 
@@ -84,14 +84,28 @@ end
 
 ###Querying the database
 
-To query for all places within a given radius of 100 meters from the origin 30,50 just use:
+To query for all places within a given radius of 100 meters from the origin -22.951916,-43.210487 just use:
 ```ruby
-Place.within_radius(500, 30, 50).all
+Place.within_radius(100, -22.951916, -43.210487).all
 ```
 
 You can also order the records based on the distance from a point
 ```ruby
-Place.within_radius(500, 30, 50).order_by_distance(20,30)
+Place.within_radius(100, -22.951916,-43.210487).order_by_distance(-22.951916,-43.210487)
+```
+
+The `within_radius` query performs two checks: first against the *bounding box*, followed by computing the exact distance for
+all contained elements. The latter might be computationally expensive for big ranges.
+So if precision is not an issue but query speed is, you might want to query against the bounding box only:
+```ruby
+Place.within_box(1_000_000, -22.951916,-43.210487)
+```
+
+Select the distance from a point:
+```ruby
+point = [-22.951916, -43.210487]
+closest = Place.within_radius(100, *point).order_by_distance(*point).selecting_distance_from(*point).first
+closest.distance
 ```
 
 ##Test Database

data/activerecord-postgres-earthdistance.gemspec

@@ -4,7 +4,7 @@ $:.unshift lib unless $:.include?(lib)
 
 Gem::Specification.new do |s|
   s.name = "activerecord-postgres-earthdistance"
-  s.version = "0.3.2"
+  s.version = "0.4.0"
 
   s.platform    = Gem::Platform::RUBY
   s.license     = "MIT"

data/lib/activerecord-postgres-earthdistance/acts_as_geolocated.rb

@@ -14,18 +14,32 @@ module ActiveRecordPostgresEarthdistance
         end
       end
 
+      def within_box radius, lat, lng
+        where("ll_to_earth(#{self.latitude_column}, #{self.longitude_column}) <@ earth_box(ll_to_earth(?, ?), ?)", lat, lng, radius)
+      end
+
       def within_radius radius, lat, lng
-        where(["ll_to_earth(#{self.latitude_column}, #{self.longitude_column}) <@ earth_box(ll_to_earth(?, ?), ?)" +
-               "AND earth_distance(ll_to_earth(#{self.latitude_column}, #{self.longitude_column}), ll_to_earth(?, ?)) <= ?",
-               lat, lng, radius, lat, lng, radius])
+        within_box(radius, lat, lng).where("earth_distance(ll_to_earth(#{self.latitude_column}, #{self.longitude_column}), ll_to_earth(?, ?)) <= ?", lat, lng, radius)
       end
 
       def order_by_distance lat, lng, order= "ASC"
         order("earth_distance(ll_to_earth(#{self.latitude_column}, #{self.longitude_column}), ll_to_earth(#{lat}, #{lng})) #{order}")
       end
+    end
+  end
 
+  module QueryMethods
+    def selecting_distance_from lat, lng, name="distance", include_default_columns=true
+      clone.tap do |relation|
+        values = []
+        values << relation.arel_table[Arel.star] if relation.select_values.empty? && include_default_columns
+        values << "earth_distance(ll_to_earth(#{self.latitude_column}, #{self.longitude_column}), ll_to_earth(#{lat}, #{lng})) as #{name}"
+        relation.select_values = values
+      end
     end
   end
+
 end
 
 ActiveRecord::Base.send :include, ActiveRecordPostgresEarthdistance::ActsAsGeolocated
+ActiveRecord::Relation.send :include, ActiveRecordPostgresEarthdistance::QueryMethods

data/spec/act_as_geolocated_spec.rb

@@ -1,6 +1,46 @@
 require 'spec_helper'
 
 describe "ActiveRecord::Base.act_as_geolocated" do
+  describe "#within_box" do
+    let(:test_data) { { lat: nil, lng: nil, radius: nil } }
+
+    subject { Place.within_box(test_data[:radius], test_data[:lat], test_data[:lng]) }
+
+    before(:all) { @place = Place.create!(:lat => -30.0277041, :lng => -51.2287346) }
+    after(:all) { @place.destroy }
+
+    context "when query with null data" do
+      it { should be_empty }
+    end
+
+    context "when query for the exact same point with radius 0" do
+      let(:test_data) { { lat: -30.0277041, lng: -51.2287346 , radius: 0 } }
+
+      it { should == [@place] }
+    end
+
+    context "when query for place within the box" do
+      let(:test_data) { { radius: 4000000, lat: -27.5969039, lng: -48.5494544 } }
+
+      it { should == [@place] }
+    end
+
+    context "when query for place within the box, but outside the radius" do
+      let(:test_data) { { radius: 300000, lat: -27.5969039, lng: -48.5494544 } }
+
+      it "the place shouldn't be within the radius" do
+        Place.within_radius(test_data[:radius], test_data[:lat], test_data[:lng]).should be_empty
+      end
+
+      it { should == [@place] }
+    end
+
+    context "when query for place outside the box" do
+      let(:test_data) { { radius: 1000, lat: -27.5969039, lng: -48.5494544 } }
+      it { should be_empty }
+    end
+  end
+
   describe "#within_radius" do
     let(:test_data){ {lat: nil, lng: nil, radius: nil} }
     subject{ Place.within_radius(test_data[:radius], test_data[:lat], test_data[:lng]) }
@@ -28,6 +68,7 @@ describe "ActiveRecord::Base.act_as_geolocated" do
 
     context "when query for place outside the radius" do
       let(:test_data){ {radius: 1000, lat: -27.5969039, lng: -48.5494544} }
+      it{ should == [] }
     end
   end
 
@@ -53,4 +94,25 @@ describe "ActiveRecord::Base.act_as_geolocated" do
       it{ should == [@place_2, @place_1] }
     end
   end
+
+  describe "#selecting_distance_from" do
+    let(:current_location){ {lat: nil, lng: nil, radius: nil} }
+    subject do
+      Place.
+        order_by_distance(current_location[:lat], current_location[:lng]).
+        selecting_distance_from(current_location[:lat], current_location[:lng]).
+        first.
+        try{|p| [p.data, p.distance.to_f] }
+    end
+    before(:all) do
+      @place = Place.create!(:data => 'Amsterdam', :lat => 52.370216, :lng => 4.895168) #Amsterdam
+    end
+    after(:all) do
+      @place.destroy
+    end
+    context "when selecting distance" do
+      let(:current_location){{lat: 52.229676, lng: 21.012229}} #Warsaw
+      it{ should == ["Amsterdam", 1095013.87438311] }
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-postgres-earthdistance
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Diogo Biazus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-16 00:00:00.000000000 Z
+date: 2014-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -142,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Check distances with latitude and longitude using PostgreSQL special indexes