tcxread 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed1afce3cee9d915fdabd00e0732caafa749719188118bbe428ddf7eadd3f52d
-  data.tar.gz: a3867ff511e74ea4e2b11efbdcfcf36d453e5b1030a4d5c28bd1ef10ac70a76f
+  metadata.gz: a0f94a5a07acd01e1c6b0419324bbef97912e0d7e67b3f2b1dc18d50336dd7e2
+  data.tar.gz: 776953d7610ffa6c6903449332eb1bf36ff2a7fb54c5fa10dde8e591ecefd3df
 SHA512:
-  metadata.gz: 0666fd2bd6601145ad998911252e4856f9e4e6d8eca9673dd2f4076c3fc0abff1cd2264a3521a5602771f4a4d16914a9ded05f678d08c8ca04efef138effbcc9
-  data.tar.gz: aa6bc442fe648352928bf01710b98ba37faca036c5e0be103fbef453e7edafe0da1060bf955fd66f206da97e048e40031f35878b45fe881e517c681ea062ab0f
+  metadata.gz: dc1240984ccb04288e3790d69529eea52269f16888e1b6d8906017b42252ce98eeef44240b729ed1358444e2f0d3f7ce377f3a49123ea5c85c21493a2438cc77
+  data.tar.gz: 99863f90228c50f2590709105fab6d55395c26462bec7b2ba2b11c429f2e85453867583fdcb964d83599f669bbc1dc991fa6ca8a0c5eff6aba8a3681007d1b48

data/README.md

@@ -49,7 +49,11 @@ puts "Distance meters: #{data.total_distance_meters}, " \
      "Average heart rate: #{data.average_heart_rate}, " \
      "Average watts: #{data.average_watts}, " \
      "Max watts: #{data.max_watts}, " \
-     "Average cadence: #{data.average_cadence}"
+     "Average speed: #{data.average_speed_all}, " \
+     "Average speed (moving): #{data.average_speed_moving}, " \
+     "Average cadence (moving): #{data.average_cadence_biking}, " \
+     "Average cadence: #{data.average_cadence_all}"
+
 ```
 
 ## 💾 Datasets

data/lib/tcxread.rb

@@ -1,11 +1,10 @@
 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,
-              :max_watts, :average_watts, :average_cadence
+              :max_watts, :average_watts, :average_cadence_all, :average_cadence_biking,
+              :average_speed_all, :average_speed_moving
 
   def initialize(file_path)
     @file_path = file_path
@@ -19,17 +18,16 @@ class TCXRead
     @total_descent = 0
     @max_altitude = 0
     @average_heart_rate = 0
-    # use NA if no watts exist in the TCX file
     @max_watts = 'NA'
     @average_watts = 'NA'
-    @average_cadence = 0
+    @average_cadence_all = 0
+    @average_cadence_biking = 0
+    @average_speed_all = 0
+    @average_speed_moving = 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?
@@ -39,7 +37,12 @@ class TCXRead
       @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)
       @max_watts, @average_watts = calculate_watts_from_activities(activities)
-      @average_cadence = calculate_average_cadence_from_activities(activities)
+      cadence_results = calculate_average_cadence_from_activities(activities)
+      @average_cadence_all = cadence_results[:average_cadence_all]
+      @average_cadence_biking = cadence_results[:average_cadence_biking]
+      speed_results = calculate_average_speed_from_activities(activities)
+      @average_speed_all = speed_results[:average_speed_all]
+      @average_speed_moving = speed_results[:average_speed_moving]
     end
 
     { activities: activities }
@@ -47,9 +50,6 @@ class TCXRead
 
   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|
@@ -76,10 +76,6 @@ class TCXRead
     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|
@@ -100,10 +96,6 @@ class TCXRead
     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|
@@ -117,7 +109,8 @@ class TCXRead
           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,
-          watts: trackpoint.xpath('xmlns:Extensions/ns3:TPX/ns3:Watts').text.to_f
+          watts: trackpoint.xpath('xmlns:Extensions/ns3:TPX/ns3:Watts').text.to_f,
+          speed: trackpoint.xpath('xmlns:Extensions/ns3:TPX/ns3:Speed').text.to_f
         }
       end
       tracks << trackpoints
@@ -125,10 +118,6 @@ class TCXRead
     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
@@ -139,10 +128,6 @@ class TCXRead
     }
   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
@@ -170,10 +155,6 @@ class TCXRead
     [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
@@ -188,10 +169,6 @@ class TCXRead
     [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
@@ -209,10 +186,6 @@ class TCXRead
     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
@@ -232,10 +205,6 @@ class TCXRead
     heart_rate_count > 0 ? total_heart_rate.to_f / heart_rate_count : 0.0
   end
 
-  # Calculates the maximum and average watts from the activities.
-  #
-  # @param activities [Array<Hash>] an array of activity hashes.
-  # @return [Array<Float, Float>] an array containing maximum watts and average watts. Returns 'NA' for both if no watts data is available.
   def calculate_watts_from_activities(activities)
     max_watts = 0
     total_watts = 0
@@ -265,26 +234,70 @@ class TCXRead
     [max_watts, average_watts]
   end
 
-  # Calculates the average cadence from the activities.
-  #
-  # @param activities [Array<Hash>] an array of activity hashes.
-  # @return [Float] the average cadence.
   def calculate_average_cadence_from_activities(activities)
-    total_cadence = 0
-    cadence_count = 0
+    total_cadence_all = 0
+    total_cadence_biking = 0
+    cadence_count_all = 0
+    cadence_count_biking = 0
 
     activities.each do |activity|
       activity[:laps].each do |lap|
         lap[:tracks].flatten.each do |trackpoint|
           cadence = trackpoint[:cadence]
+          total_cadence_all += cadence
+          cadence_count_all += 1
+
           if cadence > 0
-            total_cadence += cadence
-            cadence_count += 1
+            total_cadence_biking += cadence
+            cadence_count_biking += 1
           end
         end
       end
     end
 
-    cadence_count > 0 ? total_cadence.to_f / cadence_count : 0.0
+    average_cadence_all = cadence_count_all > 0 ? total_cadence_all.to_f / cadence_count_all : 0.0
+    average_cadence_biking = cadence_count_biking > 0 ? total_cadence_biking.to_f / cadence_count_biking : 0.0
+
+    {
+      average_cadence_all: average_cadence_all,
+      average_cadence_biking: average_cadence_biking
+    }
+  end
+
+  # Calculates the average speed from the activities.
+  #
+  # @param activities [Array<Hash>] an array of activity hashes.
+  # @return [Hash] a hash containing average speed including zeros and average speed while moving.
+  def calculate_average_speed_from_activities(activities)
+    total_speed_all = 0
+    total_speed_moving = 0
+    speed_count_all = 0
+    speed_count_moving = 0
+
+    activities.each do |activity|
+      activity[:laps].each do |lap|
+        lap[:tracks].flatten.each do |trackpoint|
+          speed = trackpoint[:speed]
+
+          if speed
+            total_speed_all += speed
+            speed_count_all += 1
+
+            if speed > 0
+              total_speed_moving += speed
+              speed_count_moving += 1
+            end
+          end
+        end
+      end
+    end
+
+    average_speed_all = speed_count_all > 0 ? total_speed_all.to_f / speed_count_all : 0.0
+    average_speed_moving = speed_count_moving > 0 ? total_speed_moving.to_f / speed_count_moving : 0.0
+
+    {
+      average_speed_all: average_speed_all,
+      average_speed_moving: average_speed_moving
+    }
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tcxread
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - firefly-cpp
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-11 00:00:00.000000000 Z
+date: 2024-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri