mongoid-geospatial 4.0.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3610388899a7280b932823c0541ac28e1590bc4a
-  data.tar.gz: 884000ab8ac5263b1fde24db7d966e823f9fa554
+  metadata.gz: e35bbf5de066ee3347846c61de3a32f8f034705b
+  data.tar.gz: ff4828b80b77ef40b8f3e3a91c3831dcab387e03
 SHA512:
-  metadata.gz: cab14e04b4353673b88bafa569743546809c8f7d179f0272ccec68390dd03f6a98923a062ff749043d8ef66a810ad5db20d21d8acc07f10570d0b1b6b92abb5f
-  data.tar.gz: 519caf325d7896a2db2ef706c60e166f67b793a827c0fb2b56965527c6c388b6ffd1ae6364d9602c12fbebe984e74444fcfc60c19bcff0870796a66b65f8a837
+  metadata.gz: e5c121ff1e4869322186eebc97362209e08b704957cbd96d2b52d3588005e6f560bced4a287e2251a6e9e16f04d02765f4140222c65b042ac39d7ec20506c987
+  data.tar.gz: 7576483685a5c3969413e7584ebb82676261ad8b4ffe9758226ce2df17485e16f3e901c6488c35275ab8f92c50f75c4b915d37d4b4878040350e1799646b32cf

data/.travis.yml

@@ -23,3 +23,5 @@ matrix:
 
 services:
   - mongodb
+
+sudo: false

data/README.md

@@ -4,24 +4,19 @@ Mongoid Geospatial
 
 A Mongoid Extension that simplifies the use of MongoDB spatial features.
 
-** On beta again **
+* Version 5.x -> Mongoid 5
+* Version 4.x -> Mongoid 4
 
-Removing some trash, improving and adding support for RGeo and GeoRuby.
-Version 3+ is going to be beta testing, when it's ready I'll release v4,
-So the major version stays the same as mongoid.
-
-** Gem name: 'mongoid-geospatial' (notice the hyphen) **
-
-The name of this gem has changed.
+** Gem name has changed: 'mongoid-geospatial' (notice the hyphen) **
 Please change the underscore to a hyphen.
-If you need to: require 'mongoid/geospatial'
-
+That will require it correctly within bundler:
+`require 'mongoid/geospatial'`
 
-[![Gem Version](https://badge.fury.io/rb/mongoid-geospatial.png)](http://badge.fury.io/rb/mongoid-geospatial)
-[![Code Climate](https://codeclimate.com/github/nofxx/mongoid-geospatial.png)](https://codeclimate.com/github/nofxx/mongoid-geospatial)
-[![Coverage Status](https://coveralls.io/repos/nofxx/mongoid-geospatial/badge.png)](https://coveralls.io/r/nofxx/mongoid-geospatial)
+[![Gem Version](https://badge.fury.io/rb/mongoid-geospatial.svg)](http://badge.fury.io/rb/mongoid-geospatial)
+[![Code Climate](https://codeclimate.com/github/nofxx/mongoid-geospatial.svg)](https://codeclimate.com/github/nofxx/mongoid-geospatial)
+[![Coverage Status](https://coveralls.io/repos/nofxx/mongoid-geospatial/badge.svg?branch=master)](https://coveralls.io/r/nofxx/mongoid-geospatial?branch=master)
 [![Dependency Status](https://gemnasium.com/nofxx/mongoid-geospatial.svg)](https://gemnasium.com/nofxx/mongoid-geospatial)
-[![Build Status](https://travis-ci.org/nofxx/mongoid-geospatial.png?branch=master)](https://travis-ci.org/nofxx/mongoid-geospatial)
+[![Build Status](https://travis-ci.org/nofxx/mongoid-geospatial.svg?branch=master)](https://travis-ci.org/nofxx/mongoid-geospatial)
 
 
 Quick Start
@@ -34,7 +29,7 @@ But you may also use an external Geometric/Spatial gem alongside.
     gem 'mongoid-geospatial'
 
 
-A place to illustrate Point, Line and Polygon
+A `Place` to illustrate `Point`, `Line` and `Polygon`
 
     class Place
       include Mongoid::Document
@@ -50,23 +45,19 @@ A place to illustrate Point, Line and Polygon
       field :route,    type: Linestring
       field :area,     type: Polygon
 
-      # If your are going to query on your points, don't forget to index:
-      spatial_index :location
+      # To query on your points, don't forget to index:
+      # You may use a method:
+      sphere_index :location  # 2d
+      # or
+      spatial_index :location # 2dsphere
 
-      # Or you can index points with 'spatial: true' option too:
-      field :location, type: Point, spatial: true
+      # Or use a helper directly on the `field`:
+      field :location, type: Point, spatial: true  # 2d
+      # or
+      field :location, type: Point, sphere: true   # 2dsphere
     end
 
 
-For geo points, an extra macro `geo_field` is available
-
-      geo_field :location
-
-Will generate:
-
-      field :location, type: Point, spatial: true
-
-
 
 Generate indexes on MongoDB via rake:
 
@@ -81,7 +72,6 @@ Or programatically:
 
 
 
-
 Points
 ------
 
@@ -149,119 +139,6 @@ And for polygons and lines:
     house.area.center  # Returns calculate middle point
 
 
-Query
------
-
-Before you read about this gem have sure you read this:
-
-http://mongoid.org/en/origin/docs/selection.html#standard
-
-All MongoDB queries are handled by Mongoid.
-
-
-You can use Geometry instance directly on any query:
-
-* near
-  * Bar.near(location: person.house)
-  * Bar.where(:location.near => person.house)
-
-
-* near_sphere
-  * Bar.near_sphere(location: person.house)
-  * Bar.where(:location.near_sphere => person.house)
-
-
-### Not supported (until Mongoid 5.0.0)
-Those have been dropped from moped, should return on mongoid 5.
-Sad story.
-
-* within_box
-  * Bar.within_box(location: hood.area)
-
-
-* within_circle
-  * Bar.within_circle(location: hood.area)
-
-
-* within_circle_sphere
-  * Bar.within_circle_sphere(location: hood.area)
-
-
-* within_polygon
-  * Bar.within_polygon(location: city.area)
-
-
-
-External Libraries
-------------------
-
-Use RGeo?
-https://github.com/dazuma/rgeo
-
-RGeo is a Ruby wrapper for Proj/GEOS.
-It's perfect when you need to work with complex calculations and projections.
-It'll require more stuff installed to compile/work.
-
-
-Use GeoRuby?
-https://github.com/nofxx/georuby
-
-GeoRuby is a pure Ruby Geometry Library.
-It's perfect if you want simple calculations and/or keep your stack in pure ruby.
-Albeit not full featured in maths it has a handful of methods and good import/export helpers.
-
-
-
-Geometry Helpers
-----------------
-
-We currently support GeoRuby and RGeo.
-If you require one of those, a #to_geo and #to_rgeo, respectivelly,
-method(s) will be available to all spatial fields, returning the
-external library corresponding object.
-
-To illustrate:
-
-    class Person
-      include Mongoid::Document
-      include Mongoid::Geospatial
-
-      field :location, type: Point
-    end
-
-    me = Person.new(location: [8, 8])
-
-    # Example with GeoRuby
-    point.class # Mongoid::Geospatial::Point
-    point.to_geo.class # GeoRuby::SimpleFeatures::Point
-
-    # Example with RGeo
-    point.class # Mongoid::Geospatial::Point
-    point.to_rgeo.class # RGeo::Geographic::SphericalPointImpl
-
-
-Configure
----------
-
-Assemble it as you need (use a initializer file):
-
-With RGeo
-
-    Mongoid::Geospatial.with_rgeo!
-    # Optional
-    # Mongoid::Geospatial.factory = RGeo::Geographic.spherical_factory
-
-
-With GeoRuby
-
-    Mongoid::Geospatial.with_georuby!
-
-
-Defaults (change if you know what you're doing)
-
-    Mongoid::Geospatial.lng_symbol = :x
-    Mongoid::Geospatial.lat_symbol = :y
-    Mongoid::Geospatial.earth_radius = EARTH_RADIUS
 
 
 
@@ -294,13 +171,20 @@ You can create Point, Line, Circle, Box and Polygon on your models:
 Helpers
 -------
 
-You can use `spatial: true` to add an '2d' index automatically,
+You can use `spatial: true` to add a '2d' index automatically,
 No need for `spatial_index :location`:
 
 
     field :location,  type: Point, spatial: true
 
 
+And you can use `sphere: true` to add a '2dsphere' index automatically,
+No need for `spatial_sphere :location`:
+
+
+    field :location,  type: Point, sphere: true
+
+
 You can delegate some point methods to the instance itself:
 
 
@@ -335,7 +219,7 @@ Some helper methods are available to them:
 
 
     # Returns a geometry bounding box
-    # Useful to query #within_box
+    # Useful to query #within_geometry
     polygon.bbox
     polygon.bounding_box
 
@@ -349,127 +233,123 @@ Some helper methods are available to them:
     polygon.radius_sphere(5) # [[1.0, 1.0], 0.00048..]
 
 
+Query
+-----
 
+Before you read about this gem have sure you read this:
 
-Mongo DB 1.9+ New Geo features
----------
+http://mongoid.org/en/origin/docs/selection.html#standard
 
-Multi-location Documents v.1.9+
+All MongoDB queries are handled by Mongoid/Origin.
+
+http://www.rubydoc.info/github/mongoid/origin/Origin/Selectable
+
+You can use Geometry instance directly on any query:
+
+* near
 
-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" })
+Bar.near(location: person.house)
+Bar.where(:location.near => person.house)
 ```
 
-Multiple locations may also be specified in a single field:
+* near_sphere
 
 ```
-> 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" })
+Bar.near_sphere(location: person.house)
+Bar.where(:location.near_sphere => person.house)
 ```
 
-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:
+* within_polygon
 
 ```
-> db.runCommand( { geoNear : "places" , near : [50,50], num : 10, uniqueDocs : false } )
-> db.places.find( { loc : { $within : { $center : [[0.5, 0.5], 20], $uniqueDocs : true } } } )
+Bar.within_polygon(location: [[[x,y],...[x,y]]])
+# or with a bbox
+Bar.within_polygon(location: street.bbox)
 ```
 
-  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.
+* intersects_line
+* intersects_point
+* intersects_polygon
 
-  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 ;)
+External Libraries
+------------------
+
+We currently support GeoRuby and RGeo.
+If you require one of those, a #to_geo and #to_rgeo, respectivelly,
+method(s) will be available to all spatial fields, returning the
+external library corresponding object.
+
+
+### Use RGeo?
+https://github.com/dazuma/rgeo
+
+RGeo is a Ruby wrapper for Proj/GEOS.
+It's perfect when you need to work with complex calculations and projections.
+It'll require more stuff installed to compile/work.
+
+
+### Use GeoRuby?
+https://github.com/nofxx/georuby
+
+GeoRuby is a pure Ruby Geometry Library.
+It's perfect if you want simple calculations and/or keep your stack in pure ruby.
+Albeit not full featured in maths it has a handful of methods and good import/export helpers.
+
+
+### Example
+
+    class Person
+      include Mongoid::Document
+      include Mongoid::Geospatial
+
+      field :location, type: Point
+    end
+
+    me = Person.new(location: [8, 8])
+
+    # Example with GeoRuby
+    point.class # Mongoid::Geospatial::Point
+    point.to_geo.class # GeoRuby::SimpleFeatures::Point
+
+    # Example with RGeo
+    point.class # Mongoid::Geospatial::Point
+    point.to_rgeo.class # RGeo::Geographic::SphericalPointImpl
+
+
+## Configure
+
+Assemble it as you need (use a initializer file):
+
+With RGeo
+
+    Mongoid::Geospatial.with_rgeo!
+    # Optional
+    # Mongoid::Geospatial.factory = RGeo::Geographic.spherical_factory
+
+
+With GeoRuby
+
+    Mongoid::Geospatial.with_georuby!
+
+
+Defaults (change if you know what you're doing)
+
+    Mongoid::Geospatial.lng_symbol = :x
+    Mongoid::Geospatial.lat_symbol = :y
+    Mongoid::Geospatial.earth_radius = EARTH_RADIUS
+
+
 
 This Fork
 ---------
 
-This fork is not backwards compatible with 'mongoid_spatial'.
-This fork delegates calculations to the external libs and use Moped.
+This fork is not backwards compatible with 'mongoid_spacial'.
+This fork delegates calculations to external libs.
 
 Change in your models:
 
@@ -487,7 +367,7 @@ And for the fields:
 
 to
 
-    field :source,  type: Point,    spatial: true
+    field :source,  type: Point,    spatial: true # or sphere: true
 
 
 Beware the 't' and 'c' issue. It's spaTial.
@@ -503,6 +383,10 @@ Indexes need to be created. Execute command:
 
     rake db:mongoid:create_indexes
 
+Programatically
+
+    Model.create_indexes
+
 
 Contributing
 ------------