tcxread 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dc0fbb7ddc6ca33b8c42dd160de524513ed81570dcf9f82c2b28410af1e036c9
+  data.tar.gz: 9ee1726006b6f3a267bd3cc72f6accae4c7d275058a0998febdb039d365d8b98
+SHA512:
+  metadata.gz: a5fcce73beceff1cfd7dadfaf6c5c9afa4c8e599ac2be1cf09181d505140b2d48c464f981705b20cf98b808023cd5bf04d442bdebf671d3b4c529c18270ab3d5
+  data.tar.gz: 9537cdffd7f6b8973ca497841e8b818b330f318fcbebee83a2120a87a75f6a6b797438f7f074579cb02b811a980968d6307907b552c42597d3da5ae52266009b

data/lib/tcxread.rb

@@ -0,0 +1,229 @@
+require "nokogiri"
+
+# TCXRead is a class that parses TCX (Training Center XML) files to extract
+# workout data such as activities, laps, tracks, trackpoints, and integral metrics.
+class TCXRead
+  attr_reader :total_distance_meters, :total_time_seconds, :total_calories,
+              :total_ascent, :total_descent, :max_altitude, :average_heart_rate
+
+  # Initializes the TCXRead with the path to the TCX file.
+  #
+  # @param file_path [String] the path to the TCX file.
+  def initialize(file_path)
+    @file_path = file_path
+    @doc = Nokogiri::XML(File.open(file_path))
+
+    # Init the properties
+    @total_distance_meters = 0
+    @total_time_seconds = 0
+    @total_calories = 0
+    @total_ascent = 0
+    @total_descent = 0
+    @max_altitude = 0
+    @average_heart_rate = 0
+
+    parse
+  end
+
+  # Parses the TCX file and extracts data.
+  #
+  # @return [Hash] a hash containing the parsed activities.
+  def parse
+    activities = parse_activities
+    if activities.any?
+      @total_time_seconds = activities.sum { |activity| activity[:total_time_seconds] }
+      @total_distance_meters = activities.sum { |activity| activity[:total_distance_meters] }
+      @total_calories = activities.sum { |activity| activity[:total_calories] }
+      @total_ascent, @total_descent, @max_altitude = calculate_ascent_descent_and_max_altitude_from_activities(activities)
+      @average_heart_rate = calculate_average_heart_rate_from_activities(activities)
+    end
+
+    { activities: activities }
+  end
+
+  private
+
+  # Parses the activities from the TCX file.
+  #
+  # @return [Array<Hash>] an array of hashes, each representing an activity.
+  def parse_activities
+    activities = []
+    @doc.xpath('//xmlns:Activities/xmlns:Activity').each do |activity|
+      laps = parse_laps(activity)
+      total_time_seconds = laps.sum { |lap| lap[:total_time_seconds] }
+      total_distance_meters = laps.sum { |lap| lap[:distance_meters] }
+      total_calories = laps.sum { |lap| lap[:calories] }
+      total_ascent, total_descent, max_altitude = calculate_ascent_descent_and_max_altitude(laps)
+      average_heart_rate = calculate_average_heart_rate(laps)
+
+      activities << {
+        sport: activity.attr('Sport'),
+        id: activity.xpath('xmlns:Id').text,
+        laps: laps,
+        total_time_seconds: total_time_seconds,
+        total_distance_meters: total_distance_meters,
+        total_calories: total_calories,
+        total_ascent: total_ascent,
+        total_descent: total_descent,
+        max_altitude: max_altitude,
+        average_heart_rate: average_heart_rate
+      }
+    end
+    activities
+  end
+
+  # Parses the laps for a given activity.
+  #
+  # @param activity [Nokogiri::XML::Element] the activity element from the TCX file.
+  # @return [Array<Hash>] an array of hashes, each representing a lap.
+  def parse_laps(activity)
+    laps = []
+    activity.xpath('xmlns:Lap').each do |lap|
+      laps << {
+        start_time: lap.attr('StartTime'),
+        total_time_seconds: lap.xpath('xmlns:TotalTimeSeconds').text.to_f,
+        distance_meters: lap.xpath('xmlns:DistanceMeters').text.to_f,
+        maximum_speed: lap.xpath('xmlns:MaximumSpeed').text.to_f,
+        calories: lap.xpath('xmlns:Calories').text.to_i,
+        average_heart_rate: lap.xpath('xmlns:AverageHeartRateBpm/xmlns:Value').text.to_i,
+        maximum_heart_rate: lap.xpath('xmlns:MaximumHeartRateBpm/xmlns:Value').text.to_i,
+        intensity: lap.xpath('xmlns:Intensity').text,
+        cadence: lap.xpath('xmlns:Cadence').text.to_i,
+        trigger_method: lap.xpath('xmlns:TriggerMethod').text,
+        tracks: parse_tracks(lap)
+      }
+    end
+    laps
+  end
+
+  # Parses the tracks for a given lap.
+  #
+  # @param lap [Nokogiri::XML::Element] the lap element from the TCX file.
+  # @return [Array<Array<Hash>>] an array of arrays, each representing a track containing trackpoints.
+  def parse_tracks(lap)
+    tracks = []
+    lap.xpath('xmlns:Track').each do |track|
+      trackpoints = []
+      track.xpath('xmlns:Trackpoint').each do |trackpoint|
+        trackpoints << {
+          time: trackpoint.xpath('xmlns:Time').text,
+          position: parse_position(trackpoint),
+          altitude_meters: trackpoint.xpath('xmlns:AltitudeMeters').text.to_f,
+          distance_meters: trackpoint.xpath('xmlns:DistanceMeters').text.to_f,
+          heart_rate: trackpoint.xpath('xmlns:HeartRateBpm/xmlns:Value').text.to_i,
+          cadence: trackpoint.xpath('xmlns:Cadence').text.to_i,
+          sensor_state: trackpoint.xpath('xmlns:SensorState').text
+        }
+      end
+      tracks << trackpoints
+    end
+    tracks
+  end
+
+  # Parses the position for a given trackpoint.
+  #
+  # @param trackpoint [Nokogiri::XML::Element] the trackpoint element from the TCX file.
+  # @return [Hash, nil] a hash representing the position (latitude and longitude) or nil if no position is available.
+  def parse_position(trackpoint)
+    position = trackpoint.at_xpath('xmlns:Position')
+    return nil unless position
+
+    {
+      latitude: position.xpath('xmlns:LatitudeDegrees').text.to_f,
+      longitude: position.xpath('xmlns:LongitudeDegrees').text.to_f
+    }
+  end
+
+  # Calculates the total ascent, total descent, and maximum altitude from the laps.
+  #
+  # @param laps [Array<Hash>] an array of lap hashes.
+  # @return [Array<Float>] an array containing total ascent, total descent, and maximum altitude.
+  def calculate_ascent_descent_and_max_altitude(laps)
+    total_ascent = 0.0
+    total_descent = 0.0
+    max_altitude = -Float::INFINITY
+    previous_altitude = nil
+
+    laps.each do |lap|
+      lap[:tracks].flatten.each do |trackpoint|
+        altitude = trackpoint[:altitude_meters]
+        max_altitude = altitude if altitude > max_altitude
+
+        if previous_altitude
+          altitude_change = altitude - previous_altitude
+          if altitude_change > 0
+            total_ascent += altitude_change
+          elsif altitude_change < 0
+            total_descent += altitude_change.abs
+          end
+        end
+
+        previous_altitude = altitude
+      end
+    end
+
+    [total_ascent, total_descent, max_altitude]
+  end
+
+  # Calculates the total ascent, total descent, and maximum altitude from the activities.
+  #
+  # @param activities [Array<Hash>] an array of activity hashes.
+  # @return [Array<Float>] an array containing total ascent, total descent, and maximum altitude.
+  def calculate_ascent_descent_and_max_altitude_from_activities(activities)
+    total_ascent = 0.0
+    total_descent = 0.0
+    max_altitude = -Float::INFINITY
+
+    activities.each do |activity|
+      total_ascent += activity[:total_ascent]
+      total_descent += activity[:total_descent]
+      max_altitude = activity[:max_altitude] if activity[:max_altitude] > max_altitude
+    end
+
+    [total_ascent, total_descent, max_altitude]
+  end
+
+  # Calculates the average heart rate from the laps.
+  #
+  # @param laps [Array<Hash>] an array of lap hashes.
+  # @return [Float] the average heart rate.
+  def calculate_average_heart_rate(laps)
+    total_heart_rate = 0
+    heart_rate_count = 0
+
+    laps.each do |lap|
+      lap[:tracks].flatten.each do |trackpoint|
+        heart_rate = trackpoint[:heart_rate]
+        if heart_rate > 0
+          total_heart_rate += heart_rate
+          heart_rate_count += 1
+        end
+      end
+    end
+
+    heart_rate_count > 0 ? total_heart_rate.to_f / heart_rate_count : 0.0
+  end
+
+  # Calculates the average heart rate from the activities.
+  #
+  # @param activities [Array<Hash>] an array of activity hashes.
+  # @return [Float] the average heart rate.
+  def calculate_average_heart_rate_from_activities(activities)
+    total_heart_rate = 0
+    heart_rate_count = 0
+
+    activities.each do |activity|
+      activity[:laps].each do |lap|
+        lap[:tracks].flatten.each do |trackpoint|
+          heart_rate = trackpoint[:heart_rate]
+          if heart_rate > 0
+            total_heart_rate += heart_rate
+            heart_rate_count += 1
+          end
+        end
+      end
+    end
+
+    heart_rate_count > 0 ? total_heart_rate.to_f / heart_rate_count : 0.0
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: tcxread
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- firefly-cpp
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+description:
+email:
+- iztok@iztok-jr-fister.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/tcxread.rb
+homepage: https://github.com/firefly-cpp/tcxread
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/firefly-cpp/tcxread
+  source_code_uri: https://github.com/firefly-cpp/tcxread
+  changelog_uri: https://github.com/firefly-cpp/tcxread
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: tcx reader/parser in Ruby
+test_files: []