gpx 1.0.0 → 1.1.0

data/lib/gpx/route.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GPX
   # A Route in GPX is very similar to a Track, but it is created by a user
   # from a series of Waypoints, whereas a Track is created by the GPS device
@@ -7,10 +9,11 @@ module GPX
 
     # Initialize a Route from a XML::Node.
     def initialize(opts = {})
+      super()
       if opts[:gpx_file] && opts[:element]
         rte_element = opts[:element]
         @gpx_file = opts[:gpx_file]
-        @name = rte_element.at('name').inner_text
+        @name = rte_element.at('name')&.inner_text
         @points = []
         rte_element.search('rtept').each do |point|
           @points << Point.new(element: point, gpx_file: @gpx_file)

data/lib/gpx/segment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GPX
   # A segment is the basic container in a GPX file.  A Segment contains points
   # (in this lib, they're called TrackPoints).  A Track contains Segments.  An
@@ -10,6 +12,7 @@ module GPX
     # If a XML::Node object is passed-in, this will initialize a new
     # Segment based on its contents.  Otherwise, a blank Segment is created.
     def initialize(opts = {})
+      super()
       @gpx_file = opts[:gpx_file]
       @track = opts[:track]
       @points = []
@@ -22,7 +25,8 @@ module GPX
       @bounds = Bounds.new
 
       segment_element = opts[:element]
-      return unless segment_element && segment_element.is_a?(Nokogiri::XML::Node)
+      return unless segment_element.is_a?(Nokogiri::XML::Node)
+
       segment_element.search('trkpt').each do |trkpt|
         pt = TrackPoint.new(element: trkpt, segment: self, gpx_file: @gpx_file)
         append_point(pt)
@@ -33,8 +37,8 @@ module GPX
     def append_point(pt)
       last_pt = @points[-1]
       if pt.time
-        @earliest_point = pt if @earliest_point.nil? || (pt.time < @earliest_point.time)
-        @latest_point = pt if @latest_point.nil? || (pt.time > @latest_point.time)
+        @earliest_point = pt if @earliest_point.nil? || (@earliest_point.time && pt.time < @earliest_point.time)
+        @latest_point = pt if @latest_point.nil? || (@latest_point.time && pt.time > @latest_point.time)
       else
         # when no time information in data, we consider the points are ordered
         @earliest_point = @points[0]
@@ -91,6 +95,7 @@ module GPX
       last_pt = nil
       points.each do |pt|
         next if yield(pt)
+
         keep_points << pt
         update_meta_data(pt, last_pt)
         last_pt = pt
@@ -124,7 +129,7 @@ module GPX
       elsif indicator.is_a?(Time)
         closest_point(indicator)
       else
-        raise Exception, 'find_end_point_by_time_or_offset requires an argument of type Time or Integer'
+        raise ArgumentError, 'find_end_point_by_time_or_offset requires an argument of type Time or Integer'
       end
     end
 
@@ -174,9 +179,9 @@ module GPX
 
     protected
 
-    # rubocop:disable Style/GuardClause
     def find_closest(pts, time)
       return pts.first if pts.size == 1
+
       midpoint = pts.size / 2
       if pts.size == 2
         diff_1 = pts[0].time - time
@@ -184,14 +189,13 @@ module GPX
         return (diff_1 < diff_2 ? pts[0] : pts[1])
       end
       if (time >= pts[midpoint].time) && (time <= pts[midpoint + 1].time)
-        return pts[midpoint]
+        pts[midpoint]
       elsif time <= pts[midpoint].time
-        return find_closest(pts[0..midpoint], time)
+        find_closest(pts[0..midpoint], time)
       else
-        return find_closest(pts[(midpoint + 1)..-1], time)
+        find_closest(pts[(midpoint + 1)..-1], time)
       end
     end
-    # rubocop:enable Style/GuardClause
 
     # Calculate the Haversine distance between two points. This is the method
     # the library uses to calculate the cumulative distance of GPX files.
@@ -231,6 +235,7 @@ module GPX
       @bounds.add(pt)
 
       return unless last_pt
+
       @distance += haversine_distance(last_pt, pt)
       @duration += pt.time - last_pt.time if pt.time && last_pt.time
     end

data/lib/gpx/track.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 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
@@ -12,6 +14,7 @@ module GPX
     # Initialize a track from a XML::Node, or, if no :element option is
     # passed, initialize a blank Track object.
     def initialize(opts = {})
+      super()
       @gpx_file = opts[:gpx_file]
       @segments = []
       @points = []
@@ -20,17 +23,20 @@ module GPX
       return unless opts[:element]
 
       trk_element = opts[:element]
-      @name = (begin
+      @name = (
+      begin
         trk_element.at('name').inner_text
       rescue StandardError
         ''
       end)
-      @comment = (begin
+      @comment = (
+      begin
         trk_element.at('cmt').inner_text
       rescue StandardError
         ''
       end)
-      @description = (begin
+      @description = (
+      begin
         trk_element.at('desc').inner_text
       rescue StandardError
         ''
@@ -44,6 +50,7 @@ module GPX
     # 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
     end
@@ -88,7 +95,7 @@ module GPX
     # 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? || points.size.zero?)
+      (points.nil? || points.empty?)
     end
 
     # Prints out a friendly summary of this track (sans points).  Useful for

data/lib/gpx/track_point.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 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

data/lib/gpx/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GPX
-  VERSION = "1.0.0".freeze
+  VERSION = "1.1.0"
 end

data/lib/gpx/waypoint.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 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.
@@ -5,6 +7,7 @@ module GPX
     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

data/lib/gpx.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require 'time'
 require 'nokogiri'
 
 require File.expand_path('gpx/version', __dir__)
-
 require File.expand_path('gpx/gpx', __dir__)
 require File.expand_path('gpx/gpx_file', __dir__)
 require File.expand_path('gpx/bounds', __dir__)
@@ -13,3 +14,4 @@ require File.expand_path('gpx/point', __dir__)
 require File.expand_path('gpx/track_point', __dir__)
 require File.expand_path('gpx/waypoint', __dir__)
 require File.expand_path('gpx/magellan_track_log', __dir__)
+require File.expand_path('gpx/geo_json', __dir__)

data/tests/geojson_files/combined_data.json

@@ -0,0 +1,68 @@
+{
+    "type": "FeatureCollection",
+    "features": [{
+        "type": "Feature",
+        "geometry": {
+            "type": "LineString",
+            "coordinates": [
+                [-118.41511, 34.06298, 80],
+                [-118.41506, 34.06301, 80],
+                [-118.415, 34.06305, 80],
+                [-118.41494, 34.06309, 80]
+            ]
+        }
+    }, {
+        "type": "Feature",
+        "geometry": {
+            "type": "LineString",
+            "coordinates": [
+                [-118.3689, 34.05826, 40],
+                [-118.36894, 34.05818, 40],
+                [-118.369, 34.05806, 40]
+            ]
+        }
+    }, {
+        "type": "Feature",
+        "geometry": {
+            "type": "LineString",
+            "coordinates": [
+                [-118.35042, 34.03788, 30],
+                [-118.35046, 34.03779, 30]
+            ]
+        }
+    }, {
+        "type": "Feature",
+        "geometry": {
+            "type": "MultiLineString",
+            "coordinates": [
+              [
+                [-118.41511, 34.06298, 80],
+                [-118.41506, 34.06301, 80],
+                [-118.415, 34.06305, 80],
+                [-118.41494, 34.06309, 80]
+            ],
+            [
+              [-118.3689, 34.05826, 40],
+              [-118.36894, 34.05818, 40],
+              [-118.369, 34.05806, 40]
+            ]
+          ]
+        }
+    }, {
+        "type": "Feature",
+        "geometry": {
+            "type": "Point",
+            "coordinates": [-118.41585, 34.06253, 80]
+        }
+    }, {
+        "type": "Feature",
+        "geometry": {
+            "type": "MultiPoint",
+            "coordinates": [
+                [-118.41585, 34.06253, 80],
+                [-118.4158, 34.06256, 80],
+                [-118.41575, 34.06259, 80]
+            ]
+        }
+    }]
+}

data/tests/geojson_files/line_string_data.json

@@ -0,0 +1,83 @@
+{
+    "type": "FeatureCollection",
+    "features": [{
+        "type": "Feature",
+        "geometry": {
+            "type": "LineString",
+            "coordinates": [
+                [-118.41585, 34.06253, 80],
+                [-118.4158, 34.06256, 80],
+                [-118.41575, 34.06259, 80],
+                [-118.4157, 34.06262, 80],
+                [-118.41566, 34.06265, 80],
+                [-118.41561, 34.06268, 80],
+                [-118.41556, 34.06271, 80],
+                [-118.41551, 34.06274, 80],
+                [-118.41546, 34.06277, 80],
+                [-118.41541, 34.0628, 80],
+                [-118.41536, 34.06283, 80],
+                [-118.41531, 34.06286, 80],
+                [-118.41526, 34.06289, 80],
+                [-118.41521, 34.06292, 80],
+                [-118.41516, 34.06295, 80],
+                [-118.41511, 34.06298, 80],
+                [-118.41506, 34.06301, 80],
+                [-118.415, 34.06305, 80],
+                [-118.41494, 34.06309, 80]
+              ]
+          }
+      }, {
+        "type": "Feature",
+        "geometry": {
+            "type": "LineString",
+            "coordinates": [
+              [-118.36855, 34.05844, 40],
+              [-118.36849, 34.05843, 40],
+              [-118.36843, 34.05842, 40],
+              [-118.36837, 34.05841, 40],
+              [-118.36906, 34.05878, 40],
+              [-118.36895, 34.05877, 40],
+              [-118.36884, 34.05876, 40],
+              [-118.36873, 34.05875, 40],
+              [-118.36866, 34.05874, 40],
+              [-118.3687, 34.05866, 40],
+              [-118.36874, 34.05858, 40],
+              [-118.36878, 34.0585, 40],
+              [-118.36882, 34.05842, 40],
+              [-118.36886, 34.05834, 40],
+              [-118.3689, 34.05826, 40],
+              [-118.36894, 34.05818, 40],
+              [-118.369, 34.05806, 40]
+            ]
+        }
+      }, {
+          "type": "Feature",
+          "geometry": {
+              "type": "LineString",
+              "coordinates": [
+            [-118.35043, 34.0392, 30],
+            [-118.35047, 34.03911, 30],
+            [-118.35051, 34.03902, 30],
+            [-118.35055, 34.03893, 30],
+            [-118.35057, 34.03887, 30],
+            [-118.35045, 34.03885, 30],
+            [-118.35033, 34.03883, 30],
+            [-118.35021, 34.03881, 30],
+            [-118.35009, 34.03879, 30],
+            [-118.35002, 34.03878, 30],
+            [-118.35006, 34.03869, 30],
+            [-118.3501, 34.0386, 30],
+            [-118.35014, 34.03851, 30],
+            [-118.35018, 34.03842, 30],
+            [-118.35022, 34.03833, 30],
+            [-118.35026, 34.03824, 30],
+            [-118.3503, 34.03815, 30],
+            [-118.35034, 34.03806, 30],
+            [-118.35038, 34.03797, 30],
+            [-118.35042, 34.03788, 30],
+            [-118.35046, 34.03779, 30],
+            [-118.3505, 34.03768, 30]
+          ]
+        }
+    }]
+}

data/tests/geojson_files/multi_line_string_data.json

@@ -0,0 +1,74 @@
+{
+    "type": "FeatureCollection",
+    "features": [{
+        "type": "Feature",
+        "geometry": {
+            "type": "MultiLineString",
+            "coordinates": [
+              [
+                [-118.41585, 34.06253, 80],
+                [-118.4158, 34.06256, 80],
+                [-118.41575, 34.06259, 80],
+                [-118.4157, 34.06262, 80],
+                [-118.41566, 34.06265, 80],
+                [-118.41561, 34.06268, 80],
+                [-118.41556, 34.06271, 80],
+                [-118.41551, 34.06274, 80],
+                [-118.41546, 34.06277, 80],
+                [-118.41541, 34.0628, 80],
+                [-118.41536, 34.06283, 80],
+                [-118.41531, 34.06286, 80],
+                [-118.41526, 34.06289, 80],
+                [-118.41521, 34.06292, 80],
+                [-118.41516, 34.06295, 80],
+                [-118.41511, 34.06298, 80],
+                [-118.41506, 34.06301, 80],
+                [-118.415, 34.06305, 80],
+                [-118.41494, 34.06309, 80]
+            ],
+            [
+              [-118.36855, 34.05844, 40],
+              [-118.36849, 34.05843, 40],
+              [-118.36843, 34.05842, 40],
+              [-118.36837, 34.05841, 40],
+              [-118.36906, 34.05878, 40],
+              [-118.36895, 34.05877, 40],
+              [-118.36884, 34.05876, 40],
+              [-118.36873, 34.05875, 40],
+              [-118.36866, 34.05874, 40],
+              [-118.3687, 34.05866, 40],
+              [-118.36874, 34.05858, 40],
+              [-118.36878, 34.0585, 40],
+              [-118.36882, 34.05842, 40],
+              [-118.36886, 34.05834, 40],
+              [-118.3689, 34.05826, 40],
+              [-118.36894, 34.05818, 40],
+              [-118.369, 34.05806, 40]
+          ],
+          [
+            [-118.35043, 34.0392, 30],
+            [-118.35047, 34.03911, 30],
+            [-118.35051, 34.03902, 30],
+            [-118.35055, 34.03893, 30],
+            [-118.35057, 34.03887, 30],
+            [-118.35045, 34.03885, 30],
+            [-118.35033, 34.03883, 30],
+            [-118.35021, 34.03881, 30],
+            [-118.35009, 34.03879, 30],
+            [-118.35002, 34.03878, 30],
+            [-118.35006, 34.03869, 30],
+            [-118.3501, 34.0386, 30],
+            [-118.35014, 34.03851, 30],
+            [-118.35018, 34.03842, 30],
+            [-118.35022, 34.03833, 30],
+            [-118.35026, 34.03824, 30],
+            [-118.3503, 34.03815, 30],
+            [-118.35034, 34.03806, 30],
+            [-118.35038, 34.03797, 30],
+            [-118.35042, 34.03788, 30],
+            [-118.35046, 34.03779, 30],
+            [-118.3505, 34.03768, 30]
+          ]]
+        }
+    }]
+}

data/tests/geojson_files/multi_point_data.json

@@ -0,0 +1,14 @@
+{
+    "type": "FeatureCollection",
+    "features": [{
+        "type": "Feature",
+        "geometry": {
+            "type": "MultiPoint",
+            "coordinates": [
+                [-118.41585, 34.06253, 80],
+                [-118.4158, 34.06256, 80],
+                [-118.41575, 34.06259, 80]
+            ]
+        }
+    }]
+}

data/tests/geojson_files/point_data.json

@@ -0,0 +1,22 @@
+{
+    "type": "FeatureCollection",
+    "features": [{
+        "type": "Feature",
+        "geometry": {
+            "type": "Point",
+            "coordinates": [-118.41585, 34.06253, 80]
+        }
+    }, {
+        "type": "Feature",
+        "geometry": {
+            "type": "Point",
+            "coordinates": [-118.36855, 34.05844, 40]
+        }
+    }, {
+        "type": "Feature",
+        "geometry": {
+            "type": "Point",
+            "coordinates": [-118.35043, 34.0392, 30]
+        }
+    }]
+}

data/tests/geojson_test.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+require 'gpx'
+require 'json'
+
+class GeojsonTest < Minitest::Test
+  # Test passing a file name
+  def test_geojson_file_name_as_param
+    file_name = "#{File.dirname(__FILE__)}/geojson_files/line_string_data.json"
+    gpx_file = GPX::GeoJSON.convert_to_gpx(geojson_file: file_name)
+    assert_equal(1, gpx_file.tracks.size)
+  end
+
+  # Test passing a file
+  def test_geojson_file_as_param
+    file_name = "#{File.dirname(__FILE__)}/geojson_files/line_string_data.json"
+    file = File.new(file_name, 'r')
+    gpx_file = GPX::GeoJSON.convert_to_gpx(geojson_file: file)
+    assert_equal(1, gpx_file.tracks.size)
+  end
+
+  def test_raises_arg_error_when_no_params
+    assert_raises(ArgumentError) do
+      GPX::GeoJSON.convert_to_gpx
+    end
+  end
+
+  # Test that lat/lon allocated correctly
+  def test_point_to_waypoint
+    pt = [-118, 34]
+    waypoint = GPX::GeoJSON.send(:point_to_waypoint, pt, nil)
+    assert_equal(34, waypoint.lat)
+    assert_equal(-118, waypoint.lon)
+  end
+
+  # Test that lat/lon allocated correctly
+  def test_point_to_trackpoint
+    pt = [-118, 34]
+    waypoint = GPX::GeoJSON.send(:point_to_track_point, pt, nil)
+    assert_equal(34, waypoint.lat)
+    assert_equal(-118, waypoint.lon)
+  end
+
+  def test_line_string_functionality
+    file = File.join(File.dirname(__FILE__), 'geojson_files/line_string_data.json')
+    gpx_file = GPX::GeoJSON.convert_to_gpx(geojson_file: file)
+
+    assert_equal(1, gpx_file.tracks.size)
+    assert_equal(3, gpx_file.tracks.first.segments.size)
+    pts_size = gpx_file.tracks.first.segments[0].points.size +
+               gpx_file.tracks.first.segments[1].points.size +
+               gpx_file.tracks.first.segments[2].points.size
+    assert_equal(58, pts_size)
+  end
+
+  def test_multi_line_string_functionality
+    file = File.join(File.dirname(__FILE__), 'geojson_files/multi_line_string_data.json')
+    gpx_file = GPX::GeoJSON.convert_to_gpx(geojson_file: file)
+    assert_equal(1, gpx_file.tracks.size)
+    assert_equal(3, gpx_file.tracks.first.segments.size)
+    pts_size = gpx_file.tracks.first.segments[0].points.size +
+               gpx_file.tracks.first.segments[1].points.size +
+               gpx_file.tracks.first.segments[2].points.size
+    assert_equal(58, pts_size)
+  end
+
+  def test_point_functionality
+    file = File.join(File.dirname(__FILE__), 'geojson_files/point_data.json')
+    gpx_file = GPX::GeoJSON.convert_to_gpx(geojson_file: file)
+    assert_equal(3, gpx_file.waypoints.size)
+  end
+
+  def test_multi_point_functionality
+    file = File.join(File.dirname(__FILE__), 'geojson_files/multi_point_data.json')
+    gpx_file = GPX::GeoJSON.convert_to_gpx(geojson_file: file)
+    assert_equal(3, gpx_file.waypoints.size)
+  end
+
+  def test_combined_functionality
+    file = File.join(File.dirname(__FILE__), 'geojson_files/combined_data.json')
+    gpx_file = GPX::GeoJSON.convert_to_gpx(geojson_file: file)
+
+    # 1 for all LineStrings, 1 for MultiLineString
+    assert_equal(2, gpx_file.tracks.size)
+    assert_equal(3, gpx_file.tracks.first.segments.size)
+    assert_equal(2, gpx_file.tracks.last.segments.size)
+    pt_sum = gpx_file.tracks.inject(0) { |sum, trk| sum + trk.points.size }
+    assert_equal(16, pt_sum)
+    assert_equal(4, gpx_file.waypoints.size)
+  end
+end

data/tests/gpx10_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'minitest/autorun'
 require 'gpx'
 

data/tests/gpx_file_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'minitest/autorun'
 require 'gpx'