mongoid_geospatial 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f481eb153c311039d3c9ab431dd181481b51a97b
-  data.tar.gz: 3d1fa8021e6b79c79e85463a468ea865e53cdd99
+  metadata.gz: 21d6d74c13e2891b09aa7aeffa7b6fa6399d9d48
+  data.tar.gz: ac5e8cd42381ebce08dc3db81f43abcecea37db0
 SHA512:
-  metadata.gz: bc40ac5a0f57a48a1d83c4c940b86ca381252aafa17b2eb90a1943fc27303007230e66a3ff1b98420735dadfc5b58f0d1e2478c58c1e58c7d73b66e3f5a8e433
-  data.tar.gz: d5264c6beec42461c03d803892b2b46270e17e9bdbdd6f9f160cdcabc9cd2230d162bfbf39f59889b4b809e6d52da67247ad7346a1ee12e3ceac874d62cd6dab
+  metadata.gz: 9eb99f91d65bd9ff57b4047deeedcd0853b86412fa98906703f1a3e90e7752f9642a2a490de19ef312931647bbc37abe76c40cd6c9cf5d45eb908daa3179d36d
+  data.tar.gz: b78d364526ccd9a4da0ec39863c70b5ee1129c9813e2e7c75fab5c23ce6afb5a92744d374b9ca388cb44d28b4912acf0e5574debb351743d1a56e3d3aa365cb3

data/lib/mongoid_geospatial.rb

@@ -2,8 +2,6 @@ require 'mongoid'
 require 'active_support/core_ext/string/inflections'
 require 'active_support/concern'
 require 'mongoid_geospatial/geospatial'
-require 'mongoid_geospatial/extensions/rgeo_spherical_point_impl'
-require 'mongoid_geospatial/helpers/core'
 require 'mongoid_geospatial/helpers/spatial'
 require 'mongoid_geospatial/helpers/sphere'
 require 'mongoid_geospatial/helpers/delegate'

data/lib/mongoid_geospatial/{extensions → ext}/rgeo_spherical_point_impl.rb

@@ -3,7 +3,7 @@ module RGeo
     # RGeo Point
     class SphericalPointImpl
 
-      def mongoize
+      def to_xy
         [x, y]
       end
 

data/lib/mongoid_geospatial/fields/box.rb

@@ -1,7 +1,6 @@
 module Mongoid
   module Geospatial
     class Box < GeometryField
-
     end
   end
 end

data/lib/mongoid_geospatial/fields/circle.rb

@@ -1,12 +1,14 @@
 module Mongoid
   module Geospatial
+    # Circle
+    #
     class Circle < GeometryField
       attr_accessor :center, :radius
 
       def point
         Point.new(self[0])
       end
-      alias :point :center
+      alias_method :point, :center
 
       def radius
         self[1]

data/lib/mongoid_geospatial/fields/geometry_field.rb

@@ -1,5 +1,7 @@
 module Mongoid
   module Geospatial
+    # Main Geometry Array
+    # Holds Lines/Polygons....
     class GeometryField < Array
 
       def bounding_box
@@ -13,32 +15,30 @@ module Mongoid
         end
         [[min_x, min_y], [max_x, max_y]]
       end
-      alias :bbox :bounding_box
+      alias_method :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
+      alias_method :center, :center_point
 
-      def radius r = 1
+      def radius(r = 1)
         [center, r]
       end
 
-      def radius_sphere r = 1, unit = :km
-        radius r.to_f/Mongoid::Geospatial.earth_radius[unit]
+      def radius_sphere(r = 1, unit = :km)
+        radius r.to_f / Mongoid::Geospatial.earth_radius[unit]
       end
 
-
       class << self
 
         # Database -> Object
         def demongoize(o)
-          self.new(o)
+          new(o)
         end
 
       end
-
     end
   end
 end

data/lib/mongoid_geospatial/fields/point.rb

@@ -1,21 +1,24 @@
 module Mongoid
   module Geospatial
+    # Point
+    #
     class Point
       include Enumerable
       attr_reader :x, :y
 
       def initialize(x = nil, y = nil)
-        return unless x
-        ll = y ? [x, y] : x.split(/,|\s/).reject(&:empty?)
-        @x, @y = ll.map(&:to_f)
+        return unless x && y
+        @x, @y = x, y
       end
 
       # Object -> Database
+      # Let's store NilClass if we are invalid.
       def mongoize
+        return nil unless x && y
         [x, y]
       end
-      alias :to_a  :mongoize
-      alias :to_xy :mongoize
+      alias_method :to_a,  :mongoize
+      alias_method :to_xy, :mongoize
 
       def [](args)
         mongoize[args]
@@ -30,44 +33,88 @@ module Mongoid
         "#{x}, #{y}"
       end
 
-      def to_hsh xl = :x, yl = :y
-        {xl => x, yl => y}
+      def to_hsh(xl = :x, yl = :y)
+        { xl => x, yl => y }
       end
-      alias :to_hash :to_hsh
+      alias_method :to_hash, :to_hsh
 
-      def radius r = 1
+      def radius(r = 1)
         [mongoize, r]
       end
 
-      def radius_sphere r = 1, unit = :km
-        radius r.to_f/Mongoid::Geospatial.earth_radius[unit]
+      def radius_sphere(r = 1, unit = :km)
+        radius r.to_f / Mongoid::Geospatial.earth_radius[unit]
+      end
+
+      def valid?
+        x && y && x.is_a?(Numeric) && y.is_a?(Numeric)
       end
 
       #
       # Distance calculation methods. Thinking about not using it
       # One needs to choose and external lib. GeoRuby or RGeo
       #
-      # #Return the distance between the 2D points (ie taking care only of the x and y coordinates), assuming
-      # #the points are in projected coordinates. Euclidian distance in whatever unit the x and y ordinates are.
+      # Return the distance between the 2D points (ie taking care
+      # only of the x and y coordinates), assuming the points are
+      # in projected coordinates. Euclidian distance in whatever
+      # unit the x and y ordinates are.
       # def euclidian_distance(point)
       #   Math.sqrt((point.x - x)**2 + (point.y - y)**2)
       # end
 
       # # Spherical distance in meters, using 'Haversine' formula.
       # # with a radius of 6471000m
-      # # Assumes x is the lon and y the lat, in degrees (Changed in version 1.1).
-      # # The user has to make sure using this distance makes sense (ie she should be in latlon coordinates)
+      # # Assumes x is the lon and y the lat, in degrees (Changed
+      # in version 1.1).
+      # # The user has to make sure using this distance makes sense
+      # (ie she should be in latlon coordinates)
       # def spherical_distance(point,r=6370997.0)
       #   dlat = (point.lat - lat) * DEG2RAD / 2
       #   dlon = (point.lon - lon) * DEG2RAD / 2
 
-      #   a = Math.sin(dlat)**2 + Math.cos(lat * DEG2RAD) * Math.cos(point.lat * DEG2RAD) * Math.sin(dlon)**2
+      #   a = Math.sin(dlat)**2 + Math.cos(lat * DEG2RAD) *
+      #         Math.cos(point.lat * DEG2RAD) * Math.sin(dlon)**2
       #   c = 2 * Math.atan2(Math.sqrt(a), Math.sqrt(1-a))
       #   r * c
       # end
 
       class << self
 
+        # Makes life easier:
+        # "" -> nil
+        def from_string(str)
+          return nil if str.empty?
+          str.split(/,|\s/).reject(&:empty?).map(&:to_f)
+        end
+
+        # Also makes life easier:
+        # [] -> nil
+        def from_array(ary)
+          return nil if ary.empty?
+          ary[0..1].map(&:to_f)
+        end
+
+        # Throw error on wrong hash, just for a change.
+        def from_hash(hsh)
+          fail "Hash must have at least 2 items" if hsh.size < 2
+          [from_hash_x(hsh), from_hash_y(hsh)]
+        end
+
+        def from_hash_y(hsh)
+          v = (Mongoid::Geospatial.lat_symbols & hsh.keys).first
+          return hsh[v].to_f if !v.nil? && hsh[v]
+          fail "Hash must contain #{Mongoid::Geospatial.lat_symbols.inspect} if Ruby version is less than 1.9" if RUBY_VERSION.to_f < 1.9
+          fail "Hash cannot contain #{Mongoid::Geospatial.lng_symbols.inspect} as the second item if there is no #{Mongoid::Geospatial.lat_symbols.inspect}" if Mongoid::Geospatial.lng_symbols.index(hsh.keys[1])
+          hsh.values[1].to_f
+        end
+
+        def from_hash_x(hsh)
+          v = (Mongoid::Geospatial.lng_symbols & hsh.keys).first
+          return hsh[v].to_f if !v.nil? && hsh[v]
+          fail "Hash cannot contain #{Mongoid::Geospatial.lat_symbols.inspect} as the first item if there is no #{Mongoid::Geospatial.lng_symbols.inspect}" if Mongoid::Geospatial.lat_symbols.index(keys[0])
+          values[0].to_f
+        end
+
         # Database -> Object
         def demongoize(object)
           Point.new(*object) if object
@@ -75,10 +122,14 @@ module Mongoid
 
         def mongoize(object)
           case object
-          when Point then object.mongoize
-          when Array then Geospatial.from_array(object)
-          when Hash then Geospatial.from_hash(object)
-          else object.mongoize
+          when Point  then object.mongoize
+          when String then from_string(object)
+          when Array  then from_array(object)
+          when Hash   then from_hash(object)
+          when NilClass then nil
+          else
+            return object.to_xy if object.respond_to?(:to_xy)
+            fail 'Invalid Point'
           end
         end
 
@@ -87,8 +138,9 @@ module Mongoid
         def evolve(object)
           object.respond_to?(:x) ? object.mongoize : object
         end
-      end
 
-    end
-  end
-end
+      end # << self
+
+    end # Point
+  end # Geospatial
+end # Mongoid

data/lib/mongoid_geospatial/fields/polygon.rb

@@ -1,7 +1,6 @@
 module Mongoid
   module Geospatial
     class Polygon < GeometryField
-
     end
   end
 end

data/lib/mongoid_geospatial/geospatial.rb

@@ -12,7 +12,7 @@ module Mongoid
       :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,
+      :ft => EARTH_RADIUS_KM * 5280 * 0.621371192,
       :sm => EARTH_RADIUS_KM * 0.53995680345572 # sea mile
     }
 
@@ -41,6 +41,7 @@ module Mongoid
     end
 
     module ClassMethods #:nodoc:
+
       def geo_field name, options = {}
         field name, {type: Mongoid::Geospatial::Point, spatial: true}.merge(options)
       end
@@ -51,15 +52,15 @@ module Mongoid
       # http://www.mongodb.org/display/DOCS/Geospatial+Indexing#GeospatialIndexing-geoNearCommand
       def spatial_index name, options = {}
         self.spatial_fields_indexed << name
-        index({name => '2d'}, options)
+        index({ name => '2d' }, options)
       end
 
-      def sphere_index name, options = {}
+      def sphere_index(name, options = {})
         self.spatial_fields_indexed << name
-        index({name => '2dsphere'}, options)
+        index({ name => '2dsphere' }, options)
       end
 
-      def spatial_scope field, opts = {}
+      def spatial_scope(field, opts = {})
         self.singleton_class.class_eval do
           # define_method(:close) do |args|
           define_method(:nearby) do |args|

data/lib/mongoid_geospatial/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module Geospatial
-    VERSION = "3.0.0"
+    VERSION = "3.1.0"
   end
 end

data/lib/mongoid_geospatial/wrappers/georuby.rb

@@ -1,5 +1,4 @@
 require 'geo_ruby'
-require 'mongoid_geospatial/extensions/georuby_point'
 
 module Mongoid
   module Geospatial
@@ -8,10 +7,11 @@ module Mongoid
       delegate :distance, :to => :to_geo
 
       def to_geo
+        return unless valid?
         GeoRuby::SimpleFeatures::Point.xy(x, y)
       end
 
-      def geo_distance other
+      def geo_distance(other)
         to_geo.spherical_distance(other.to_geo)
       end
 

data/lib/mongoid_geospatial/wrappers/rgeo.rb

@@ -1,5 +1,5 @@
 require 'rgeo'
-require 'mongoid_geospatial/extensions/rgeo_spherical_point_impl'
+require 'mongoid_geospatial/ext/rgeo_spherical_point_impl'
 
 module Mongoid
   module Geospatial

data/spec/mongoid_geospatial/fields/point_spec.rb

@@ -21,19 +21,19 @@ describe Mongoid::Geospatial::Point do
 
   it "should set point with comma separated text" do
     bar = Bar.create!(name: "Moe's", location: Mongoid::Geospatial::Point.new)
-    bar.location = Mongoid::Geospatial::Point.new("2.99,3.99")
+    bar.location = "2.99,3.99"
     bar.location.mongoize.should eq([2.99, 3.99])
   end
 
   it "should set point with space separated text" do
     bar = Bar.create!(name: "Moe's", location: Mongoid::Geospatial::Point.new)
-    bar.location = Mongoid::Geospatial::Point.new("2.99 3.99")
+    bar.location = "2.99 3.99"
     bar.location.mongoize.should eq([2.99, 3.99])
   end
 
   it "should set point with space comma separated text" do
     bar = Bar.create!(name: "Moe's", location: Mongoid::Geospatial::Point.new)
-    bar.location = Mongoid::Geospatial::Point.new("2.99 ,  3.99")
+    bar.location = "2.99 ,  3.99"
     bar.location.mongoize.should eq([2.99, 3.99])
   end
 
@@ -42,7 +42,23 @@ describe Mongoid::Geospatial::Point do
     bar.location = nil
     bar.location.should be_nil
     bar.save.should be_true
-    Bar.first.location.should be_nil
+    Bar.where(location: nil).first.should eq(bar)
+  end
+
+  it "should set point empty string to nil" do
+    bar = Bar.create!(name: "Moe's", location: [1, 1])
+    bar.location = ""
+    bar.location.should be_nil
+    bar.save.should be_true
+    Bar.where(location: nil).first.should eq(bar)
+  end
+
+  it "should set point empty array to nil" do
+    bar = Bar.create!(name: "Moe's", location: [1, 1])
+    bar.location = []
+    bar.location.should be_nil
+    bar.save.should be_true
+    Bar.where(location: nil).first.should eq(bar)
   end
 
   describe "methods" do

data/spec/mongoid_geospatial/wrappers/georuby_spec.rb

@@ -20,7 +20,6 @@ describe Mongoid::Geospatial::Point do
     bar.location.should_not respond_to(:distance)
   end
 
-
   describe "queryable" do
 
     before do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_geospatial
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Ryan Ong
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-06 00:00:00.000000000 Z
+date: 2013-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -70,8 +70,7 @@ files:
 - README.md
 - Rakefile
 - lib/mongoid_geospatial.rb
-- lib/mongoid_geospatial/extensions/georuby_point.rb
-- lib/mongoid_geospatial/extensions/rgeo_spherical_point_impl.rb
+- lib/mongoid_geospatial/ext/rgeo_spherical_point_impl.rb
 - lib/mongoid_geospatial/fields/box.rb
 - lib/mongoid_geospatial/fields/circle.rb
 - lib/mongoid_geospatial/fields/geometry_field.rb
@@ -79,7 +78,6 @@ files:
 - lib/mongoid_geospatial/fields/point.rb
 - lib/mongoid_geospatial/fields/polygon.rb
 - lib/mongoid_geospatial/geospatial.rb
-- lib/mongoid_geospatial/helpers/core.rb
 - lib/mongoid_geospatial/helpers/delegate.rb
 - lib/mongoid_geospatial/helpers/spatial.rb
 - lib/mongoid_geospatial/helpers/sphere.rb

data/lib/mongoid_geospatial/extensions/georuby_point.rb

@@ -1,12 +0,0 @@
-module GeoRuby
-  module SimpleFeatures
-    # GeoRuby Point
-    class Point
-
-      def mongoize
-        [x, y]
-      end
-
-    end
-  end
-end

data/lib/mongoid_geospatial/helpers/core.rb

@@ -1,28 +0,0 @@
-module Mongoid
-  module Geospatial
-
-    def self.from_array(ary)
-      ary[0..1].map(&:to_f)
-    end
-
-    def self.from_hash(hsh)
-      raise "Hash must have at least 2 items" if hsh.size < 2
-      [from_hash_x(hsh), from_hash_y(hsh)]
-    end
-
-    def self.from_hash_y(hsh)
-      v = (Mongoid::Geospatial.lat_symbols & hsh.keys).first
-      return hsh[v].to_f if !v.nil? && hsh[v]
-      fail "Hash must contain #{Mongoid::Geospatial.lat_symbols.inspect} if ruby version is less than 1.9" if RUBY_VERSION.to_f < 1.9
-      fail "Hash cannot contain #{Mongoid::Geospatial.lng_symbols.inspect} as the second item if there is no #{Mongoid::Geospatial.lat_symbols.inspect}" if Mongoid::Geospatial.lng_symbols.index(hsh.keys[1])
-      hsh.values[1].to_f
-    end
-
-    def self.from_hash_x(hsh)
-      v = (Mongoid::Geospatial.lng_symbols & hsh.keys).first
-      return hsh[v].to_f if !v.nil? && hsh[v]
-      fail "Hash cannot contain #{Mongoid::Geospatial.lat_symbols.inspect} as the first item if there is no #{Mongoid::Geospatial.lng_symbols.inspect}" if Mongoid::Geospatial.lat_symbols.index(keys[0])
-      values[0].to_f
-    end
-  end
-end