Major update, support properties, add basic example, modify README and tests

Author: firefly-cpp

README.md

@@ -9,30 +9,44 @@ tcxread is a Ruby package designed to simplify the process of reading and proces
 
 ## Installation 📦
 
-```
-
+```sh
+$ gem install ast-tdl
 ```
 
 ## Basic run example 🚀
 
 ```ruby
 require 'tcxread'
 
-parser = TCXRead.new('2.tcx')
-data = parser.parse
-puts data.inspect
+data = TCXRead.new('2.tcx')
+
+puts "Distance meters: #{data.total_distance_meters}, " \
+     "Time seconds: #{data.total_time_seconds}, " \
+     "Calories: #{data.total_calories}, " \
+     "Total ascent: #{data.total_ascent}, " \
+     "Total descent: #{data.total_descent}, " \
+     "Max altitude: #{data.max_altitude}, " \
+     "Average heart rate: #{data.average_heart_rate}"
 ```
 
 ## Datasets
 
 Datasets available and used in the examples on the following links: [DATASET1](http://iztok-jr-fister.eu/static/publications/Sport5.zip), [DATASET2](http://iztok-jr-fister.eu/static/css/datasets/Sport.zip), [DATASET3](https://github.com/firefly-cpp/tcx-test-files).
 
+## Further read
+
+[1] [Awesome Computational Intelligence in Sports](https://github.com/firefly-cpp/awesome-computational-intelligence-in-sports)
+
 ## Related packages/frameworks
 
 [1] [tcxreader: Python reader/parser for Garmin's TCX file format.](https://github.com/alenrajsp/tcxreader)
 
 [2] [sport-activities-features: A minimalistic toolbox for extracting features from sports activity files written in Python](https://github.com/firefly-cpp/sport-activities-features)
 
+[3] [TCXReader.jl: Julia package designed for parsing TCX files](https://github.com/firefly-cpp/TCXReader.jl)
+
+[4] [TCXWriter: A Tiny Library for writing/creating TCX files on Arduino](https://github.com/firefly-cpp/tcxwriter)
+
 ## License
 
 This package is distributed under the MIT License. This license can be found online at <http://www.opensource.org/licenses/MIT>.

examples/basic_run.rb

@@ -0,0 +1,12 @@
+require 'tcxread'
+
+data = TCXRead.new('2.tcx')
+
+puts "Distance meters: #{data.total_distance_meters}, " \
+     "Time seconds: #{data.total_time_seconds}, " \
+     "Calories: #{data.total_calories}, " \
+     "Total ascent: #{data.total_ascent}, " \
+     "Total descent: #{data.total_descent}, " \
+     "Max altitude: #{data.max_altitude}, " \
+     "Average heart rate: #{data.average_heart_rate}"
+

lib/tcxread.rb

@@ -1,23 +1,44 @@
 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.
+# 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
-    }
+    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
@@ -128,7 +149,6 @@ def calculate_ascent_descent_and_max_altitude(laps)
         altitude = trackpoint[:altitude_meters]
         max_altitude = altitude if altitude > max_altitude
 
-        # can be improved
         if previous_altitude
           altitude_change = altitude - previous_altitude
           if altitude_change > 0
@@ -145,6 +165,24 @@ def calculate_ascent_descent_and_max_altitude(laps)
     [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.
@@ -165,4 +203,27 @@ def calculate_average_heart_rate(laps)
 
     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

test/test_tcxread.rb

@@ -5,32 +5,30 @@
 class TCXReadTest < Minitest::Test
   def setup
     # tests for file 2.tcx
-    @parser1 = TCXRead.new('test/2.tcx')
-    @data1 = @parser1.parse
+    @data1 = TCXRead.new('test/2.tcx')
 
     # tests for file 15.tcx
-    @parser2 = TCXRead.new('test/15.tcx')
-    @data2 = @parser2.parse
+    @data2 = TCXRead.new('test/15.tcx')
   end
 
   def test_total_calories
-    assert_equal @data1[:activities][0][:total_calories], 924
-    assert_equal @data2[:activities][0][:total_calories], 2010
+    assert_equal @data1.total_calories, 924
+    assert_equal @data2.total_calories, 2010
   end
 
   def test_total_distance
-      assert_equal @data1[:activities][0][:total_distance_meters], 24732.34
-      assert_equal @data2[:activities][0][:total_distance_meters], 116366.98
+      assert_equal @data1.total_distance_meters, 24732.34
+      assert_equal @data2.total_distance_meters, 116366.98
 
   end
 
   def test_total_duration
-      assert_equal @data1[:activities][0][:total_time_seconds], 3876.0
-      assert_equal @data2[:activities][0][:total_time_seconds], 17250.0
+      assert_equal @data1.total_time_seconds, 3876.0
+      assert_equal @data2.total_time_seconds, 17250.0
   end
 
   def test_total_ascent
-      assert_equal @data1[:activities][0][:total_ascent], 452.5999946594238
-      assert_equal @data2[:activities][0][:total_ascent], 1404.400026500225
+      assert_equal @data1.total_ascent, 452.5999946594238
+      assert_equal @data2.total_ascent, 1404.400026500225
   end
 end