mongoid_geospatial 2.5.1 → 2.7.0

data/README.md

@@ -31,16 +31,16 @@ You can also use an external Geometric/Spatial alongside.
       # Include the module
       include Mongoid::Geospatial
 
-	  # Just like mongoid,
+      # Just like mongoid,
       field :name,     type: String
-	  # define your field, but choose a geometry type:
-      field :location, type: Point, :spatial => true
+      # define your field, but choose a geometry type:
+      field :location, type: Point
       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
-	  
+
+      # If your are going to query on your points, don't forget to index:
+      spatial_index :location
+      # You can index points with :spatial => true option too, see below.
     end
 
 
@@ -57,15 +57,14 @@ 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:
 
-* 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] ([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
-* anything with the method to_lng_lat that converts it to a [long,lat]
+* 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 [lng,lat] array then reformat when it is returned to you
+We store data in the DB as a [x, y] array then reformat when it is returned to you
 
 
     hudson = River.create(
@@ -81,15 +80,17 @@ We store data in the DB as a [lng,lat] array then reformat when it is returned t
 Now to access this spatial information we can do this
 
     hudson.mouth  # => [-74.026667, 40.703056]
-	
+
 If you need a hash
 
     hudson.mouth.to_hsh  # => { x: -74.026667, y: 40.703056 }
-	
+
 If you are using GeoRuby or RGeo
 
     hudson.mouth.to_geo  # => NiceGeolib::Point
 
+Conventions: This lib uses #x and #y everywhere. 1. It's shorter than lat or lng or another variation that also confuses. 2. 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. In the eyes of a moralist it's not even a valid position point, it does not have #z or #m.
+
 Distance and other geometrical calculations are delegated to the external
 library you choosed. More info about using RGeo or GeoRuby below.
 Some built in helpers for mongoid queries:
@@ -106,9 +107,9 @@ Some built in helpers for mongoid queries:
 
 And for polygons and lines:
 
-	house.area.bbox    # Returns polygon bounding_box (envelope)
-	house.area.center  # Returns calculate middle point
-	
+    house.area.bbox    # Returns polygon bounding_box (envelope)
+    house.area.center  # Returns calculate middle point
+
 
 Query
 --------
@@ -125,7 +126,7 @@ 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)
@@ -134,15 +135,15 @@ You can use Geometry instance directly on any query:
 
 * 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)
@@ -213,7 +214,7 @@ With RGeo
 With GeoRuby
 
     Mongoid::Geospatial.use_georuby
-	
+
 
 Defaults (change if you know what you're doing)
 
@@ -233,25 +234,43 @@ You can create Point, Line, Circle, Box and Polygon on your models:
       include Mongoid::Document
       include Mongoid::Geospatial
 
-      field :location,     type: Point
+      field :location,  type: Point, :spatial => true, :delegate => true
+
+      field :route,     type: Line
+      field :area,      type: Polygon
+
+      field :square,    type: Box
+      field :around,    type: Circle
 
-      field :route,        type: Line
-      field :area,         type: Polygon
-     
-	  field :square,       type: Box
-	  field :around,       type: Circle
-    
       # spatial indexing
       spatial_index :mouth
 
       # default mongodb options
       spatial_index :mouth, {bit: 24, min: -180, max: 180}
-	  
-	  # query by location
-	  spatial_scope :location	  
+
+      # query by location
+      spatial_scope :location
     end
 
 
+Helpers
+-------
+
+You can use `:spatial => true` to add an '2d' index automatically,
+No need for `spatial_index :location`:
+
+
+    field :location,  type: Point, :spatial => true
+
+
+You can delegate some point methods to the instance itself:
+
+
+    field :location,  type: Point, :delegate => true
+
+
+Now instead of `instance.location.x` you may call `instance.x`.
+
 
 Nearby
 ------
@@ -259,11 +278,11 @@ Nearby
 You can add a `spatial_scope` on your models. So you can query:
 
     Bar.nearby(my.location)
-	
+
 instead of
 
     Bar.near(location: my.location)
-	
+
 Good when you're drunk. Just add to your model:
 
     spatial_scope :<field>

data/lib/mongoid_geospatial/helpers/delegate.rb

@@ -0,0 +1,24 @@
+Mongoid::Fields.option :delegate do |model, field, options|
+  options = {} unless options.kind_of?(Hash)
+  x_meth = options[:x] || :x
+  y_meth = options[:y] || :y
+
+  model.instance_eval do
+    define_method x_meth do self[field.name][0]; end
+    define_method y_meth do self[field.name][1]; end
+
+    define_method "#{x_meth}=" do |arg|
+      self[field.name][0] = arg
+    end
+
+    define_method "#{y_meth}=" do |arg|
+      self[field.name][1] = arg
+    end
+
+    # model.class_eval do
+    #   define_method "close_to" do |*args|
+    #     queriable.where(field.name.near_sphere => *args)
+    #   end
+    # end
+  end
+end

data/lib/mongoid_geospatial/{field_option.rb → helpers/spatial.rb}

@@ -1,5 +1,3 @@
-#require 'ostruct'
-
 Mongoid::Fields.option :spatial do |model,field,options|
   options = {} unless options.kind_of?(Hash)
   # x_meth = options[:x] || :x
@@ -13,9 +11,14 @@ Mongoid::Fields.option :spatial do |model,field,options|
 
   model.class_eval do
     (self.spatial_fields ||= []) << field.name.to_sym
-  #   define_method "distance_from_#{field.name}" do |*args|
-  #     self.distance_from(field.name, *args)
-  #   end
+    (self.spatial_fields_indexed ||= []) << field.name.to_sym
+
+    # Create 2D index
+    spatial_index field.name
+
+    # define_method "near_#{field.name}" do |*args|
+    #   queryable.where(field.near_sphere => args)
+    # end
   end
 
 end

data/lib/mongoid_geospatial/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module Geospatial
-    VERSION = "2.5.1"
+    VERSION = "2.7.0"
   end
 end

data/lib/mongoid_geospatial/wrappers/georuby.rb

@@ -1,17 +1,33 @@
-require 'georuby'
+require 'geo_ruby'
 # require 'mongoid_geospatial/extensions/georuby'
 
 module Mongoid
   module Geospatial
 
     class Point
+      delegate :distance, :to => :to_geo
+
       def to_geo
-        GeoRuby::SimpleFeatures::Point.from_x_y(x, y)
+        GeoRuby::SimpleFeatures::Point.xy(x, y)
+      end
+
+      def distance other
+        to_geo.spherical_distance(other.to_geo)
+      end
+
+      def self.mongoize(obj)
+        case obj
+        when GeoRuby::SimpleFeatures::Point then [obj.x, obj.y]
+        when Point then obj.mongoize
+        when Array then obj.to_xy
+        when Hash  then obj.to_xy
+        else obj
+        end
       end
     end
 
 
-    class Line < Array
+    class Line < GeometryField
       def to_geo
         GeoRuby::SimpleFeatures::LineString.from_array(self)
       end

data/lib/mongoid_geospatial/wrappers/rgeo.rb

@@ -5,12 +5,15 @@ module Mongoid
   module Geospatial
 
     class Point
-      delegate :distance, :to => :to_geo
 
       def to_geo
         RGeo::Geographic.spherical_factory.point x, y
       end
 
+      def distance other
+        to_geo.distance other.to_geo
+      end
+
       def self.mongoize(obj)
         case obj
         when RGeo::Geographic::SphericalPointImpl then [obj.x, obj.y]

data/lib/mongoid_geospatial.rb

@@ -4,7 +4,8 @@ require 'active_support/concern'
 require 'mongoid_geospatial/geospatial'
 require 'mongoid_geospatial/extensions/core_ext'
 require 'mongoid_geospatial/extensions/rgeo_spherical_point_impl'
-require 'mongoid_geospatial/field_option'
+require 'mongoid_geospatial/helpers/spatial'
+require 'mongoid_geospatial/helpers/delegate'
 
 require 'mongoid_geospatial/fields/geometry_field'
 

data/spec/models/bar.rb

@@ -7,7 +7,6 @@ class Bar
 
   has_one :rating, :as => :ratable
 
-  spatial_index :location
   spatial_scope :location
 
 end

data/spec/models/bus.rb

@@ -0,0 +1,11 @@
+class Bus
+  include Mongoid::Document
+  include Mongoid::Geospatial
+
+  field :plates,   :type => String
+  field :location, :type => Point, :delegate => true
+
+  spatial_index :location
+  spatial_scope :location
+
+end

data/spec/models/place.rb

@@ -0,0 +1,13 @@
+class Place
+  include Mongoid::Document
+  include Mongoid::Geospatial
+
+  field :name,     :type => String
+  field :location, :type => Point, :spatial => true
+
+  has_one :rating, :as => :ratable
+
+  spatial_index :location
+  spatial_scope :location
+
+end

data/spec/mongoid_geospatial/field_option_spec.rb

@@ -1,21 +0,0 @@
-require "spec_helper"
-
-describe Mongoid::Fields do
-
-  context "spatial" do
-    before do
-      Bar.create_indexes
-    end
-
-    it "should set some class methods" do
-      far  = Bar.create!(name: "Far", location: [7,7])
-      near = Bar.create!(name: "Near", location: [2,2])
-      Bar.nearby([1,1]).should eq([near, far])
-    end
-
-  end
-
-  context "geom" do
-  end
-
-end

data/spec/mongoid_geospatial/helpers/delegate_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+
+describe Mongoid::Fields do
+
+  context "delegate" do
+    before do
+      Bus.create_indexes
+    end
+
+    context 'x, y helpers' do
+
+      let(:bus) { Bus.create!(name: "Far", location: [7,8]) }
+
+      it "should set instance method x" do
+        bus.x.should eq(7)
+      end
+
+      it "should set instance method y" do
+        bus.y.should eq(8)
+      end
+
+      it "should set instance method x=" do
+        bus.x = 9
+        bus.x.should eq(9)
+      end
+
+      it "should set instance method y=" do
+        bus.y = 9
+        bus.y.should eq(9)
+      end
+
+    end
+
+    it "should set instance method x and y" do
+      bus = Bus.create!(name: "B", location: [7,7])
+      bus.x = 9; bus.y = 9
+      bus.location.to_a.should eq([9,9])
+    end
+
+  end
+
+  context "geom" do
+  end
+
+end

data/spec/mongoid_geospatial/helpers/spatial_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+describe Mongoid::Fields do
+
+  context "spatial" do
+    before do
+      Bar.create_indexes
+    end
+
+    it "should created indexes" do
+      Bar.index_options.keys.should include({'location' => '2d'})
+    end
+
+    it "should set spatial fields" do
+      Bar.spatial_fields.should eql([:location])
+    end
+
+    it "should set some class methods" do
+      far  = Bar.create!(name: "Far", location: [7,7])
+      near = Bar.create!(name: "Near", location: [2,2])
+      Bar.nearby([1,1]).should eq([near, far])
+    end
+
+    # it "should set some class methods" do
+    #   far  = Bar.create!(name: "Far", location: [7,7])
+    #   near = Bar.create!(name: "Near", location: [2,2])
+    #   Bar.near_location([1,1]).should eq([near, far])
+    # end
+
+  end
+
+  context "geom" do
+  end
+
+end

data/spec/mongoid_geospatial/wrappers/georuby_spec.rb

@@ -0,0 +1,62 @@
+require "spec_helper"
+
+
+describe Mongoid::Geospatial::Point do
+
+  before(:all) do
+    Mongoid::Geospatial.send(:remove_const, 'Point')
+    load "#{File.dirname(__FILE__)}/../../../lib/mongoid_geospatial/fields/point.rb"
+    Object.send(:remove_const, 'Place')
+    load "#{File.dirname(__FILE__)}/../../models/place.rb"
+  end
+
+  it "should not inferfer with mongoid" do
+    Place.create!(name: "Moe's")
+    Place.count.should eql(1)
+  end
+
+  it "should not respond to distance before loading external gem" do
+    bar = Place.create!(location: [5,5])
+    bar.location.should_not respond_to(:distance)
+  end
+
+
+  describe "queryable" do
+
+    before do
+      Mongoid::Geospatial.use_georuby
+      Place.create_indexes
+    end
+
+    describe "(de)mongoize" do
+
+      it "should mongoize array" do
+        geom = Place.new(location: [10, -9]).location
+        geom.class.should eql(Mongoid::Geospatial::Point)
+        geom.to_geo.class.should eql(GeoRuby::SimpleFeatures::Point)
+        geom.x.should be_within(0.1).of(10)
+        geom.to_geo.y.should be_within(0.1).of(-9)
+      end
+
+      it "should mongoize hash" do
+        geom = Place.new(location: {x: 10, y: -9}).location
+        geom.class.should eql(Mongoid::Geospatial::Point)
+        geom.to_geo.class.should eql(GeoRuby::SimpleFeatures::Point)
+      end
+
+      it "should accept a GeoRuby point" do
+        point = GeoRuby::SimpleFeatures::Point.from_x_y 1, 2
+        bar = Place.create!(location: point)
+        bar.location.x.should be_within(0.1).of(1)
+        bar.location.y.should be_within(0.1).of(2)
+      end
+
+      it "should calculate 3d distances by default" do
+        bar = Place.create! location: [-73.77694444, 40.63861111 ]
+        bar2 = Place.create! location: [-118.40, 33.94] #,:unit=>:mi, :spherical => true)
+        bar.location.distance(bar2.location).to_i.should be_within(1).of(3973808)
+      end
+
+    end
+  end
+end

data/spec/mongoid_geospatial/wrappers/rgeo_spec.rb

@@ -2,6 +2,13 @@ require "spec_helper"
 
 describe Mongoid::Geospatial::Point do
 
+  before(:all) do
+    Mongoid::Geospatial.send(:remove_const, 'Point')
+    load "#{File.dirname(__FILE__)}/../../../lib/mongoid_geospatial/fields/point.rb"
+    Object.send(:remove_const, 'Bar')
+    load "#{File.dirname(__FILE__)}/../../models/bar.rb"
+  end
+
   it "should not inferfer with mongoid" do
     Bar.create!(name: "Moe's")
     Bar.count.should eql(1)
@@ -16,8 +23,8 @@ describe Mongoid::Geospatial::Point do
   describe "queryable" do
 
     before do
-      Bar.create_indexes
       Mongoid::Geospatial.use_rgeo
+      Bar.create_indexes
     end
 
     describe "(de)mongoize" do
@@ -46,7 +53,7 @@ describe Mongoid::Geospatial::Point do
       it "should calculate 3d distances by default" do
         bar = Bar.create! location: [-73.77694444, 40.63861111 ]
         bar2 = Bar.create! location: [-118.40, 33.94] #,:unit=>:mi, :spherical => true)
-        bar.location.distance(bar2.location.to_geo).to_i.should be_within(1).of(3978262)
+        bar.location.distance(bar2.location).to_i.should be_within(1).of(3978262)
       end
 
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_geospatial
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-17 00:00:00.000000000 Z
+date: 2012-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -143,7 +143,6 @@ files:
 - lib/mongoid_geospatial.rb
 - lib/mongoid_geospatial/extensions/core_ext.rb
 - lib/mongoid_geospatial/extensions/rgeo_spherical_point_impl.rb
-- lib/mongoid_geospatial/field_option.rb
 - lib/mongoid_geospatial/fields/box.rb
 - lib/mongoid_geospatial/fields/circle.rb
 - lib/mongoid_geospatial/fields/geometry_field.rb
@@ -151,6 +150,8 @@ files:
 - lib/mongoid_geospatial/fields/point.rb
 - lib/mongoid_geospatial/fields/polygon.rb
 - lib/mongoid_geospatial/geospatial.rb
+- lib/mongoid_geospatial/helpers/delegate.rb
+- lib/mongoid_geospatial/helpers/spatial.rb
 - lib/mongoid_geospatial/version.rb
 - lib/mongoid_geospatial/wrappers/georuby.rb
 - lib/mongoid_geospatial/wrappers/rgeo.rb
@@ -158,10 +159,12 @@ files:
 - spec/models/address.rb
 - spec/models/alarm.rb
 - spec/models/bar.rb
+- spec/models/bus.rb
 - spec/models/event.rb
 - spec/models/farm.rb
 - spec/models/person.rb
 - spec/models/phone.rb
+- spec/models/place.rb
 - spec/models/river.rb
 - spec/mongoid_geospatial/extensions/core_ext_spec.rb
 - spec/mongoid_geospatial/field_option_spec.rb
@@ -171,6 +174,9 @@ files:
 - spec/mongoid_geospatial/fields/point_spec.rb
 - spec/mongoid_geospatial/fields/polygon_spec.rb
 - spec/mongoid_geospatial/geospatial_spec.rb
+- spec/mongoid_geospatial/helpers/delegate_spec.rb
+- spec/mongoid_geospatial/helpers/spatial_spec.rb
+- spec/mongoid_geospatial/wrappers/georuby_spec.rb
 - spec/mongoid_geospatial/wrappers/rgeo_spec.rb
 - spec/spec_helper.rb
 - spec/support/authentication.rb
@@ -205,10 +211,12 @@ test_files:
 - spec/models/address.rb
 - spec/models/alarm.rb
 - spec/models/bar.rb
+- spec/models/bus.rb
 - spec/models/event.rb
 - spec/models/farm.rb
 - spec/models/person.rb
 - spec/models/phone.rb
+- spec/models/place.rb
 - spec/models/river.rb
 - spec/mongoid_geospatial/extensions/core_ext_spec.rb
 - spec/mongoid_geospatial/field_option_spec.rb
@@ -218,6 +226,9 @@ test_files:
 - spec/mongoid_geospatial/fields/point_spec.rb
 - spec/mongoid_geospatial/fields/polygon_spec.rb
 - spec/mongoid_geospatial/geospatial_spec.rb
+- spec/mongoid_geospatial/helpers/delegate_spec.rb
+- spec/mongoid_geospatial/helpers/spatial_spec.rb
+- spec/mongoid_geospatial/wrappers/georuby_spec.rb
 - spec/mongoid_geospatial/wrappers/rgeo_spec.rb
 - spec/spec_helper.rb
 - spec/support/authentication.rb