vincenty 1.0.9 → 1.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8c6ea3c3470ff15da8327c1d3a0094a3f3c4b1c8d0796a38b9fd6218a61673c
-  data.tar.gz: 9a648f496428a4c1cf42ae6fcf2d3fdf595c40da7db73bea862e147998d8eded
+  metadata.gz: d8da3071ee96be2492c012b7cadd49fa3138b83fc94082a8884fd802daae1812
+  data.tar.gz: dd77a978fc6e6c48f68e5f502521b70e34433e923d67b7efa7d133102a0ffc8f
 SHA512:
-  metadata.gz: c9839e6de4ac0d516d29577d6bd0d4594c8967bb793bc19e202c75ee03fd5c1e50e543888ad32e3915324307c11d01e8c7ade41793c811e2e3c99bf48fab519e
-  data.tar.gz: f6ba931e58dc2835d24a8f1a604fac8c14d70c409f4d8667fd0c5ce16b47a9a138f45b816cbb337a0294de0e07a6a763af9f79d646a72d01e854a5c34270b7e1
+  metadata.gz: 3f3a482610d9613ba8223fe40faae17bca233dad29d1c44586a1f42e40a9f413881015c988228d4cac7d1ed0e6453acacf81861b68a15b428d77f86b30d849d0
+  data.tar.gz: 0fc65c74e71f91c4be148c6c2bde7ae01ba3f45cc00b0fcb64a5e9d5f96c3850dc9d6d1754e0ba18af38c1f54ed3184f88e1c9129cf72daa75ff4883b93df874

data/History.txt

@@ -1,3 +1,17 @@
+robertburrowes	Thu Oct 14 15:09:23 2021 +1300
+	bumped version
+robertburrowes	Thu Oct 14 15:06:18 2021 +1300
+	Bump version.
+robertburrowes	Thu Oct 14 14:43:00 2021 +1300
+	Bearing 0 and 180 edgecase for spherical test method resulted in negative sqrt
+robertburrowes	Sun Oct 10 12:09:10 2021 +1300
+	#{PROJECT} release 1.0.10
+robertburrowes	Sun Oct 10 12:07:45 2021 +1300
+	Inc version
+robertburrowes	Sun Oct 10 12:05:54 2021 +1300
+	removed Float.round, as ruby now does this. removed to_r, as it is now defined in the core ruby libraries, with a different meaning
+robertburrowes	Sun Oct 10 11:44:09 2021 +1300
+	Chmod, adding world readable
 robertburrowes	Sun Oct 10 11:39:21 2021 +1300
 	Bump Version, after removing stray '.'
 robertburrowes	Fri Oct 8 16:32:19 2021 +1300

data/lib/angle.rb

@@ -141,26 +141,26 @@ class Angle
   # @return [Angle,self]
   # @param [Angle,Numeric] angle
   def **(other)
-    self.class.radians(@angle**other)
+    return self.class.radians(@angle**other)
   end
 
   # Binary division operator. Can add angles and numbers, or two angles.
   # @return [Angle,self]
   # @param [Angle,Numeric] angle
   def /(other)
-    self.class.radians(@angle / other)
+    return self.class.radians(@angle / other)
   end
 
   # Binary mod operator. Can add angles and numbers, or two angles.
   # @return [Angle,self]
   # @param [Angle,Numeric] angle
   def %(other)
-    self.class.radians(@angle % other)
+    return self.class.radians(@angle % other)
   end
 
   # @return [Float] angle in degrees
   def to_degrees
-    @angle.to_degrees
+    return @angle.to_degrees
   end
 
   # @return [Float] angle in degrees
@@ -169,7 +169,7 @@ class Angle
 
   # @return [Float]  angle in radians
   def to_radians
-    @angle
+    return @angle
   end
 
   alias to_rad to_radians
@@ -205,7 +205,7 @@ class Angle
 
   # @return [Fixnum] the angle truncated to an integer, in radians.
   def to_i
-    to_radians.to_i
+    return to_radians.to_i
   end
 
   # @return [Fixnum] the angle truncated to an integer, in radians.
@@ -214,23 +214,23 @@ class Angle
   # @return [Array] the angle parameter as a Float and the @angle parameter from this class.
   # @param [Numeric] angle
   def coerce(angle)
-    [ Float(angle), @angle ]
+    return [ Float(angle), @angle ]
   end
 
   # @return [Fixnum] the sign of the angle. 1 for positive, -1 for negative.
   def sign
-    @angle.sign
+    return @angle.sign
   end
 
   # @return [Float] the absolute angle of the angle in radians
   def abs
-    @angle.abs
+    return @angle.abs
   end
 
   # @return [Float] angle as compass bearing in radians.
   # Compass bearings are clockwise, Math angles are counter clockwise.
   def to_bearing
-    self.class.new((Math::PI * 2) - @angle, true)
+    return self.class.new((Math::PI * 2) - @angle, true)
   end
 
   # @return [Float] the reverse angle in radians. i.e. angle + PI (or angle + 180 degrees)

data/lib/coordinate.rb

@@ -33,4 +33,7 @@ class Coordinate
   def to_hash
     { latitude: @latitude, longitude: @longitude, altitude: @altitude }
   end
+
+  alias deconstruct_keys to_hash
+  alias deconstruct to_ary
 end

data/lib/core_extensions.rb

@@ -25,7 +25,6 @@ class Numeric
     end
   end
 
-  alias to_r to_radians
   alias to_rad to_radians
   alias to_deg to_degrees
 
@@ -35,25 +34,6 @@ class Numeric
   end
 end
 
-# Alters round method to have an optional number of decimal places.
-class Float
-  # Replace default round, so we can reference it later.
-  # @return [Float]
-  alias round0 round
-
-  # Compatible Replacement for Float.round
-  # @return [Float] float rounded to n decimal places.
-  # @param [Numeric] n Optional argument n is the number of decimal places to round to.
-  def round(n = 0)
-    if n == 0
-      self.round0 # This is to preserve the default behaviour, which is to return a Fixnum, not a float.
-    else
-      m = 10.0**n
-      (self * m).round0 / m
-    end
-  end
-end
-
 # Extends String to to_dec_degrees, add to_r and to_d
 class String
   # string expected to be degrees, returns decimal degrees.
@@ -93,6 +73,5 @@ class String
   end
 
   alias to_rad to_radians
-  alias to_r to_radians
   alias to_deg to_degrees
 end

data/lib/track_and_distance.rb

@@ -37,4 +37,7 @@ class TrackAndDistance
   def to_hash
     return { bearing: @bearing, distance: @distance }
   end
+
+  alias deconstruct_keys to_hash
+  alias deconstruct to_ary
 end

data/lib/vincenty.rb

@@ -12,7 +12,7 @@ require_relative 'coordinate.rb'
 # Modified to incorporate corrections to formulae as found in script on http://www.movable-type.co.uk/scripts/LatLongVincenty.html
 # Added my Modification of the distanceAndAngle formulae to correct the compass bearing.
 class Vincenty < Coordinate
-  VERSION = '1.0.9'
+  VERSION = '1.0.12'
 
   # @return [String] constant VERSION
   def version
@@ -30,13 +30,11 @@ class Vincenty < Coordinate
   # @param [Coordinate] p2 is target coordinate that we want the bearing to.
   # @return [TrackAndDistance]  with the compass bearing and distance in meters to P2
   def sphericalDistanceAndAngle( p2, equatorial_radius = WGS84_ER, inverse_flattening = WGS84_IF )
-    if self.latitude == p2.latitude && self.longitude == p2.longitude
-      return TrackAndDistance.new(0, 0, true) # No calculations necessary
-    end
+    # No calculations necessary, if these are the same point.
+    return TrackAndDistance.new(0, 0, true) if @latitude == p2.latitude && @longitude == p2.longitude
 
     a = equatorial_radius # equatorial radius in meters     (+/-2 m)
-    f = inverse_flattening
-    b = a - a / f # WGS84 = 6356752.314245179 polar radius in meters
+    b = a - a / inverse_flattening # WGS84 = 6356752.314245179 polar radius in meters
     r = (a + b) / 2 # average diametre as a rough estimate for our tests.
 
     sin_lat1 = Math.sin(@latitude.to_rad)
@@ -45,9 +43,11 @@ class Vincenty < Coordinate
     atan1_2 = Math.atan(1) * 2
     t1 = cos_lat1 * Math.cos(p2.latitude.to_rad) * Math.cos(@longitude.to_rad - p2.longitude.to_rad) + sin_lat1 * sin_lat2
     angular_distance = Math.atan(-t1 / Math.sqrt(-t1 * t1 + 1)) + atan1_2 # central angle in radians so we can calculate the arc length.
-
     t2 = (sin_lat2 - sin_lat1 * Math.cos(angular_distance)) / (cos_lat1 * Math.sin(angular_distance))
-    bearing = if Math.sin(p2.longitude.to_rad - @longitude.to_rad) < 0
+
+    bearing = if @longitude == p2.longitude
+                @latitude > p2.latitude ? Math::PI : 0
+              elsif Math.sin(p2.longitude.to_rad - @longitude.to_rad) < 0
                 2 * Math::PI - (Math.atan(-t2 / Math.sqrt(-t2 * t2 + 1)) + atan1_2) # Compass Bearing in radians (clockwise)
               else
                 Math.atan(-t2 / Math.sqrt(-t2 * t2 + 1)) + atan1_2 # Compass Bearing in radians (clockwise)

data/test/ts_vincenty.rb

@@ -90,6 +90,36 @@ class TestVincenty < Test::Unit::TestCase
     assert_equal(0, vtrack_and_bearing.distance.round(4))
   end
 
+  # Edge case, when points are close, and 180 degrees
+  def test_vincenty_angle_when_180
+    start_track = Vincenty.new(-36.98684848301985, 174.4873448681314)
+    end_track = Vincenty.new(-36.989952870042174, 174.4873448681314)
+
+    vtrack_and_bearing = start_track.distanceAndAngle( end_track )
+    assert_equal(180.0, vtrack_and_bearing.bearing.to_deg.round(4))
+
+    vtrack_and_bearing = end_track.distanceAndAngle( start_track )
+    assert_equal(0.0, vtrack_and_bearing.bearing.to_deg.round(4))
+  end
+
+  # Edge case, when points are close, and 180 degrees
+  def test_spherical_angle_when_180
+    start_track = Vincenty.new(-36.98684848301985, 174.4873448681314)
+    end_track = Vincenty.new(-36.989952870042174, 174.4873448681314)
+
+    vtrack_and_bearing = start_track.sphericalDistanceAndAngle( end_track )
+    assert_equal(180.0, vtrack_and_bearing.bearing.to_deg.round(4))
+  end
+
+  #Edgecase when points are close and 0 degress
+  def test_spherical_angle_when_0
+    start_track = Vincenty.new(-36.98684848301985, 174.4873448681314)
+    end_track = Vincenty.new(-36.989952870042174, 174.4873448681314)
+
+    vtrack_and_bearing = end_track.sphericalDistanceAndAngle( start_track )
+    assert_equal(0.0, vtrack_and_bearing.bearing.to_deg.round(4))
+  end
+
   # Run the Australian Geoscience site example.
   def test_geoscience_au
     flindersPeak = Vincenty.new("-37 57'3.72030″", "144 25'29.52440″" )

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vincenty
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.0.12
 platform: ruby
 authors:
 - Rob Burrowes
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-09 00:00:00.000000000 Z
+date: 2022-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hoe-yard
@@ -113,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: "* Vincenty wrote an algorithm for calculating the bearing and distance between