activerecord-postgres-earthdistance 0.5.2 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 94eb40debf0a4955024e1c8c4213b88530b294b1
-  data.tar.gz: ec0ec0eb7d2472ebe8bad60197bbf0a7b45f1d36
+SHA256:
+  metadata.gz: 14b64ce9adeedc19f81dcd2c359b11535643f2d40654dbb8577e3cde19246c5a
+  data.tar.gz: 146a8b1d02d23c2e53e12b26e7c97beff80a2adc4cdc8ffff677fbba77378c1a
 SHA512:
-  metadata.gz: c9818e3e89ae5b0906c30fa097b26eb7445541541dbce5b31e633641f13d8a1ba797c500f4e420b0b6fad88315914e35c345971540043626ef1d1b589f5ecc35
-  data.tar.gz: b6dfb3232de9828d812589a01a4f199ee36af6dbdda53064373253e5000370982465eec956f122e9efcdb3fdb9029f1c24e3e5cc820653146d01f56208ae5384
+  metadata.gz: e69b871105d854bae2e6b3595960af66970ca28451e85c664348b8802302db0cbb2b3f44047b302e181844d7da229522a800e533849698a51220794a717d8ad3
+  data.tar.gz: 599d73218999e4e6656b95ff2dacc7014e58d1afebb0d4e669a35aec584c43e101ad6e5593df8675523ac346f4887f67f0064c77a991b520d5e402b2a95b449c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    activerecord-postgres-earthdistance (0.5.2)
+    activerecord-postgres-earthdistance (0.7.1)
       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.2.1.1)
+      activesupport (= 5.2.1.1)
+    activerecord (5.2.1.1)
+      activemodel (= 5.2.1.1)
+      activesupport (= 5.2.1.1)
+      arel (>= 9.0)
+    activesupport (5.2.1.1)
       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 (9.0.0)
     coderay (1.1.1)
-    concurrent-ruby (1.0.5)
+    concurrent-ruby (1.1.3)
     diff-lcs (1.3)
-    i18n (0.8.1)
+    i18n (1.1.1)
+      concurrent-ruby (~> 1.0)
     method_source (0.8.2)
-    minitest (5.10.1)
-    pg (0.20.0)
+    minitest (5.11.3)
+    pg (1.1.3)
     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.3

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.7.2"
 
   s.platform    = Gem::Platform::RUBY
   s.license     = "MIT"

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

@@ -1,17 +1,29 @@
 module ActiveRecordPostgresEarthdistance
+  MILES_TO_METERS_FACTOR = 1609.344
   module ActsAsGeolocated
     extend ActiveSupport::Concern
+    
 
-    module ClassMethods
+    module ClassMethods  
       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]
+        begin
+          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
+        rescue PG::ConnectionBad
+        end
       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 +39,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)))
@@ -34,7 +47,7 @@ module ActiveRecordPostgresEarthdistance
 
       def order_by_distance(lat, lng, order = "ASC")
         earth_distance = Utils.earth_distance(through_table_klass, lat, lng)
-        joins(through_table).order("#{earth_distance.to_sql} #{order}")
+        joins(through_table).order(Arel.sql("#{earth_distance.to_sql} #{order}"))
       end
 
       def through_table_klass
@@ -87,7 +100,12 @@ module ActiveRecordPostgresEarthdistance
         if relation.select_values.empty? && include_default_columns
           values << relation.arel_table[Arel.star]
         end
-        values << Utils.earth_distance(through_table_klass, lat, lng, name)
+        distances = Utils.earth_distance(through_table_klass, lat, lng, name)
+        distances = Arel::Nodes::Multiplication.new(
+          Utils.quote_value(1 / MILES_TO_METERS_FACTOR), distances
+        ) if relation.distance_unit === :miles
+
+        values << distances
 
         relation.select_values = values
       end

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

@@ -32,7 +32,19 @@ class EarthDistance < Rails::Railtie
     end
 
     def create_migration_file
-      migration_template "setup_earthdistance.rb", "db/migrate/setup_earthdistance.rb"
+      migration_template "setup_earthdistance.rb", "db/migrate/setup_earthdistance.rb", migration_version: migration_version
+    end
+
+    private
+
+    def requires_migration_version?
+      Rails::VERSION::MAJOR >= 5
+    end
+
+    def migration_version
+      if requires_migration_version?
+        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+      end
     end
   end
 end

data/lib/templates/setup_earthdistance.rb

@@ -1,4 +1,4 @@
-class SetupEarthdistance < ActiveRecord::Migration
+class SetupEarthdistance < ActiveRecord::Migration<%= migration_version %>
   def self.up
     execute "CREATE EXTENSION IF NOT EXISTS cube"
     execute "CREATE EXTENSION IF NOT EXISTS earthdistance"

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 } }
 
@@ -221,4 +358,46 @@ describe "ActiveRecord::Base.act_as_geolocated" do
       end
     end
   end
+
+  describe "#selecting_distance_from with miles" 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.acts_as_geolocated distance_unit: :miles
+      @place = Place.create!(data: "Amsterdam", lat: 52.370216, lng: 4.895168) # Amsterdam
+    end
+    after(:all) do
+      Place.acts_as_geolocated
+      @place.destroy
+    end
+    context "when selecting distance" do
+      let(:current_location) { { lat: 52.229676, lng: 21.012229 } } # Warsaw
+      it { is_expected.to eq ["Amsterdam", 680.410076641856] }
+    end
+
+    context "through table" do
+
+      subject { Job.all.selecting_distance_from(current_location[:lat], current_location[:lng]).first }
+
+      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 selecting distance" do
+        it { is_expected.to respond_to :distance }
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-postgres-earthdistance
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.7.2
 platform: ruby
 authors:
 - Diogo Biazus
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-04-01 00:00:00.000000000 Z
+date: 2021-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -143,7 +143,7 @@ homepage: http://github.com/diogob/activerecord-postgres-earthdistance
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -158,14 +158,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Check distances with latitude and longitude using PostgreSQL special indexes
-test_files:
-- spec/act_as_geolocated_spec.rb
-- spec/fixtures/event.rb
-- spec/fixtures/job.rb
-- spec/fixtures/place.rb
-- spec/spec_helper.rb
+test_files: []