gpx_doctor 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0ba71f5752f36af3efd9f3b12de47d843a85b3ecd7fbcabd7468a2eef43355e
-  data.tar.gz: b58cb9eb1f207c3ec26f127b615ba43f70efe741904c6e73aa2c4ab059a7b710
+  metadata.gz: 804ebe2457e24c9688e6e8993d0dc3d4adab7b7fddc27478706eaf72a9d09f59
+  data.tar.gz: e1bb3e8d17ff968a1cd6414c736d9f444559f447d5e6cc8dd3c79175a394b68b
 SHA512:
-  metadata.gz: 053df672b67de8623f4749e7a5d0e8419667abd7227e31a8937d2434ebad3a0af73d04ae54af95112ecffe1e7824314634316cc1bc1793863d5c9289057cf4bd
-  data.tar.gz: 2376c74be6339f8aeeb535e8f79dbd9dd876bca7526713f9be8e09da3793718eaba4e285a455e4a07e1f182768affcf206c6ae7ba81483e37c6468e59bf96e27
+  metadata.gz: f8e5bd2ab41937b0faa004c5d1c1ae3c422ba9d332e3aa1ea353fe7f9c22706c0f53e5b3c8161361e8d38ead9bed4fa516d7415d580cc912bdc3976452107dfb
+  data.tar.gz: 68e78f3a4f84027272a1a96127b998d2a00c447e1f0b75daff611a8d3123c374df0ab6ebf92563e6ab516a4ff9d2bcaa2540dabdad8358a9d35f87fd4cd23860

data/README.md

@@ -89,7 +89,8 @@ result = GpxDoctor::Parser.parse("path/to/file.gpx", params: {
   max_points:         500,           # reduce each segment to at most this many points
   segment_statistics: true,          # compute distance_to_next, elevation_change, direction for each point
   cumulative_distance: true,         # add cumulative distance from start of each segment/route
-  enhance_elevation:  true           # fetch missing elevations from the configured elevation server
+  enhance_elevation:  true,          # fetch missing elevations from the configured elevation server
+  full_poi_data:      true           # populate result.pois with start/finish boundary data for the whole GPX and each track segment
 })
 ```
 
@@ -100,11 +101,14 @@ Processing is applied in the following order:
 3. `segment_statistics` — per-point statistics (distance, bearing, elevation change)
 4. `cumulative_distance` — cumulative distance from the start of each segment/route
 5. `enhance_elevation` — elevation lookup via the elevation server
+6. `full_poi_data` — POI boundary extraction (start, finish, and per-segment boundaries)
 
 `enhance_elevation: true` requires the elevation server to be configured (see **Configuration** above). It only fills in points that have no elevation value; existing elevations are left unchanged.
 
 `cumulative_distance: true` adds a `cumulative_distance` field to each point, representing the cumulative distance in kilometers from the start of its segment or route. For tracks with multiple segments, each segment's cumulative distance starts at 0.0 (gaps between segments are not included in the calculation).
 
+`full_poi_data: true` populates `result.pois` with the first and last geographic point of the entire GPX (across all routes and track segments), plus optional per-segment boundary data. Distances within each segment start at 0.0 and reflect that segment's length only. The `ele` key is omitted for points that have no elevation value. The global `finish` distance is the sum of all individual collection lengths. See **`result.pois`** below for the output shape.
+
 ## Accessing data
 
 ```ruby
@@ -113,6 +117,7 @@ result.waypoints # => [#<Waypoint …>]  (top-level <wpt> elements only)
 result.routes    # => [#<Route …>]
 result.tracks    # => [#<Track …>]
 result.metadata  # => #<Metadata …>  (or nil)
+result.pois      # => Hash (only when parsed with full_poi_data: true, otherwise nil)
 ```
 
 `result.points` is a flat array containing **all** geographic points from:
@@ -120,6 +125,31 @@ result.metadata  # => #<Metadata …>  (or nil)
 - `<rtept>` elements inside each `<rte>`
 - `<trkpt>` elements inside each `<trkseg>` inside each `<trk>`
 
+### `result.pois`
+
+When parsed with `full_poi_data: true`, `result.pois` contains boundary data for the entire GPX and each track segment:
+
+```ruby
+result = GpxDoctor::Parser.parse("route.gpx", params: { full_poi_data: true })
+result.pois
+# =>
+# {
+#   start:  { lon: 16.38, lat: 48.23, ele: 170.0, distance: 0.0 },
+#   finish: { lon: 16.39, lat: 48.24, ele: 175.0, distance: 1.42 },
+#   segments: [
+#     {
+#       start:  { lon: 16.38, lat: 48.23, ele: 170.0, distance: 0.0 },
+#       finish: { lon: 16.39, lat: 48.24, ele: 175.0, distance: 1.42 }
+#     }
+#   ]
+# }
+```
+
+- **`start`** / **`finish`** — first and last geographic point across all routes and track segments, each with `lon`, `lat`, `distance` (and `ele` when present). `start` always has `distance: 0.0`; `finish` distance is the sum of all individual route/segment lengths.
+- **`segments`** — present only when the GPX contains track segments. Each entry is `{start:, finish:}` for one `<trkseg>`, with distances measured from the beginning of that segment (`start` is always `distance: 0.0`).
+- The `ele` key is omitted for points that have no elevation value.
+- Distance values respect the configured `unit_system` (kilometres for `:metric`, miles for `:imperial`).
+
 ## Building GPX files
 
 The `GpxDoctor::Builder` class generates GPX 1.1 XML from a `Result` object (the same structure returned by the parser).

data/lib/gpx_doctor/parser.rb

@@ -7,7 +7,7 @@ module GpxDoctor
   class Parser
     GPX_NS = 'http://www.topografix.com/GPX/1/1'
 
-    Result = Struct.new(:waypoints, :routes, :tracks, :metadata, keyword_init: true) do
+    Result = Struct.new(:waypoints, :routes, :tracks, :metadata, :pois, keyword_init: true) do
       def points
         waypoints + routes.flat_map(&:points) + tracks.flat_map(&:points)
       end
@@ -55,6 +55,7 @@ module GpxDoctor
       enhance_statistics(result) if @params[:segment_statistics]
       enhance_cumulative_distance(result) if @params[:cumulative_distance]
       enhance_elevations(result) if @params[:enhance_elevation]
+      result.pois = build_pois(result) if @params[:full_poi_data]
 
       result
     end
@@ -276,5 +277,51 @@ module GpxDoctor
         track.segments.each { |seg| enhancer.enhance(seg.points) }
       end
     end
+
+    def point_to_poi(point, distance)
+      poi = { lon: point.lon, lat: point.lat }
+      poi[:ele] = point.ele if point.ele
+      poi[:distance] = distance
+      poi
+    end
+
+    def build_pois(result)
+      collections = result.routes.map(&:points) +
+                    result.tracks.flat_map { |t| t.segments.map(&:points) }
+      non_empty = collections.reject(&:empty?)
+
+      return {} if non_empty.empty?
+
+      total_distance = non_empty.sum { |pts| collection_distance(pts) }
+
+      pois = {
+        start: point_to_poi(non_empty.first.first, 0.0),
+        finish: point_to_poi(non_empty.last.last, total_distance)
+      }
+
+      segments_pois = result.tracks.flat_map do |track|
+        track.segments.filter_map do |seg|
+          next if seg.points.empty?
+
+          {
+            start: point_to_poi(seg.points.first, 0.0),
+            finish: point_to_poi(seg.points.last, collection_distance(seg.points))
+          }
+        end
+      end
+
+      pois[:segments] = segments_pois unless segments_pois.empty?
+      pois
+    end
+
+    def collection_distance(points)
+      return 0.0 if points.length < 2
+
+      unit_system = GpxDoctor.configuration.unit_system
+      points.each_cons(2).sum do |a, b|
+        dist_km = DistanceCalculator.distance(a, b) / 1000.0
+        UnitConverter.convert_cumulative_distance(dist_km, unit_system)
+      end
+    end
   end
 end

data/lib/gpx_doctor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GpxDoctor
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gpx_doctor
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Poltrax