activerecord-postgres-earthdistance 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94eb40debf0a4955024e1c8c4213b88530b294b1
-  data.tar.gz: ec0ec0eb7d2472ebe8bad60197bbf0a7b45f1d36
+  metadata.gz: 49e3fc1de6b2ece19a9479d5276208b3b0219d14
+  data.tar.gz: 218459e70fbd4a1086a20b93545d30b1d7df828d
 SHA512:
-  metadata.gz: c9818e3e89ae5b0906c30fa097b26eb7445541541dbce5b31e633641f13d8a1ba797c500f4e420b0b6fad88315914e35c345971540043626ef1d1b589f5ecc35
-  data.tar.gz: b6dfb3232de9828d812589a01a4f199ee36af6dbdda53064373253e5000370982465eec956f122e9efcdb3fdb9029f1c24e3e5cc820653146d01f56208ae5384
+  metadata.gz: 83e61e7ff6ec64126fb22fd32397a9711e03010e67eeb545c9aa6d5ce90760ca9b497f6d0e35b8cb8de3063f21bec45c02228bda5b50e079abd716e2d293a3c5
+  data.tar.gz: f9695b98ed7528a2132b2b355dd56b2f8facf98233b78c7a87c604a5355968e1473aaa7d0dded4473b9792b83745dbf6bfce829af72a52ebbc65523a668e1c56

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    activerecord-postgres-earthdistance (0.5.2)
+    activerecord-postgres-earthdistance (0.6.0)
       activerecord (>= 3.1)
       pg
       rake
@@ -9,30 +9,31 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (5.0.2)
-      activesupport (= 5.0.2)
-    activerecord (5.0.2)
-      activemodel (= 5.0.2)
-      activesupport (= 5.0.2)
-      arel (~> 7.0)
-    activesupport (5.0.2)
+    activemodel (5.1.6)
+      activesupport (= 5.1.6)
+    activerecord (5.1.6)
+      activemodel (= 5.1.6)
+      activesupport (= 5.1.6)
+      arel (~> 8.0)
+    activesupport (5.1.6)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    arel (7.1.4)
+    arel (8.0.0)
     coderay (1.1.1)
     concurrent-ruby (1.0.5)
     diff-lcs (1.3)
-    i18n (0.8.1)
+    i18n (1.0.0)
+      concurrent-ruby (~> 1.0)
     method_source (0.8.2)
-    minitest (5.10.1)
-    pg (0.20.0)
+    minitest (5.11.3)
+    pg (1.0.0)
     pry (0.10.4)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    rake (12.0.0)
+    rake (12.3.1)
     rdoc (5.1.0)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
@@ -49,7 +50,7 @@ GEM
     rspec-support (3.5.0)
     slop (3.6.0)
     thread_safe (0.3.6)
-    tzinfo (1.2.3)
+    tzinfo (1.2.5)
       thread_safe (~> 0.1)
 
 PLATFORMS
@@ -63,4 +64,4 @@ DEPENDENCIES
   rspec
 
 BUNDLED WITH
-   1.14.3
+   1.16.1

data/activerecord-postgres-earthdistance.gemspec

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

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

@@ -3,15 +3,23 @@ module ActiveRecordPostgresEarthdistance
     extend ActiveSupport::Concern
 
     module ClassMethods
+      MILES_TO_METERS_FACTOR = 1609.344
       def acts_as_geolocated(options = {})
-        cattr_accessor :latitude_column, :longitude_column, :through_table
-        self.latitude_column = options[:lat] || (column_names.include?("lat") ? "lat" : "latitude")
-        self.longitude_column = options[:lng] ||
-                                (column_names.include?("lng") ? "lng" : "longitude")
-        self.through_table = options[:through]
+        if table_exists?
+          cattr_accessor :latitude_column, :longitude_column, :through_table, :distance_unit
+          self.latitude_column = options[:lat] || (column_names.include?("lat") ? "lat" : "latitude")
+          self.longitude_column = options[:lng] ||
+                                  (column_names.include?("lng") ? "lng" : "longitude")
+          self.through_table = options[:through]
+          self.distance_unit = options[:distance_unit]
+        else
+          puts "[WARNING] table #{table_name} doesn't exist, acts_as_geolocated won't work. Skip this warning if you are running db migration"
+        end
+      rescue ActiveRecord::NoDatabaseError
       end
 
       def within_box(radius, lat, lng)
+        radius = radius.try(:*, MILES_TO_METERS_FACTOR) if distance_unit === :miles
         earth_box = Arel::Nodes::NamedFunction.new(
           "earth_box",
           [Utils.ll_to_earth_coords(lat, lng), Utils.quote_value(radius)]
@@ -27,6 +35,7 @@ module ActiveRecordPostgresEarthdistance
       end
 
       def within_radius(radius, lat, lng)
+        radius = radius.try(:*, MILES_TO_METERS_FACTOR) if distance_unit === :miles
         earth_distance = Utils.earth_distance(through_table_klass, lat, lng)
         within_box(radius, lat, lng)
           .where(Arel::Nodes::InfixOperation.new("<=", earth_distance, Utils.quote_value(radius)))

data/spec/act_as_geolocated_spec.rb

@@ -73,6 +73,74 @@ describe "ActiveRecord::Base.act_as_geolocated" do
     end
   end
 
+  describe "#within_box with miles" 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.acts_as_geolocated distance_unit: :miles
+      @place = Place.create!(lat: -30.0277041, lng: -51.2287346) 
+    }
+    after(:all) { 
+      Place.acts_as_geolocated
+      @place.destroy 
+    }
+
+    context "when query with null data" do
+      it { is_expected.to 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 { is_expected.to eq [@place] }
+    end
+
+    context "when query for place within the box" do
+      let(:test_data) { { radius: 2400, lat: -27.5969039, lng: -48.5494544 } }
+
+      it { is_expected.to eq [@place] }
+    end
+
+    context "when query for place within the box, but outside the radius" do
+      let(:test_data) { { radius: 186, lat: -27.5969039, lng: -48.5494544 } }
+
+      it "the place shouldn't be within the radius" do
+        expect(Place.within_radius(test_data[:radius], test_data[:lat], test_data[:lng])).to be_empty
+      end
+
+      it { is_expected.to eq [@place] }
+    end
+
+    context "when query for place outside the box" do
+      let(:test_data) { { radius: 0.62, lat: -27.5969039, lng: -48.5494544 } }
+      it { is_expected.to be_empty }
+    end
+
+    context "when joining tables that are also geoloacted" do
+      let(:test_data) { { radius: 0.62, lat: -27.5969039, lng: -48.5494544 } }
+
+      subject { Place.within_box(test_data[:radius], test_data[:lat], test_data[:lng]) }
+
+      it "should work with objects having columns with the same name" do
+        expect do
+          Place
+            .joins(:events)
+            .within_radius(test_data[:radius], test_data[:lat], test_data[:lng]).to_a
+        end.to_not raise_error
+      end
+
+      it "should work with nested associations" do
+        expect do
+          Event
+            .joins(:events)
+            .within_radius(test_data[:radius], test_data[:lat], test_data[:lng]).to_a
+        end.to_not raise_error
+      end
+    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]) }
@@ -139,6 +207,75 @@ describe "ActiveRecord::Base.act_as_geolocated" do
     end
   end
 
+  describe "#within_radius with miles" do
+    let(:test_data) { { lat: nil, lng: nil, radius: nil } }
+    subject { Place.within_radius(test_data[:radius], test_data[:lat], test_data[:lng]) }
+    before(:all) do
+      # Place.distance_unit = :miles
+      Place.acts_as_geolocated distance_unit: :miles
+      @place = Place.create!(lat: -30.0277041, lng: -51.2287346)
+    end
+
+    after(:all) do
+      Place.acts_as_geolocated
+      @place.destroy
+    end
+
+    context "when query with null data" do
+      it { is_expected.to eq [] }
+    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 { is_expected.to eq [@place] }
+    end
+
+    context "when query for place within radius" do
+      let(:test_data) { { radius: 2400, lat: -27.5969039, lng: -48.5494544 } }
+      it { is_expected.to eq [@place] }
+    end
+
+    context "when query for place outside the radius" do
+      let(:test_data) { { radius: 0.62, lat: -27.5969039, lng: -48.5494544 } }
+      it { is_expected.to eq [] }
+    end
+
+    context "uses lat and long of through table" do
+      subject do
+        Job.within_radius(test_data[:radius], test_data[:lat], test_data[:lng])
+      end
+
+      before(:all) do
+        @event = Event.create!(lat: -30.0277041, lng: -51.2287346)
+        @job = Job.create!(event: @event)
+      end
+
+      after(:all) do
+        @event.destroy
+        @job.destroy
+      end
+
+      context "when query with null data" do
+        it { is_expected.to eq [] }
+      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 { is_expected.to eq [@job] }
+      end
+
+      context "when query for place within radius" do
+        let(:test_data) { { radius: 4_000_000, lat: -27.5969039, lng: -48.5494544 } }
+        it { is_expected.to eq [@job] }
+      end
+
+      context "when query for place outside the radius" do
+        let(:test_data) { { radius: 1000, lat: -27.5969039, lng: -48.5494544 } }
+        it { is_expected.to eq [] }
+      end
+    end
+  end
+
   describe "#order_by_distance" do
     let(:current_location) { { lat: nil, lng: nil, radius: nil } }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-postgres-earthdistance
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Diogo Biazus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-01 00:00:00.000000000 Z
+date: 2018-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -159,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Check distances with latitude and longitude using PostgreSQL special indexes