gpx_doctor 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 367e09fc58af88bd756703fd5e2647632fd9991f753f3581e3bcb439f7733ce3
-  data.tar.gz: 3a7922964bb774be1eb1a1d2af78aee4a7d56b868b7652c481fb186cc6438bce
+  metadata.gz: e0ba71f5752f36af3efd9f3b12de47d843a85b3ecd7fbcabd7468a2eef43355e
+  data.tar.gz: b58cb9eb1f207c3ec26f127b615ba43f70efe741904c6e73aa2c4ab059a7b710
 SHA512:
-  metadata.gz: 9bad3d27880e55e001fea734b7d481f19569f0e0d202958d4ae893a1722eef5b0fb7a5431030f970872358c812e5a83a492f99c945096652e9547f0945238624
-  data.tar.gz: 0a4a032459ed9916bc8cd99c64d38676822efbed6e1a470d86a9806878f3ee65f5239827f1830eeb6dbdac573f845a64bcea70b7f24f5b686bc8ef440fb29325
+  metadata.gz: 053df672b67de8623f4749e7a5d0e8419667abd7227e31a8937d2434ebad3a0af73d04ae54af95112ecffe1e7824314634316cc1bc1793863d5c9289057cf4bd
+  data.tar.gz: 2376c74be6339f8aeeb535e8f79dbd9dd876bca7526713f9be8e09da3793718eaba4e285a455e4a07e1f182768affcf206c6ae7ba81483e37c6468e59bf96e27

data/README.md

@@ -24,6 +24,7 @@ GpxDoctor.configure do |config|
   config.elevation_server_url      = "https://elevation.example.com"
   config.elevation_server_user     = "user"
   config.elevation_server_password = "secret"
+  config.unit_system               = :imperial  # or :metric (default)
 end
 
 GpxDoctor.configuration.elevation_server_url # => "https://elevation.example.com"
@@ -36,6 +37,33 @@ GpxDoctor.reset_configuration!               # resets to defaults
 | `elevation_server_url` | String | `nil` | URL of the elevation server |
 | `elevation_server_user` | String | `nil` | Username for the elevation server |
 | `elevation_server_password` | String | `nil` | Password for the elevation server |
+| `unit_system` | Symbol | `:metric` | Unit system (`:metric` or `:imperial`) for distance and elevation values |
+
+### Unit System
+
+The `unit_system` configuration affects the following fields:
+
+- **`:metric` (default)**:
+  - `distance_to_next` and `elevation_change` are in **meters**
+  - `cumulative_distance` is in **kilometers**
+- **`:imperial`**:
+  - `distance_to_next` and `elevation_change` are in **feet**
+  - `cumulative_distance` is in **miles**
+
+```ruby
+# Use imperial units
+GpxDoctor.configure do |config|
+  config.unit_system = :imperial
+end
+
+result = GpxDoctor::Parser.parse("path/to/file.gpx", params: { 
+  segment_statistics: true, 
+  cumulative_distance: true 
+})
+
+# distance_to_next and elevation_change will be in feet
+# cumulative_distance will be in miles
+```
 
 ## Parsing
 
@@ -60,6 +88,7 @@ result = GpxDoctor::Parser.parse("path/to/file.gpx", params: {
   max_distance:       200,           # insert interpolated points so no two consecutive points exceed this distance (metres)
   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
 })
 ```
@@ -69,10 +98,13 @@ Processing is applied in the following order:
 1. `max_distance` — segment splitting (interpolates intermediate points)
 2. `max_points` — point reduction
 3. `segment_statistics` — per-point statistics (distance, bearing, elevation change)
-4. `enhance_elevation` — elevation lookup via the elevation server
+4. `cumulative_distance` — cumulative distance from the start of each segment/route
+5. `enhance_elevation` — elevation lookup via the elevation server
 
 `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).
+
 ## Accessing data
 
 ```ruby
@@ -88,6 +120,121 @@ result.metadata  # => #<Metadata …>  (or nil)
 - `<rtept>` elements inside each `<rte>`
 - `<trkpt>` elements inside each `<trkseg>` inside each `<trk>`
 
+## Building GPX files
+
+The `GpxDoctor::Builder` class generates GPX 1.1 XML from a `Result` object (the same structure returned by the parser).
+
+### Build to a string
+
+```ruby
+result = GpxDoctor::Parser::Result.new(
+  waypoints: [],
+  routes: [],
+  tracks: [],
+  metadata: nil
+)
+
+xml_string = GpxDoctor::Builder.build(result)
+# => "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<gpx version=\"1.1\"..."
+
+# Optional: specify a custom creator attribute (identifies the software that created the GPX file)
+xml_string = GpxDoctor::Builder.build(result, creator: 'My Application')
+```
+
+### Build to a file
+
+```ruby
+GpxDoctor::Builder.build_file(result, 'path/to/output.gpx')
+# Writes the GPX XML to the file and returns the XML string
+
+# Optional: specify a custom creator attribute
+GpxDoctor::Builder.build_file(result, 'path/to/output.gpx', creator: 'My Application')
+```
+
+### Input structure
+
+The builder expects a `GpxDoctor::Parser::Result` object with the following fields:
+
+- **`waypoints`** — Array of `GpxDoctor::Waypoint` objects (top-level waypoints)
+- **`routes`** — Array of `GpxDoctor::Route` objects
+- **`tracks`** — Array of `GpxDoctor::Track` objects
+- **`metadata`** — `GpxDoctor::Metadata` object (optional)
+
+All model classes are simple Ruby objects with attributes matching the GPX 1.1 specification (see **Model field reference** below).
+
+### Example: Creating a GPX file from scratch
+
+```ruby
+require 'gpx_doctor'
+
+# Create waypoints
+waypoint = GpxDoctor::Waypoint.new(
+  lat: 48.2093723,
+  lon: 16.356099,
+  ele: 160.0,
+  name: 'Vienna',
+  desc: 'Capital of Austria'
+)
+
+# Create a route with points
+route_point_1 = GpxDoctor::Waypoint.new(lat: 48.21, lon: 16.36, ele: 155.0)
+route_point_2 = GpxDoctor::Waypoint.new(lat: 48.22, lon: 16.37, ele: 162.0)
+
+route = GpxDoctor::Route.new(
+  name: 'City Tour',
+  desc: 'A route through the city',
+  points: [route_point_1, route_point_2]
+)
+
+# Create a track with segments
+track_point_1 = GpxDoctor::Waypoint.new(lat: 48.23, lon: 16.38, ele: 170.0)
+track_point_2 = GpxDoctor::Waypoint.new(lat: 48.24, lon: 16.39, ele: 175.0)
+
+segment = GpxDoctor::TrackSegment.new(points: [track_point_1, track_point_2])
+track = GpxDoctor::Track.new(
+  name: 'Morning Run',
+  desc: 'My morning jog',
+  segments: [segment]
+)
+
+# Create metadata (optional)
+metadata = GpxDoctor::Metadata.new(
+  name: 'My GPX File',
+  desc: 'A custom GPX file',
+  time: Time.now
+)
+
+# Build the result object
+result = GpxDoctor::Parser::Result.new(
+  waypoints: [waypoint],
+  routes: [route],
+  tracks: [track],
+  metadata: metadata
+)
+
+# Generate GPX XML
+xml_string = GpxDoctor::Builder.build(result, creator: 'My Application')
+
+# Or write directly to a file
+GpxDoctor::Builder.build_file(result, 'my_route.gpx', creator: 'My Application')
+```
+
+### Round-trip workflow
+
+You can parse an existing GPX file, modify it, and build it back:
+
+```ruby
+# Parse existing file
+result = GpxDoctor::Parser.parse('input.gpx')
+
+# Modify data
+result.routes.first.name = 'Updated Route Name'
+result.waypoints << GpxDoctor::Waypoint.new(lat: 48.5, lon: 16.5, name: 'New Point')
+
+# Build back to GPX
+GpxDoctor::Builder.build_file(result, 'output.gpx')
+```
+
 ## Model field reference
 
 ### `Waypoint`
@@ -114,6 +261,10 @@ result.metadata  # => #<Metadata …>  (or nil)
 | `pdop` | Float | |
 | `ageofdgpsdata` | Float | |
 | `dgpsid` | Integer | 0–1023 |
+| `distance_to_next` | Float | Distance to next point (metres or feet based on `unit_system`) — set by `segment_statistics: true` |
+| `elevation_change` | Float | Elevation change to next point (metres or feet based on `unit_system`) — set by `segment_statistics: true` |
+| `direction` | Float | Bearing to next point (0–360°) — set by `segment_statistics: true` |
+| `cumulative_distance` | Float | Cumulative distance from segment/route start (kilometres or miles based on `unit_system`) — set by `cumulative_distance: true` |
 
 `Waypoint#to_h` returns a hash of all non-nil fields.
 

data/lib/gpx_doctor/configuration.rb

@@ -5,13 +5,22 @@ module GpxDoctor
     attr_accessor :elevation_server,
                   :elevation_server_url,
                   :elevation_server_user,
-                  :elevation_server_password
+                  :elevation_server_password,
+                  :unit_system
 
     def initialize
       @elevation_server          = false
       @elevation_server_url      = nil
       @elevation_server_user     = nil
       @elevation_server_password = nil
+      @unit_system               = :metric
+    end
+
+    def unit_system=(value)
+      unless [:metric, :imperial].include?(value)
+        raise ArgumentError, "unit_system must be :metric or :imperial"
+      end
+      @unit_system = value
     end
   end
 end

data/lib/gpx_doctor/cumulative_distance_enhancer.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module GpxDoctor
+  class CumulativeDistanceEnhancer
+    # Enhances each waypoint with cumulative distance from the start of the segment/route.
+    # The first point receives cumulative_distance = 0.0
+    # Each subsequent point receives cumulative_distance = previous.cumulative_distance + distance from previous
+    # Distance is stored in kilometers for metric and miles for imperial.
+    #
+    # Mutates waypoints in place.
+    def enhance(waypoints)
+      return if waypoints.nil? || waypoints.empty?
+
+      unit_system = GpxDoctor.configuration.unit_system
+
+      cumulative = 0.0
+      waypoints.first.cumulative_distance = cumulative
+
+      waypoints.each_cons(2) do |current, nxt|
+        distance_meters = DistanceCalculator.distance(current, nxt)
+        distance_km = distance_meters / 1000.0
+        distance_converted = UnitConverter.convert_cumulative_distance(distance_km, unit_system)
+        cumulative += distance_converted
+        nxt.cumulative_distance = cumulative
+      end
+    end
+  end
+end

data/lib/gpx_doctor/models/waypoint.rb

@@ -8,7 +8,7 @@ module GpxDoctor
         sym type fix sat hdop vdop pdop ageofdgpsdata dgpsid
       ].freeze
 
-      STATISTICS_FIELDS = %i[distance_to_next elevation_change direction].freeze
+      STATISTICS_FIELDS = %i[distance_to_next elevation_change direction cumulative_distance].freeze
 
       attr_accessor(*STATISTICS_FIELDS)
 

data/lib/gpx_doctor/parser.rb

@@ -53,6 +53,7 @@ module GpxDoctor
       split_segments(result, eff_max_dist) if eff_max_dist
       select_max_points(result) if @params[:max_points]
       enhance_statistics(result) if @params[:segment_statistics]
+      enhance_cumulative_distance(result) if @params[:cumulative_distance]
       enhance_elevations(result) if @params[:enhance_elevation]
 
       result
@@ -267,5 +268,13 @@ module GpxDoctor
         track.segments.each { |seg| enhancer.enhance(seg.points) }
       end
     end
+
+    def enhance_cumulative_distance(result)
+      enhancer = CumulativeDistanceEnhancer.new
+      result.routes.each { |route| enhancer.enhance(route.points) }
+      result.tracks.each do |track|
+        track.segments.each { |seg| enhancer.enhance(seg.points) }
+      end
+    end
   end
 end

data/lib/gpx_doctor/statistics_enhancer.rb

@@ -3,20 +3,24 @@
 module GpxDoctor
   class StatisticsEnhancer
     # Enhances each consecutive pair of waypoints with statistics:
-    #   - distance_to_next  (meters, flat-earth Pythagorean approximation)
-    #   - elevation_change   (meters, next.ele - current.ele; nil when elevation missing)
-    #   - direction          (degrees 0-360, geographic bearing to next point)
+    #   - distance_to_next  (meters or feet depending on configuration)
+    #   - elevation_change  (meters or feet depending on configuration)
+    #   - direction         (degrees 0-360, geographic bearing to next point)
     #
     # The last point in the list receives nil for all three fields.
     # Mutates waypoints in place.
     def enhance(waypoints)
       return if waypoints.nil? || waypoints.size < 2
 
+      unit_system = GpxDoctor.configuration.unit_system
+
       waypoints.each_cons(2) do |current, nxt|
-        current.distance_to_next = DistanceCalculator.distance(current, nxt)
+        distance_meters = DistanceCalculator.distance(current, nxt)
+        current.distance_to_next = UnitConverter.convert_distance(distance_meters, unit_system)
 
         current.elevation_change = if current.ele && nxt.ele
-                                     nxt.ele - current.ele
+                                     elevation_change_meters = nxt.ele - current.ele
+                                     UnitConverter.convert_elevation(elevation_change_meters, unit_system)
                                    end
 
         current.direction = DistanceCalculator.bearing(current, nxt)

data/lib/gpx_doctor/unit_converter.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module GpxDoctor
+  module UnitConverter
+    METERS_TO_FEET = 3.28084
+    METERS_TO_MILES = 0.000621371
+    KILOMETERS_TO_MILES = 0.621371
+
+    module_function
+
+    # Convert meters to the configured unit system
+    # Returns feet for imperial, meters for metric
+    def convert_distance(meters, unit_system = :metric)
+      return meters if unit_system == :metric
+      meters * METERS_TO_FEET
+    end
+
+    # Convert meters to the configured unit system
+    # Returns feet for imperial, meters for metric
+    def convert_elevation(meters, unit_system = :metric)
+      return meters if unit_system == :metric
+      meters * METERS_TO_FEET
+    end
+
+    # Convert kilometers to the configured unit system
+    # Returns miles for imperial, kilometers for metric
+    def convert_cumulative_distance(kilometers, unit_system = :metric)
+      return kilometers if unit_system == :metric
+      kilometers * KILOMETERS_TO_MILES
+    end
+  end
+end

data/lib/gpx_doctor/version.rb

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

data/lib/gpx_doctor.rb

@@ -15,8 +15,10 @@ require 'gpx_doctor/models/track_segment'
 require 'gpx_doctor/models/route'
 require 'gpx_doctor/models/track'
 require 'gpx_doctor/distance_calculator'
+require 'gpx_doctor/unit_converter'
 require 'gpx_doctor/elevation_client'
 require 'gpx_doctor/statistics_enhancer'
+require 'gpx_doctor/cumulative_distance_enhancer'
 require 'gpx_doctor/segment_splitter'
 require 'gpx_doctor/point_selector'
 require 'gpx_doctor/parser'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gpx_doctor
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Poltrax
@@ -47,6 +47,7 @@ files:
 - lib/gpx_doctor.rb
 - lib/gpx_doctor/builder.rb
 - lib/gpx_doctor/configuration.rb
+- lib/gpx_doctor/cumulative_distance_enhancer.rb
 - lib/gpx_doctor/distance_calculator.rb
 - lib/gpx_doctor/elevation_client.rb
 - lib/gpx_doctor/errors.rb
@@ -65,6 +66,7 @@ files:
 - lib/gpx_doctor/point_selector.rb
 - lib/gpx_doctor/segment_splitter.rb
 - lib/gpx_doctor/statistics_enhancer.rb
+- lib/gpx_doctor/unit_converter.rb
 - lib/gpx_doctor/validator.rb
 - lib/gpx_doctor/version.rb
 homepage: https://github.com/Poltrax-live/gpx-doctor