mongoid_geospatial 1.0.0rc0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,49 @@
+Gemfile.lock
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,11 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in mongoid_spacial.gemspec
+gemspec
+
+gem 'rgeo'
+
+group :development do
+  gem 'rspec'
+  gem 'fuubar'
+end

data/README.md

@@ -0,0 +1,330 @@
+Mongoid Geospatial
+==================
+
+A Mongoid Extention that simplifies and adds support for MongoDB and
+RGeo Spatial Calculations.
+
+Quick Start
+-----------
+Add mongoid_geospatial to your Gemfile:
+
+```ruby
+gem 'mongoid_geospatial'
+```
+
+Set up some slugs:
+
+```ruby
+class River
+  include Mongoid::Document
+  include Mongoid::Geospatial
+
+  field :name,              type: String
+  field :length,            type: Integer
+  field :average_discharge, type: Integer
+  field :source,            type: Point,    spatial: true
+
+  # set return_array to true if you do not want a hash returned all the time
+  field :mouth,             type: Point,    spatial: {lat: :latitude, lng: :longitude, return_array: true }
+  field :course,            type: Polygon
+
+  # simplified spatial indexing
+  # you can only index one point in mongodb version below 1.9
+  # if you want something besides the defaults {bit: 24, min: -180, max: 180} just set index to the options on the index
+  spatial_index :source
+
+end
+```
+
+Avaiable data types:
+
+* Point
+* LineString
+* Polygon
+
+
+Generate indexes on MongoDB:
+
+```
+rake db:mongoid:create_indexes
+```
+
+
+Before we manipulate the data mongoid_spatial handles is what we call points.
+
+Points can be:
+
+* an unordered hash with the lat long string keys defined when setting the field (only applies for setting the field)
+* longitude latitude array in that order - [long,lat]
+* an unordered hash with latitude key(:lat, :latitude) and a longitude key(:lon, :long, :lng, :longitude)
+* an ordered hash with longitude as the first item and latitude as the second item
+  This hash does not have include the latitude and longitude keys
+  \*only works in ruby 1.9 and up because hashes below ruby 1.9 because they are not ordered
+* anything with the method to_lng_lat that converts it to a [long,lat]
+We store data in the DB as a [lng,lat] array then reformat when it is returned to you
+
+```ruby
+hudson = River.create(
+  name: 'Hudson',
+  length: 315,
+  average_discharge: 21_400,
+  # when setting array LONGITUDE MUST BE FIRST LATITUDE MUST BE SECOND
+  # source: [-73.935833,44.106667],
+  # but we can use hash in any order,
+  # the default keys for latitude and longitude are :lat and :lng respectively
+  source: {:lat => 44.106667, :lng => -73.935833},
+  mouth: {:latitude => 40.703056, :longitude => -74.026667}
+)
+
+# now to access this spatial information we can now do this
+hudson.source #=> {:lng => -73.935833, :lat => 44.106667}
+hudson.mouth  #=> [-74.026667, 40.703056] # notice how this returned as a lng,lat array because return_array was true
+# notice how the order of lng and lat were switched. it will always come out like this when using spatial.
+# Also adds a handy distance function
+hudson.distance_from(:source, [-74,40], {:unit=>:mi})
+
+```
+Mongoid Geo has extended all built in spatial symbol extentions
+
+* near
+  * River.where(:source.near => [-73.98, 40.77])
+  * River.where(:source.near => [[-73.98, 40.77],5]) # sets max distance of 5
+  * River.where(:source.near => {:point => [-73.98, 40.77], :max => 5}) # sets max distance of 5
+  * River.where(:source.near(:sphere) => [[-73.98, 40.77],5]) # sets max distance of 5 radians
+  * River.where(:source.near(:sphere) => {:point => [-73.98, 40.77], :max => 5, :unit => :km}) # sets max distance of 5 km
+  * River.where(:source.near(:sphere) => [-73.98, 40.77])
+* within
+  * River.where(:source.within(:box) => [[-73.99756,40.73083], [-73.988135,40.741404]])
+  * River.where(:source.within(:box) => [ {:lat => 40.73083, :lng => -73.99756}, [-73.988135,40.741404]])
+  * River.where(:source.within(:polygon) => [ [ 10, 20 ], [ 10, 40 ], [ 30, 40 ], [ 30, 20 ] ]
+  * River.where(:source.within(:polygon) => { a : { x : 10, y : 20 }, b : { x : 15, y : 25 }, c : { x : 20, y : 20 } })
+  * River.where(:source.within(:center) => [[-73.98, 40.77],5])         # same format as near
+  * River.where(:source.within(:center_sphere) => [[-73.98, 40.77],5])  # same format as near(:sphere)
+
+One of the most handy features we have added is geo_near finder
+
+```ruby
+# accepts all criteria chains except without, only, asc, desc, order\_by
+River.where(:name=>'hudson').geo_near({:lat => 40.73083, :lng => -73.99756})
+
+# geo\_near accepts a few parameters besides a point
+# :num = limit
+# :query = where
+# :unit - [:km, :m, :mi, :ft] - converts :max\_distance to appropriate values and automatically sets :distance\_multiplier. accepts
+# :max\_distance - Integer
+# :distance\_multiplier - Integer
+# :spherical - true - To enable spherical calculations
+River.geo_near([-73.99756,40.73083], :max_distance => 4, :unit => :mi, :spherical => true)
+```
+
+There are two types of pagination!
+
+* MongoDB Pagination - Stores start of rows to page limit in memory
+* Post Query Pagination - Stores all rows in memory
+
+Post-Result is only minutely slower than MongoDB because MongoDB has to calculate distance for all of the rows anyway. The slow up is in the transfer of data from the database to ruby.
+
+Post-Result has some advantages that are listed below.
+
+```ruby
+# MongoDB pagination
+# overwrites #skip chain method
+# :page - pagination will be enabled if set to any variable including nil, pagination will not be enabled if either :per\_page or :paginator is set
+#   :per\_page
+#   :paginator - Choose which paginator to use. [default :arrary]
+#     Prefered method to set is Mongoid::Geospatial.paginator=:array
+#     Available Paginators [:kaminari, :will\_paginate, :array]
+#     The only thing this does really is configure default per\_page so it is only kind of useful
+River.geo_near([-73.99756,40.73083], :page => 1)
+```
+
+```ruby
+# Post Query Pagination
+# At carzen we use Post Query Pagination because we need to re-sort our rows after fetching. Pagination is not friendly with re-sorting.
+# You can jump pages continously without querying the database again.
+# listens to #limit/:num & #skip before geo\_near
+# #page(page\_number, opts = {})
+#  opts:
+#   :per\_page
+#   :paginator
+# #per(per\_page\_number, opts = {})
+#  opts:
+#   :page
+#   :paginator
+#
+# both return a GeoNearResults, which is really just a modified Array
+# #per really just #page but just moves the options around
+rivers = River.geo_near([-73.99756,40.73083]).sort_by!{|r| r.geo[:distance] * r.multiplier }
+rivers = rivers.per(25).page(1)
+rivers.reset! # resets the object to it is original state right after query.
+```
+
+Mongo DB 1.9+ New Geo features
+---------
+
+Multi-location Documents v.1.9+
+
+MongoDB now also supports indexing documents by multiple locations. These locations can be specified in arrays of sub-objects, for example:
+
+```
+> db.places.insert({ addresses : [ { name : "Home", loc : [55.5, 42.3] }, { name : "Work", loc : [32.3, 44.2] } ] })
+> db.places.ensureIndex({ "addresses.loc" : "2d" })
+```
+
+Multiple locations may also be specified in a single field:
+
+```
+> db.places.insert({ lastSeenAt : [ { x : 45.3, y : 32.2 }, [54.2, 32.3], { lon : 44.2, lat : 38.2 } ] })
+> db.places.ensureIndex({ "lastSeenAt" : "2d" })
+```
+
+By default, when performing geoNear or $near-type queries on collections containing multi-location documents, the same document may be returned multiple times, since $near queries return ordered results by distance. Queries using the $within operator by default do not return duplicate documents.
+
+  v2.0
+In v2.0, this default can be overridden by the use of a $uniqueDocs parameter for geoNear and $within queries, like so:
+
+```
+> db.runCommand( { geoNear : "places" , near : [50,50], num : 10, uniqueDocs : false } )
+> db.places.find( { loc : { $within : { $center : [[0.5, 0.5], 20], $uniqueDocs : true } } } )
+```
+
+  Currently it is not possible to specify $uniqueDocs for $near queries
+Whether or not uniqueDocs is true, when using a limit the limit is applied (as is normally the case) to the number of results returned (and not to the docs or locations).  If running a geoNear query with uniqueDocs : true, the closest location in a document to the center of the search region will always be returned - this is not true for $within queries.
+
+In addition, when using geoNear queries and multi-location documents, often it is useful to return not only distances, but also the location in the document which was used to generate the distance.  In v2.0, to return the location alongside the distance in the geoNear results (in the field loc), specify includeLocs : true in the geoNear query. The location returned will be a copy of the location in the document used.
+
+  If the location was an array, the location returned will be an object with "0" and "1" fields in v2.0.0 and v2.0.1.
+
+```
+> db.runCommand({ geoNear : "places", near : [ 0, 0 ], maxDistance : 20, includeLocs : true })
+{
+  "ns" : "test.places",
+  "near" : "1100000000000000000000000000000000000000000000000000",
+  "results" : [
+    {
+      "dis" : 5.830951894845301,
+      "loc" : {
+        "x" : 3,
+        "y" : 5
+      },
+      "obj" : {
+        "_id" : ObjectId("4e52672c15f59224bdb2544d"),
+        "name" : "Final Place",
+        "loc" : {
+          "x" : 3,
+          "y" : 5
+        }
+      }
+    },
+    {
+      "dis" : 14.142135623730951,
+      "loc" : {
+        "0" : 10,
+        "1" : 10
+      },
+      "obj" : {
+        "_id" : ObjectId("4e5266a915f59224bdb2544b"),
+        "name" : "Some Place",
+        "loc" : [
+          [
+            10,
+            10
+          ],
+          [
+            50,
+            50
+          ]
+        ]
+      }
+    },
+    {
+      "dis" : 14.142135623730951,
+      "loc" : {
+        "0" : -10,
+        "1" : -10
+      },
+      "obj" : {
+        "_id" : ObjectId("4e5266ba15f59224bdb2544c"),
+        "name" : "Another Place",
+        "loc" : [
+          [
+            -10,
+            -10
+          ],
+          [
+            -50,
+            -50
+          ]
+        ]
+      }
+    }
+  ],
+  "stats" : {
+    "time" : 0,
+    "btreelocs" : 0,
+    "nscanned" : 5,
+    "objectsLoaded" : 3,
+    "avgDistance" : 11.371741047435734,
+    "maxDistance" : 14.142157540259815
+  },
+  "ok" : 1
+}
+```
+
+The plan is to include this functionality in a future release. Please help out ;)
+
+This Fork
+---------
+
+This fork is not backwards compatible with 'mongoid_spatial'.
+This fork delegates all the calculation to the nice RGeo.
+As a result, all the GEOS/Proj features are available in Ruby/Mongoid.
+
+Change in your models:
+
+    include Mongoid::Spacial::Document
+
+to
+
+    include Mongoid::Geospatial
+
+
+And for the fields:
+
+
+    field :source,  type: Array,    spacial: true
+
+to
+
+    field :source,  type: Point,    spatial: true
+
+
+
+Troubleshooting
+---------------
+
+**Mongo::OperationFailure: can't find special index: 2d**
+
+Indexes need to be created. Execute command: <code>rake db:mongoid:create_indexes</code>
+
+
+Thanks
+-----------
+* Thanks to Kristian Mandrup for creating the base of the gem and a few of the tests
+* Thanks to CarZen LLC. for letting me release the code we are using
+
+Contributing to mongoid_spatial
+-----------
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+Copyright
+-----------
+Copyright (c) 2011 Ryan Ong. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,18 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'yard'
+

data/lib/mongoid_geospatial/contexts/mongo.rb

@@ -0,0 +1,115 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Contexts #:nodoc:
+    class Mongo #:nodoc:
+
+      # Fetches rows from the data base sorted by distance.
+      # In MongoDB versions 1.7 and above it returns a distance.
+      # Uses all criteria chains except without, only, asc, desc, order_by
+      #
+      # @example Minimal Query
+      #
+      #   Address.geo_near([70,40])
+      #
+      # @example Chained Query
+      #
+      #   Address.where(:state => 'ny').geo_near([70,40])
+      #
+      # @example Calc Distances Query
+      #
+      #   Address.geo_near([70,40], :max_distance => 5, :unit => 5)
+      #
+      # @param [ Array, Hash, #to_lng_lat ] center The center of where to calculate distance from
+      # @param [ Hash ] opts the options to query with
+      # @options opts [Integer] :num The number of rows to fetch
+      # @options opts [Hash] :query The query to filter the rows by, accepts
+      # @options opts [Numeric] :distance_multiplier this is multiplied against the calculated distance
+      # @options opts [Numeric] :max_distance The max distance of a row that should be returned in :unit(s)
+      # @options opts [Numeric, :km, :k, :mi, :ft] :unit automatically sets :distance_multiplier and converts :max_distance
+      # @options opts [true,false] :spherical Will determine the distance either by spherical calculation or flat calculation
+      # @options opts [TrueClass,Array<Symbol>] :calculate Which extra fields to calculate distance for in ruby, if set to TrueClass it will calculate all spatial fields
+      #
+      # @return [ Array ] Sorted Rows
+      def geo_near(center, opts = {})
+        opts = self.options.merge(opts)
+        # convert point
+        center = center.to_lng_lat if center.respond_to?(:to_lng_lat)
+        center = [center.x, center.y] if center.respond_to?(:x)
+
+        # set default opts
+        opts[:skip] ||= 0
+
+        if unit = Mongoid::Geospatial.earth_radius[opts[:unit]]
+          opts[:unit] = (opts[:spherical]) ? unit : unit * Mongoid::Geospatial::RAD_PER_DEG
+        end
+
+        if unit = Mongoid::Geospatial.earth_radius[opts[:distance_multiplier]]
+          opts[:distance_multiplier] = (opts[:spherical]) ? unit : unit * Mongoid::Geospatial::RAD_PER_DEG
+        end
+
+        opts[:distance_multiplier] = opts[:unit] if opts[:unit].kind_of?(Numeric)
+
+        # setup paging.
+        if opts.has_key?(:page)
+          opts[:page] ||= 1
+          opts[:paginator] ||= Mongoid::Geospatial.paginator()
+
+           if opts[:per_page].blank?
+             opts[:per_page] = case opts[:paginator]
+                              when :will_paginate
+                                @document.per_page
+                              when :kaminari
+                                Kaminari.config.default_per_page
+                              else
+                                Mongoid::Geospatial.default_per_page
+                              end
+             opts[:per_page] = opts[:per_page].to_i
+           end
+
+        end
+        opts[:query] = create_geo_near_query(center,opts)
+        results = klass.db.command(opts[:query])
+        Mongoid::Geospatial::GeoNearResults.new(klass,results,opts)
+      end
+
+      private
+
+      def create_geo_near_query(center,opts)
+        # minimum query
+        query = BSON::OrderedHash.new
+        query[:geoNear] = klass.collection_name
+        query[:near] = center
+
+        # create limit and use skip
+        if opts[:num]
+          query['num']         = opts[:skip].to_i + opts[:num].to_i
+        elsif opts[:limit]
+          query['num']         = opts[:skip].to_i + opts[:limit].to_i
+        elsif opts[:page]
+          query['num'] = opts[:skip].to_i + (opts[:page].to_i * opts[:per_page].to_i)
+        end
+
+        # allow the use of complex werieis
+        if opts[:query]
+          query['query']         = self.criteria.where(opts[:query]).selector
+        elsif self.selector != {}
+          query['query']         = self.selector
+        end
+
+        if opts[:max_distance]
+          query['maxDistance'] = opts[:max_distance].to_f
+          query['maxDistance'] = query['maxDistance']/opts[:unit].to_f if opts[:unit]
+        end
+
+        if klass.db.connection.server_version >= '1.7'
+          query['spherical']  = true if opts[:spherical]
+
+          # mongodb < 1.7 returns degrees but with earth flat. in Mongodb 1.7 you can set sphere and let mongodb calculate the distance in Miles or KM
+          # for mongodb < 1.7 we need to run Haversine first before calculating degrees to Km or Miles. See below.
+          query['distanceMultiplier'] = opts[:distance_multiplier].to_f if opts[:distance_multiplier]
+        end
+        query
+      end
+    end
+  end
+end

data/lib/mongoid_geospatial/criteria.rb

@@ -0,0 +1,5 @@
+module Mongoid #:nodoc:
+  class Criteria
+    delegate :geo_near, :to => :context 
+  end
+end

data/lib/mongoid_geospatial/criterion/complex.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Criterion #:nodoc:
+    # Complex criterion are used when performing operations on symbols to get
+    # get a shorthand syntax for where clauses.
+    #
+    # Example:
+    #
+    # <tt>{ :field => { "$lt" => "value" } }</tt>
+    # becomes:
+    # <tt> { :field.lt => "value }</tt>
+    class Complex
+
+      def to_mongo_query v
+        {"$#{operator}" => v}
+      end
+    end
+  end
+end

data/lib/mongoid_geospatial/criterion/inclusion.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Criterion #:nodoc:
+    module Inclusion
+      def near(attributes = {})
+        update_selector(attributes, "$near")
+      end
+
+      def near_sphere(attributes = {})
+        update_selector(attributes, "$near")
+      end
+    end
+  end
+end

data/lib/mongoid_geospatial/criterion/near_spatial.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Criterion #:nodoc:
+
+    # NearSpecial criterion is used when performing #near with symbols to get
+    # get a shorthand syntax for where clauses.
+    #
+    # @example Coninputersion of a simple to complex criterion.
+    #   { :field => { "$nearSphere" => => [20,30]}, '$maxDistance' => 5 }
+    #   becomes:
+    #   { :field.near(:sphere) => {:point => [20,30], :max => 5, :unit => :km} }
+    class NearSpatial < Complex
+
+      # Coninputert input to query for near or nearSphere
+      #
+      # @example
+      #   near = NearSpatial.new(:key => :field, :operator => "near")
+      #   near.to_mongo_query({:point => [:50,50], :max => 5, :unit => :km}) => { '$near : [50,50]' , '$maxDistance' : 5 }
+      #
+      # @param [Hash,Array] input input to coninputer to query
+      def to_mongo_query(input)
+        if input.kind_of?(Hash)
+          raise ':point required to make valid query' unless input[:point]
+          input[:point] = input[:point].to_lng_lat if input[:point].respond_to?(:to_lng_lat)
+          query = {"$#{operator}" => input[:point] }
+          if input[:max]
+            query['$maxDistance'] = input[:max].to_f
+
+            if unit = Mongoid::Geospatial.earth_radius[input[:unit]]
+              unit *= Mongoid::Geospatial::RAD_PER_DEG unless operator =~ /sphere/i
+              input[:unit] = unit
+            end
+
+            query['$maxDistance'] = query['$maxDistance']/input[:unit].to_f if input[:unit]
+          end
+          query
+        elsif input.kind_of? Array
+          if input.first.kind_of? Numeric
+            {"$#{operator}" => input }
+          else
+            input[0] = input[0].to_lng_lat if input[0].respond_to?(:to_lng_lat)
+            {"$#{operator}" => input[0], '$maxDistance' => input[1] }
+          end
+        end
+      end
+
+    end
+  end
+end
+

data/lib/mongoid_geospatial/criterion/within_spatial.rb

@@ -0,0 +1,60 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Criterion #:nodoc:
+
+    # WithinSpecial criterion is used when performing #within with symbols to get
+    # get a shorthand syntax for where clauses.
+    #
+    # @example Conversion of a simple to complex criterion.
+    #   { :field => { "$within" => {'$center' => [20,30]} } }
+    #   becomes:
+    #   { :field.within(:center) => [20,30] }
+    class WithinSpatial < Complex
+
+      # Convert input to query for box, polygon, center, and centerSphere
+      #
+      # @example
+      #   within = WithinSpatial.new(opts[:key] => 'point', :operator => 'center')
+      #   within.to_mongo_query({:point => [20,30], :max => 5, :unit => :km}) #=>
+      #
+      # @param [Hash,Array] input Variable to conver to query
+      def to_mongo_query(input)
+        if ['box','polygon'].index(@operator)
+          input = input.values if input.kind_of?(Hash)
+          if input.respond_to?(:map)
+            input.map!{ |v| (v.respond_to?(:to_lng_lat)) ? v.to_lng_lat : v }
+          else
+            input
+          end
+        elsif ['center','centerSphere'].index(@operator)
+
+          if input.kind_of?(Hash) || input.kind_of?(ActiveSupport::OrderedHash)
+            raise ':point required to make valid query' unless input[:point]
+            input[:point] = input[:point].to_lng_lat if input[:point].respond_to?(:to_lng_lat)
+            if input[:max]
+              input[:max] = input[:max].to_f
+
+              if unit = Mongoid::Geospatial.earth_radius[input[:unit]]
+                unit *= Mongoid::Geospatial::RAD_PER_DEG unless operator =~ /sphere/i
+                input[:unit] = unit
+              end
+
+              input[:max] = input[:max]/input[:unit].to_f if input[:unit]
+
+              input = [input[:point],input[:max]]
+            else
+              input = input[:point]
+            end
+          end
+
+          if input.kind_of? Array
+            input[0] = input[0].to_lng_lat if input[0].respond_to?(:to_lng_lat)
+          end
+
+        end
+        {'$within' => {"$#{@operator}"=>input} }
+      end
+    end
+  end
+end
+

data/lib/mongoid_geospatial/criterion.rb

@@ -0,0 +1,3 @@
+require 'mongoid_geospatial/criterion/complex'
+require 'mongoid_geospatial/criterion/near_spatial'
+require 'mongoid_geospatial/criterion/within_spatial'