tcx_rb 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2cccf049adc64faead1fa408b9e08baac75b980f118f49f4792b9b33d52c51f
-  data.tar.gz: 25ad6a3d9969a5ca4c31012003729155a0ed213d059db636180589a03c41e506
+  metadata.gz: 57eac59c633ebe544e4fbb134a527121d261f66755575d9cdd966865a39a29fd
+  data.tar.gz: ec031953f8875c10db3cb3c866621bd0ee452ac0030e1d5f344e7c68f7d27212
 SHA512:
-  metadata.gz: ceca00ba0a2b0a2abd7fcf5a023cc4b3528dd80289893a2ee89ea06a70d7c27584ab416fcae8653e7262ef5482d07b4776877725d5099d3021faf063d61da228
-  data.tar.gz: 43f78661f597204a7c3e8337a6a53cf7f1c3764887201c12f0de26438c7b384617482efa2423de6e2e19c714638f2ea57749f490d1179da5550d216eb167158d
+  metadata.gz: 5c3ba59454afd34ea5e01b2066e0c731401d2b18f4ef61b4ec280918a849b5b6769cb07badeb3575cfb26e6fcb83e7d74c3b09483f456eb3a02c4409b3ae5369
+  data.tar.gz: 4c7083b701bbe4164a9a731356326caea924ff5b3047b12a58aa24754e12f82104009f9825dc18fc4ce27155e1ecac4586cc9d73dec3ab6e5c90ae25cc7b75ca

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tcx_rb (0.1.0)
+    tcx_rb (0.2.0)
       nokogiri (~> 1.10)
 
 GEM

data/README.md

@@ -1,8 +1,8 @@
-# TcxRb
+[![Build Status](https://travis-ci.org/Kdoggett887/tcx_rb.svg?branch=master)](https://travis-ci.org/Kdoggett887/tcx_rb)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tcx_rb`. To experiment with that code, run `bin/console` for an interactive prompt.
+# TcxRb
 
-TODO: Delete this and the text above, and describe your gem
+TcxRb is a ruby library for parsing Garmin TCX files into sensible Ruby objects.
 
 ## Installation
 
@@ -22,7 +22,137 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+The simplest way to start using TcxRb is to create a workout from a file.
+
+```ruby
+workout = TcxRb.workout_from_file('/path/to/file')
+# => TcxRb::Workout
+
+workout.max_heart_rate
+# => 181
+
+workout.min_altitude
+# => -3.17
+
+workout.avg_pace
+# => 3.027
+
+workout.activities
+# => [TcxRb::Activity]
+
+workout.activities[0].laps
+# => [TcxRb::Lap]
+
+workout.activities[0].laps[0].trackpoints.size
+# => 3762
+
+workout.activities[0].laps[0].trackpoints[0].lat
+# => 39.965614
+
+workout.activities[0].laps[0].trackpoints[0].lon
+# => -75.180849
+```
+
+### Types
+
+The main classes in TcxRb are `Workout`, `Activity`, `Lap`, and `Trackpoint`.
+
+#### Workout
+
+`Workout` is the highest level object and its only attribute is `activities` which is an array of `Activity` objects.
+
+`Workout` also implements `+` and `-`.
+
+#### Activity
+
+`Activity` is the highest level object in the tcx schema. It has the following attributes:
+
+- `sport` - Sport detailed by the tracker (ex. Running).
+- `id` - ID given by the tracker.
+- `creator` - Name of the tracker.
+- `laps` - Array of `Lap` objects.
+
+#### Lap
+
+`Lap` represents one "session" in the schema. It has a collection of trackpoints and distance associated with it. It has the following attributes:
+
+- `start_time` - Start time of lap (string).
+- `total_time` - Total time of the lap (float).
+- `distance` - Total distance traveled in meters.
+- `calories` - Total calories burned.
+- `intensity` - Classification of lap intensity.
+- `trigger_method` - Method used to start the lap.
+- `trackpoints` - Array of `Trackpoint` objects.
+
+#### Trackpoint
+
+`Trackpoint` reprsents a sample from the tracker. Lowest level object in the hierarchy that contains the data that the other objects use for computations. It has the following attributes:
+
+- `time` - Time the trackpoint was sampled (string).
+- `latitude` - Latitude of the trackpoint.
+- `longitude` - Longitude of the trackpoint.
+- `altitude` - Height from sea level, in meters.
+- `distance` - Total distance since the beginning of the workout, in meters.
+- `heart_rate` - Heart rate the tracker sampled.
+- `lat` - alias for latitude.
+- `lon` - alias for longitude.
+
+#### Parser
+
+`Parser` is the class used to parse the tcx file into a `Workout`. A `parser` can be instansiated by passing in tcx string. It exposes the `parse_trackpoints`, `parse_laps`, and `parse_activities` methods which will return an array of hashes of the corresponding object.
+
+Ex:
+
+```ruby
+tcx_str = File.read('/path/to/data')
+parser = TcxRb::Parser.new(tcx_str)
+parser.parse_trackpoints
+
+#  => [{:time=>"2020-02-11T21:44:03.000-05:00", :latitude=>"39.965614", :longitude=>"-75.180849", :altitude=>"8.071420612508698", :distance=>"55.1", :heart_rate=>"146"}]
+```
+
+### Methods
+
+Instances of `Workout`, `Activity`, and `Lap` all implement the following methods:
+
+- `max_heart_rate` - Max heart rate of all trackpoints.
+- `min_heart_rate` - Min heart rate of all trackpoints.
+- `avg_heart_rate` - Avg heart rate of all trackpoints.
+- `max_altitude` - Max altitude of all trackpoints.
+- `min_altitude` - Min altitude of all trackpoints.
+- `avg_altitude` - Avg altitude of all trackpoints.
+- `max_pace` - Max pace of all pairs of trackpoints (m/s).
+- `min_pace` - Min pace of all pairs of trackpoints (m/s).
+- `avg_pace` - Avg pace of all pairs of trackpoitns (m/s).
+
+Additionally, `Workout` and `Activity` implement the following:
+
+- `total_tps` - The sum of the size of trackpoints contained in the child laps.
+- `time` - The total "active" time of all the child laps (discounts time spent paused).
+- `distance` - Total distance of all the child laps.
+- `calories` - Sum of the calories burned in each child lap.
+
+### Examples
+
+Example using `+` and `-` with `Workout`:
+
+```ruby
+sat_workout = TcxRb.workout_from_file('saturday.tcx')
+sun_workout = TcxRb.workout_from_file('sunday.tcx')
+
+sat_workout.total_distance
+# => 5000
+
+sun_workout.total_distance
+# => 10000
+
+weekend_workouts = sat_workout + sun_workout
+weekend_workouts.total_distance
+# => 15000
+
+(weekend_workouts - sat_workout).total_distance
+# => 10000
+```
 
 ## Development
 
@@ -32,8 +162,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tcx_rb.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/kdoggett887/tcx_rb.
 
 ## License
 

data/lib/tcx_rb/activity.rb

@@ -9,5 +9,61 @@ module TcxRb
       @laps = args[:laps]
     end
     attr_accessor :sport, :id, :creator, :laps
+
+    def max_heart_rate
+      @laps.map(&:max_heart_rate).max
+    end
+
+    def min_heart_rate
+      @laps.map(&:min_heart_rate).min
+    end
+
+    def avg_heart_rate
+      # weighted average of each laps avg_heart_rate based on
+      # trackpoints size
+      total = total_tps.to_f
+      @laps.sum { |lap| (lap.trackpoints.size / total) * lap.avg_heart_rate }
+    end
+
+    def max_altitude
+      @laps.map(&:max_altitude).max
+    end
+
+    def min_altitude
+      @laps.map(&:min_altitude).min
+    end
+
+    def avg_altitude
+      total = total_tps.to_f
+      @laps.sum { |lap| (lap.trackpoints.size / total) * lap.avg_altitude }
+    end
+
+    def max_pace
+      @laps.map(&:max_pace).max
+    end
+
+    def min_pace
+      @laps.map(&:min_pace).min
+    end
+
+    def avg_pace
+      distance / time
+    end
+
+    def total_tps
+      @laps.sum { |lap| lap.trackpoints.size }
+    end
+
+    def time
+      @laps.sum(&:active_time)
+    end
+
+    def distance
+      @laps.sum(&:distance)
+    end
+
+    def calories
+      @laps.sum(&:calories)
+    end
   end
 end

data/lib/tcx_rb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TcxRb
-  VERSION = '0.1.0'
+  VERSION = '0.2.1'
 end

data/lib/tcx_rb/workout.rb

@@ -6,5 +6,67 @@ module TcxRb
       @activities = activities
     end
     attr_accessor :activities
+
+    def +(other)
+      Workout.new(@activities + other.activities)
+    end
+
+    def -(other)
+      Workout.new(@activities - other.activities)
+    end
+
+    def max_heart_rate
+      @activities.map(&:max_heart_rate).max
+    end
+
+    def min_heart_rate
+      @activities.map(&:min_heart_rate).min
+    end
+
+    def avg_heart_rate
+      total = total_tps.to_f
+      @activities.sum { |act| (act.total_tps / total) * act.avg_heart_rate }
+    end
+
+    def max_altitude
+      @activities.map(&:max_altitude).max
+    end
+
+    def min_altitude
+      @activities.map(&:min_altitude).min
+    end
+
+    def avg_altitude
+      total = total_tps.to_f
+      @activities.sum { |act| (act.total_tps / total) * act.avg_altitude }
+    end
+
+    def max_pace
+      @activities.map(&:max_pace).max
+    end
+
+    def min_pace
+      @activities.map(&:min_pace).min
+    end
+
+    def avg_pace
+      distance / time
+    end
+
+    def total_tps
+      @activities.sum(&:total_tps)
+    end
+
+    def time
+      @activities.sum(&:time)
+    end
+
+    def distance
+      @activities.sum(&:distance)
+    end
+
+    def calories
+      @activities.sum(&:calories)
+    end
   end
 end

data/lib/tcx_rb.rb

@@ -11,17 +11,22 @@ module TcxRb
   class Error < StandardError; end
   # Your code goes here...
 
-  def self.workout_from_tcx(tcx_str)
+  def self.workout_from_str(tcx_str)
     parser = TcxRb::Parser.new(tcx_str)
-    workout_tree = parser.parse_activities
+    workout = parser.parse_activities
 
-    activities = workout_tree.map do |activity|
+    activities = workout.map do |activity|
       activity[:laps] = generate_laps(activity[:laps])
       TcxRb::Activity.new(activity)
     end
     TcxRb::Workout.new(activities)
   end
 
+  def self.workout_from_file(path)
+    str = File.read(path)
+    workout_from_str(str)
+  end
+
   class << self
     private
 

data/tcx_rb.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Keith Doggett']
   spec.email         = ['keith.doggett887@gmail.com']
 
-  spec.summary       = 'TcxRB is a Garminc TCX parsing library for Ruby.'
+  spec.summary       = 'TcxRB is a Garmin TCX parsing library for Ruby.'
   spec.description   =
     'TcxRB is a Garmin TCX parsing library for Ruby. '\
     'It gives access to raw data and has helpful aggregate '\
@@ -17,8 +17,6 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
 
-  # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
-
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage
   # spec.metadata['changelog_uri'] = "TODO: Put your gem's CHANGELOG.md URL here."

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tcx_rb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Keith Doggett
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-21 00:00:00.000000000 Z
+date: 2020-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -101,5 +101,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: TcxRB is a Garminc TCX parsing library for Ruby.
+summary: TcxRB is a Garmin TCX parsing library for Ruby.
 test_files: []