mongoid_geospatial 2.0.0 → 2.2.0

data/Gemfile

@@ -1,10 +1,11 @@
 source 'http://rubygems.org'
 gemspec # Specify  gem's dependencies in mongoid_geospatial.gemspec
 
-gem 'rgeo'
 gem 'mongoid', '~> 3.0'
 
 group :development do
+  gem 'rgeo'
+  gem 'georuby'
   gem 'rspec'
   gem 'guard-rspec'
   gem 'pry'

data/README.md

@@ -1,8 +1,8 @@
 Mongoid Geospatial
 ==================
 
-A Mongoid Extension that simplifies and adds support for MongoDB and
-RGeo Spatial Calculations.
+A Mongoid Extension that simplifies the use of MongoDB spatial features.
+
 
 ** On beta again **
 
@@ -18,13 +18,80 @@ There are no plans to support Mongoid <= 2.0
 
 Quick Start
 -----------
-Add mongoid_geospatial to your Gemfile:
 
-```ruby
-gem 'mongoid_geospatial'
-```
+This gem focus on (making helpers for) spatial features MongoDB has.
+You can also use an external Geometric/Spatial alongside.
+
+    # Gemfile
+    gem 'mongoid_geospatial'
+
+
+    # A place to illustrate Point, LineString and Polygon
+    class Place
+      include Mongoid::Document
+      include Mongoid::Geospatial
+
+      field :name,     type: String
+      field :location, type: Point, :spatial => true
+      field :route,    type: Linestring
+      field :area,     type: Polygon
+    end
+
+
+Geometry Helpers
+----------------
+
+We currently support GeoRuby and RGeo.
+If you require one of those, a #to_geo method 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_geo.class # RGeo::Geographic::SphericalPointImpl
+
+
+Configure
+----------------
+
+Assemble it as you need:
+
+With RGeo
+
+    Mongoid::Geospatial.use_rgeo
+    # Optional
+    # Mongoid::Geospatial.factory = RGeo::Geographic.spherical_factory
+
+With GeoRuby
+
+    Mongoid::Geospatial.use_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
+
+
+
+Model Setup
+-----------
+
+You can create Point, LineString and Polygon on your models:
 
-Set up some slugs:
 
 ```ruby
 class River
@@ -48,12 +115,6 @@ class River
 end
 ```
 
-Avaiable data types:
-
-* Point
-* LineString
-* Polygon
-
 
 Generate indexes on MongoDB:
 
@@ -129,47 +190,6 @@ River.where(:name=>'hudson').geo_near({:lat => 40.73083, :lng => -73.99756})
 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
 ---------
@@ -289,8 +309,7 @@ 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.
+This fork delegates calculations to the external libs and use Moped.
 
 Change in your models:
 
@@ -320,16 +339,20 @@ Troubleshooting
 
 **Mongo::OperationFailure: can't find special index: 2d**
 
-Indexes need to be created. Execute command: <code>rake db:mongoid:create_indexes</code>
+Indexes need to be created. Execute command:
+
+    rake db:mongoid:create_indexes
 
 
 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
------------
+Contributing
+------------
+
 * 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
@@ -340,5 +363,6 @@ Contributing to mongoid_spatial
 
 Copyright
 -----------
+
 Copyright (c) 2011 Ryan Ong. See LICENSE.txt for
 further details.

data/lib/mongoid_geospatial.rb

@@ -1,18 +1,14 @@
-require 'rgeo'
 require 'mongoid'
 require 'active_support/core_ext/string/inflections'
 require 'active_support/concern'
-require 'mongoid_geospatial/contextual/mongo'
-require 'mongoid_geospatial/criteria'
-require 'mongoid_geospatial/extensions/symbol'
+require 'mongoid_geospatial/extensions/core_ext'
 require 'mongoid_geospatial/extensions/rgeo_spherical_point_impl'
 require 'mongoid_geospatial/field_option'
 
-fields_path = 'mongoid_geospatial/fields'
+require 'mongoid_geospatial/fields/geometry_field'
 
 %w{point polygon line_string}.each do |type|
-  require "#{fields_path}/#{type}"
+  require "mongoid_geospatial/fields/#{type}"
 end
 
-require 'mongoid_geospatial/finders'
 require 'mongoid_geospatial/geospatial'

data/lib/mongoid_geospatial/field_option.rb

@@ -2,11 +2,10 @@
 
 Mongoid::Fields.option :spatial do |model,field,options|
   options = {} unless options.kind_of?(Hash)
-  lat_meth = options[:lat] || :lat
-  lng_meth = options[:lng] || :lng
+  # x_meth = options[:x] || :x
+  # y_meth = options[:y] || :y
   model.class_eval do
-    self.spatial_fields ||= []
-    self.spatial_fields << field.name.to_sym if self.spatial_fields.kind_of? Array
+    (self.spatial_fields ||= []) << field.name.to_sym
 
     define_method "distance_from_#{field.name}" do |*args|
       self.distance_from(field.name, *args)

data/lib/mongoid_geospatial/fields/geometry_field.rb

@@ -0,0 +1,34 @@
+module Mongoid
+  module Geospatial
+    class GeometryField < Array
+
+      def bounding_box
+        max_x, min_x = -Float::MAX, Float::MAX
+        max_y, min_y = -Float::MAX, Float::MAX
+        each do |point|
+          max_y = point[1] if point[1] > max_y
+          min_y = point[1] if point[1] < min_y
+          max_x = point[0] if point[0] > max_x
+          min_x = point[0] if point[0] < min_x
+        end
+        [[min_x, min_y], [max_x, max_y]]
+      end
+      alias :bbox :bounding_box
+
+      def center_point
+        min, max = *bbox
+        [min[0] + max[0] / 2.0, min[1] + max[1] / 2.0]
+      end
+      alias :center :center_point
+
+      def radius r = 1
+        [center, r]
+      end
+
+      def radius_sphere r = 1
+        [center, r.to_f/Mongoid::Geospatial.earth_radius[:km]]
+      end
+
+    end
+  end
+end

data/lib/mongoid_geospatial/fields/line_string.rb

@@ -1,14 +1,12 @@
 module Mongoid
   module Geospatial
-    class LineString
-
-      def mongoize
-        to_a
-      end
+    class LineString < GeometryField
 
       class << self
-        def demongoize(object)
-          RGeo::Geographic.spherical_factory.line_string object
+
+        # Database -> Object
+        def demongoize(o)
+          LineString.new(o)
         end
 
       end

data/lib/mongoid_geospatial/fields/point.rb

@@ -1,62 +1,47 @@
 module Mongoid
   module Geospatial
     class Point
+      attr_accessor :x, :y
 
+      def initialize(x, y)
+        @x, @y = x, y
+      end
+
+      # Object -> Database
       def mongoize
         [x, y]
       end
+      alias :to_a  :mongoize
+      alias :to_xy :mongoize
+
+      def [](args)
+        mongoize[args]
+      end
 
       class << self
 
+        # Database -> Object
         def demongoize(object)
-          return unless object && !object.empty?
-          RGeo::Geographic.spherical_factory.point *object
-          #["x"], object["y"]
+          # return unless object && !object.empty?
+          Point.new(object[0], object[1])
         end
 
         def mongoize(object)
-          #return new.mongoize if object.respond_to?(:x)
           case object
           when Point then object.mongoize
-          when Hash then [object[:x], object[:y]]
+          when Array then object.to_xy
+          when Hash then object.to_xy
           else object
           end
         end
 
-        # Converts the object that was supplied to a criteria and converts it
+        # Converts the object that was supplied to a criteria
         # into a database friendly form.
         def evolve(object)
           object.respond_to?(:x) ? object.mongoize : object
         end
       end
 
-#       -    self.spacial_fields ||= []
-# -    self.spacial_fields << field.name.to_sym if self.spacial_fields.kind_of? Array
-# -
-# -    define_method "distance_from_#{field.name}" do |*args|
-# -      self.distance_from(field.name, *args)
-# -    end
-# -
-# -    define_method field.name do
-# -      output = self[field.name] || [nil,nil]
-# -      output = {lng_meth => output[0], lat_meth => output[1]} unless options[:return_array]
-# -      return options[:class].new(output) if options[:class]
-# -      output
-# -    end
-# -
-# -    define_method "#{field.name}=" do |arg|
-# -      if arg.kind_of?(Hash) && arg[lng_meth] && arg[lat_meth]
-# -        arg = [arg[lng_meth].to_f, arg[lat_meth].to_f]
-# -      elsif arg.respond_to?(:to_xy)
-# -        arg = arg.to_xy
-# -      end
-# -      self[field.name]=arg
-# -      arg = [nil,nil] if arg.nil?
-# -      return arg[0..1] if options[:return_array]
-# -      h = {lng_meth => arg[0], lat_meth => arg[1]}
-# -      return h if options[:class].blank?
-# -      options[:class].new(h)
-
     end
   end
 end

data/lib/mongoid_geospatial/fields/polygon.rb

@@ -1,24 +1,16 @@
 module Mongoid
   module Geospatial
-    class Polygon
-
-      def mongoize
-        self #.flatten
-      end
+    class Polygon < GeometryField
 
       class << self
-        def demongoize(object)
-          points = object.map do |pair|
-            RGeo::Geographic.spherical_factory.point *pair
-          end
-          ring = RGeo::Geographic.spherical_factory.linear_ring points
-          RGeo::Geographic.spherical_factory.polygon ring
+
+        # Database -> Object
+        def demongoize(o)
+          Polygon.new(o)
         end
 
-        # def evolve(object)
-        #   { "$gte" => object.first, "$lte" => object.last }
-        # end
       end
+
     end
   end
 end

data/lib/mongoid_geospatial/geospatial.rb

@@ -1,6 +1,3 @@
-require 'mongoid_geospatial/geospatial/core_ext'
-require 'mongoid_geospatial/geospatial/geo_near_results'
-
 module Mongoid
   module Geospatial
     extend ActiveSupport::Concern
@@ -9,36 +6,24 @@ module Mongoid
     LAT_SYMBOLS = [:y, :lat, :latitude]
 
     EARTH_RADIUS_KM = 6371 # taken directly from mongodb
+    RAD_PER_DEG = Math::PI / 180
 
     EARTH_RADIUS = {
       :km => EARTH_RADIUS_KM,
-      :m  => EARTH_RADIUS_KM*1000,
-      :mi => EARTH_RADIUS_KM*0.621371192, # taken directly from mongodb
-      :ft => EARTH_RADIUS_KM*5280*0.621371192,
-      :sm => EARTH_RADIUS_KM*0.53995680345572 # sea mile
+      :m  => EARTH_RADIUS_KM * 1000,
+      :mi => EARTH_RADIUS_KM * 0.621371192, # taken directly from mongodb
+      :ft => EARTH_RADIUS_KM * 5280*0.621371192,
+      :sm => EARTH_RADIUS_KM * 0.53995680345572 # sea mile
     }
 
-    GEO_FACTORY = RGeo::Geographic.spherical_factory
-    RAD_PER_DEG = Math::PI/180
     mattr_accessor :lng_symbols
-    @@lng_symbols = LNG_SYMBOLS.dup
-
     mattr_accessor :lat_symbols
-    @@lat_symbols = LAT_SYMBOLS.dup
-
     mattr_accessor :earth_radius
-    @@earth_radius = EARTH_RADIUS.dup
+    mattr_accessor :factory
 
-    mattr_accessor :paginator
-    @@paginator = :array
-
-    mattr_accessor :default_per_page
-    @@default_per_page = 25
-
-    # mattr_accessor :spherical_distance_formula
-    # @@spherical_distance_formula = :n_vector
-    mattr_accessor :geo_factory
-    @@geo_factory = GEO_FACTORY.dup
+    @@lng_symbols  = LNG_SYMBOLS.dup
+    @@lat_symbols  = LAT_SYMBOLS.dup
+    @@earth_radius = EARTH_RADIUS.dup
 
     included do
       attr_accessor :geo
@@ -47,15 +32,25 @@ module Mongoid
       @@spatial_fields_indexed = []
     end
 
+    def self.use_rgeo
+      require 'mongoid_geospatial/wrappers/rgeo'
+    end
+
+    def self.use_georuby
+      require 'mongoid_geospatial/wrappers/georuby'
+    end
+
     module ClassMethods #:nodoc:
+
       # create spatial index for given field
       # @param [String,Symbol] name
       # @param [Hash] options options for spatial_index
-
+      # http://www.mongodb.org/display/DOCS/Geospatial+Indexing#GeospatialIndexing-geoNearCommand
       def spatial_index name, options = {}
         self.spatial_fields_indexed << name
         index({name => '2d'}, options)
       end
+
     end
 
   end