mongoid_geo 0.1.1 → 0.1.2

data/README.textile

@@ -5,18 +5,57 @@ A Geo extension for Mongoid.
 "MongoDB Geospatial Indexing":http://www.mongodb.org/display/DOCS/Geospatial+Indexing
 
 * Supports Mongoid 1.7 sphere distance calculations and 
-* Adds a set of geo related inflections
 * Adds nearSphere inclusion method
+* Adds a set of geo related inflections
+* Adds an exta option for defining a "geo" field, to have the generated attr_writer parse and convert strings etc. to float arrays.
+
+h2. Mongoid 2 geo features
+
+h3. Find addresses near a point
+
+<pre>
+  Address.near(:latlng => [37.761523, -122.423575, 1])
+</pre>
+
+h3. Find locations within a circle
 
-h2. Status
+<pre>
+  base.where(:location.within => { "$center" => [ [ 50, -40 ], 1 ] })  
+</pre>
+
+h3. Create geo-spatial index
+
+<pre>
+  class Person
+    field :locations, :type => Array
+    index [[ :locations, Mongo::GEO2D ]], :min => -180, :max => 180      
+  end
 
-This gem has so far just the initial design and has not been tested. Feel free to help in the effort. Thanks!
+  # to ensure indexes are created, either:
+  Mongoid.autocreate_indexes = true
 
-h2. Fields
+  # or in the mongoid.yml
+  autocreate_indexes: true  
+</pre>
+
+These are the only geo features I could find are currently built-in for Mongoid 2. 
+_Mongoid Geo_ implements the following extra features...
+
+h1. Mongoid Geo features
+
+The following briefly demonstrates all the features that Mongoid Geo currently provides
+
+h2. Geo index
+
+Old/Manual way: @index [[ :locations, Mongo::GEO2D ]], :min => -180, :max => 180@
+
+Using new _geo_index_ class method : @geo_index :locations@
+
+h2. Special geo-array attribute writer 
 
 When setting a geo-location array, the setter should try to convert the value to an array of floats 
 
-Old/Manual style:
+Old/Manual way:
 
 <pre>
   class Person
@@ -28,11 +67,13 @@ Old/Manual style:
   end  
 </pre>
 
-With _mongoid-geo_, becomes:
+With the new @:geo@ option supplied by _mongoid-geo_ :
 
 <pre>
   class Person
     field :locations, :type => Array, :geo => true
+    
+    geo_index :locations
   end  
   
    p = Person.new
@@ -43,9 +84,17 @@ With _mongoid-geo_, becomes:
    assert([45.1, -3.4], p.locations)   
 </pre>
 
-h2. Extra Geo Inclusions
 
-Find all addresses near a point using spherical distance calculation
+h2. Mongoid Geo extra inclusions
+
+Find addresses near a point using spherical distance calculation
+
+<pre>
+  Address.nearSphere(:locations => [ 72, -44 ])
+</pre>
+
+
+h2. Mongoid Geo extra inflections
 
 h3. nearSphere
 
@@ -54,8 +103,6 @@ h3. nearSphere
   # => :locations => { "$nearSphere" : [ 72, -44 ] }
 </pre>
 
-h2. Extra Geo Inflections
-
 h3. nearMax
 
 Find all addresses near a point using spherical distance calculation

data/lib/mongoid/geo.rb

@@ -1,2 +1,3 @@
 require 'mongoid/geo/criteria'
-require 'mongoid/geo/fields'
+require 'mongoid/geo/fields'
+require 'mongoid/geo/index'

data/lib/mongoid/geo/index.rb

@@ -0,0 +1,9 @@
+module Mongoid #:nodoc
+  module Indexes #:nodoc
+    module ClassMethods #:nodoc
+      def geo_index name
+        index [[ name, Mongo::GEO2D ]], :min => -180, :max => 180
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_geo
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: !!null 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ default_executable: !!null
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156773960 !ruby/object:Gem::Requirement
+  requirement: &2156734180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156773960
+  version_requirements: *2156734180
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &2156773320 !ruby/object:Gem::Requirement
+  requirement: &2156733620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: 2.0.0.rc.6
   type: :runtime
   prerelease: false
-  version_requirements: *2156773320
+  version_requirements: *2156733620
 - !ruby/object:Gem::Dependency
   name: bson_ext
-  requirement: &2156772700 !ruby/object:Gem::Requirement
+  requirement: &2156733100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,7 +44,7 @@ dependencies:
         version: 1.1.6
   type: :runtime
   prerelease: false
-  version_requirements: *2156772700
+  version_requirements: *2156733100
 description: Geo spatial extension on Mongoid 2, to add more geo-spatial capabilities
 email:
 - kmandrup@gmail.com
@@ -59,6 +59,7 @@ files:
 - lib/mongoid/geo/criterion/outer_operator.rb
 - lib/mongoid/geo/criterion/twin_operators.rb
 - lib/mongoid/geo/fields.rb
+- lib/mongoid/geo/index.rb
 - lib/mongoid/geo/inflections.rb
 - lib/mongoid/geo.rb
 - lib/mongoid_geo.rb