tcxread 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 209745c7c980f590adf7944373f33951373b2c000d3a6a1bcfaed33b63cd59ad
-  data.tar.gz: 8abbe15da4a5a3ef688d531fa2d00c32dbfc19066a3c1baabe9de825202d6041
+  metadata.gz: ed1afce3cee9d915fdabd00e0732caafa749719188118bbe428ddf7eadd3f52d
+  data.tar.gz: a3867ff511e74ea4e2b11efbdcfcf36d453e5b1030a4d5c28bd1ef10ac70a76f
 SHA512:
-  metadata.gz: 9c135f57bc1f24d640afdb59550301e491595652acafa18884d1df0b9f67547780aaffefd8f42cefec74ebb610aeeb8199b70697deff2f596fce1f4e601c3b92
-  data.tar.gz: de5960e78c0ba9a569778a17a066410fed531a07d359cbe1a7c5e85eea9edae8f3826ef721b410ce0223fd1f9cd32e1a327871f92bbe5c20b7d48e57d08881ab
+  metadata.gz: 0666fd2bd6601145ad998911252e4856f9e4e6d8eca9673dd2f4076c3fc0abff1cd2264a3521a5602771f4a4d16914a9ded05f678d08c8ca04efef138effbcc9
+  data.tar.gz: aa6bc442fe648352928bf01710b98ba37faca036c5e0be103fbef453e7edafe0da1060bf955fd66f206da97e048e40031f35878b45fe881e517c681ea062ab0f

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022-2024 Iztok Fister Jr.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,79 @@
+<h1 align="center">
+     tcxread -- A parser for TCX files written in Ruby
+</h1>
+
+<p align="center">
+     <a href="https://badge.fury.io/rb/tcxread">
+          <img alt="Gem Version" src="https://badge.fury.io/rb/tcxread.svg">
+     </a>
+     <a href="https://github.com/firefly-cpp/tcxread/blob/master/LICENSE">
+          <img alt="License" src="https://img.shields.io/github/license/firefly-cpp/tcxread.svg">
+     </a>
+     <a href=https://repology.org/project/ruby:tcxread/versions>
+          <img alt="Packaging status" src="https://repology.org/badge/tiny-repos/ruby:tcxread.svg">
+     </a>
+     <img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/w/firefly-cpp/tcxread.svg">
+     <img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/firefly-cpp/tcxread">
+</p>
+
+<p align="center">
+     <a href="#-installation">📦 Installation</a> •
+     <a href="#-basic-run-example">🚀 Basic run example</a> •
+     <a href="#-datasets">💾 Datasets</a> •
+     <a href="#-further-read">📖 Further read</a> •
+     <a href="#-related-packagesframeworks">🔗 Related packages/frameworks</a> •
+     <a href="#-license">🔑 License</a>
+</p>
+
+tcxread is a Ruby package designed to simplify the process of reading and processing .tcx files, commonly used by Garmin devices and other GPS-enabled fitness devices to store workout data.
+
+## 📦 Installation
+
+```sh
+$ gem install tcxread
+```
+
+## 🚀 Basic run example
+
+```ruby
+require 'tcxread'
+
+data = TCXRead.new('23.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}, " \
+     "Average watts: #{data.average_watts}, " \
+     "Max watts: #{data.max_watts}, " \
+     "Average cadence: #{data.average_cadence}"
+```
+
+## 💾 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>.
+
+## Disclaimer
+
+This framework is provided as-is, and there are no guarantees that it fits your purposes or that it is bug-free. Use it at your own risk!

data/lib/tcxread.rb

@@ -5,7 +5,7 @@ require "nokogiri"
 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
+              :max_watts, :average_watts, :average_cadence
 
   def initialize(file_path)
     @file_path = file_path
@@ -22,6 +22,7 @@ class TCXRead
     # use NA if no watts exist in the TCX file
     @max_watts = 'NA'
     @average_watts = 'NA'
+    @average_cadence = 0
 
     parse
   end
@@ -38,6 +39,7 @@ 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)
     end
 
     { activities: activities }
@@ -168,7 +170,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.
@@ -263,4 +264,27 @@ 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
+
+    activities.each do |activity|
+      activity[:laps].each do |lap|
+        lap[:tracks].flatten.each do |trackpoint|
+          cadence = trackpoint[:cadence]
+          if cadence > 0
+            total_cadence += cadence
+            cadence_count += 1
+          end
+        end
+      end
+    end
+
+    cadence_count > 0 ? total_cadence.to_f / cadence_count : 0.0
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tcxread
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - firefly-cpp
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-27 00:00:00.000000000 Z
+date: 2024-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -31,6 +31,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
 - lib/tcxread.rb
 homepage: https://github.com/firefly-cpp/tcxread
 licenses: