mongoid-geospatial 4.0.1 → 5.0.0

data/bench/bench

@@ -2,12 +2,12 @@
 #
 # Just for fun
 #
-$: << File.expand_path("../../lib", __FILE__)
+$LOAD_PATH << File.expand_path('../../lib', __FILE__)
 
 require 'mongoid/geospatial'
 
 Mongoid.configure do |config|
-  config.connect_to("mongoid_geospatial_bench")
+  config.connect_to('mongoid_geospatial_bench')
 end
 
 Mongoid::Geospatial.with_georuby!
@@ -36,27 +36,28 @@ Mongoid.purge!
 
 Benchmark.bmbm do |b|
   [100, 1000, 3000].each do |t|
-    nogeo, cafes = [], []
+    nogeo = []
+    cafes = []
     b.report("#{t} W NoGeo") do
       t.times { nogeo << NoGeo.create(name: 'Boring').id }
     end
     b.report("#{t} W Rider") { t.times { Rider.create(name: 'Munro') } }
 
     b.report("#{t} W Cafe ") do
-      t.times { cafes << Cafe.create(name: 'Bacco', spot: [3,3]).id }
+      t.times { cafes << Cafe.create(name: 'Bacco', spot: [3, 3]).id }
     end
     # puts "---"
-    b.report("#{t} R NoGeo") { nogeo.each { |id| NoGeo.find(id) }}
+    b.report("#{t} R NoGeo") { nogeo.each { |id| NoGeo.find(id) } }
     # b.report("#{t} R Rider") { t.times { Rider.create(name: 'Munro') } }
-    b.report("#{t} R Cafe ") { cafes.each { |id| Cafe.find(id) }}
-    b.report("#{t} R Cafe Georuby") { cafes.each { |id| Cafe.find(id).spot.to_geo }}
-    b.report("#{t} R Cafe RGeo") { cafes.each { |id| Cafe.find(id).spot.to_rgeo }}
+    b.report("#{t} R Cafe ") { cafes.each { |id| Cafe.find(id) } }
+    b.report("#{t} R Cafe Georuby") { cafes.each { |id| Cafe.find(id).spot.to_geo } }
+    b.report("#{t} R Cafe RGeo") { cafes.each { |id| Cafe.find(id).spot.to_rgeo } }
   end
-  b.report("R Cafe GeoRuby") do
+  b.report('R Cafe GeoRuby') do
     cafe = Cafe.first
     1_000_000.times { cafe.spot.to_geo }
   end
-  b.report("R Cafe RGeo") do
+  b.report('R Cafe RGeo') do
     cafe = Cafe.first
     1_000_000.times { cafe.spot.to_rgeo }
   end

data/lib/mongoid/geospatial.rb

@@ -6,23 +6,22 @@ require 'mongoid/geospatial/helpers/sphere'
 require 'mongoid/geospatial/helpers/delegate'
 
 module Mongoid
-
   #
   # Main Geospatial module
   #
   # include Mongoid::Geospatial
   #
   module Geospatial
-    autoload :GeometryField,      'mongoid/geospatial/geometry_field'
+    autoload :GeometryField, 'mongoid/geospatial/geometry_field'
 
-    autoload :Point,      'mongoid/geospatial/fields/point'
-    autoload :LineString, 'mongoid/geospatial/fields/line_string'
-    autoload :Polygon,    'mongoid/geospatial/fields/polygon'
+    autoload :Point,         'mongoid/geospatial/fields/point'
+    autoload :LineString,    'mongoid/geospatial/fields/line_string'
+    autoload :Polygon,       'mongoid/geospatial/fields/polygon'
 
-    autoload :Box,        'mongoid/geospatial/fields/box'
-    autoload :Circle,     'mongoid/geospatial/fields/circle'
+    autoload :Box,           'mongoid/geospatial/fields/box'
+    autoload :Circle,        'mongoid/geospatial/fields/circle'
 
-    autoload :VERSION,    'mongoid/geospatial/version'
+    autoload :VERSION,       'mongoid/geospatial/version'
 
     extend ActiveSupport::Concern
 
@@ -70,6 +69,7 @@ module Mongoid
       require 'mongoid/geospatial/wrappers/georuby'
     end
 
+    # Methods applied to Document's class
     module ClassMethods
       #
       # Create Spatial index for given field
@@ -78,7 +78,8 @@ module Mongoid
       # @param [String,Symbol] name
       # @param [Hash] options options for spatial_index
       #
-      # http://www.mongodb.org/display/DOCS/Geospatial+Indexing#GeospatialIndexing-geoNearCommand
+      # http://www.mongodb.org/display/DOCS/Geospatial+Indexing
+      # #GeospatialIndexing-geoNearCommand
       #
       def spatial_index(name, options = {})
         spatial_fields_indexed << name
@@ -92,7 +93,8 @@ module Mongoid
       # @param [String,Symbol] name
       # @param [Hash] options options for spatial_index
       #
-      # http://www.mongodb.org/display/DOCS/Geospatial+Indexing#GeospatialIndexing-geoNearCommand
+      # http://www.mongodb.org/display/DOCS/Geospatial+Indexing
+      # #GeospatialIndexing-geoNearCommand
       def sphere_index(name, options = {})
         spatial_fields_indexed << name
         index({ name => '2dsphere' }, options)
@@ -105,7 +107,8 @@ module Mongoid
       # @param [String,Symbol] name
       # @param [Hash] options options for spatial_index
       #
-      # http://www.mongodb.org/display/DOCS/Geospatial+Indexing#GeospatialIndexing-geoNearCommand
+      # http://www.mongodb.org/display/DOCS/Geospatial+Indexing
+      # #GeospatialIndexing-geoNearCommand
       def spatial_scope(field, _opts = {})
         singleton_class.class_eval do
           # define_method(:close) do |args|
@@ -114,12 +117,6 @@ module Mongoid
           end
         end
       end
-
-      private
-      def geo_field(name, options = {})
-        field name, { type: Mongoid::Geospatial::Point,
-                      spatial: true }.merge(options)
-      end
     end
   end
 end

data/lib/mongoid/geospatial/fields/point.rb

@@ -4,10 +4,12 @@ module Mongoid
     #
     class Point
       include Enumerable
-      attr_reader :x, :y
+      attr_accessor :x, :y, :z
 
       def initialize(x, y, z = nil)
-        @x, @y, @z = x, y, z
+        @x = x
+        @y = y
+        @z = z
       end
 
       # Object -> Database
@@ -29,21 +31,33 @@ module Mongoid
         yield x
         yield y
       end
+
       #
       # Point representation as a Hash
       #
-      # @return (Hash)
+      # @return [Hash] with { xl => x, yl => y }
+      #
       def to_hsh(xl = :x, yl = :y)
         { xl => x, yl => y }
       end
       alias_method :to_hash, :to_hsh
 
+      #
       # Helper for [self, radius]
+      #
+      # @return [Array] with [self, radius]
+      #
       def radius(r = 1)
         [mongoize, r]
       end
 
-      # Helper for [self, radius / earth radius]
+      #
+      # Radius Sphere
+      #
+      # Validates that #x & #y are `Numeric`
+      #
+      # @return [Array] with [self, radius / earth radius]
+      #
       def radius_sphere(r = 1, unit = :km)
         radius r.to_f / Mongoid::Geospatial.earth_radius[unit]
       end
@@ -51,7 +65,9 @@ module Mongoid
       #
       # Am I valid?
       #
-      # Validates that x & y are `Numeric`
+      # Validates that #x & #y are `Numeric`
+      #
+      # @return [Boolean] if self #x && #y are valid
       #
       def valid?
         x && y && x.is_a?(Numeric) && y.is_a?(Numeric)
@@ -63,10 +79,23 @@ module Mongoid
       # "x, y"
       #
       # @return [String] Point as comma separated String
+      #
       def to_s
         "#{x}, #{y}"
       end
 
+      #
+      # Point inverse/reverse
+      #
+      # MongoDB: "x, y"
+      # Reverse: "y, x"
+      #
+      # @return [Array] Point reversed: "y, x"
+      #
+      def reverse
+        [y, x]
+      end
+
       #
       # Distance calculation methods. Thinking about not using it
       # One needs to choose and external lib. GeoRuby or RGeo
@@ -100,7 +129,7 @@ module Mongoid
         # Database -> Object
         # Get it back
         def demongoize(obj)
-          obj && Point.new(*obj)
+          obj && new(*obj)
         end
 
         #
@@ -122,7 +151,10 @@ module Mongoid
         # Converts the object that was supplied to a criteria
         # into a database friendly form.
         def evolve(obj)
-          obj.respond_to?(:x) ? obj.mongoize : obj
+          case obj
+          when Point then obj.mongoize
+          else obj
+          end
         end
 
         private
@@ -151,9 +183,9 @@ module Mongoid
         #
         # @return (Array)
         #
-        def from_array(ary)
-          return nil if ary.empty?
-          ary.flatten[0..1].map(&:to_f)
+        def from_array(array)
+          return nil if array.empty?
+          array.flatten[0..1].map(&:to_f)
         end
 
         #

data/lib/mongoid/geospatial/geometry_field.rb

@@ -1,5 +1,6 @@
 module Mongoid
   module Geospatial
+    #
     #
     # Main Geometry Array
     #
@@ -8,8 +9,12 @@ module Mongoid
     #
     class GeometryField < Array
       #
-      # Determines the multi point geometry bounding box.
+      #
+      # Determines the 2 points geometry bounding box.
       # Useful to find map boundaries, and fit to screen.
+      # Returns [bottom left, top right]
+      #
+      # @return [Array] containing 2 points
       #
       def bounding_box
         max_x, min_x = -Float::MAX, Float::MAX
@@ -24,10 +29,26 @@ module Mongoid
       end
       alias_method :bbox, :bounding_box
 
+      #
+      # Determines the 5 points geometry bounding box.
+      # Useful to use with Mongoid #within_geometry
+      #
+      # Returns a closed ring:
+      # [bottom left, top left, top right, bottom right, bottom left]
+      #
+      # @return [Array] containing 5 points
+      #
+      def geom_box
+        xl, yl = bounding_box
+        [xl, [xl[0], yl[1]], yl, [yl[0], xl[1]], xl]
+      end
+
       #
       # Determines the center point of a multi point geometry.
       # Geometry may be closed or not.
       #
+      # @return [Array] containing 1 point [x,y]
+      #
       def center_point
         min, max = *bbox
         [(min[0] + max[0]) / 2.0, (min[1] + max[1]) / 2.0]
@@ -39,6 +60,7 @@ module Mongoid
       #
       # @param [Numeric] r radius
       # @return [Array]  [point, r] point and radius in mongoid format
+      #
       def radius(r = 1)
         [center, r]
       end
@@ -49,7 +71,7 @@ module Mongoid
       # point.radius(x) ->  [point, x / earth radius]
       #
       # @see Point#radius
-      # @return (Float)
+      # @return [Array]
       #
       def radius_sphere(r = 1, unit = :km)
         radius r.to_f / Mongoid::Geospatial.earth_radius[unit]
@@ -59,6 +81,7 @@ module Mongoid
         #
         # Database -> Object
         #
+        # @return [Object]
         def demongoize(obj)
           obj && new(obj)
         end

data/lib/mongoid/geospatial/helpers/delegate.rb

@@ -18,11 +18,15 @@ Mongoid::Fields.option :delegate do |model, field, options|
     end
 
     define_method "#{x_meth}=" do |arg|
-      self[field.name][0] = arg
+      # HACK: Mongoid has detecting an Array changed
+      # self[field.name][0] = arg
+      send("#{field.name}=", [arg, self[field.name][1]])
     end
 
     define_method "#{y_meth}=" do |arg|
-      self[field.name][1] = arg
+      # self[field.name][1] = arg
+      # self[field.name] = [self[field.name][0], arg]
+      send("#{field.name}=", [self[field.name][0], arg])
     end
   end
 end

data/lib/mongoid/geospatial/version.rb

@@ -1,6 +1,6 @@
 module Mongoid
   # Mongoid Geospatial version
   module Geospatial
-    VERSION = '4.0.1'
+    VERSION = '5.0.0'
   end
 end

data/lib/mongoid/geospatial/wrappers/georuby.rb

@@ -1,6 +1,10 @@
 require 'geo_ruby'
 
 module Mongoid
+  #
+  # Wrappers for GeoRuby
+  # https://github.com/nofxx/georuby
+  #
   module Geospatial
     # Wrapper to GeoRuby's Point
     Point.class_eval do

data/lib/mongoid/geospatial/wrappers/rgeo.rb

@@ -2,6 +2,10 @@ require 'rgeo'
 require 'mongoid/geospatial/ext/rgeo_spherical_point_impl'
 
 module Mongoid
+  #
+  # Wrappers for RGeo
+  # https://github.com/rgeo/rgeo
+  #
   module Geospatial
     # Wrapper to Rgeo's Point
     Point.class_eval do
@@ -24,7 +28,6 @@ module Mongoid
 
     # Rgeo's GeometryField concept
     GeometryField.class_eval do
-
       def points
         map do |pair|
           RGeo::Geographic.spherical_factory.point(*pair)

data/mongoid-geospatial.gemspec

@@ -4,8 +4,8 @@ require File.expand_path('../lib/mongoid/geospatial/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ['Ryan Ong', 'Marcos Piccinini']
   gem.email         = ['use@git.hub.com']
-  gem.description   = 'Mongoid Extension that simplifies MongoDB casting and operations on spatial Ruby objects.'
   gem.summary       = 'Mongoid Extension that simplifies MongoDB Geospatial Operations.'
+  gem.description   = 'Mongoid Extension that simplifies MongoDB casting and operations on spatial Ruby objects.'
   gem.homepage      = 'https://github.com/nofxx/mongoid-geospatial'
 
   gem.files         = `git ls-files`.split("\n")
@@ -15,5 +15,5 @@ Gem::Specification.new do |gem|
   gem.version       = Mongoid::Geospatial::VERSION
   gem.license       = 'MIT'
 
-  gem.add_dependency('mongoid', ['>= 4.0.0'])
+  gem.add_dependency('mongoid', ['>= 5.0.0.beta'])
 end

data/spec/models/bar.rb

@@ -5,7 +5,7 @@ class Bar
 
   field :name,     type: String
 
-  geo_field :location
+  field :location, type: Point, spatial: true
 
   has_one :rating, as: :ratable
 

data/spec/models/farm.rb

@@ -4,7 +4,7 @@ class Farm
   include Mongoid::Geospatial
 
   field :name,         type: String
-  field :geom,         type: Point,    spatial: true
+  field :geom,         type: Point,    sphere: true
   field :area,         type: Polygon,  spatial: true
   field :m2,           type: Fixnum
 

data/spec/models/person.rb

@@ -26,7 +26,8 @@ class Person
   field :employer_id
   field :security_code
   field :blood_alcohol_content, type: Float, default: -> { 0.0 }
-  field :last_drink_taken_at,   type: Date,  default: -> { 1.day.ago.in_time_zone('Alaska') }
+  field :last_drink_taken_at,   type: Date,
+        default: -> { 1.day.ago.in_time_zone('Alaska') }
 
   # Geo
   field :location, type: Point

data/spec/models/river.rb

@@ -3,14 +3,14 @@ class River
   include Mongoid::Document
   include Mongoid::Geospatial
 
-  field :name,        type: String
-  field :length,      type: Integer
-  field :discharge,   type: Integer
-  field :course,      type: LineString,      spatial: true
+  field :name,       type: String
+  field :length,     type: Integer
+  field :discharge,  type: Integer
+  field :course,     type: LineString,   spatial: true
   # set return_array to true if you do not want a hash returned all the time
-  field :source,      type: Point,     spatial: true
-  field :mouth,       type: Point,    spatial: { lat: 'latitude', lng: 'longitude' }
-  field :mouth_array, type: Array,    spatial: { return_array: true }
+  field :source,     type: Point,        spatial: true
+  field :mouth,      type: Point, spatial: { lat: 'latitude', lng: 'longitude' }
+  field :mouth_array, type: Array, spatial: { return_array: true }
 
   # simplified spatial indexing
   # you can only index one field in mongodb < 1.9