geo_calc 0.5.3 → 0.6.0

data/lib/geo_calc/geo_point.rb

@@ -1,4 +1,5 @@
-require 'geo_calc/calculations'
+require 'geo_calc/geo'
+require 'geo_calc/calc'
 
  #  Sample usage:                                                                                 
  #    p1 = GeoPoint.new(51.5136, -0.0983)                                                      
@@ -13,7 +14,7 @@ require 'geo_calc/calculations'
  # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -  
 
 class GeoPoint
-  include GeoCalc
+  include GeoCalc::Calc::All
   # Creates a point on the earth's surface at the supplied latitude / longitude
   # 
   # Constructor
@@ -79,6 +80,16 @@ class GeoPoint
 
   alias_method :to_dms, :to_s
 
+  def reverse_point!
+    self.lat = lat * -1
+    self.lng = lng * -1
+    self    
+  end
+
+  def reverse_point
+    self.dup.reverse_point!
+  end
+
   def to_lat_lng
     [lat, lng]
   end

data/lib/geo_calc/pretty_print.rb

@@ -0,0 +1,52 @@
+module GeoCalc
+  module PrettyPrint
+    # Returns the latitude of this point; signed numeric degrees if no format, otherwise format & dp 
+    # as per Geo.to_lat
+    # 
+    # - String [format]: Return value as 'd', 'dm', 'dms'
+    # - Numeric [dp=0|2|4]: No of decimal places to display
+    #
+    # Returns {Numeric|String}: Numeric degrees if no format specified, otherwise deg/min/sec
+    # 
+
+    def to_lat format = :dms, dp = 0
+      return lat if !format
+      Geo.to_lat lat, format, dp
+    end
+
+
+    # Returns the longitude of this point; signed numeric degrees if no format, otherwise format & dp 
+    # as per Geo.toLon()
+    # 
+    # @param   {String} [format]: Return value as 'd', 'dm', 'dms'
+    # @param   {Number} [dp=0|2|4]: No of decimal places to display
+    # @returns {Number|String} Numeric degrees if no format specified, otherwise deg/min/sec
+    # 
+    # @requires Geo
+
+    def to_lon format, dp
+      return lon if !format
+      Geo.to_lon lon, format, dp
+    end
+
+
+    # Returns a string representation of this point; format and dp as per lat()/lon()
+    # 
+    # @param   {String} [format]: Return value as 'd', 'dm', 'dms'
+    # @param   {Number} [dp=0|2|4]: No of decimal places to display
+
+    # @returns {String} Comma-separated latitude/longitude
+    # 
+
+    def to_s format = :dms, dp = 0 
+      format ||= :dms
+
+      return '-,-' if !lat || !lon
+
+      _lat = Geo.to_lat lat, format, dp
+      _lon = Geo.to_lon lon, format, dp
+
+      "#{_lat}, #{_lon}"
+    end
+  end
+end

data/spec/geo_calc/calculations_spec.rb

@@ -51,7 +51,8 @@ describe GeoCalc do
     # Midpoint: 54°21′44″N, 004°31′50″W
     describe '#midpoint_to' do
       it 'should return the initial bearing from p1 to p2 as 011 16 31' do
-        @p1.midpoint_to(@p2).to_dms.should match /54.+21.+44.+N, 004.+31.+50.+W/
+        mp = @p1.midpoint_to(@p2)
+        mp.to_dms.should match /54.+21.+44.+N, 004.+31.+50.+W/
       end
     end
   end # context
@@ -94,7 +95,7 @@ describe GeoCalc do
     # Intersection point:   50°54′06″N, 004°29′39″E
     describe '#intersection' do      
       it 'should return the intersection between p1 and p2 as (50 54 06 N, 004 29 39 E)' do
-        GeoCalc.intersection(@p1, @brng1, @p2, @brng2).to_dms.should match /50.+54.+06.+N, 004.+29.+39.+E/
+        GeoCalc::Calc::Intersection.intersection(@p1, @brng1, @p2, @brng2).to_dms.should match /50.+54.+06.+N, 004.+29.+39.+E/
       end
     end
   end

data/spec/geo_calc/core_ext/array_ext_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+# - www.movable-type.co.uk/scripts/latlong.html
+describe GeoPoint do 
+  describe 'ruby core Class extensions' do
+    describe 'Array extension' do
+      describe '#to_lat' do              
+        it 'should return latitude as first element' do
+          @arr = [4, 27]
+          @arr.to_lat.should == 4
+        end
+
+        it 'should return latitude as #to_lng of first element' do
+          @arr = ["4.1", 27]
+          @arr.to_lat.should == 4.1
+        end
+      end      
+
+      describe '#to_lng' do              
+        it 'should return latitude degree value for 360' do
+          @arr = [4, 27]            
+          @arr.to_lng.should == 27
+        end
+
+        it 'should return latitude as #to_lng of first element' do
+          @arr = [4, "27.2"]            
+          @arr.to_lng.should == 27.2
+        end
+      end   
+
+      describe '#to_lat_lng' do              
+        it 'should return Array with lat, lng' do
+          @arr = ["3", {:lng => "2"}]
+          @arr.to_lat_lng.should == [3, 2]
+        end
+      end 
+  
+      describe '#geo_point' do              
+        it 'should return a GeoPoint' do
+          @p = [3, 2].geo_point
+          @p.should be_a(GeoPoint)
+          @p.to_lat_lng.should == [3, 2]
+        end
+      end                            
+    end # Array
+  end
+end

data/spec/geo_calc/core_ext/hash_ext_spec.rb

@@ -0,0 +1,44 @@
+describe GeoPoint do 
+  describe 'ruby core Class extensions' do
+    describe 'Hash extension' do
+      describe '#to_lat' do              
+        it 'should return latitude as #to_lat on the value for key :lat' do
+          @hash = {:lat => 4}
+          @hash.to_lat.should == 4
+        end
+
+        it 'should return latitude as #to_lat on the value for key :latitude' do
+          @hash = {:latitude => "7"}
+          @hash.to_lat.should == 7
+        end
+      end      
+
+      describe '#to_lng' do              
+        it 'should return latitude as #to_lng on the value for key :lng' do
+          @hash = {:lng => 2}
+          @hash.to_lng.should == 2
+        end
+
+        it 'should return latitude as #to_lng on the value for key :longitude' do
+          @hash = {:longitude => "3.1"}
+          @hash.to_lng.should == 3.1
+        end 
+      end
+
+      describe '#to_lat_lng' do              
+        it 'should return Array with lat, lng' do
+          @hash = {:lng => 2, :lat => "3"}
+          @hash.to_lat_lng.should == [3, 2]
+        end
+      end 
+  
+      describe '#geo_point' do              
+        it 'should return a GeoPoint' do
+          @p = {:lng => 2, :lat => "3"}.geo_point
+          @p.should be_a(GeoPoint)            
+          @p.to_lat_lng.should == [3, 2]
+        end
+      end         
+    end # Hash 
+  end
+end

data/spec/geo_calc/core_ext/numeric_geo_ext_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+# - www.movable-type.co.uk/scripts/latlong.html
+describe GeoPoint do 
+  describe 'ruby core Class extensions' do
+    describe NumericGeoExt do
+      describe '#to_rad' do
+        it 'should convert 0 degrees to 0 radians' do
+          0.to_rad.should == 0
+        end
+
+        it 'should convert 180 degrees to PI radians' do
+          180.to_rad.should == Math::PI        
+        end
+
+        it 'should convert 360 degrees to 6.28 radians' do
+          360.to_rad.should == Math::PI*2                
+        end
+      end
+
+      describe '#to_radians' do      
+        it 'should alias to_rad' do
+          360.to_rad.should == 360.to_radians
+        end
+      end
+
+      describe '#to_deg' do
+        it 'should convert 0 radians to 0 degrees' do
+          0.to_deg.should == 0
+        end
+
+        it 'should convert PI radians to 180 degrees' do
+          180.to_rad.to_deg.should be_within(0.01).of(180)
+        end
+
+        it 'should convert 6.28 radians to 360 degrees' do
+          360.to_rad.to_deg.should be_within(0.01).of(360)
+        end
+      end
+      
+      describe '#to_degrees' do      
+        it 'should alias to_deg' do
+          360.to_deg.should == 360.to_degrees
+        end
+      end
+      
+      describe '#to_fixed' do
+        it 'should make precision 4' do
+          1.123456.to_fixed(2).should == '1.12'
+        end
+      end
+
+      describe '#to_precision' do
+        it 'should alis to_fixed' do
+          1.123456.to_precision(4).should == '1.1235'
+        end
+      end
+
+      describe '#normalize' do
+        it 'should turn 180 deg and normalize' do
+          361.normalize_deg(180).should == 181
+        end
+        it 'should normalize deg' do
+          361.normalize_deg.should == 1
+        end
+
+        it 'should alias with #normalize_degrees' do
+          362.normalize_degrees.should == 2
+        end
+      end
+    end # NumericGeoExt
+  end
+end

data/spec/geo_calc/core_ext/string_ext_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+# - www.movable-type.co.uk/scripts/latlong.html
+describe GeoPoint do 
+  describe 'ruby core Class extensions' do
+    describe 'String extension' do
+      describe '#to_lat' do              
+        it 'should not return latitude on empty String' do
+          @str = ""
+          lambda { @str.to_lat}.should raise_error
+        end
+
+        it 'should return latitude' do
+          @str = "4"
+          @str.to_lat.should == 4
+        end
+
+        it 'should convert to latitude' do
+          @str = "50 03 59N"
+          @str.to_lat.should be_within(0.4).of(50)
+        end
+      end      
+
+      describe '#to_lng' do              
+        it 'should not return longitude on empty String' do
+          @str = ""
+          lambda { @str.to_lng}.should raise_error
+        end
+
+        it 'should return latitude' do
+          @str = "4"
+          @str.to_lat.should == 4
+        end
+
+        it 'should convert to latitude' do
+          @str = "50 03 59E"
+          @str.to_lat.should be_within(0.4).of(50)
+        end
+      end
+
+      describe '#to_lat_lng' do              
+        it 'should return Array with lat, lng' do
+          @str = "4, 3"
+          @str.to_lat_lng.should == [4, 3]
+        end
+
+        it 'should raise error if only latitude' do
+          @str = "4"
+          lambda { @str.to_lat_lng}.should raise_error
+        end
+
+        it 'should raise error if "," but only latitude' do
+          @str = "4,"
+          lambda { @str.to_lat_lng}.should raise_error
+        end
+
+        it 'should raise error if "," in bad position' do
+          @str = ", 4 3"
+          lambda { @str.to_lat_lng}.should raise_error
+        end
+
+        it 'should raise error if not using "," as seperator' do
+          @str = "4; 3"
+          lambda { @str.to_lat_lng}.should raise_error
+        end
+      end 
+  
+      describe '#geo_point' do              
+        it 'should return a GeoPoint' do
+          @p = "3, 2".geo_point
+          @p.should be_a(GeoPoint)            
+          @p.to_lat_lng.should == [3, 2]
+        end
+      end                 
+    end # String
+  end
+end

data/spec/geo_calc/core_ext_spec.rb

@@ -3,76 +3,15 @@ require 'spec_helper'
 # - www.movable-type.co.uk/scripts/latlong.html
 describe GeoPoint do 
   describe 'ruby core Class extensions' do
-    describe NumericGeoExt do
-      describe '#to_rad' do
-        it 'should convert 0 degrees to 0 radians' do
-          0.to_rad.should == 0
-        end
-
-        it 'should convert 180 degrees to PI radians' do
-          180.to_rad.should == Math::PI        
-        end
-
-        it 'should convert 360 degrees to 6.28 radians' do
-          360.to_rad.should == Math::PI*2                
-        end
-      end
-
-      describe '#to_radians' do      
-        it 'should alias to_rad' do
-          360.to_rad.should == 360.to_radians
-        end
-      end
-
-      describe '#to_deg' do
-        it 'should convert 0 radians to 0 degrees' do
-          0.to_deg.should == 0
-        end
-
-        it 'should convert PI radians to 180 degrees' do
-          180.to_rad.to_deg.should be_within(0.01).of(180)
-        end
-
-        it 'should convert 6.28 radians to 360 degrees' do
-          360.to_rad.to_deg.should be_within(0.01).of(360)
-        end
-      end
-      
-      describe '#to_degrees' do      
-        it 'should alias to_deg' do
-          360.to_deg.should == 360.to_degrees
-        end
-      end
-      
-      describe '#to_fixed' do
-        it 'should make precision 4' do
-          1.123456.to_fixed(2).should == '1.12'
-        end
-      end
-
-      describe '#to_precision' do
-        it 'should alis to_fixed' do
-          1.123456.to_precision(4).should == '1.1235'
-        end
-      end
-
-      describe '#normalize' do
-        it 'should turn 180 deg and normalize' do
-          361.normalize_deg(180).should == 181
-        end
-        it 'should normalize deg' do
-          361.normalize_deg.should == 1
-        end
-
-        it 'should alias with #normalize_degrees' do
-          362.normalize_degrees.should == 2
-        end
-      end
-    end # NumericGeoExt
-    
     describe NumericLatLngExt do
       describe 'Fixnum extension' do
         describe '#to_lat' do              
+          it 'should set origin at 0,0' do
+            origin = [0, 0].geo_point
+            origin.lat.should == 0       
+            origin.lng.should == 0
+          end
+
           it 'should return latitude degree value for 360' do
             360.to_lat.should == 0
           end
@@ -114,159 +53,6 @@ describe GeoPoint do
           end
         end      
       end
-
-      describe 'Array extension' do
-        describe '#to_lat' do              
-          it 'should return latitude as first element' do
-            @arr = [4, 27]
-            @arr.to_lat.should == 4
-          end
-
-          it 'should return latitude as #to_lng of first element' do
-            @arr = ["4.1", 27]
-            @arr.to_lat.should == 4.1
-          end
-        end      
-
-        describe '#to_lng' do              
-          it 'should return latitude degree value for 360' do
-            @arr = [4, 27]            
-            @arr.to_lng.should == 27
-          end
-
-          it 'should return latitude as #to_lng of first element' do
-            @arr = [4, "27.2"]            
-            @arr.to_lng.should == 27.2
-          end
-        end   
-
-        describe '#to_lat_lng' do              
-          it 'should return Array with lat, lng' do
-            @arr = ["3", {:lng => "2"}]
-            @arr.to_lat_lng.should == [3, 2]
-          end
-        end 
-        
-        describe '#geo_point' do              
-          it 'should return a GeoPoint' do
-            @p = [3, 2].geo_point
-            @p.should be_a(GeoPoint)
-            @p.to_lat_lng.should == [3, 2]
-          end
-        end                            
-      end # Array
-
-      describe 'Hash extension' do
-        describe '#to_lat' do              
-          it 'should return latitude as #to_lat on the value for key :lat' do
-            @hash = {:lat => 4}
-            @hash.to_lat.should == 4
-          end
-
-          it 'should return latitude as #to_lat on the value for key :latitude' do
-            @hash = {:latitude => "7"}
-            @hash.to_lat.should == 7
-          end
-        end      
-
-        describe '#to_lng' do              
-          it 'should return latitude as #to_lng on the value for key :lng' do
-            @hash = {:lng => 2}
-            @hash.to_lng.should == 2
-          end
-
-          it 'should return latitude as #to_lng on the value for key :longitude' do
-            @hash = {:longitude => "3.1"}
-            @hash.to_lng.should == 3.1
-          end 
-        end
-
-        describe '#to_lat_lng' do              
-          it 'should return Array with lat, lng' do
-            @hash = {:lng => 2, :lat => "3"}
-            @hash.to_lat_lng.should == [3, 2]
-          end
-        end 
-        
-        describe '#geo_point' do              
-          it 'should return a GeoPoint' do
-            @p = {:lng => 2, :lat => "3"}.geo_point
-            @p.should be_a(GeoPoint)            
-            @p.to_lat_lng.should == [3, 2]
-          end
-        end         
-      end # Hash 
-      
-      describe 'String extension' do
-        describe '#to_lat' do              
-          it 'should not return latitude on empty String' do
-            @str = ""
-            lambda { @str.to_lat}.should raise_error
-          end
-
-          it 'should return latitude' do
-            @str = "4"
-            @str.to_lat.should == 4
-          end
-
-          it 'should convert to latitude' do
-            @str = "50 03 59N"
-            @str.to_lat.should be_within(0.4).of(50)
-          end
-        end      
-
-        describe '#to_lng' do              
-          it 'should not return longitude on empty String' do
-            @str = ""
-            lambda { @str.to_lng}.should raise_error
-          end
-
-          it 'should return latitude' do
-            @str = "4"
-            @str.to_lat.should == 4
-          end
-
-          it 'should convert to latitude' do
-            @str = "50 03 59E"
-            @str.to_lat.should be_within(0.4).of(50)
-          end
-        end
-
-        describe '#to_lat_lng' do              
-          it 'should return Array with lat, lng' do
-            @str = "4, 3"
-            @str.to_lat_lng.should == [4, 3]
-          end
-
-          it 'should raise error if only latitude' do
-            @str = "4"
-            lambda { @str.to_lat_lng}.should raise_error
-          end
-
-          it 'should raise error if "," but only latitude' do
-            @str = "4,"
-            lambda { @str.to_lat_lng}.should raise_error
-          end
-
-          it 'should raise error if "," in bad position' do
-            @str = ", 4 3"
-            lambda { @str.to_lat_lng}.should raise_error
-          end
-
-          it 'should raise error if not using "," as seperator' do
-            @str = "4; 3"
-            lambda { @str.to_lat_lng}.should raise_error
-          end
-        end 
-        
-        describe '#geo_point' do              
-          it 'should return a GeoPoint' do
-            @p = "3, 2".geo_point
-            @p.should be_a(GeoPoint)            
-            @p.to_lat_lng.should == [3, 2]
-          end
-        end                 
-      end # String      
     end
   end
 end

data/spec/geo_calc/geo_point_spec.rb

@@ -32,7 +32,7 @@ describe GeoPoint do
             p1 = GeoPoint.new "58 38 38N, 003 04 12W"
             p1.should be_a(GeoPoint)
             p1.lat.should be_within(0.5).of(58.38)
-            p1.lon.should be_within(0.5).of(356.5)
+            p1.lon.should be_within(0.5).of(-3)
             p1.unit.should == :degrees
             p1.radius.should == 6371
           end
@@ -43,7 +43,7 @@ describe GeoPoint do
             p1 = GeoPoint.new "(58 38 38N, 003 04 12W)"
             p1.should be_a(GeoPoint)
             p1.lat.should be_within(0.5).of(58.38)
-            p1.lon.should be_within(0.5).of(356.5) # W is negative, then normalize
+            p1.lon.should be_within(0.5).of(-3) # W is negative, then normalize
             p1.unit.should == :degrees
             p1.radius.should == 6371
           end
@@ -138,7 +138,7 @@ describe GeoPoint do
           p1 = GeoPoint.new "58 38 38N", "003 04 12W"
           p1.should be_a(GeoPoint)
           p1.lat.should be_within(0.5).of(58.38)
-          p1.lon.should be_within(0.5).of(356.5)
+          p1.lon.should be_within(0.5).of(-3)
           p1.unit.should == :degrees
           p1.radius.should == 6371
         end
@@ -146,6 +146,31 @@ describe GeoPoint do
     end
   end # initializer  
 
+  describe '#reverse_point' do
+    before :each do
+      @p = GeoPoint.new -2, 5
+    end
+  
+    it 'should return reverse GeoPoint (2, -5)' do
+      @p2 = @p.reverse_point
+      @p2.should_not == @p  
+      @p2.lat.should == 2
+      @p2.lng.should == -5
+    end
+  end
+
+  describe '#reverse_point!' do
+    before :each do
+      @p = GeoPoint.new -2, 5
+    end
+  
+    it 'should return reverse GeoPoint (2, -5)' do
+      @p.reverse_point!
+      @p.lat.should == 2
+      @p.lng.should == -5
+    end
+  end
+
   describe '#to_s' do
     before :each do
       @p1 = GeoPoint.new 50.1, 5
@@ -192,6 +217,17 @@ describe GeoPoint do
       @p1.lat.should == 60
     end
 
+    it 'should set new latitude -2' do
+      @p1.lat = -2
+      @p1.lat.should == -2
+    end
+
+    it 'should convert latitude -182 to -2' do
+      @p1.lat = -2
+      @p1.lat.should == -2
+    end
+
+
     it 'should set new latitude within allowed range' do
       @p1.lat = 520
       @p1.lat.should be_between(0, 360)

data/spec/geo_calc/geo_spec.rb

@@ -91,7 +91,7 @@ describe GeoPoint do
       it 'should convert 58.3 to a longitude String' do
         brng = Geo.to_brng(-58.3)
         brng.to_f.should be_between(0, 360)
-        expr = Regexp.escape "42".concat("\u00B0", "42", "\u2032", "00")
+        expr = Regexp.escape "301".concat("\u00B0", "42", "\u2032", "00")
         brng.should match expr
       end
     end