active_record_nearest_neighbor 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4a6cebd11a459d5e5ac39cd785dad61430819e4a
+  data.tar.gz: de4ed564bed54ed3d4c9cb02db44fddc6eb9a70b
+SHA512:
+  metadata.gz: 53bf4f5226b2459420157f9aabbd59bf251c1f23d1c13c1efdbb98e8915ba5db9c8c9de7c9ddc103eced0339628364040915b0b1e152682ebd903ce51b0c1c91
+  data.tar.gz: 95de3884ee094bf09565b180c9ccb52b7dbaf34666473ce7692d420b59a834388d5f5d9e8f26da82d21f3ee6fd8be1b938ad2f69e5a3108937b0b6803fca0978

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Andrew Hautau
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,21 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActiveRecordNearestNeighbor'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/active_record_nearest_neighbor.rb

@@ -0,0 +1,36 @@
+require 'active_support'
+require 'active_record'
+require 'active_record_nearest_neighbor/railtie' if defined?(Rails)
+
+class ActiveRecord::Base
+
+  module NearestNeighbor
+
+    require 'active_record_nearest_neighbor/scopes'
+    require 'active_record_nearest_neighbor/close_to'
+
+    extend ActiveSupport::Concern
+
+    included do
+
+      # ensure the lonlat attribute
+      before_save :set_lonlat!
+
+    end
+
+    module ClassMethods
+      extend ActiveSupport::Concern
+      
+      include Scopes
+      include CloseTo
+
+    end
+
+    private
+
+    def set_lonlat!
+      self.lonlat = "POINT(#{self.longitude} #{self.latitude})"
+    end
+    
+  end
+end

data/lib/active_record_nearest_neighbor/close_to.rb

@@ -0,0 +1,36 @@
+module ActiveRecord::Base::NearestNeighbor::CloseTo
+
+  def close_to(longitude_or_object, longitude_or_latitude_or_options={}, options={})
+    scope_method = :bounding_box
+    scope_params = {}
+
+    if longitude_or_object.class.ancestors.include?(ActiveRecord::Base)  
+      # We are using an object as the point reference
+      object = longitude_or_object
+      options = longitude_or_latitude_or_options
+
+      scope_method = options[:method] || scope_method
+      scope_params = {id: options[:id], distance: options[:distance], limit: options[:limit]}.
+      merge(longitude: object.longitude, latitude: object.latitude, id: object.id)
+    else
+      # We are using longitude and latitude
+      longitude = longitude_or_object
+      latitude = longitude_or_latitude_or_options
+
+      scope_method = options[:method] || scope_method
+
+      scope_params = {id: options[:id], distance: options[:distance], limit: options[:limit]}.
+      merge(longitude: longitude, latitude: latitude)
+    end
+
+    close_to_with_scope(scope_method, scope_params)
+  end
+
+  private
+
+  def close_to_with_scope(scope_method, params={})
+    scope = "#{scope_method}_close_to".to_sym
+    self.send(scope,params) 
+  end
+
+end

data/lib/active_record_nearest_neighbor/railtie.rb

@@ -0,0 +1,17 @@
+require 'active_record/connection_adapters/postgis_adapter'
+
+module ActiveRecordNearestNeighbor
+
+  class Railtie < Rails::Railtie
+
+    rake_tasks do
+      load 'tasks/active_record_nearest_neighbor_tasks.rake'
+      load 'active_record/connection_adapters/postgis_adapter/databases.rake'
+    end
+
+  end
+
+
+
+end
+

data/lib/active_record_nearest_neighbor/scopes.rb

@@ -0,0 +1,51 @@
+module ActiveRecord::Base::NearestNeighbor::Scopes
+
+  def bounding_box_close_to(params)
+    latitude = params[:latitude]
+    longitude = params[:longitude]
+    limit = params[:limit]
+
+    # default of 10km
+    distance = params[:distance] || 10000
+
+    # If we have an object id, don't include the object in results
+    not_id_subclause = params[:id] ? "id != #{params[:id]}" : ''
+
+    where(%{ST_DWithin(points.lonlat, ST_GeographyFromText('SRID=4326;POINT(#{longitude} #{latitude})')::geometry, #{distance})}).
+      where(not_id_subclause).
+    order(%{ST_Distance(
+      #{table_name}.lonlat,
+      ST_GeographyFromText('SRID=4326;POINT(#{longitude} #{latitude})')::geometry
+    )}).
+    limit(params[:limit])
+  end
+
+  def k_nearest_neighbor_close_to(params)
+    longitude = params[:longitude]
+    latitude = params[:latitude]
+    limit = params[:limit]  || 'NULL'
+    # If we have an object id, don't include the object in results
+    not_id_subclause = params[:id] ? "WHERE(id != #{params[:id]})" : ''
+
+    find_by_sql(
+       %{WITH closest_candidates AS (
+          SELECT "#{table_name}".* FROM "#{table_name}"
+          #{not_id_subclause}
+          ORDER BY
+            #{table_name}.lonlat::geometry <->
+            ST_GeographyFromText('SRID=4326;POINT(#{longitude} #{latitude})')::geometry
+        )
+        SELECT *
+        FROM closest_candidates
+        ORDER BY
+          ST_Distance(
+            closest_candidates.lonlat,
+            ST_GeographyFromText('SRID=4326;POINT(#{longitude} #{latitude})')::geometry
+          )
+        LIMIT #{limit};} 
+    )
+  end
+
+
+end
+

data/lib/active_record_nearest_neighbor/version.rb

@@ -0,0 +1,3 @@
+module ActiveRecordNearestNeighbor
+  VERSION = "0.1.3"
+end

data/lib/tasks/active_record_nearest_neighbor_tasks.rake

@@ -0,0 +1,48 @@
+require 'pry'
+
+namespace :nearest_neighbor do
+  desc "Create a new table with latitude, longitude, lonlat (point type), and a spatial index for lonlat" 
+  task :create, [:table_name] do |task, args|
+    timestamp  = Time.now.strftime("%Y%m%d%H%M%S")
+    table_name = args[:table_name]
+    class_name = table_name.split("_").map(&:capitalize).join
+    migration = 
+%{class Create#{class_name} < ActiveRecord::Migration
+  def change
+    create_table :#{table_name} do |t|
+      t.decimal :latitude,  precision: 9, scale: 6, null: false
+      t.decimal :longitude, precision: 9, scale: 6, null: false
+      t.point :lonlat, :geographic => true
+      t.index :lonlat, :spatial => true
+    end
+  end
+end}
+    file_name = "./db/migrate/#{timestamp}_create_#{table_name}.rb"
+    file = File.open(file_name,"w+")
+    file.write(migration)
+    file.close
+    puts "generated migration: #{file_name}"
+  end
+
+  desc "Add columns to existing table: latitude, longitude, lonlat (point type), and a spatial index for lonlat" 
+  task :add_columns, [:table_name] do |task, args|
+    timestamp  = Time.now.strftime("%Y%m%d%H%M%S")
+    table_name = args[:table_name]
+    class_name = table_name.split("_").map(&:capitalize).join
+    migration = 
+%{class AddGeospatialColumnsTo#{class_name} < ActiveRecord::Migration
+  def change
+    add_column :#{table_name}, :latitude, :decimal, precision: 9, scale: 6, null: false
+    add_column :#{table_name}, :longitude, :decimal, precision: 9, scale: 6, null: false
+    add_column :#{table_name}, :lonlat, :point, geographic: true
+    add_index :#{table_name}, :lonlat, spatial: true
+  end
+end}
+    file_name = "db/migrate/#{timestamp}_add_geospatial_columns_to_#{table_name}.rb"
+    file = File.open(file_name,"w+")
+    file.write(migration)
+    file.close
+    puts "generated migration: #{file_name}"
+  end
+
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: active_record_nearest_neighbor
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Andrew Hautau
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: activerecord-postgis-adapter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ActiveRecordNearestNeighbor adds methods to your ActiveRecord models
+  to perform nearest neighbor searches, using different algorithms. The plugin also
+  provides a rake task for generating migrations to add geospatial columns and indexes
+  to your models.
+email:
+- arhautau@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- lib/active_record_nearest_neighbor.rb
+- lib/active_record_nearest_neighbor/close_to.rb
+- lib/active_record_nearest_neighbor/railtie.rb
+- lib/active_record_nearest_neighbor/scopes.rb
+- lib/active_record_nearest_neighbor/version.rb
+- lib/tasks/active_record_nearest_neighbor_tasks.rake
+homepage: https://github.com/CrossTheStreams/active_record_nearest_neighbor
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A Rails/ActiveRecord plugin to easily add nearest neighbor geospatial queries
+  with PostGIS and PostgreSQL.
+test_files: []
+has_rdoc: