gpx_doctor 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62f11c008dcbf53c4585d1cc1d4935555ddecbfc98ce4db4f0141476f2847ce3
-  data.tar.gz: ebf37bed3a22db9e84a6a0d1b593f2e3f9e9bf0146f114a06d8b900cc2e853f8
+  metadata.gz: c13f7a8d06c283b5a8dba624cced9d7244d60f2720918b495f35cf96ce8ae1e3
+  data.tar.gz: 4237a5927878077f57a7912e8cd61ec7d2300e31551890e653840aca9197049c
 SHA512:
-  metadata.gz: b096d0f32832c3ecd0147bd5b6066dd18f1fd19233af68101d486b5a4895febb2228da30fd907b849436a1feaca98bc707cfd2a0963b05b0587962d11a803f85
-  data.tar.gz: 5cf20d498a2247483904a86ca637bff0cc527bafe74f7c312d869694ef05fa798f675940f536980240eab12a90034bed42e841bcc6056bf43fb5505484baddc8
+  metadata.gz: 9841a014b0a980fd3c980ad92cb6ad04affb45eb711058bca7575967086bf2edeb311833ed5117233c379a80c5616ee0c15ec1cecf3eef15c8d40ed2c6450cc8
+  data.tar.gz: e022a619a37fb50308ed5414644c8c82cc4e70cacc6b30c06a588718e70c71d54f56e1f49b953fb2875a628399cc50dde6424037da8760f88066db3079f26566

data/README.md

@@ -1,6 +1,6 @@
 # GPX Doctor
 
-A Ruby gem for parsing and manipulating GPX 1.1 routes.
+A Ruby gem for parsing and manipulating GPX routes. The parser reads GPX 1.1 and GPX 1.0 (`http://www.topografix.com/GPX/1/0`, e.g. Traseo and older RideWithGPS exports); the builder always writes GPX 1.1.
 
 ## Installation
 
@@ -116,19 +116,28 @@ Processing is applied in the following order:
 ## Accessing data
 
 ```ruby
-result.points    # => [#<Waypoint lat=…, lon=…, ele=…>, …]  (all geographic points)
-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     # => [#<Waypoint lat=…, lon=…, ele=…>, …]  (the path)
+result.all_points # => [#<Waypoint …>, …]  (the path plus standalone waypoints)
+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:
-- Top-level `<wpt>` elements
+`result.points` is a flat array describing **the path**, in order:
 - `<rtept>` elements inside each `<rte>`
 - `<trkpt>` elements inside each `<trkseg>` inside each `<trk>`
 
+Top-level `<wpt>` elements are **not** included. They are points of interest that may
+sit anywhere on — or off — the path, and exporters list them in file order rather than
+path order, so treating them as path points draws straight lines back and forth across
+the map. Read them from `result.waypoints`, or use `result.all_points` (standalone
+waypoints first, then the path) when you genuinely want every geographic point in the
+file. All processing params (`max_points`, `cumulative_distance`, `label_interval`,
+`segment_statistics`, `full_poi_data`) operate on the path only; `enhance_elevation` is
+the exception and fills in elevations for standalone waypoints too.
+
 ### `result.pois`
 
 When parsed with `full_poi_data: true`, `result.pois` contains boundary data for the entire GPX and each track segment:

data/lib/gpx_doctor/parser.rb

@@ -6,10 +6,32 @@ require 'time'
 module GpxDoctor
   class Parser
     GPX_NS = 'http://www.topografix.com/GPX/1/1'
+    GPX_10_NS = 'http://www.topografix.com/GPX/1/0'
+    # Validator accepts both versions, so the parser must read both. Element
+    # names used here (wpt, rte, trk, trkseg, trkpt, ele, time, name) are the
+    # same in 1.0 and 1.1 — only the namespace differs.
+    GPX_NAMESPACES = [GPX_NS, GPX_10_NS].freeze
 
     Result = Struct.new(:waypoints, :routes, :tracks, :metadata, :pois, keyword_init: true) do
+      # The path described by the file, in order: <rtept> then <trkpt>.
+      #
+      # Standalone <wpt> elements are deliberately NOT part of it. They are
+      # points of interest scattered anywhere on (or off) the path — exporters
+      # such as komoot emit them for highlights like bridges or churches — so
+      # folding them in front of the path turns a valid route into a zig-zag of
+      # straight lines back and forth across the whole map. Every other stage of
+      # the gem (split_segments, select_max_points, enhance_statistics,
+      # enhance_cumulative_distance, label_points, build_pois) already walks
+      # routes and track segments only; this makes #points agree with them.
+      #
+      # Use #all_points for every geographic point in the file, waypoints included.
       def points
-        waypoints + routes.flat_map(&:points) + tracks.flat_map(&:points)
+        routes.flat_map(&:points) + tracks.flat_map(&:points)
+      end
+
+      # Every geographic point in the file: standalone waypoints followed by the path.
+      def all_points
+        waypoints + points
       end
     end
 
@@ -31,7 +53,7 @@ module GpxDoctor
 
       def detect_namespace(doc)
         root_ns = doc.root&.namespace&.href
-        root_ns == GPX_NS ? GPX_NS : nil
+        GPX_NAMESPACES.include?(root_ns) ? root_ns : nil
       end
     end
 
@@ -224,7 +246,9 @@ module GpxDoctor
       config = GpxDoctor.configuration
       return unless config.elevation_server && config.elevation_server_url
 
-      ElevationClient.new.enhance(result.points)
+      # all_points, not points: standalone waypoints are POIs the caller still
+      # wants an elevation for, even though they are not part of the path.
+      ElevationClient.new.enhance(result.all_points)
     end
 
     def effective_max_distance(result)

data/lib/gpx_doctor/version.rb

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

metadata

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