geo_units 0.2.1 → 0.2.3

data/README.textile

@@ -5,6 +5,61 @@ Distance unit functionality (conversions etc.) for Geo libraries. See specs for
 This gem is used by the _geo_point_ and _geo_calc_ gems and perhaps by others. The aim is that it will contain most of the basic 
 distance unit functionality required by typical Geo projects.
 
+h2. Usage
+
+in Gemfile:
+
+@gem 'geo_units'@
+
+Then run the bundler!
+
+@$ bundle@
+
+h2. GeoUnits API
+
+<pre>GeoUnits.key(:foot) # will convert any kind of unit into one of (:feet, :meters, :kms, :miles, :radians)
+=> :feet
+</pre>
+
+<pre>GeoUnits.kms_to :meters, 5 # convert number of one distance unit to another unit
+=> 5000  
+</pre>
+
+h2. Core extensions API
+
+<pre>2.radians_to(:kms)
+=> 222.34  
+</pre>
+
+<pre>@2.miles_to(:kms)
+=> 3.21
+</pre>
+
+h2. Dms Converter
+
+module _GeoUnits::DmsConverter_ 
+
+* parse_dms(string)
+* to_dms(deg, format = :dms, dp = nil)
+
+h2. Numeric conversions
+
+module _GeoUnits::NumericExt_
+
+This module is included on the _Fixnum_ and _Float_ classes
+
+* to_lat
+* to_lng
+* to_dms
+* to_lat_dms
+* to_lon_dms
+* to_rad
+* to_deg
+* normalize_lng
+* normalize_lat
+* normalize_deg(shift)
+
+
 h2. Contributing to geo_units
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.3

data/geo_units.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{geo_units}
-  s.version = "0.2.1"
+  s.version = "0.2.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Kristian Mandrup}]
-  s.date = %q{2011-06-19}
+  s.date = %q{2011-06-22}
   s.description = %q{Easily convert between different distance units such as kms, miles etc.}
   s.email = %q{kmandrup@gmail.com}
   s.extra_rdoc_files = [
@@ -31,8 +31,10 @@ Gem::Specification.new do |s|
     "lib/geo_units/dms_converter.rb",
     "lib/geo_units/numeric_ext.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_spec.rb",
     "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/kristianmandrup/geo_units}

data/lib/geo_units/core_ext.rb

@@ -1,10 +1,32 @@
+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
+    }
+  end
+
+  include NumberDslExt # from sugar-high
+
+  def rpd
+    self * GeoUnits.radians_per_degree
+  end  
+  alias_method :to_radians, :rpd
+end
+
 class Fixnum
-  include ::GeoUnits::NumericExt 
+  include GeoUnitExt
+  include ::GeoUnits::NumericExt   
 end
 
 class Float
-  include ::GeoUnits::NumericExt
-end
+  include GeoUnitExt
+  include ::GeoUnits::NumericExt 
+end 
 
 class String  
   def parse_dms

data/lib/geo_units/numeric_ext.rb

@@ -11,7 +11,6 @@ module GeoUnits
     def is_between? lower, upper
       (lower..upper).cover? self
     end
-
     
     def to_dms format = :dms, dp = nil
       GeoUnits::DmsConverter.to_dms self, format, dp

data/lib/geo_units.rb

@@ -11,8 +11,8 @@
 # or fixed-width format without separators (eg 0033709W). Seconds and minutes may be omitted. 
 # (Note minimal validation is done).
 # 
-# @param   {String|Number} dmsStr: Degrees or deg/min/sec in variety of formats
-# @returns {Number} Degrees as decimal number
+# @param   [String|Number] Degrees or deg/min/sec in variety of formats
+# @returns [Number] Degrees as decimal number
 # @throws  ArgumentError
 
 require 'sugar-high/numeric'
@@ -22,15 +22,82 @@ module GeoUnits
   autoload :DmsConverter,   'geo_units/dms_converter'
   autoload :NumericExt,     'geo_units/numeric_ext'
 
+  EARTH_RADIUS = { 
+    :miles      => 3963.1676, 
+    :kilometers => 6378.135, 
+    :meters     =>  6378135, 
+    :feet       => 20925639.8 
+  }
+
+  EARTH_MAJOR_AXIS_RADIUS = { 
+    :miles      => 3963.19059, 
+    :kilometers => 6378.137,
+    :meters     => 6378137,
+    :feet       => 20925646.36
+  }
+
+  EARTH_MINOR_AXIS_RADIUS = { 
+    :kilometers => 6356.7523142,
+    :miles      => 3949.90276,
+    :meters     => 6356752.3142,
+    :feet       => 20855486.627
+  }
+  
+  RADIAN_PER_DEGREE = Math::PI / 180.0
+
+  # Haversine Formula
+  # Adapted from Geokit Gem
+  # https://github.com/andre/geokit-gem.git
+  # By: Andre Lewis
+  PI_DIV_RAD = 0.0174
+
+  KMS_PER_MILE = 1.609
+  METERS_PER_FEET = 3.2808399
+
+  MILES_PER_LATITUDE_DEGREE = 69.1
+  KMS_PER_LATITUDE_DEGREE = MILES_PER_LATITUDE_DEGREE * KMS_PER_MILE
+  LATITUDE_DEGREES = EARTH_RADIUS[:miles] / MILES_PER_LATITUDE_DEGREE  
+
   module ClassMethods
     def key unit = :km
       unit = unit.to_sym
-      methods.grep(/_unit/).each do |meth|
+      methods.grep(/_unit$/).each do |meth|
         return meth.to_s.chomp('_unit').to_sym if send(meth).include? unit
       end
       raise ArgumentError, "Unknown unit key: #{unit}"
     end
 
+    def units
+      [:feet, :meters, :kms, :miles, :radians]
+    end
+
+    def all_units
+      [:miles, :mile, :kms, :km, :feet, :foot, :meter, :meters, :radians, :rad]
+    end
+
+    [:feet, :meters, :kms, :miles, :radians].each do |unit|
+      class_eval %{
+        def #{unit}_to unit, number = 0
+          return 0 if number <= 0
+          unit = key(unit)
+          m = number / GeoUnits.meters_map[:#{unit}]
+          m * meters_map[unit]
+        end
+      }
+    end
+
+    def earth_radius units
+      GeoUnits.EARTH_RADIUS[units.to_sym]
+    end
+
+    def radians_per_degree
+      0.017453293  #  PI/180
+    end    
+        
+    def radians_ratio unit
+      radians_per_degree * earth_radius[unit]          
+    end
+
     def precision
       {
         :feet => 0,
@@ -44,30 +111,31 @@ module GeoUnits
     # from mongoid-geo, as suggested by niedhui :)
     def radian_multiplier
       {
-        :feet => 364491.8,
-        :meters => 111170,
-        :kms => 111.17,
-        :miles => 69.407,
-        :radians => 1
+        :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
+        :feet     => 0.305,
+        :meters   => 1,
+        :kms      => 6371,
+        :miles    => 3959,
+        :radians  => 111170 
       }
     end
 
     def meters_map
       {
-       :feet => 3.2808,
-       :meters => 1,
-       :kms => 0.001,
-       :miles => 0.00062137,
-       :radians => 111170
+       :feet    => 3.2808399,
+       :meters  => 1,
+       :kms     => 0.001,
+       :miles   => 0.00062137,
+       :radians => 0.00000899
       }
     end
 
@@ -91,7 +159,7 @@ module GeoUnits
 
     def radians_unit
       [:rad, :radians]
-    end  
+    end          
   end
   
   extend ClassMethods

data/spec/geo_units/core_ext_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe GeoUnits do
+  describe 'Core extensions' do
+    describe '#radians_to' do
+      it 'should convert radians to kms' do
+        2.radians_to(:kms).should be_within(0.5).of 111.17 * 2
+      end
+    end
+
+    describe '#miles_to' do
+      it 'should convert miles to kms' do
+        2.miles_to(:kms).should be_within(0.2).of 3.21
+      end
+    end
+  end
+end

data/spec/geo_units_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe GeoUnits do
+  describe '#key' do
+    it 'should return the unit key' do
+      GeoUnits.key(:foot).should == :feet
+    end
+  end
+
+  describe '#radians_to' do
+    it 'should convert radians to kms' do
+      GeoUnits.radians_to(:kms, 2).should be_within(0.5).of 111.17 * 2
+    end
+  end
+
+  describe '#miles_to' do
+    it 'should convert miles to kms' do
+      GeoUnits.miles_to(:kms, 2).should be_within(0.2).of 3.21
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geo_units
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-06-19 00:00:00.000000000Z
+date: 2011-06-22 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sugar-high
-  requirement: &2157728000 !ruby/object:Gem::Requirement
+  requirement: &2153948000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.4.6.2
   type: :runtime
   prerelease: false
-  version_requirements: *2157728000
+  version_requirements: *2153948000
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2157727160 !ruby/object:Gem::Requirement
+  requirement: &2153947180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 2.5.0
   type: :development
   prerelease: false
-  version_requirements: *2157727160
+  version_requirements: *2153947180
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2157726400 !ruby/object:Gem::Requirement
+  requirement: &2153940460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.0.6
   type: :development
   prerelease: false
-  version_requirements: *2157726400
+  version_requirements: *2153940460
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2157725640 !ruby/object:Gem::Requirement
+  requirement: &2153939720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.6.2
   type: :development
   prerelease: false
-  version_requirements: *2157725640
+  version_requirements: *2153939720
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2157724940 !ruby/object:Gem::Requirement
+  requirement: &2153938740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157724940
+  version_requirements: *2153938740
 description: Easily convert between different distance units such as kms, miles etc.
 email: kmandrup@gmail.com
 executables: []
@@ -88,8 +88,10 @@ files:
 - lib/geo_units/dms_converter.rb
 - lib/geo_units/numeric_ext.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_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/kristianmandrup/geo_units
 licenses:
@@ -106,7 +108,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1770670745232636098
+      hash: -2024456778129613620
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: