geo-calculator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad31f2eb55e43264bc6f0b7c6e7cf73a4bf89f13
+  data.tar.gz: 62de18df9d4dc630fae7c4ddd4004bb4a515575b
+SHA512:
+  metadata.gz: 2149633f7a90f466839b83d83d0b256b8eeb006ea0c3d304055e14618687f40adcdcd080b66175b67abeb9314697331c60d8efbce58ae396528a6cb3c1278d5e
+  data.tar.gz: fff58386134bfe6cb04c504051b322f698be8f7735bca9fbd66c0156844ffda53c704103b34b617825fecf12f6f2dbf98eed9810185e2e97ab3b72a2b3ec270e

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/.rbenv-version

@@ -0,0 +1 @@
+2.2.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in geo-calculator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Ryan MacInnes
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# GeoCalculator
+
+GeoCalculator is an extraction of the calculation methods from the [Ruby Geocoder](https://github.com/alexreisner/geocoder) gem. Its purpose is to allow the geocoding calculation methods for models that already have latitude and longitude (obtained from the browser or an iphone app) to use distance calculations to find nearby model instances. It was extracted for use in Heat.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'geo-calculator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install geo-calculator
+
+## Usage
+
+Add the line `include Geocoder::Store::ActiveRecord` into your model like so:
+
+	# app/models/location.rb
+	class Location < ActiveRecord::Base
+	  include Geocoder::Store::ActiveRecord
+
+	  def self.geocoder_options
+	    {
+	      latitude: 'latitude',
+	      longitude: 'longitude',
+	      units: :mi
+	    }
+	  end
+	end
+
+make sure that your model has a `latitude` and `longitude` column.
+
+Make sure to define the `geocoder_options` method, and specify the names of your latitude / longitude columns plus the units you want to use.
+
+This will give your model a bunch of calculation methods, like `.near` and `.within_bounding_box`. See them all [here](https://github.com/alexreisner/geocoder/blob/master/lib/geocoder/stores/active_record.rb)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)

data/geo-calculator.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'geo-calculator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'geo-calculator'
+  spec.version       = GeoCalculator::VERSION
+  spec.authors       = ['Ryan MacInnes']
+  spec.email         = ['ryan.macinnes@gmail.com']
+  spec.description   = %q{Use ruby geocoder calculation methods without geocoding}
+  spec.summary       = %q{This gem uses the ruby geocoder gem calculation methods to allow calculation of nearby locations without needing all the geocoding code.}
+  spec.homepage      = 'https://github.com/goddamnyouryan/geo-calculator'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'activerecord'
+  spec.add_development_dependency 'sqlite3'
+end

data/lib/geo-calculator.rb

@@ -0,0 +1,6 @@
+require 'geo-calculator/version'
+require 'geo-calculator/sql'
+require 'geo-calculator/calculations'
+require 'geo-calculator/configuration'
+require 'geo-calculator/store/base'
+require 'geo-calculator/store/active_record'

data/lib/geo-calculator/calculations.rb

@@ -0,0 +1,428 @@
+module Geocoder
+  module Calculations
+    extend self
+
+    ##
+    # Compass point names, listed clockwise starting at North.
+    #
+    # If you want bearings named using more, fewer, or different points
+    # override Geocoder::Calculations.COMPASS_POINTS with your own array.
+    #
+    COMPASS_POINTS = %w[N NE E SE S SW W NW]
+
+    ##
+    # Radius of the Earth, in kilometers.
+    # Value taken from: http://en.wikipedia.org/wiki/Earth_radius
+    #
+    EARTH_RADIUS = 6371.0
+
+    ##
+    # Conversion factor: multiply by kilometers to get miles.
+    #
+    KM_IN_MI = 0.621371192
+
+    ##
+    # Conversion factor: multiply by nautical miles to get miles.
+    #
+    KM_IN_NM = 0.539957
+
+    ##
+    # Conversion factor: multiply by radians to get degrees.
+    #
+    DEGREES_PER_RADIAN = 57.2957795
+
+    # Not a number constant
+    NAN = defined?(::Float::NAN) ? ::Float::NAN : 0 / 0.0
+
+    ##
+    # Returns true if all given arguments are valid latitude/longitude values.
+    #
+    def coordinates_present?(*args)
+      args.each do |a|
+        # note that Float::NAN != Float::NAN
+        # still, this could probably be improved:
+        return false if (!a.is_a?(Numeric) or a.to_s == "NaN")
+      end
+      true
+    end
+
+    ##
+    # Distance spanned by one degree of latitude in the given units.
+    #
+    def latitude_degree_distance(units = nil)
+      units ||= Geocoder.config.units
+      2 * Math::PI * earth_radius(units) / 360
+    end
+
+    ##
+    # Distance spanned by one degree of longitude at the given latitude.
+    # This ranges from around 69 miles at the equator to zero at the poles.
+    #
+    def longitude_degree_distance(latitude, units = nil)
+      units ||= Geocoder.config.units
+      latitude_degree_distance(units) * Math.cos(to_radians(latitude))
+    end
+
+    ##
+    # Distance between two points on Earth (Haversine formula).
+    # Takes two points and an options hash.
+    # The points are given in the same way that points are given to all
+    # Geocoder methods that accept points as arguments. They can be:
+    #
+    # * an array of coordinates ([lat,lon])
+    # * a geocodable address (string)
+    # * a geocoded object (one which implements a +to_coordinates+ method
+    #   which returns a [lat,lon] array
+    #
+    # The options hash supports:
+    #
+    # * <tt>:units</tt> - <tt>:mi</tt> or <tt>:km</tt>
+    #   Use Geocoder.configure(:units => ...) to configure default units.
+    #
+    def distance_between(point1, point2, options = {})
+
+      # set default options
+      options[:units] ||= Geocoder.config.units
+
+      # convert to coordinate arrays
+      point1 = extract_coordinates(point1)
+      point2 = extract_coordinates(point2)
+
+      # convert degrees to radians
+      point1 = to_radians(point1)
+      point2 = to_radians(point2)
+
+      # compute deltas
+      dlat = point2[0] - point1[0]
+      dlon = point2[1] - point1[1]
+
+      a = (Math.sin(dlat / 2))**2 + Math.cos(point1[0]) *
+          (Math.sin(dlon / 2))**2 * Math.cos(point2[0])
+      c = 2 * Math.atan2( Math.sqrt(a), Math.sqrt(1-a))
+      c * earth_radius(options[:units])
+    end
+
+    ##
+    # Bearing between two points on Earth.
+    # Returns a number of degrees from due north (clockwise).
+    #
+    # See Geocoder::Calculations.distance_between for
+    # ways of specifying the points. Also accepts an options hash:
+    #
+    # * <tt>:method</tt> - <tt>:linear</tt> or <tt>:spherical</tt>;
+    #   the spherical method is "correct" in that it returns the shortest path
+    #   (one along a great circle) but the linear method is less confusing
+    #   (returns due east or west when given two points with the same latitude).
+    #   Use Geocoder.configure(:distances => ...) to configure calculation method.
+    #
+    # Based on: http://www.movable-type.co.uk/scripts/latlong.html
+    #
+    def bearing_between(point1, point2, options = {})
+
+      # set default options
+      options[:method] ||= Geocoder.config.distances
+      options[:method] = :linear unless options[:method] == :spherical
+
+      # convert to coordinate arrays
+      point1 = extract_coordinates(point1)
+      point2 = extract_coordinates(point2)
+
+      # convert degrees to radians
+      point1 = to_radians(point1)
+      point2 = to_radians(point2)
+
+      # compute deltas
+      dlat = point2[0] - point1[0]
+      dlon = point2[1] - point1[1]
+
+      case options[:method]
+      when :linear
+        y = dlon
+        x = dlat
+
+      when :spherical
+        y = Math.sin(dlon) * Math.cos(point2[0])
+        x = Math.cos(point1[0]) * Math.sin(point2[0]) -
+            Math.sin(point1[0]) * Math.cos(point2[0]) * Math.cos(dlon)
+      end
+
+      bearing = Math.atan2(x,y)
+      # Answer is in radians counterclockwise from due east.
+      # Convert to degrees clockwise from due north:
+      (90 - to_degrees(bearing) + 360) % 360
+    end
+
+    ##
+    # Translate a bearing (float) into a compass direction (string, eg "North").
+    #
+    def compass_point(bearing, points = COMPASS_POINTS)
+      seg_size = 360 / points.size
+      points[((bearing + (seg_size / 2)) % 360) / seg_size]
+    end
+
+    ##
+    # Compute the geographic center (aka geographic midpoint, center of
+    # gravity) for an array of geocoded objects and/or [lat,lon] arrays
+    # (can be mixed). Any objects missing coordinates are ignored. Follows
+    # the procedure documented at http://www.geomidpoint.com/calculation.html.
+    #
+    def geographic_center(points)
+
+      # convert objects to [lat,lon] arrays and convert degrees to radians
+      coords = points.map{ |p| to_radians(extract_coordinates(p)) }
+
+      # convert to Cartesian coordinates
+      x = []; y = []; z = []
+      coords.each do |p|
+        x << Math.cos(p[0]) * Math.cos(p[1])
+        y << Math.cos(p[0]) * Math.sin(p[1])
+        z << Math.sin(p[0])
+      end
+
+      # compute average coordinate values
+      xa, ya, za = [x,y,z].map do |c|
+        c.inject(0){ |tot,i| tot += i } / c.size.to_f
+      end
+
+      # convert back to latitude/longitude
+      lon = Math.atan2(ya, xa)
+      hyp = Math.sqrt(xa**2 + ya**2)
+      lat = Math.atan2(za, hyp)
+
+      # return answer in degrees
+      to_degrees [lat, lon]
+    end
+
+    ##
+    # Returns coordinates of the southwest and northeast corners of a box
+    # with the given point at its center. The radius is the shortest distance
+    # from the center point to any side of the box (the length of each side
+    # is twice the radius).
+    #
+    # This is useful for finding corner points of a map viewport, or for
+    # roughly limiting the possible solutions in a geo-spatial search
+    # (ActiveRecord queries use it thusly).
+    #
+    # See Geocoder::Calculations.distance_between for
+    # ways of specifying the point. Also accepts an options hash:
+    #
+    # * <tt>:units</tt> - <tt>:mi</tt> or <tt>:km</tt>.
+    #   Use Geocoder.configure(:units => ...) to configure default units.
+    #
+    def bounding_box(point, radius, options = {})
+      lat,lon = extract_coordinates(point)
+      radius  = radius.to_f
+      units   = options[:units] || Geocoder.config.units
+      [
+        lat - (radius / latitude_degree_distance(units)),
+        lon - (radius / longitude_degree_distance(lat, units)),
+        lat + (radius / latitude_degree_distance(units)),
+        lon + (radius / longitude_degree_distance(lat, units))
+      ]
+    end
+
+    ##
+    # Random point within a circle of provided radius centered
+    # around the provided point
+    # Takes one point, one radius, and an options hash.
+    # The points are given in the same way that points are given to all
+    # Geocoder methods that accept points as arguments. They can be:
+    #
+    # * an array of coordinates ([lat,lon])
+    # * a geocodable address (string)
+    # * a geocoded object (one which implements a +to_coordinates+ method
+    #   which returns a [lat,lon] array
+    #
+    # The options hash supports:
+    #
+    # * <tt>:units</tt> - <tt>:mi</tt> or <tt>:km</tt>
+    #   Use Geocoder.configure(:units => ...) to configure default units.
+    def random_point_near(center, radius, options = {})
+
+      # set default options
+      options[:units] ||= Geocoder.config.units
+
+      # convert to coordinate arrays
+      center = extract_coordinates(center)
+
+      earth_circumference = 2 * Math::PI * earth_radius(options[:units])
+      max_degree_delta =  360.0 * (radius / earth_circumference)
+
+      # random bearing in radians
+      theta = 2 * Math::PI * rand
+
+      # random radius, use the square root to ensure a uniform
+      # distribution of points over the circle
+      r = Math.sqrt(rand) * max_degree_delta
+
+      delta_lat, delta_long = [r * Math.cos(theta), r * Math.sin(theta)]
+      [center[0] + delta_lat, center[1] + delta_long]
+    end
+
+    ##
+    # Given a start point, distance, and heading (in degrees), provides
+    # an endpoint.
+    # The starting point is given in the same way that points are given to all
+    # Geocoder methods that accept points as arguments. It can be:
+    #
+    # * an array of coordinates ([lat,lon])
+    # * a geocodable address (string)
+    # * a geocoded object (one which implements a +to_coordinates+ method
+    #   which returns a [lat,lon] array
+    #
+    def endpoint(start, heading, distance, options = {})
+      options[:units] ||= Geocoder.config.units
+      radius = earth_radius(options[:units])
+
+      start = extract_coordinates(start)
+
+      # convert degrees to radians
+      start = to_radians(start)
+
+      lat = start[0]
+      lon = start[1]
+      heading = to_radians(heading)
+      distance = distance.to_f
+
+      end_lat = Math.asin(Math.sin(lat)*Math.cos(distance/radius) +
+                    Math.cos(lat)*Math.sin(distance/radius)*Math.cos(heading))
+
+      end_lon = lon+Math.atan2(Math.sin(heading)*Math.sin(distance/radius)*Math.cos(lat),
+                    Math.cos(distance/radius)-Math.sin(lat)*Math.sin(end_lat))
+
+      to_degrees [end_lat, end_lon]
+    end
+
+    ##
+    # Convert degrees to radians.
+    # If an array (or multiple arguments) is passed,
+    # converts each value and returns array.
+    #
+    def to_radians(*args)
+      args = args.first if args.first.is_a?(Array)
+      if args.size == 1
+        args.first * (Math::PI / 180)
+      else
+        args.map{ |i| to_radians(i) }
+      end
+    end
+
+    ##
+    # Convert radians to degrees.
+    # If an array (or multiple arguments) is passed,
+    # converts each value and returns array.
+    #
+    def to_degrees(*args)
+      args = args.first if args.first.is_a?(Array)
+      if args.size == 1
+        (args.first * 180.0) / Math::PI
+      else
+        args.map{ |i| to_degrees(i) }
+      end
+    end
+
+    def distance_to_radians(distance, units = nil)
+      units ||= Geocoder.config.units
+      distance.to_f / earth_radius(units)
+    end
+
+    def radians_to_distance(radians, units = nil)
+      units ||= Geocoder.config.units
+      radians * earth_radius(units)
+    end
+
+    ##
+    # Convert miles to kilometers.
+    #
+    def to_kilometers(mi)
+      mi * mi_in_km
+    end
+
+    ##
+    # Convert kilometers to miles.
+    #
+    def to_miles(km)
+      km * km_in_mi
+    end
+
+    ##
+    # Convert kilometers to nautical miles.
+    #
+    def to_nautical_miles(km)
+      km * km_in_nm
+    end
+
+    ##
+    # Radius of the Earth in the given units (:mi or :km).
+    # Use Geocoder.configure(:units => ...) to configure default units.
+    #
+    def earth_radius(units = nil)
+      units ||= Geocoder.config.units
+      case units
+        when :km; EARTH_RADIUS
+        when :mi; to_miles(EARTH_RADIUS)
+        when :nm; to_nautical_miles(EARTH_RADIUS)
+      end
+    end
+
+    ##
+    # Conversion factor: km to mi.
+    #
+    def km_in_mi
+      KM_IN_MI
+    end
+
+    ##
+    # Conversion factor: km to nm.
+    #
+    def km_in_nm
+      KM_IN_NM
+    end
+
+
+
+    ##
+    # Conversion factor: mi to km.
+    #
+    def mi_in_km
+      1.0 / KM_IN_MI
+    end
+
+    ##
+    # Conversion factor: nm to km.
+    #
+    def nm_in_km
+      1.0 / KM_IN_NM
+    end
+
+    ##
+    # Takes an object which is a [lat,lon] array, a geocodable string,
+    # or an object that implements +to_coordinates+ and returns a
+    # [lat,lon] array. Note that if a string is passed this may be a slow-
+    # running method and may return nil.
+    #
+    def extract_coordinates(point)
+      case point
+      when Array
+        if point.size == 2
+          lat, lon = point
+          if !lat.nil? && lat.respond_to?(:to_f) and
+            !lon.nil? && lon.respond_to?(:to_f)
+          then
+            return [ lat.to_f, lon.to_f ]
+          end
+        end
+      when String
+        point = Geocoder.coordinates(point) and return point
+      else
+        if point.respond_to?(:to_coordinates)
+          if Array === array = point.to_coordinates
+            return extract_coordinates(array)
+          end
+        end
+      end
+      [ NAN, NAN ]
+    end
+  end
+end
+