mongoid-geospatial 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e35bbf5de066ee3347846c61de3a32f8f034705b
-  data.tar.gz: ff4828b80b77ef40b8f3e3a91c3831dcab387e03
+SHA256:
+  metadata.gz: 6c947554ea1c07198ca1c8b7c649ed93464fd1a08c6c71a2b2752e826344f049
+  data.tar.gz: 49d2636d235a0b91671564db6807241a4600d40070089e3d2729dd598151b2d2
 SHA512:
-  metadata.gz: e5c121ff1e4869322186eebc97362209e08b704957cbd96d2b52d3588005e6f560bced4a287e2251a6e9e16f04d02765f4140222c65b042ac39d7ec20506c987
-  data.tar.gz: 7576483685a5c3969413e7584ebb82676261ad8b4ffe9758226ce2df17485e16f3e901c6488c35275ab8f92c50f75c4b915d37d4b4878040350e1799646b32cf
+  metadata.gz: 8da975f59a71106fc991043f1438f5c7c910e1e7c2cc78f7e112062bee9fc34a966ecf80a39ec423230805aa6756f0c01e5882085fb5e701618b0ec7d4d6b6f5
+  data.tar.gz: 8c8c89eec0397d1a0e3bcae04ca972ef5b3aa82094d76b4b060c53c2bb6dbc4eb058bc80cfb0d9c5b5fbb7b217aaed973212b98193247c3cfe079fb5de67a489

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  Exclude:
+    - vendor/**/*
+    - bin/**/*
+
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,93 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-11-09 16:09:41 -0500 using RuboCop version 0.60.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 4
+# Configuration parameters: Include.
+# Include: **/*.gemfile, **/Gemfile, **/gems.rb
+Bundler/DuplicatedGem:
+  Exclude:
+    - 'Gemfile'
+
+# Offense count: 2
+Lint/DuplicateMethods:
+  Exclude:
+    - 'lib/mongoid/geospatial/fields/circle.rb'
+
+# Offense count: 3
+Metrics/AbcSize:
+  Max: 22
+
+# Offense count: 21
+# Configuration parameters: CountComments, ExcludedMethods.
+# ExcludedMethods: refine
+Metrics/BlockLength:
+  Max: 216
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+# Offense count: 1
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 11
+
+# Offense count: 1
+Naming/AccessorMethodName:
+  Exclude:
+    - 'spec/models/address.rb'
+
+# Offense count: 9
+# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
+# AllowedNames: io, id, to, by, on, in, at, ip, db
+Naming/UncommunicativeMethodParamName:
+  Exclude:
+    - 'lib/mongoid/geospatial/fields/point.rb'
+    - 'lib/mongoid/geospatial/geometry_field.rb'
+
+# Offense count: 3
+Style/ClassVars:
+  Exclude:
+    - 'lib/mongoid/geospatial.rb'
+
+# Offense count: 4
+Style/CommentedKeyword:
+  Exclude:
+    - 'lib/mongoid/geospatial/fields/point.rb'
+
+# Offense count: 6
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'bench/bench'
+    - 'lib/mongoid/geospatial/config.rb'
+    - 'lib/mongoid/geospatial/config/point.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: module_function, extend_self
+Style/ModuleFunction:
+  Exclude:
+    - 'lib/mongoid/geospatial/config.rb'
+    - 'lib/mongoid/geospatial/config/point.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, AllowInnerSlashes.
+# SupportedStyles: slashes, percent_r, mixed
+Style/RegexpLiteral:
+  Exclude:
+    - 'Guardfile'
+
+# Offense count: 15
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 113

data/.travis.yml

@@ -1,27 +1,33 @@
+sudo: false
+
 language: ruby
-bundler_args: --without development
+
+cache: bundler
+
+services: mongodb
+
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-  - 2.2.0
-  - ruby-head
-  - jruby
-  - jruby-head
-  - rbx-2
+  - 2.5.3
 
-jdk:
-  - oraclejdk7
-  - openjdk7
+before_install:
+  - gem update bundler
 
-env: CI="travis" JRUBY_OPTS="--server -Xcompile.invokedynamic=false -J-XX:+TieredCompilation -J-XX:TieredStopAtLevel=1 -J-noverify -J-Xms512m -J-Xmx1024m"
+before_script:
+  - bundle exec danger
 
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head
+addons:
+  apt:
+    sources:
+      - mongodb-3.2-precise
+    packages:
+      - mongodb-org-server
 
-services:
-  - mongodb
+env:
+  - MONGOID_VERSION=5
+  - MONGOID_VERSION=6
+  - MONGOID_VERSION=7
+  - MONGOID_VERSION=HEAD
 
-sudo: false
+matrix:
+  allow_failures:
+    - env: MONGOID_VERSION=HEAD

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+## 5.1.0 (2018/11/09)
+
+* [#61](https://github.com/mongoid/mongoid-geospatial/pull/64): Add global configuration for switching between LngLat and LatLng - [@dblock](https://github.com/dblock).
+* [#59](https://github.com/mongoid/mongoid-geospatial/pull/59), [#65](https://github.com/mongoid/mongoid-geospatial/pull/65): Test against Mongoid 5, 6 and 7 - [@dblock](https://github.com/dblock).
+* [#52](https://github.com/mongoid/mongoid-geospatial/pull/52), [#70](https://github.com/mongoid/mongoid-geospatial/pull/70): Added Danger and Rubocop, PR and code linters - [@dblock](https://github.com/dblock).
+
+## 5.0.0 (2015/07/23)
+
+* Mongoid 5 support - [@nofxx](https://github.com/nofxx).
+
+## 4.0.1 (2015/03/04)
+
+## 4.0.0 (2015/01/11)
+
+* Mongoid 4 support - [@nofxx](https://github.com/nofxx).
+
+## 3.9.0 (2014/12/22)
+
+* Initial public release - [@nofxx](https://github.com/nofxx).

data/CONTRIBUTING.md

@@ -0,0 +1,118 @@
+Contributing to Mongoid::Geospatial
+===================================
+
+Mongoid::Geospatial is work of [many of contributors](https://github.com/mongoid/mongoid-geospatial/graphs/contributors). You're encouraged to submit [pull requests](https://github.com/mongoid/mongoid-geospatial/pulls), [propose features, ask questions and discuss issues](https://github.com/mongoid/mongoid-geospatial/issues).
+
+#### Fork the Project
+
+Fork the [project on Github](https://github.com/mongoid/mongoid-geospatial) and check out your copy.
+
+```
+git clone https://github.com/contributor/mongoid-geospatial.git
+cd mongoid-geospatial
+git remote add upstream https://github.com/mongoid/mongoid-geospatial.git
+```
+
+#### Create a Topic Branch
+
+Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
+
+```
+git checkout master
+git pull upstream master
+git checkout -b my-feature-branch
+```
+
+#### Bundle Install and Test
+
+Ensure that you can build the project and run tests.
+
+```
+bundle install
+bundle exec rake
+```
+
+#### Write Tests
+
+Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build. Add to [spec/mongoid-geospatial](spec/mongoid-geospatial).
+
+We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
+
+#### Write Code
+
+Implement your feature or bug fix.
+
+Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop), run `bundle exec rubocop` and fix any style issues highlighted.
+
+Make sure that `bundle exec rake` completes without errors.
+
+#### Write Documentation
+
+Document any external behavior in the [README](README.md).
+
+#### Update Changelog
+
+Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*. Make it look like every other line, including your name and link to your Github account.
+
+#### Commit Changes
+
+Make sure git knows your name and email address:
+
+```
+git config --global user.name "Your Name"
+git config --global user.email "contributor@example.com"
+```
+
+Writing good commit logs is important. A commit log should describe what changed and why.
+
+```
+git add ...
+git commit
+```
+
+#### Push
+
+```
+git push origin my-feature-branch
+```
+
+#### Make a Pull Request
+
+Go to https://github.com/contributor/mongoid-geospatial and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
+
+#### Rebase
+
+If you've been working on a change for a while, rebase with upstream/master.
+
+```
+git fetch upstream
+git rebase upstream/master
+git push origin my-feature-branch -f
+```
+
+#### Update CHANGELOG Again
+
+Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.
+
+```
+* [#123](https://github.com/mongoid/mongoid-geospatial/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
+```
+
+Amend your previous commit and force push the changes.
+
+```
+git commit --amend
+git push origin my-feature-branch -f
+```
+
+#### Check on Your Pull Request
+
+Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
+
+#### Be Patient
+
+It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
+
+#### Thank You
+
+Please do know that we really appreciate and value your time and work. We love you, really.

data/Dangerfile

@@ -0,0 +1 @@
+danger.import_dangerfile(gem: 'mongoid-danger')

data/Gemfile

@@ -1,25 +1,37 @@
 source 'http://rubygems.org'
 
-gemspec # Specify  gem's dependencies in mongoid_geospatial.gemspec
+case version = ENV['MONGOID_VERSION'] || '7'
+when 'HEAD'
+  gem 'mongoid', github: 'mongodb/mongoid'
+when /^7/
+  gem 'mongoid', '~> 7.0.0'
+when /^6/
+  gem 'mongoid', '~> 6.0.0'
+when /^5/
+  gem 'mongoid', '~> 5.0'
+else
+  gem 'mongoid', version
+end
 
-gem 'rake'
+gemspec
 
-group :test do
+group :development, :test do
+  gem 'fuubar'
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-rubocop'
   gem 'pry'
+  gem 'rake'
   gem 'yard'
-  gem 'nokogiri'
+end
 
+group :test do
+  gem 'coveralls', require: false if ENV['CI']
   gem 'dbf'
-  gem 'rgeo'
   gem 'georuby'
-
+  gem 'mongoid-danger', '~> 0.1.0', require: false
+  gem 'nokogiri'
+  gem 'rgeo'
   gem 'rspec'
-
-  gem 'rubocop'
-  gem 'fuubar'
-  gem 'guard'
-  gem 'guard-rubocop'
-  gem 'guard-rspec'
-
-  gem 'coveralls', require: false if ENV['CI']
+  gem 'rubocop', '0.60.0'
 end

data/Guardfile

@@ -11,6 +11,6 @@ end
 
 guard :rspec, cmd: 'bundle exec rspec', notification: true do
   watch(/^spec\/.+_spec\.rb$/)
-  watch(/^lib\/(.+)\.rb$/)     { |m| "spec/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { 'spec' }
+  watch(/^lib\/(.+)\.rb$/) { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { 'spec' }
 end

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2015 Mongoid Geospatial Authors
+Copyright (c) 2009-2017 Mongoid Geospatial Authors
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -17,4 +17,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,172 +1,161 @@
 Mongoid Geospatial
 ==================
 
-
 A Mongoid Extension that simplifies the use of MongoDB spatial features.
 
-* Version 5.x -> Mongoid 5
-* Version 4.x -> Mongoid 4
-
-** Gem name has changed: 'mongoid-geospatial' (notice the hyphen) **
-Please change the underscore to a hyphen.
-That will require it correctly within bundler:
-`require '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.svg?branch=master)](https://travis-ci.org/nofxx/mongoid-geospatial)
-
+[![Code Climate](https://codeclimate.com/github/mongoid/mongoid-geospatial.svg)](https://codeclimate.com/github/mongoid/mongoid-geospatial)
+[![Coverage Status](https://coveralls.io/repos/github/mongoid/mongoid-geospatial/badge.svg?branch=master)](https://coveralls.io/github/mongoid/mongoid-geospatial?branch=master)
+[![Build Status](https://travis-ci.org/mongoid/mongoid-geospatial.svg?branch=master)](https://travis-ci.org/mongoid/mongoid-geospatial)
 
 Quick Start
 -----------
 
-This gem focus on (making helpers for) MongoDB's spatial features.
-But you may also use an external Geometric/Spatial gem alongside.
-
-    # Gemfile
-    gem 'mongoid-geospatial'
+This gem focuses on (making helpers for) MongoDB's spatial features using Mongoid 5, 6 and 7.
 
+```ruby
+# Gemfile
+gem 'mongoid-geospatial'
+```
 
 A `Place` to illustrate `Point`, `Line` and `Polygon`
 
-    class Place
-      include Mongoid::Document
+```ruby
+class Place
+  include Mongoid::Document
 
-      # Include the module
-      include Mongoid::Geospatial
+  # Include the module
+  include Mongoid::Geospatial
 
-      # Just like mongoid,
-      field :name,     type: String
+  # Just like mongoid,
+  field :name,     type: String
 
-      # define your field, but choose a geometry type:
-      field :location, type: Point
-      field :route,    type: Linestring
-      field :area,     type: Polygon
-
-      # 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 use a helper directly on the `field`:
-      field :location, type: Point, spatial: true  # 2d
-      # or
-      field :location, type: Point, sphere: true   # 2dsphere
-    end
+  # define your field, but choose a geometry type:
+  field :location, type: Point
+  field :route,    type: LineString
+  field :area,     type: Polygon
 
+  # To query on your points, don't forget to index:
+  # You may use a method:
+  sphere_index :location  # 2dsphere
+  # or
+  spatial_index :location # 2d
 
+  # Or use a helper directly on the `field`:
+  field :location, type: Point, spatial: true  # 2d
+  # or
+  field :location, type: Point, sphere: true   # 2dsphere
+end
+```
 
 Generate indexes on MongoDB via rake:
 
-
-    rake db:mongoid:create_indexes
-
+```
+rake db:mongoid:create_indexes
+```
 
 Or programatically:
 
-
-    Place.create_indexes
-
-
+```ruby
+Place.create_indexes
+```
 
 Points
 ------
 
-Currently, MongoDB supports query operations on 2D points only, so that's
-what this lib does. All geometries apart from points are just arrays
-in the database. Here's is how you can input a point as:
+This gem defines a specific `Point` class under the Mongoid::Geospatial namespace. Make sure to use `type: ::Mongoid::Geospatial::Point` to avoid name errors or collisions with other `Point` classes you might already have defined `NameError`s.
+
+Currently, MongoDB supports query operations on 2D points only, so that's what this lib does. All geometries apart from points are just arrays in the database. Here's is how you can input a point as:
 
 * longitude latitude array in that order - [long,lat] ([x, y])
 * 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
+* 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
 * anything with the a method #to_xy or #to_lng_lat that converts itself to  [long, lat] array
 
-We store data in the DB as a [x, y] array then reformat when it is returned to you
+_Note: the convention of having longitude as the first coordinate may vary for other libraries. For instance, Google Maps often refer to "LatLng". Make sure you keep those differences in mind. See below for how to configure this library for LatLng._
 
+We store data in the DB as a [x, y] array then reformat when it is returned to you
 
-    cafe = Place.create(
-      name: 'Café Rider',
-      location: {:lat => 44.106667, :lng => -73.935833},
-      # or
-      location: {latitude: 40.703056, longitude: -74.026667}
-      #...
+```ruby
+cafe = Place.create(
+  name: 'Café Rider',
+  location: {:lat => 44.106667, :lng => -73.935833},
+  # or
+  location: {latitude: 40.703056, longitude: -74.026667}
+  #...
+```
 
 Now to access this spatial information we can do this
 
-    cafe.location  # => [-74.026667, 40.703056]
+```ruby
+cafe.location  # => [-74.026667, 40.703056]
+```
 
 If you need a hash
 
-    cafe.location.to_hsh   # => { x: -74.026667, y: 40.703056 }
+```ruby
+cafe.location.to_hsh   # => { x: -74.026667, y: 40.703056 }
+```
 
 If you are using GeoRuby or RGeo
 
-    cafe.location.to_geo   # => GeoRuby::Point
-
-    cafe.location.to_rgeo  # => RGeo::Point
+```ruby
+cafe.location.to_geo   # => GeoRuby::Point
 
+cafe.location.to_rgeo  # => RGeo::Point
+```
 
 Conventions:
 
 This lib uses #x and #y everywhere.
 It's shorter than lat or lng or another variation that also confuses.
-A point is a 2D mathematical notation, longitude/latitude is when you
-use that notation to map an sphere. In other words:
-All longitudes are 'xs' where not all 'xs' are longitudes.
-
-Distance and other geometrical calculations are delegated to the external
-library of your choice. More info about using RGeo or GeoRuby below.
-Some built in helpers for mongoid queries:
+A point is a 2D mathematical notation, longitude/latitude is when you use that notation to map an sphere. In other words: all longitudes are 'xs' where not all 'xs' are longitudes.
 
-    # Returns middle point + radius
-    # Useful to search #within_circle
-    cafe.location.radius(5)        # [[-74.., 40..], 5]
-    cafe.location.radius_sphere(5) # [[-74.., 40..], 0.00048..]
+Distance and other geometrical calculations are delegated to the external library of your choice. More info about using RGeo or GeoRuby below. Some built in helpers for mongoid queries:
 
-    # Returns hash if needed
-    cafe.location.to_hsh              # {:x => -74.., :y => 40..}
-    cafe.location.to_hsh(:lon, :lat)  # {:lon => -74.., :lat => 40..}
+```ruby
+# Returns middle point + radius
+# Useful to search #within_circle
+cafe.location.radius(5)        # [[-74.., 40..], 5]
+cafe.location.radius_sphere(5) # [[-74.., 40..], 0.00048..]
 
+# Returns hash if needed
+cafe.location.to_hsh              # {:x => -74.., :y => 40..}
+cafe.location.to_hsh(:lon, :lat)  # {:lon => -74.., :lat => 40..}
+```
 
 And for polygons and lines:
 
-    house.area.bbox    # Returns polygon bounding_box (envelope)
-    house.area.center  # Returns calculate middle point
-
-
-
-
+```ruby
+house.area.bbox    # Returns polygon bounding_box (envelope)
+house.area.center  # Returns calculate middle point
+```
 
 Model Setup
 -----------
 
 You can create Point, Line, Circle, Box and Polygon on your models:
 
+```ruby
+class CrazyGeom
+  include Mongoid::Document
+  include Mongoid::Geospatial
 
-    class CrazyGeom
-      include Mongoid::Document
-      include Mongoid::Geospatial
+  field :location,  type: Point, spatial: true, delegate: true
 
-      field :location,  type: Point, spatial: true, delegate: true
+  field :route,     type: Line
+  field :area,      type: Polygon
 
-      field :route,     type: Line
-      field :area,      type: Polygon
+  field :square,    type: Box
+  field :around,    type: Circle
 
-      field :square,    type: Box
-      field :around,    type: Circle
-
-      # default mongodb options
-      spatial_index :location, {bit: 24, min: -180, max: 180}
-
-      # query by location
-      spatial_scope :location
-    end
+  # default mongodb options
+  spatial_index :location, {bit: 24, min: -180, max: 180}
 
+  # query by location
+  spatial_scope :location
+end
+```
 
 Helpers
 -------
@@ -174,42 +163,44 @@ Helpers
 You can use `spatial: true` to add a '2d' index automatically,
 No need for `spatial_index :location`:
 
+```ruby
+field :location,  type: Point, spatial: true
+```
 
-    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
+And you can use `sphere: true` to add a '2dsphere' index automatically, no need for `spatial_sphere :location`:
 
+```ruby
+field :location,  type: Point, sphere: true
+```
 
 You can delegate some point methods to the instance itself:
 
-
-    field :location,  type: Point, delegate: true
-
+```ruby
+field :location,  type: Point, delegate: true
+```
 
 Now instead of `instance.location.x` you may call `instance.x`.
 
-
 Nearby
 ------
 
 You can add a `spatial_scope` on your models. So you can query:
 
-    Bar.nearby(my.location)
+```ruby
+Bar.nearby(my.location)
+```
 
 instead of
 
-    Bar.near(location: my.location)
+```ruby
+Bar.near(location: my.location)
+```
 
 Good when you're drunk. Just add to your model:
 
-    spatial_scope :<field>
-
-
+```ruby
+spatial_scope :<field>
+```
 
 Geometry
 --------
@@ -217,28 +208,28 @@ Geometry
 You can also store Circle, Box, Line (LineString) and Polygons.
 Some helper methods are available to them:
 
+```ruby
+# Returns a geometry bounding box
+# Useful to query #within_geometry
+polygon.bbox
+polygon.bounding_box
 
-    # Returns a geometry bounding box
-    # Useful to query #within_geometry
-    polygon.bbox
-    polygon.bounding_box
-
-    # Returns a geometry calculated middle point
-    # Useful to query for #near
-    polygon.center
-
-    # Returns middle point + radius
-    # Useful to search #within_circle
-    polygon.radius(5)        # [[1.0, 1.0], 5]
-    polygon.radius_sphere(5) # [[1.0, 1.0], 0.00048..]
+# Returns a geometry calculated middle point
+# Useful to query for #near
+polygon.center
 
+# Returns middle point + radius
+# Useful to search #within_circle
+polygon.radius(5)        # [[1.0, 1.0], 5]
+polygon.radius_sphere(5) # [[1.0, 1.0], 0.00048..]
+```
 
 Query
 -----
 
-Before you read about this gem have sure you read this:
+Before you proceed, make sure you have read this:
 
-http://mongoid.org/en/origin/docs/selection.html#standard
+http://mongoid.github.io/old/en/origin/docs/selection.html#standard
 
 All MongoDB queries are handled by Mongoid/Origin.
 
@@ -248,34 +239,31 @@ You can use Geometry instance directly on any query:
 
 * near
 
-
-```
+```ruby
 Bar.near(location: person.house)
 Bar.where(:location.near => person.house)
 ```
 
 * near_sphere
 
-```
+```ruby
 Bar.near_sphere(location: person.house)
 Bar.where(:location.near_sphere => person.house)
 ```
 
 * within_polygon
 
-```
+```ruby
 Bar.within_polygon(location: [[[x,y],...[x,y]]])
 # or with a bbox
 Bar.within_polygon(location: street.bbox)
 ```
 
-
 * intersects_line
 * intersects_point
 * intersects_polygon
 
 
-
 External Libraries
 ------------------
 
@@ -284,42 +272,42 @@ 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
+```ruby
+class Person
+  include Mongoid::Document
+  include Mongoid::Geospatial
 
-      field :location, type: Point
-    end
+  field :location, type: Point
+end
 
-    me = Person.new(location: [8, 8])
+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
+# 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
 
@@ -327,23 +315,28 @@ Assemble it as you need (use a initializer file):
 
 With RGeo
 
-    Mongoid::Geospatial.with_rgeo!
-    # Optional
-    # Mongoid::Geospatial.factory = RGeo::Geographic.spherical_factory
-
+```ruby
+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)
+```ruby
+Mongoid::Geospatial.with_georuby!
+```
 
-    Mongoid::Geospatial.lng_symbol = :x
-    Mongoid::Geospatial.lat_symbol = :y
-    Mongoid::Geospatial.earth_radius = EARTH_RADIUS
+By default the convention of this library is LngLat, configure it for LatLng as follows.
 
+```ruby
+Mongoid::Geospatial.configure do |config|
+  config.point.x = Mongoid::Geospatial.lat_symbols
+  config.point.y = Mongoid::Geospatial.lng_symbols
+end
+```
 
+You will need to manually migrate any existing `Point` data if you change configuration in an existing system.
 
 This Fork
 ---------
@@ -353,27 +346,30 @@ This fork delegates calculations to external libs.
 
 Change in your models:
 
-    include Mongoid::Spacial::Document
+```ruby
+include Mongoid::Spacial::Document
+```
 
 to
 
-    include Mongoid::Geospatial
-
+```ruby
+include Mongoid::Geospatial
+```
 
 And for the fields:
 
-
-    field :source,  type: Array,    spacial: true
+```ruby
+field :source,  type: Array,    spacial: true
+```
 
 to
 
-    field :source,  type: Point,    spatial: true # or sphere: true
-
+```ruby
+field :source,  type: Point,    spatial: true # or sphere: true
+```
 
 Beware the 't' and 'c' issue. It's spaTial.
 
-
-
 Troubleshooting
 ---------------
 
@@ -381,16 +377,25 @@ Troubleshooting
 
 Indexes need to be created. Execute command:
 
-    rake db:mongoid:create_indexes
+```
+rake db:mongoid:create_indexes
+```
 
 Programatically
 
-    Model.create_indexes
-
+```
+Model.create_indexes
+```
 
 Contributing
 ------------
 
-* Have mongod running
-* Install dev gems with `bundle install`
-* Run `rake spec`, `spec spec` or `guard`
+See [CONTRIBUTING](CONTRIBUTING.md).
+
+License
+-------
+
+Copyright (c) 2009-2017 Mongoid Geospatial Authors
+
+MIT License, see [MIT-LICENSE](MIT-LICENSE).
+