gpx 0.9.0 → 1.0.0

data/lib/gpx/track.rb

@@ -1,25 +1,3 @@
-#--
-# Copyright (c) 2006  Doug Fales
-#
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-#
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-#++
 module GPX
   # In GPX, a single Track can hold multiple Segments, each of which hold
   # multiple points (in this library, those points are instances of
@@ -38,24 +16,36 @@ module GPX
       @segments = []
       @points = []
       reset_meta_data
-      if(opts[:element])
-        trk_element = opts[:element]
-        @name = (trk_element.at("name").inner_text rescue "")
-        @comment = (trk_element.at('cmt').inner_text rescue '')
-        @description = (trk_element.at('desc').inner_text rescue '')
-        trk_element.search("trkseg").each do |seg_element|
-          seg = Segment.new(:element => seg_element, :track => self, :gpx_file => @gpx_file)
-          update_meta_data(seg)
-          @segments << seg
-        end
+
+      return unless opts[:element]
+
+      trk_element = opts[:element]
+      @name = (begin
+        trk_element.at('name').inner_text
+      rescue StandardError
+        ''
+      end)
+      @comment = (begin
+        trk_element.at('cmt').inner_text
+      rescue StandardError
+        ''
+      end)
+      @description = (begin
+        trk_element.at('desc').inner_text
+      rescue StandardError
+        ''
+      end)
+      trk_element.search('trkseg').each do |seg_element|
+        seg = Segment.new(element: seg_element, track: self, gpx_file: @gpx_file)
+        append_segment(seg)
       end
     end
 
     # Append a segment to this track, updating its meta data along the way.
     def append_segment(seg)
+      return if seg.points.empty?
       update_meta_data(seg)
       @segments << seg
-      @points.concat(seg.points) unless seg.nil?
     end
 
     # Returns true if the given time occurs within any of the segments of this track.
@@ -63,7 +53,7 @@ module GPX
       segments.each do |seg|
         return true if seg.contains_time?(time)
       end
-      return false
+      false
     end
 
     # Finds the closest point (to "time") within this track.  Useful for
@@ -82,7 +72,7 @@ module GPX
         seg.crop(area)
         update_meta_data(seg) unless seg.empty?
       end
-      segments.delete_if { |seg| seg.empty? }
+      segments.delete_if(&:empty?)
     end
 
     # Deletes all points within a given area and updates the meta data.
@@ -92,13 +82,13 @@ module GPX
         seg.delete_area(area)
         update_meta_data(seg) unless seg.empty?
       end
-      segments.delete_if { |seg| seg.empty? }
+      segments.delete_if(&:empty?)
     end
 
     # Returns true if this track has no points in it.  This should return
     # true even when the track has empty segments.
     def empty?
-      (points.nil? or points.size.zero?)
+      (points.nil? || points.size.zero?)
     end
 
     # Prints out a friendly summary of this track (sans points).  Useful for
@@ -115,7 +105,7 @@ module GPX
       result << "\tMoving duration: #{moving_duration} km\n"
       result << "\tLowest Point: #{lowest_point.elevation} \n"
       result << "\tHighest Point: #{highest_point.elevation}\n "
-      result << "\tBounds: #{bounds.to_s}"
+      result << "\tBounds: #{bounds}"
       result
     end
 
@@ -125,12 +115,12 @@ module GPX
         @distance += seg.distance
       end
     end
- 
+
     protected
 
     def update_meta_data(seg)
-      @lowest_point   = seg.lowest_point if(@lowest_point.nil? or seg.lowest_point.elevation < @lowest_point.elevation)
-      @highest_point  = seg.highest_point if(@highest_point.nil? or seg.highest_point.elevation > @highest_point.elevation)
+      @lowest_point = seg.lowest_point if @lowest_point.nil? || (seg.lowest_point.elevation < @lowest_point.elevation)
+      @highest_point = seg.highest_point if @highest_point.nil? || (seg.highest_point.elevation > @highest_point.elevation)
       @bounds.add(seg.bounds)
       @distance += seg.distance
       @moving_duration += seg.duration
@@ -145,6 +135,5 @@ module GPX
       @moving_duration = 0.0
       @points = []
     end
-
   end
 end

data/lib/gpx/track_point.rb

@@ -0,0 +1,30 @@
+module GPX
+  # Basically the same as a point, the TrackPoint class is supposed to
+  # represent the points that are children of Segment elements.  So, the only
+  # real difference is that TrackPoints hold a reference to their parent
+  # Segments.
+  class TrackPoint < Point
+    RADIUS = 6371 # earth's mean radius in km
+
+    attr_accessor :segment
+
+    def initialize(opts = {})
+      super(opts)
+      @segment = opts[:segment]
+    end
+
+    # Units are in km
+    def haversine_distance_from(p2)
+      d_lat = p2.latr - latr
+      d_lon = p2.lonr - lonr
+      a = Math.sin(d_lat / 2) * Math.sin(d_lat / 2) + Math.cos(latr) * Math.cos(p2.latr) * Math.sin(d_lon / 2) * Math.sin(d_lon / 2)
+      c = 2 * Math.atan2(Math.sqrt(a), Math.sqrt(1 - a))
+      RADIUS * c
+    end
+
+    # Units are in km
+    def law_of_cosines_distance_from(p2)
+      Math.acos(Math.sin(latr) * Math.sin(p2.latr) + Math.cos(latr) * Math.cos(p2.latr) * Math.cos(p2.lonr - lonr)) * RADIUS
+    end
+  end
+end

data/lib/gpx/version.rb

@@ -1,3 +1,3 @@
 module GPX
-  VERSION = "0.9.0"
+  VERSION = "1.0.0".freeze
 end

data/lib/gpx/waypoint.rb

@@ -1,56 +1,29 @@
-#--
-# Copyright (c) 2006  Doug Fales
-#
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-#
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-#++
 module GPX
   # This class supports the concept of a waypoint.  Beware that this class has
   # not seen much use yet, since WalkingBoss does not use waypoints right now.
   class Waypoint < Point
-
-    SUB_ELEMENTS = %w{ele magvar geoidheight name cmt desc src link sym type fix sat hdop vdop pdop ageofdgpsdata dgpsid extensions}
+    SUB_ELEMENTS = %w[ele magvar geoidheight name cmt desc src link sym type fix sat hdop vdop pdop ageofdgpsdata dgpsid extensions].freeze
 
     attr_reader :gpx_file
     SUB_ELEMENTS.each { |sub_el| attr_accessor sub_el.to_sym }
 
     # Not implemented
-    def crop(area)
-    end
+    def crop(area); end
 
     # Not implemented
-    def delete_area(area)
-    end
+    def delete_area(area); end
 
     # Initializes a waypoint from a XML::Node.
     def initialize(opts = {})
-      if(opts[:element] and opts[:gpx_file])
+      if opts[:element] && opts[:gpx_file]
         wpt_elem = opts[:element]
         @gpx_file = opts[:gpx_file]
-        super(:element => wpt_elem, :gpx_file => @gpx_file)
+        super(element: wpt_elem, gpx_file: @gpx_file)
         instantiate_with_text_elements(wpt_elem, SUB_ELEMENTS)
       else
         opts.each do |key, value|
           assignment_method = "#{key}="
-          if self.respond_to?(assignment_method)
-            self.send(assignment_method, value)
-          end
+          send(assignment_method, value) if respond_to?(assignment_method)
         end
       end
     end
@@ -65,7 +38,7 @@ module GPX
       result << "\tElevation: #{elevation}\n "
       result << "\tTime: #{time}\n"
       SUB_ELEMENTS.each do |sub_element_attribute|
-        val = self.send(sub_element_attribute)
+        val = send(sub_element_attribute)
         result << "\t#{sub_element_attribute}: #{val}\n" unless val.nil?
       end
       result

data/tests/gpx10_test.rb

@@ -2,11 +2,10 @@ require 'minitest/autorun'
 require 'gpx'
 
 class GPX10Test < Minitest::Test
-   GPX_FILE = File.join(File.dirname(__FILE__), "gpx_files/gpx10.gpx")
-
-   def test_read
-      # make sure we can read a GPX 1.0 file
-      @gpx_file = GPX::GPXFile.new(:gpx_file => GPX_FILE)
-   end
+  GPX_FILE = File.join(File.dirname(__FILE__), 'gpx_files/gpx10.gpx')
 
+  def test_read
+    # make sure we can read a GPX 1.0 file
+    @gpx_file = GPX::GPXFile.new(gpx_file: GPX_FILE)
+  end
 end

data/tests/gpx_file_test.rb

@@ -2,18 +2,18 @@ require 'minitest/autorun'
 require 'gpx'
 
 class GPXFileTest < Minitest::Test
-
-  ONE_TRACK_FILE = File.join(File.dirname(__FILE__), "gpx_files/one_track.gpx")
-  WITH_OR_WITHOUT_ELEV_FILE = File.join(File.dirname(__FILE__), "gpx_files/with_or_without_elev.gpx")
-  BIG_FILE = File.join(File.dirname(__FILE__), "gpx_files/big.gpx")
+  ONE_TRACK_FILE = File.join(File.dirname(__FILE__), 'gpx_files/one_track.gpx')
+  WITH_OR_WITHOUT_ELEV_FILE = File.join(File.dirname(__FILE__), 'gpx_files/with_or_without_elev.gpx')
+  WITH_EMPTY_TRACKS = File.join(File.dirname(__FILE__), 'gpx_files/with_empty_tracks.gpx')
+  BIG_FILE = File.join(File.dirname(__FILE__), 'gpx_files/big.gpx')
 
   def test_load_data_from_string
-    gpx_file = GPX::GPXFile.new(:gpx_data => open(ONE_TRACK_FILE).read)
+    gpx_file = GPX::GPXFile.new(gpx_data: File.open(ONE_TRACK_FILE).read)
     assert_equal(1, gpx_file.tracks.size)
     assert_equal(8, gpx_file.tracks.first.segments.size)
-    assert_equal("ACTIVE LOG", gpx_file.tracks.first.name)
-    assert_equal("active_log.gpx", gpx_file.name)
-    assert_equal("2006-04-08T16:44:28Z", gpx_file.time.xmlschema)
+    assert_equal('ACTIVE LOG', gpx_file.tracks.first.name)
+    assert_equal('active_log.gpx', gpx_file.name)
+    assert_equal('2006-04-08T16:44:28Z', gpx_file.time.xmlschema)
     assert_equal(38.681488, gpx_file.bounds.min_lat)
     assert_equal(-109.606948, gpx_file.bounds.min_lon)
     assert_equal(38.791759, gpx_file.bounds.max_lat)
@@ -21,45 +21,55 @@ class GPXFileTest < Minitest::Test
     assert_equal('description of my GPX file with special char like &, <, >', gpx_file.description)
     assert_equal('description of my GPX file with special char like &, <, >', gpx_file.description)
     assert_equal(3.0724966849262554, gpx_file.distance)
-    assert_equal(15237.0, gpx_file.duration)
+    assert_equal(15_237.0, gpx_file.duration)
     assert_equal(3036.0, gpx_file.moving_duration)
     assert_equal(3.6432767014935834, gpx_file.average_speed)
   end
 
   def test_load_data_from_file
-    gpx_file = GPX::GPXFile.new(:gpx_file => ONE_TRACK_FILE)
+    gpx_file = GPX::GPXFile.new(gpx_file: ONE_TRACK_FILE)
     assert_equal(1, gpx_file.tracks.size)
     assert_equal(8, gpx_file.tracks.first.segments.size)
-    assert_equal("ACTIVE LOG", gpx_file.tracks.first.name)
-    assert_equal("active_log.gpx", gpx_file.name)
-    assert_equal("2006-04-08T16:44:28Z", gpx_file.time.xmlschema)
+    assert_equal('ACTIVE LOG', gpx_file.tracks.first.name)
+    assert_equal('active_log.gpx', gpx_file.name)
+    assert_equal('2006-04-08T16:44:28Z', gpx_file.time.xmlschema)
     assert_equal(38.681488, gpx_file.bounds.min_lat)
     assert_equal(-109.606948, gpx_file.bounds.min_lon)
     assert_equal(38.791759, gpx_file.bounds.max_lat)
     assert_equal(-109.447045, gpx_file.bounds.max_lon)
     assert_equal('description of my GPX file with special char like &, <, >', gpx_file.description)
     assert_equal(3.0724966849262554, gpx_file.distance)
-    assert_equal(15237.0, gpx_file.duration)
+    assert_equal(15_237.0, gpx_file.duration)
     assert_equal(3036.0, gpx_file.moving_duration)
     assert_equal(3.6432767014935834, gpx_file.average_speed)
   end
 
   def test_big_file
-    gpx_file = GPX::GPXFile.new(:gpx_file => BIG_FILE)
+    gpx_file = GPX::GPXFile.new(gpx_file: BIG_FILE)
     assert_equal(1, gpx_file.tracks.size)
     assert_equal(7968, gpx_file.tracks.first.points.size)
-    assert_equal(105508.0, gpx_file.duration)
-    assert_equal(57645.0, gpx_file.moving_duration)
+    assert_equal(105_508.0, gpx_file.duration)
+    assert_equal(57_645.0, gpx_file.moving_duration)
     assert_in_delta(99.60738958686505, gpx_file.average_speed, 1e-13)
   end
 
   def test_with_or_with_elev
-    gpx_file = GPX::GPXFile.new(:gpx_file => WITH_OR_WITHOUT_ELEV_FILE)
+    gpx_file = GPX::GPXFile.new(gpx_file: WITH_OR_WITHOUT_ELEV_FILE)
     assert_equal(2, gpx_file.tracks.size)
     assert_equal(0, gpx_file.duration)
     assert_equal(0, gpx_file.moving_duration)
     assert(gpx_file.average_speed.nan?)
-    #assert_equal(7968, gpx_file.tracks.first.points.size)
+    # assert_equal(7968, gpx_file.tracks.first.points.size)
   end
 
+  def test_with_empty_tracks
+    gpx_file = GPX::GPXFile.new(gpx_file: WITH_EMPTY_TRACKS)
+    # is read correctly
+    assert_equal(1, gpx_file.tracks.size)
+    # and ignores empty segments
+    assert_equal(1, gpx_file.tracks.first.segments.size)
+    assert_equal(21.0, gpx_file.duration)
+    assert_equal(21.0, gpx_file.moving_duration)
+    assert_equal(6.674040636626879, gpx_file.average_speed)
+  end
 end

data/tests/gpx_files/with_empty_tracks.gpx

@@ -0,0 +1,72 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<gpx xmlns="http://www.topografix.com/GPX/1/1" version="1.1" creator="Open GPX Tracker for iOS">
+	<wpt lat="51.185170" lon="4.662453">
+		<time>2018-01-16T11:35:01Z</time>
+		<name>12:35:01</name>
+		<desc>16 jan. 2018 12:35:01</desc>
+	</wpt>
+	<trk>
+		<trkseg>
+			<trkpt lat="51.183019" lon="4.664619">
+				<ele>0.751247</ele>
+				<time>2018-01-16T11:06:00Z</time>
+			</trkpt>
+			<trkpt lat="51.183037" lon="4.664587">
+				<ele>0.622036</ele>
+				<time>2018-01-16T11:06:02Z</time>
+			</trkpt>
+			<trkpt lat="51.183053" lon="4.664553">
+				<ele>0.042019</ele>
+				<time>2018-01-16T11:06:04Z</time>
+			</trkpt>
+			<trkpt lat="51.183073" lon="4.664515">
+				<ele>0.177456</ele>
+				<time>2018-01-16T11:06:06Z</time>
+			</trkpt>
+			<trkpt lat="51.183095" lon="4.664480">
+				<ele>0.564846</ele>
+				<time>2018-01-16T11:06:08Z</time>
+			</trkpt>
+			<trkpt lat="51.183115" lon="4.664446">
+				<ele>0.941067</ele>
+				<time>2018-01-16T11:06:10Z</time>
+			</trkpt>
+			<trkpt lat="51.183143" lon="4.664401">
+				<ele>1.960781</ele>
+				<time>2018-01-16T11:06:12Z</time>
+			</trkpt>
+			<trkpt lat="51.183160" lon="4.664372">
+				<ele>2.115200</ele>
+				<time>2018-01-16T11:06:13Z</time>
+			</trkpt>
+			<trkpt lat="51.183176" lon="4.664342">
+				<ele>2.191250</ele>
+				<time>2018-01-16T11:06:14Z</time>
+			</trkpt>
+			<trkpt lat="51.183192" lon="4.664315">
+				<ele>2.492947</ele>
+				<time>2018-01-16T11:06:15Z</time>
+			</trkpt>
+			<trkpt lat="51.183205" lon="4.664291">
+				<ele>2.459927</ele>
+				<time>2018-01-16T11:06:16Z</time>
+			</trkpt>
+			<trkpt lat="51.183217" lon="4.664270">
+				<ele>2.226833</ele>
+				<time>2018-01-16T11:06:17Z</time>
+			</trkpt>
+			<trkpt lat="51.183240" lon="4.664233">
+				<ele>2.175198</ele>
+				<time>2018-01-16T11:06:19Z</time>
+			</trkpt>
+			<trkpt lat="51.183255" lon="4.664207">
+				<ele>2.643887</ele>
+				<time>2018-01-16T11:06:21Z</time>
+			</trkpt>
+		</trkseg>
+		<trkseg>
+		</trkseg>
+		<trkseg>
+		</trkseg>
+	</trk>
+</gpx>

data/tests/magellan_test.rb

@@ -2,17 +2,16 @@ require 'minitest/autorun'
 require 'gpx'
 
 class MagellanTest < Minitest::Test
-   MAGELLAN_TRACK_LOG = File.join(File.dirname(__FILE__), "gpx_files/magellan_track.log")
-   GPX_FILE = File.join(File.dirname(__FILE__), "gpx_files/one_segment.gpx")
+  MAGELLAN_TRACK_LOG = File.join(File.dirname(__FILE__), 'gpx_files/magellan_track.log')
+  GPX_FILE = File.join(File.dirname(__FILE__), 'gpx_files/one_segment.gpx')
 
-   def test_convert
-      GPX::MagellanTrackLog.convert_to_gpx(MAGELLAN_TRACK_LOG, "/tmp/gpx_from_magellan.gpx")
-      @gpx_file = GPX::GPXFile.new(:gpx_file => "/tmp/gpx_from_magellan.gpx")
-   end
-
-   def test_file_type
-      assert(GPX::MagellanTrackLog::is_magellan_file?(MAGELLAN_TRACK_LOG))
-      assert(!GPX::MagellanTrackLog::is_magellan_file?(GPX_FILE))
-   end
+  def test_convert
+    GPX::MagellanTrackLog.convert_to_gpx(MAGELLAN_TRACK_LOG, '/tmp/gpx_from_magellan.gpx')
+    @gpx_file = GPX::GPXFile.new(gpx_file: '/tmp/gpx_from_magellan.gpx')
+  end
 
+  def test_file_type
+    assert(GPX::MagellanTrackLog.magellan_file?(MAGELLAN_TRACK_LOG))
+    assert(!GPX::MagellanTrackLog.magellan_file?(GPX_FILE))
+  end
 end