mongoid-geospatial 5.0.0 → 5.1.0

data/RELEASING.md

@@ -0,0 +1,62 @@
+Releasing Mongoid::Geospatial
+=============================
+
+There're no particular rules about when to release mongoid-geospatial. Release bug fixes frequently, features not so frequently and breaking API changes rarely.
+
+### Release
+
+Run tests, check that all tests succeed locally.
+
+```
+bundle install
+bundle exec rake
+```
+
+Check that the last build succeeded in [Travis CI](https://travis-ci.org/mongoid/mongoid-geospatial) for all supported platforms.
+
+Change "Next Release" in [CHANGELOG.md](CHANGELOG.md) to the new version.
+
+```
+### 0.4.0 (2014-01-27)
+```
+
+Remove the line with "Your contribution here.", since there will be no more contributions to this release.
+
+Commit your changes.
+
+```
+git add CHANGELOG.md lib/mongoid/geospatial/version.rb
+git commit -m "Preparing for release, 0.4.0."
+git push origin master
+```
+
+Release.
+
+```
+$ rake release
+
+mongoid-geospatial 0.4.0 built to pkg/mongoid-geospatial-0.4.0.gem.
+Tagged v0.4.0.
+Pushed git commits and tags.
+Pushed mongoid-geospatial 0.4.0 to rubygems.org.
+```
+
+### Prepare for the Next Version
+
+Add the next release to [CHANGELOG.md](CHANGELOG.md).
+
+```
+### 0.4.1 (Next)
+
+* Your contribution here.
+```
+
+Increment the minor version, modify [lib/mongoid/geospatial/version.rb](lib/mongoid/geospatial/version.rb).
+
+Commit your changes.
+
+```
+git add CHANGELOG.md lib/mongoid/geospatial/version.rb
+git commit -m "Preparing for next developer iteration, 0.4.1."
+git push origin master
+```

data/Rakefile

@@ -12,6 +12,9 @@ RSpec::Core::RakeTask.new(:rcov) do |spec|
   spec.rcov = true
 end
 
-task default: :spec
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[rubocop spec]
 
 require 'yard'

data/bench/bench

@@ -2,7 +2,7 @@
 #
 # Just for fun
 #
-$LOAD_PATH << File.expand_path('../../lib', __FILE__)
+$LOAD_PATH << File.expand_path('../lib', __dir__)
 
 require 'mongoid/geospatial'
 

data/lib/mongoid/geospatial.rb

@@ -27,10 +27,10 @@ module Mongoid
 
     # Symbols accepted as 'longitude', 'x'...
     LNG_SYMBOLS = [:x, :lon, :long, :lng, :longitude,
-                   'x', 'lon', 'long', 'lng', 'longitude']
+                   'x', 'lon', 'long', 'lng', 'longitude'].freeze
 
     # Symbols accepted as 'latitude', 'y'...
-    LAT_SYMBOLS = [:y, :lat, :latitude, 'y', 'lat', 'latitude']
+    LAT_SYMBOLS = [:y, :lat, :latitude, 'y', 'lat', 'latitude'].freeze
 
     # For distance spherical calculations
     EARTH_RADIUS_KM = 6371 # taken directly from mongodb
@@ -38,12 +38,12 @@ module Mongoid
 
     # Earth radius in multiple units
     EARTH_RADIUS = {
-      m:  EARTH_RADIUS_KM * 1000,
+      m: EARTH_RADIUS_KM * 1000,
       km: EARTH_RADIUS_KM,
       mi: EARTH_RADIUS_KM * 0.621371192,
       ft: EARTH_RADIUS_KM * 5280 * 0.621371192,
       sm: EARTH_RADIUS_KM * 0.53995680345572 # sea mile
-    }
+    }.freeze
 
     mattr_accessor :lng_symbols
     mattr_accessor :lat_symbols
@@ -120,3 +120,5 @@ module Mongoid
     end
   end
 end
+
+require 'mongoid/geospatial/config'

data/lib/mongoid/geospatial/config.rb

@@ -0,0 +1,29 @@
+module Mongoid
+  module Geospatial
+    module Config
+      autoload :Point, 'mongoid/geospatial/config/point'
+
+      extend self
+
+      def reset!
+        Mongoid::Geospatial::Config::Point.reset!
+      end
+
+      def point
+        Mongoid::Geospatial::Config::Point
+      end
+
+      reset!
+    end
+
+    class << self
+      def configure
+        block_given? ? yield(Config) : Config
+      end
+
+      def config
+        Config
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Mongoid
+  module Geospatial
+    module Config
+      module Point
+        extend self
+
+        attr_accessor :x
+        attr_accessor :y
+
+        def reset!
+          self.x = Mongoid::Geospatial.lng_symbols
+          self.y = Mongoid::Geospatial.lat_symbols
+        end
+
+        reset!
+      end
+    end
+  end
+end

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

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

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

@@ -18,10 +18,11 @@ module Mongoid
       # @return (Array)
       def mongoize
         return nil unless x && y
+
         [x, y]
       end
-      alias_method :to_a,  :mongoize
-      alias_method :to_xy, :mongoize
+      alias to_a mongoize
+      alias to_xy mongoize
 
       def [](args)
         mongoize[args]
@@ -40,7 +41,7 @@ module Mongoid
       def to_hsh(xl = :x, yl = :y)
         { xl => x, yl => y }
       end
-      alias_method :to_hash, :to_hsh
+      alias to_hash to_hsh
 
       #
       # Helper for [self, radius]
@@ -144,7 +145,8 @@ module Mongoid
           when NilClass then nil
           else
             return obj.to_xy if obj.respond_to?(:to_xy)
-            fail 'Invalid Point'
+
+            raise 'Invalid Point'
           end
         end
 
@@ -171,6 +173,7 @@ module Mongoid
         #
         def from_string(str)
           return nil if str.empty?
+
           str.split(/,|\s/).reject(&:empty?).map(&:to_f)
         end
 
@@ -185,6 +188,7 @@ module Mongoid
         #
         def from_array(array)
           return nil if array.empty?
+
           array.flatten[0..1].map(&:to_f)
         end
 
@@ -203,20 +207,23 @@ module Mongoid
         # @return (Array)
         #
         def from_hash(hsh)
-          fail 'Hash must have at least 2 items' if hsh.size < 2
+          raise '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
+          v = (Mongoid::Geospatial::Config::Point.y & hsh.keys).first
           return hsh[v].to_f if !v.nil? && hsh[v]
-          fail "Hash must contain #{Mongoid::Geospatial.lat_symbols.inspect}"
+
+          raise "Hash must contain #{Mongoid::Geospatial::Config::Point.y.inspect}"
         end
 
         def from_hash_x(hsh)
-          v = (Mongoid::Geospatial.lng_symbols & hsh.keys).first
+          v = (Mongoid::Geospatial::Config::Point.x & hsh.keys).first
           return hsh[v].to_f if !v.nil? && hsh[v]
-          fail "Hash must contain #{Mongoid::Geospatial.lng_symbols.inspect}"
+
+          raise "Hash must contain #{Mongoid::Geospatial::Config::Point.x.inspect}"
         end
       end # << self
     end # Point

data/lib/mongoid/geospatial/geometry_field.rb

@@ -17,8 +17,10 @@ module Mongoid
       # @return [Array] containing 2 points
       #
       def bounding_box
-        max_x, min_x = -Float::MAX, Float::MAX
-        max_y, min_y = -Float::MAX, Float::MAX
+        max_x = -Float::MAX
+        min_x = Float::MAX
+        max_y = -Float::MAX
+        min_y = Float::MAX
         each do |point|
           max_y = point[1] if point[1] > max_y
           min_y = point[1] if point[1] < min_y
@@ -27,7 +29,7 @@ module Mongoid
         end
         [[min_x, min_y], [max_x, max_y]]
       end
-      alias_method :bbox, :bounding_box
+      alias bbox bounding_box
 
       #
       # Determines the 5 points geometry bounding box.
@@ -53,7 +55,7 @@ module Mongoid
         min, max = *bbox
         [(min[0] + max[0]) / 2.0, (min[1] + max[1]) / 2.0]
       end
-      alias_method :center, :center_point
+      alias center center_point
 
       #
       # Generates a radius from the point

data/lib/mongoid/geospatial/version.rb

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

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

@@ -16,6 +16,7 @@ module Mongoid
       # @return (GeoRuby::SimpleFeatures::Point)
       def to_geo
         return unless valid?
+
         GeoRuby::SimpleFeatures::Point.xy(x, y)
       end
 

data/mongoid-geospatial.gemspec

@@ -1,12 +1,11 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/mongoid/geospatial/version', __FILE__)
+require File.expand_path('lib/mongoid/geospatial/version', __dir__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ['Ryan Ong', 'Marcos Piccinini']
   gem.email         = ['use@git.hub.com']
   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.homepage      = 'https://github.com/mongoid/mongoid-geospatial'
 
   gem.files         = `git ls-files`.split("\n")
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -15,5 +14,5 @@ Gem::Specification.new do |gem|
   gem.version       = Mongoid::Geospatial::VERSION
   gem.license       = 'MIT'
 
-  gem.add_dependency('mongoid', ['>= 5.0.0.beta'])
+  gem.add_dependency('mongoid', ['>= 4.0.0'])
 end

data/spec/models/event.rb

@@ -10,7 +10,7 @@ class Event
 
   def self.each_day(start_date, end_date)
     groups = only(:date).asc(:date)
-             .where(:date.gte => start_date, :date.lte => end_date).group
+                        .where(:date.gte => start_date, :date.lte => end_date).group
     groups.each do |hash|
       yield(hash['date'], hash['group'])
     end

data/spec/models/farm.rb

@@ -6,7 +6,7 @@ class Farm
   field :name,         type: String
   field :geom,         type: Point,    sphere: true
   field :area,         type: Polygon,  spatial: true
-  field :m2,           type: Fixnum
+  field :m2,           type: Integer
 
   spatial_index :geom
   spatial_index :area

data/spec/models/person.rb

@@ -27,7 +27,7 @@ class Person
   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') }
+                                default: -> { 1.day.ago.in_time_zone('Alaska') }
 
   # Geo
   field :location, type: Point
@@ -58,15 +58,13 @@ class Person
   accepts_nested_attributes_for :addresses
 
   scope :minor, -> { where(:age.lt => 18) }
-  scope :without_ssn, -> {  without(:ssn) }
+  scope :without_ssn, -> { without(:ssn) }
 
   def score_with_rescoring=(score)
     @rescored = score.to_i + 20
     self.score_without_rescoring = score
   end
 
-  alias_method_chain :score=, :rescoring
-
   def update_addresses
     addresses.each do |address|
       address.street = 'Updated Address'

data/spec/mongoid/geospatial/config_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Mongoid::Geospatial::Config do
+  context 'point' do
+    it 'uses LonLat by default' do
+      expect(Mongoid::Geospatial.config.point.x).to eq Mongoid::Geospatial.lng_symbols
+      expect(Mongoid::Geospatial.config.point.y).to eq Mongoid::Geospatial.lat_symbols
+    end
+    context 'configured as latlon' do
+      before do
+        Mongoid::Geospatial.configure do |config|
+          config.point.x = Mongoid::Geospatial.lat_symbols
+          config.point.y = Mongoid::Geospatial.lng_symbols
+        end
+      end
+      it 'uses latlon' do
+        expect(Mongoid::Geospatial.config.point.x).to eq Mongoid::Geospatial.lat_symbols
+        expect(Mongoid::Geospatial.config.point.y).to eq Mongoid::Geospatial.lng_symbols
+      end
+    end
+  end
+end

data/spec/mongoid/geospatial/fields/point_spec.rb

@@ -33,6 +33,24 @@ describe Mongoid::Geospatial::Point do
       bar.location = '2.99 ,  3.99'
       expect(bar.location.mongoize).to eq([2.99, 3.99])
     end
+
+    it 'should set point from hash' do
+      bar.location = { latitude: 2.99, longitude: 3.99 }
+      expect(bar.location.mongoize).to eq([3.99, 2.99])
+    end
+
+    context 'configured as latlon' do
+      before do
+        Mongoid::Geospatial.configure do |config|
+          config.point.x = Mongoid::Geospatial.lat_symbols
+          config.point.y = Mongoid::Geospatial.lng_symbols
+        end
+      end
+      it 'should set point from hash' do
+        bar.location = { latitude: 2.99, longitude: 3.99 }
+        expect(bar.location.mongoize).to eq([2.99, 3.99])
+      end
+    end
   end
 
   it 'should have #reverse to get lat, lon' do
@@ -83,7 +101,7 @@ describe Mongoid::Geospatial::Point do
     end
 
     it 'should have an ActiveModel symbol accessor' do
-      expect(bar[:location]).to eq([3, 2])
+      expect(bar[:location].to_a).to eq([3, 2])
     end
 
     it 'should have a radius helper' do
@@ -198,7 +216,8 @@ describe Mongoid::Geospatial::Point do
       it 'returns the documents within a box' do
         poly = Mongoid::Geospatial::LineString.new(
           [elvis.location.map { |c| c + 1 },
-           elvis.location.map { |c| c - 1 }])
+           elvis.location.map { |c| c - 1 }]
+        )
         expect(Bar.where(:location.within_polygon => [poly.geom_box]).to_a)
           .to include(mile3)
       end

data/spec/mongoid/geospatial/geospatial_spec.rb

@@ -72,7 +72,7 @@ describe Mongoid::Geospatial do
       before do
         Alarm.create_indexes
         50.times do
-          Alarm.create(spot: [rand(10) + 1, rand(10) + 1])
+          Alarm.create(spot: [rand(1..10), rand(1..10)])
         end
       end