geo_units 0.2.6 → 0.3.1

data/lib/geo_units/converter/normalizer.rb

@@ -0,0 +1,52 @@
+module GeoUnits
+  module Converter
+    module Normalizer
+      # all degrees between -180 and 180
+      def normalize_lng deg
+        case deg 
+        when -360..-180
+          deg % 180      
+        when -180..0 
+          -180 + (deg % 180) 
+        when 0..180
+          deg
+        when 180..360
+          deg % 180
+        else
+          raise ArgumentError, "Degrees #{deg} out of range, must be between -360 to 360"
+        end
+      end
+
+      # all degrees between -90 and 90
+      def normalize_lat deg
+        case deg 
+        when -360..-270
+          deg % 90      
+        when -270..-180
+          90 - (deg % 90)
+        when -180..-90
+          - (deg % 90)
+        when -90..0 
+          -90 + (deg % 90) 
+        when 0..90
+          deg
+        when 90..180 
+          deg % 90
+        when 180..270 
+          - (deg % 90)
+        when 270..360 
+          - 90 + (deg % 90)
+        else
+          raise ArgumentError, "Degrees #{deg} out of range, must be between -360 to 360"    
+        end 
+      end
+
+      def normalize_deg degrees, shift = 0
+        (degrees + shift) % 360 
+      end
+      alias_method :normalize_degrees, :normalize_deg
+      
+      extend self     
+    end
+  end
+end

data/lib/geo_units/converter/units.rb

@@ -0,0 +1,41 @@
+module GeoUnits
+  module Converter
+    module Units
+      def degrees_to_radians(degrees)   
+        degrees.to_f * GeoUnits::Constants.radians_per_degree
+      end
+
+      def units_sphere_multiplier(units)
+        units = GeoUnits.key units
+        GeoUnits::Mapsearth_radius_map[units]
+      end
+
+      def units_per_latitude_degree(units)
+        units = GeoUnits.key units
+        GeoUnits::Maps.radian_multiplier[units]
+      end
+
+      def pi_div_rad
+        GeoUnits::Constants.pi_div_rad
+      end
+
+      def units_per_longitude_degree(lat, units)
+        miles_per_longitude_degree = (lat * Math.cos(lat * pi_div_rad)).abs 
+        units = GeoUnits.key units
+        miles_per_longitude_degree.miles_to(units)
+      end 
+  
+      def earth_radius units
+        units = GeoUnits.key units
+        GeoUnits::Maps.earth_radius_map[units]
+      end
+      
+      def radians_ratio units
+        units = GeoUnits.key units
+        radians_per_degree * earth_radius(units)
+      end
+  
+      extend self       
+    end
+  end
+end

data/lib/geo_units/core_ext.rb

@@ -1,43 +1,78 @@
 require 'sugar-high/numeric'
 
 module GeoUnitExt
-  ::GeoUnits.units.each do |unit|
-    class_eval %{
-      def #{unit}_to unit
-        unit = GeoUnits.key(unit)                                   
-        (self.to_f / GeoUnits.meters_map[:#{unit}]) * GeoUnits.meters_map[unit]
-      end
-    }
+  ::GeoUnits.units.each do |unit_type|
+    define_method "#{unit_type}_to" do |unit|
+      unit = GeoUnits.normalized(unit)
+      self.to_f * GeoUnits::Maps::Meters.from_unit[unit_type] * GeoUnits::Maps::Meters.to_unit[unit]
+    end
   end
 
   include NumberDslExt # from sugar-high
 
-  def rpd
-    self * GeoUnits.radians_per_degree
-  end  
-  alias_method :to_radians, :rpd
+  def to_rad
+    GeoUnits::Converter.to_rad self
+  end
+  alias_method :to_radians, :to_rad
+  alias_method :degrees_to_rad, :to_radians
+  alias_method :deg_to_rad, :to_radians
 end
 
-class Fixnum
+class Numeric
   include GeoUnitExt
-  include ::GeoUnits::NumericExt   
+  include ::GeoUnits::Numeric
+  include ::GeoUnits::Numeric::Dms
+  include ::GeoUnits::Numeric::Normalizer
 end
 
-class Float
-  include GeoUnitExt
-  include ::GeoUnits::NumericExt 
-end 
+class String
+  def parse_dms options = {}
+    GeoUnits::Converter::Dms.parse_dms self, options
+  end
+
+  def to_lng
+    self.match(/[E|W]/) ? self.to_i : nil
+  end
 
-class String  
-  def parse_dms
-    GeoUnits::DmsConverter.parse_dms self
+  def to_lat
+    self.match(/[N|S]/) ? self.to_i : nil
   end
 end
 
 class Array
-  def to_dms
-    lat = self.respond_to?(:to_lat) ? self.to_lat : self[0]
-    lng = self.respond_to?(:to_lng) ? self.to_lng : self[1]    
-    [lat.to_lat_dms, lng.to_lng_dms].join(', ')
+  def to_dms direction = nil
+    lng, lat = extract_coords(direction)
+    res = direction == :lat_lng ? [lat.to_lat_dms, lng.to_lng_dms] : [lng.to_lng_dms, lat.to_lat_dms]
+    res.join(', ')    
+  end
+
+  def parse_dms direction = nil
+    lng, lat = extract_coords(direction)
+    direction == :lat_lng ? [lat.parse_dms, lng.parse_dms] : [lng.parse_dms, lat.parse_dms]
+  end
+
+  protected
+
+  def extract_coords direction = nil
+    direction ||= GeoUnits.default_coords_order
+
+    unless [:lng_lat, :lat_lng].include? direction
+      raise ArgumentError, "Direction must be either :lng_lat or :lat_lng, was: #{direction}. You can also set the default direction via GeoUnits#default_direction="
+    end
+
+    lat_index = direction == :reverse ? 0 : 1
+    lng_index = direction == :reverse ? 1 : 0
+
+    lat = self.to_lat if self.respond_to?(:to_lat)  
+    lat ||= self[lat_index] if self[lat_index].respond_to?(:to_lat) && self[lat_index].to_lat
+    lat ||= self[lng_index] if self[lng_index].respond_to?(:to_lat) && self[lng_index].to_lat
+    lat ||= self[lat_index]
+
+    lng = self.to_lng if self.respond_to?(:to_lng)
+    lng ||= self[lng_index] if self[lng_index].respond_to?(:to_lng) && self[lng_index].to_lng
+    lng ||= self[lat_index] if self[lat_index].respond_to?(:to_lng) && self[lat_index].to_lng
+    lng ||= self[lng_index]
+
+    [lng, lat]
   end
-end
+end

data/lib/geo_units/maps.rb

@@ -1,61 +1,10 @@
 module GeoUnits
   module Maps
-    def earth_radius_map
-      {
-      :miles      => 3963.1676, 
-      :kilometers => 6378.135, 
-      :meters     =>  6378135, 
-      :feet       => 20925639.8 
-      }
-    end
-
-    def earth_major_axis_radius_map 
-      { 
-      :miles      => 3963.19059, 
-      :kilometers => 6378.137,
-      :meters     => 6378137,
-      :feet       => 20925646.36
-      }
-    end
-
-    def earth_minor_axis_radius_map 
-      { 
-      :kilometers => 6356.7523142,
-      :miles      => 3949.90276,
-      :meters     => 6356752.3142,
-      :feet       => 20855486.627
-      }
-    end
-
-    # from mongoid-geo, as suggested by niedhui :)
-    def radian_multiplier
-      {
-        :feet     => 364491.8,
-        :meters   => 111170,
-        :kms      => 111.17,
-        :miles    => 69.407,
-        :radians  => 1
-      }
-    end
-
-    def meters_multiplier
-      {
-        :feet     => 0.305,
-        :meters   => 1,
-        :kms      => 6371,
-        :miles    => 3959,
-        :radians  => 111170 
-      }
-    end
+    autoload_modules :Earth, :Meters
 
-    def meters_map
-      {
-       :feet    => 3.2808399,
-       :meters  => 1,
-       :kms     => 0.001,
-       :miles   => 0.00062137,
-       :radians => 0.00000899
-      }
+    def self.included(base)
+      base.send :include, Earth
+      base.send :include, Meters
     end
 
     def precision
@@ -66,8 +15,7 @@ module GeoUnits
         :miles => 4,
         :radians => 4
       }
-    end 
-  
+    end
     extend self
   end
-end
+end

data/lib/geo_units/maps/earth.rb

@@ -0,0 +1,49 @@
+module GeoUnits
+  module Maps
+    module Earth
+      # from mongoid-geo, as suggested by niedhui :)
+      def distance_per_latitude_degree
+      {
+        :feet       => 364491.8,
+        :meters     => 111170,
+        :kilometers => 111.17,
+        :miles      => 69.407,
+        :degrees    => 1
+      }
+      end
+
+      def radius
+        {
+        :miles      => 3963.1676,
+        :kilometers => 6378.135,
+        :meters     => 6378135,
+        :feet       => 20925639.8
+        }
+      end
+
+      def major_axis_radius
+        {
+        :miles      => 3963.19059,
+        :kilometers => 6378.137,
+        :meters     => 6378137,
+        :feet       => 20925646.36
+        }
+      end
+
+      def minor_axis_radius
+        {
+        :kilometers => 6356.7523142,
+        :miles      => 3949.90276,
+        :meters     => 6356752.3142,
+        :feet       => 20855486.627
+        }
+      end
+
+      def latitude_degrees unit = :miles
+        radius[unit] / distance_per_latitude_degree[unit]
+      end
+
+      extend self
+    end
+  end
+end

data/lib/geo_units/maps/meters.rb

@@ -0,0 +1,25 @@
+module GeoUnits
+  module Maps
+    module Meters
+      def from_unit
+        {
+          :feet       => 0.3048,
+          :meters     => 1,
+          :kilometers => 1000,
+          :miles      => 1609.344
+        }
+      end
+
+      def to_unit
+        {
+         :feet        => 3.2808399,
+         :meters      => 1,
+         :kilometers  => 0.001,
+         :miles       => 0.00062137
+        }
+      end
+
+      extend self
+    end
+  end
+end

data/lib/geo_units/numeric.rb

@@ -0,0 +1,50 @@
+module GeoUnits
+  module Numeric
+    autoload_modules :Normalizer, :Dms
+
+    def to_lat
+      normalize_lat
+    end
+
+    def to_lng
+      normalize_lng
+    end
+
+    def is_between? lower, upper
+      (lower..upper).cover? self
+    end
+
+    # Converts numeric degrees to radians
+    def to_rad
+      self * Math::PI / 180
+    end
+    alias_method :to_radians, :to_rad
+    alias_method :as_rad,     :to_rad
+    alias_method :as_radians, :to_rad
+    alias_method :in_rad,     :to_rad
+    alias_method :in_radians, :to_rad
+
+
+    # Converts radians to numeric (signed) degrees
+    # latitude (north to south) from equator +90 up then -90 down (equator again) = 180 then 180 for south = 360 total 
+    # longitude (west to east)  east +180, west -180 = 360 total
+    def to_deg
+      self * 180 / Math::PI
+    end
+
+    alias_method :to_degrees, :to_deg
+    alias_method :as_deg,     :to_deg
+    alias_method :as_degrees, :to_deg
+    alias_method :in_deg,     :to_deg
+    alias_method :in_degrees, :to_deg
+
+    # Formats the significant digits of a number, using only fixed-point notation (no exponential)
+    # 
+    # @param   {Number} precision: Number of significant digits to appear in the returned string
+    # @returns {String} A string representation of number which contains precision significant digits
+    def to_precision precision
+      self.round(precision).to_s
+    end
+    alias_method :to_fixed, :to_precision
+  end
+end

data/lib/geo_units/numeric/dms.rb

@@ -0,0 +1,18 @@
+module GeoUnits
+  module Numeric
+    module Dms
+      def to_dms format = :dms, dp = nil
+        GeoUnits::DmsConverter.to_dms self, format, dp
+      end
+
+      def to_lat_dms format = :dms, dp = nil
+        GeoUnits::Converter.to_lat self, format, dp
+      end
+
+      def to_lon_dms format = :dms, dp = nil
+        GeoUnits::Converter.to_lon self, format, dp
+      end
+      alias_method :to_lng_dms, :to_lon_dms
+    end
+  end
+end

data/lib/geo_units/numeric/normalizer.rb

@@ -0,0 +1,62 @@
+module GeoUnits
+  module Numeric
+    module Normalizer
+      # all degrees between -180 and 180
+      def normalize_lng
+        case self
+        when -360, 0, 360
+          0
+        when -360..-180
+          self % 180
+        when -180..0
+          -180 + (self % 180)
+        when 0..180
+          self
+        when 180..360
+          self % 180
+        else
+          return (self % 360).normalize_lng if self > 360
+          return (360 - (self % 360)).normalize_lng if self < -360
+          raise ArgumentError, "Degrees #{self} out of range"
+        end
+      end
+
+      # all degrees between -90 and 90
+      def normalize_lat
+        case self 
+        when -360, 0, 360
+          0
+        when -180, 180
+          0
+        when -360..-270
+          self % 90
+        when -270..-180
+          90 - (self % 90)
+        when -180..-90
+          - (self % 90)
+        when -90..0
+          -90 + (self % 90)
+        when 0..90
+          self
+        when 90..180
+          self % 90
+        when 180..270
+          - (self % 90)
+        when 270..360
+          - 90 + (self % 90)
+        else
+          return (self % 360).normalize_lat if self > 360
+          return (360 - (self % 360)).normalize_lat if self < -360
+          raise ArgumentError, "Degrees #{self} out of range"
+        end
+      end
+
+      def normalize_deg shift = 0
+        (self + shift) % 360 
+      end
+      alias_method :normalize_degrees, :normalize_deg
+
+      extend self
+    end
+  end
+end