geo_units 0.2.6 → 0.3.1

data/.rspec

@@ -1 +1 @@
---color
+--color --format nested

data/Gemfile

@@ -2,6 +2,7 @@ source "http://rubygems.org"
 # Add dependencies required to use your gem here.
 
 gem "sugar-high", '>= 0.6.0'
+gem 'sweetloader'
 gem 'i18n' 
 gem 'activesupport' 
 

data/README.textile

@@ -15,6 +15,21 @@ Then run the bundler!
 
 @$ bundle@
 
+h2. Status update (Sept 21, 2011)
+
+GeoUnits is currently undergoing a major refactoring effort in order to group functionality in a more granular fashion, to allow for greater flexibility.
+Also, the new GeoUnits will not specifically target use for geo calculations for Earth, but also other globes/worlds, such as in a fantasy setting, planets, suns etc.
+Please help in this effort :)
+
+The master branch has now been updated in order to allow specification of the order:
+Set the `GeoUnit.default_coords_order` to fit your usage scenario.
+
+`GeoUnit.default_coords_order = :lng_lat`
+
+`GeoUnit.default_coords_order = :lat_lng` 
+
+All specs pass again and the dependencies have been updated :)
+
 h2. GeoUnits API
 
 <pre>GeoUnits.key(:foot) # will convert any kind of unit into one of (:feet, :meters, :kms, :miles, :radians)

data/VERSION

@@ -1 +1 @@
-0.2.6
+0.3.1

data/geo_units.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "geo_units"
-  s.version = "0.2.6"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
@@ -28,15 +28,28 @@ Gem::Specification.new do |s|
     "lib/geo_units.rb",
     "lib/geo_units/constants.rb",
     "lib/geo_units/converter.rb",
+    "lib/geo_units/converter/dms.rb",
+    "lib/geo_units/converter/normalizer.rb",
+    "lib/geo_units/converter/units.rb",
     "lib/geo_units/core_ext.rb",
-    "lib/geo_units/dms_converter.rb",
     "lib/geo_units/maps.rb",
-    "lib/geo_units/numeric_ext.rb",
+    "lib/geo_units/maps/earth.rb",
+    "lib/geo_units/maps/meters.rb",
+    "lib/geo_units/numeric.rb",
+    "lib/geo_units/numeric/dms.rb",
+    "lib/geo_units/numeric/normalizer.rb",
     "lib/geo_units/unit_conversions.rb",
+    "spec/geo_units/converter/dms_spec.rb",
+    "spec/geo_units/converter/normalizer_spec.rb",
+    "spec/geo_units/converter/units_spec.rb",
     "spec/geo_units/converter_spec.rb",
     "spec/geo_units/core_ext_spec.rb",
-    "spec/geo_units/dms_converter_spec.rb",
-    "spec/geo_units/numeric_ext_spec.rb",
+    "spec/geo_units/maps/earth_spec.rb",
+    "spec/geo_units/maps/meters_spec.rb",
+    "spec/geo_units/maps_spec.rb",
+    "spec/geo_units/numeric/dms_spec.rb",
+    "spec/geo_units/numeric/normalizer_spec.rb",
+    "spec/geo_units/numeric_spec.rb",
     "spec/geo_units_spec.rb",
     "spec/spec_helper.rb"
   ]
@@ -51,6 +64,7 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<sugar-high>, [">= 0.6.0"])
+      s.add_runtime_dependency(%q<sweetloader>, [">= 0"])
       s.add_runtime_dependency(%q<i18n>, [">= 0"])
       s.add_runtime_dependency(%q<activesupport>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 2.5.0"])
@@ -58,6 +72,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<jeweler>, [">= 1.6.4"])
     else
       s.add_dependency(%q<sugar-high>, [">= 0.6.0"])
+      s.add_dependency(%q<sweetloader>, [">= 0"])
       s.add_dependency(%q<i18n>, [">= 0"])
       s.add_dependency(%q<activesupport>, [">= 0"])
       s.add_dependency(%q<rspec>, [">= 2.5.0"])
@@ -66,6 +81,7 @@ Gem::Specification.new do |s|
     end
   else
     s.add_dependency(%q<sugar-high>, [">= 0.6.0"])
+    s.add_dependency(%q<sweetloader>, [">= 0"])
     s.add_dependency(%q<i18n>, [">= 0"])
     s.add_dependency(%q<activesupport>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 2.5.0"])

data/lib/geo_units.rb

@@ -16,34 +16,63 @@
 # @throws  ArgumentError
 
 require 'sugar-high/numeric'
-require 'sugar-high/class_ext'
+require 'sweetloader'
 
 module GeoUnits
-  autoload_modules :Converter, :DmsConverter, :NumericExt, :Maps, :Constants, :UnitConversions, :from => 'geo_units'
-  
-  def self.included(base)   
-    [Maps, Constants, UnitConversions].each do |module_name| 
+  autoload_modules :Constants, :Converter, :Maps, :Numeric
+
+  class << self
+    attr_accessor :default_coords_order
+
+    def default_coords_order
+      @default_coords_order ||= :lng_lat
+    end
+  end
+
+  def self.included(base)
+    [:Maps, :Constants, :"Converter::Units"].each do |module_name| 
+      module_name = "GeoUnits::#{module_name.to_s.camelize}".constantize
       base.send :include, module_name
-      base.extend module_name      
+      base.extend module_name
     end
   end
 
   def self.units
-    [:feet, :meters, :kms, :miles, :radians]
+    [:feet, :meters, :kms, :kilometers, :miles, :radians]
   end
 
-  units.each do |unit|
-    class_eval %{
-      def self.#{unit}_to unit, number = 0
-        return 0 if number <= 0
-        unit = key(unit)
-        m = number / GeoUnits::Maps.meters_map[:#{unit}]
-        m * GeoUnits::Maps.meters_map[unit]
-      end
-    }
+  (units - [:radians]).each do |unit_type|
+    define_singleton_method "#{unit_type}_to" do |unit, number = 0|
+      return 0 if number <= 0        
+      unit = normalized(unit)
+      
+      converter = GeoUnits::Maps::Meters
+      from = converter.from_unit[unit_type]
+      to = converter.to_unit[unit]
+
+      m = number * from * to
+    end
+  end
+
+  def self.radians_to unit, number, lat = 0
+    unit = normalized(unit)
+    # factor = GeoUnits::Converter::Units.units_per_longitude_degree(lat, unit)
+    # puts "factor: #{factor} - #{unit}"
+    (GeoUnits::Maps::Earth.distance_per_latitude_degree[unit] * number.to_f) 
   end
 
   module ClassMethods
+    def normalized unit = :km
+      unit = key(unit)
+      return :feet if feet_unit.include? unit
+      return :meters if meters_unit.include? unit
+      return :kilometers if kms_unit.include? unit
+      return :miles if miles_unit.include? unit
+      return :radians if radins_unit.include? unit
+
+      raise ArgumentError, "Normalize unit error, unit key: #{unit}"
+    end
+
     def key unit = :km
       unit = unit.to_sym
       methods.grep(/_unit$/).each do |meth|
@@ -76,11 +105,11 @@ module GeoUnits
 
     def radians_unit
       [:rad, :radians]
-    end          
+    end
   end
-  
+
   extend ClassMethods
-end  
+end
 
 require 'geo_units/core_ext'
 

data/lib/geo_units/constants.rb

@@ -4,30 +4,18 @@ module GeoUnits
       Math::PI / 180.0
     end
 
-    def pi_div_rad 
+    def pi_div_rad
       0.0174
     end
 
-    def kms_per_mile 
+    def kms_per_mile
       1.609
     end
 
-    def meters_per_feet 
+    def meters_per_feet
       3.2808399
     end
 
-    def miles_per_latitude_degree 
-      69.1
-    end
-
-    def kms_per_latitude_degree
-      miles_per_latitude_degree * kms_per_mile
-    end
-
-    def latitude_degrees 
-      earth_radius_map[:miles] / miles_per_latitude_degree
-    end
-  
-    extend self      
+    extend self
   end
-end
+end

data/lib/geo_units/converter.rb

@@ -1,5 +1,9 @@
 module GeoUnits
   module Converter
+    autoload_modules :Normalizer, :Dms, :Units
+
+    include Normalizer
+
     # Convert numeric degrees to deg/min/sec latitude (suffixed with N/S)
     # 
     # @param   {Number} deg: Degrees
@@ -9,7 +13,7 @@ module GeoUnits
 
     def to_lat deg, format = :dms, dp = 0
       deg = deg.normalize_lat
-      _lat = DmsConverter.to_dms deg, format, dp
+      _lat = Dms.to_dms deg, format, dp
       _lat == '' ? '' : _lat[1..-1] + (deg<0 ? 'S' : 'N')  # knock off initial '0' for lat!
     end
 
@@ -22,7 +26,7 @@ module GeoUnits
 
     def to_lon deg, format = :dms, dp = 0
       deg = deg.normalize_lng
-      lon = DmsConverter.to_dms deg, format, dp
+      lon = Dms.to_dms deg, format, dp
       lon == '' ? '' : lon + (deg<0 ? 'W' : 'E')
     end
 
@@ -36,14 +40,12 @@ module GeoUnits
 
     def to_brng deg, format = :dms, dp = 0
       deg = (deg.to_f + 360) % 360  # normalise -ve values to 180º..360º
-      brng = DmsConverter.to_dms deg, format, dp
+      brng = Dms.to_dms deg, format, dp
       brng.gsub /360/, '0'  # just in case rounding took us up to 360º!
-    end 
-
-    protected
+    end
 
     include NumericCheckExt # from sugar-high/numeric
-    
+
     # Converts numeric degrees to radians
     def to_rad degrees
       degrees * Math::PI / 180
@@ -67,54 +69,8 @@ module GeoUnits
     alias_method :as_degrees, :to_deg
     alias_method :in_deg,     :to_deg
     alias_method :in_degrees, :to_deg
-    
-    extend self    
-  end 
 
-  # 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 
+    extend self
   end
-  alias_method :normalize_degrees, :normalize_deg  
-  
   extend self
-end
+end

data/lib/geo_units/converter/dms.rb

@@ -0,0 +1,112 @@
+require 'sugar-high/numeric'
+require 'sugar-high/string'
+
+module GeoUnits
+  module Converter
+    module Dms
+      include NumericCheckExt
+
+      def parse_dms dms_str, options= {}
+        # check for signed decimal degrees without NSEW, if so return it directly
+        return dms_str if is_numeric?(dms_str)
+
+        raise "DMS parse error: #{dms_str}" if !(dms_str =~ /[NSEW]$/) || (dms_str =~ /\./)
+
+        # strip off any sign or compass dir'n & split out separate d/m/s
+        dms = dms_str.strip.gsub(/^-/,'').gsub(/[NSEW]$/i,'').split(/[^0-9.,]+/).map(&:strip).map(&:to_f)
+        return nil if dms.empty?
+
+        # and convert to decimal degrees...
+        deg = case dms.length
+        when 3 # interpret 3-part result as d/m/s
+          dms[0]/1 + dms[1]/60 + dms[2]/3600
+        when 2 # interpret 2-part result as d/m
+          dms[0]/1 + dms[1]/60
+        when 1 # just d (possibly decimal) or non-separated dddmmss
+          d = dms[0];
+          # check for fixed-width unseparated format eg 0033709W
+          d = "0#{d}" if (/[NS]/i.match(dms_str)) # - normalise N/S to 3-digit degrees
+          d = "#{d.slice(0,3)/1}#{deg.slice(3,5)/60}#{deg.slice(5)/3600}" if (/[0-9]{7}/.match(deg)) 
+          d
+        else
+          nil
+        end
+
+        raise "DMS parse error: #{deg} for #{dms_str}" if !deg
+
+        deg = (deg * -1) if (/^-|[WS]$/i.match(dms_str.strip)) # take '-', west and south as -ve
+        deg.to_f
+      end
+
+      # Convert decimal degrees to deg/min/sec format
+      #  - degree, prime, double-prime symbols are added, but sign is discarded, though no compass
+      #    direction is added
+      # 
+      # 
+      # @param   {Number} deg: Degrees
+      # @param   {String} [format=dms]: Return value as 'd', 'dm', 'dms'
+      # @param   {Number} [dp=0|2|4]: No of decimal places to use - default 0 for dms, 2 for dm, 4 for d
+      # @returns {String} deg formatted as deg/min/secs according to specified format
+      # @throws  {TypeError} deg is an object, perhaps DOM object without .value?
+
+      def to_dms deg, format = :dms, dp = nil 
+        deg = begin
+          deg.to_f
+        rescue
+          nil
+        end
+        return nil if !deg # give up here if we can't make a number from deg   
+
+        # default values
+        format ||= :dms
+        dp = if dp.nil?
+          case format.to_sym
+          when :d 
+            4
+          when :dm 
+            2
+          else
+            0 # default
+          end
+        end
+        dp ||= 0
+
+        deg = deg.abs # (unsigned result ready for appending compass dir'n)
+
+        case format
+        when :d
+          d = deg.round(dp)       # round degrees
+          ds = "0#{d}" if (d <100)    # pad with leading zeros
+          ds = "0#{ds}" if (d <10) 
+          dms = ds.to_s.concats("\u00B0")  # add º symbol
+        when :dm
+          min = (deg*60).round(dp)   # convert degrees to minutes & round
+          d = d.to_i
+          d = (min / 60).floor          # get component deg/min
+          m = (min % 60).round(dp)   # pad with trailing zeros
+          ds = d
+          ms = m
+          ds = "0#{d}" if (d<100)        # pad with leading zeros
+          ds = "0#{d}" if (d<10)
+          ms = "0#{m}" if (m<10)
+          dms = ds.to_s.concats("\u00B0", ms, "\u2032") # add º, ' symbols
+        when :dms
+          sec = (deg * 3600).round   # convert degrees to seconds & round
+          d = (sec / 3600).floor          # get component deg/min/sec
+          m = ((sec / 60) % 60).floor
+          s = (sec % 60).round(dp)     # pad with trailing zeros
+          ds = d
+          ms = m
+          ss = s
+          ds = "0#{d}" if (d < 100)          # pad with leading zeros
+          ds = "0#{ds}" if (d < 10) 
+          ms = "0#{m}" if (m < 10) 
+          ss = "0#{s}" if (s < 10) 
+          dms = ds.to_s.concats("\u00B0", ms, "\u2032", ss, "\u2033")  # add º, ', " symbols
+        end
+        return dms
+      end
+      extend self
+    end
+  end
+end