fit4ruby 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c76d1a2e0091c4aa84e7e26a381630def4b5e5b0
-  data.tar.gz: 21814b487808a93810dfedf2fe4908d7f9ecf246
+SHA256:
+  metadata.gz: '0478b4abeb404d3c3dfab616289182d37b280c0090cb3be1771e9acd78a38ae0'
+  data.tar.gz: 11e8f45f61cb2780bdd155eb2cf87e0d7952a5b4a079d5fdf8b3f6df0849a9b3
 SHA512:
-  metadata.gz: fbb6bf23b5adadb57b114444de5d067b13273bb73537e76b6a8b6436e61a5fea69af8f619625369ac5c6c9fd13018a31514e3e1662d8437f33ba71b8a52b949e
-  data.tar.gz: 5404ca45effe3b389041a036711c55006c95f304f4afa91a888c2dfda4f38ad2fc55faf450e23791cfd571c6b0c9373865161b881e87e53e268af36e93f130a3
+  metadata.gz: fbd0bcb013b1736e18b307f389f95967b3cb34b96c0ed113fef48add5604d5ef39c745e53a7612b69b61cf1a16a8ce688d3bbcddd136985b8a6a79b24943c120
+  data.tar.gz: 8de75daacdbb990b3fc2334891d9fa39f20911255a788ab5c7863610ea7f0eb344612bf24fe740f143110477a04b4bad46398d6575944dca89a7bba3feb7591c

data/Gemfile.lock

@@ -1,15 +1,34 @@
 PATH
   remote: .
   specs:
-    fit4ruby (0.0.1)
-      bindata (>= 2.0.0)
+    fit4ruby (3.3.0)
+      bindata (= 2.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    bindata (2.1.0)
+    bindata (2.3.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
     rake (0.9.6)
-    yard (0.8.7.4)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    yard (0.9.20)
 
 PLATFORMS
   ruby
@@ -17,5 +36,10 @@ PLATFORMS
 DEPENDENCIES
   bundler (>= 1.6.4)
   fit4ruby!
-  rake
-  yard
+  pry (>= 0.12)
+  rake (~> 0.9.6)
+  rspec (>= 3.8)
+  yard (~> 0.9.20)
+
+BUNDLED WITH
+   2.0.2

data/fit4ruby.gemspec

@@ -28,4 +28,6 @@ EOT
   spec.add_development_dependency('yard', '~>0.9.20')
   spec.add_development_dependency('rake', '~>0.9.6')
   spec.add_development_dependency('bundler', '>=1.6.4')
+  spec.add_development_dependency('rspec', '>=3.8')
+  spec.add_development_dependency('pry', '>=0.12')
 end

data/lib/fit4ruby/Activity.rb

@@ -24,6 +24,7 @@ require 'fit4ruby/UserProfile'
 require 'fit4ruby/PhysiologicalMetrics'
 require 'fit4ruby/Session'
 require 'fit4ruby/Lap'
+require 'fit4ruby/Length'
 require 'fit4ruby/Record'
 require 'fit4ruby/HRV'
 require 'fit4ruby/HeartRateZones'
@@ -40,7 +41,7 @@ module Fit4Ruby
     attr_accessor :file_id, :field_descriptions, :developer_data_ids, :epo_data,
                   :file_creator, :device_infos, :sensor_settings, :data_sources,
                   :user_data, :user_profiles, :physiological_metrics,
-                  :sessions, :laps, :records, :hrv,
+                  :sessions, :laps, :records, :lengths, :hrv,
                   :heart_rate_zones, :events, :personal_records
 
     # Create a new Activity object.
@@ -65,15 +66,21 @@ module Fit4Ruby
       @events = []
       @sessions = []
       @laps = []
+      @lengths = []
       @records = []
       @hrv = []
       @heart_rate_zones = []
       @personal_records = []
 
       @cur_session_laps = []
+
       @cur_lap_records = []
+      @cur_lap_lengths = []
+
+      @cur_length_records = []
 
       @lap_counter = 1
+      @length_counter = 1
 
       set_field_values(field_values)
     end
@@ -141,11 +148,20 @@ module Fit4Ruby
 
       # Laps must have a consecutively growing message index.
       @laps.each.with_index do |lap, index|
-        lap.check(index)
+        lap.check(index, self)
         # If we have heart rate zone records, there should be one for each
         # lap
         @heart_rate_zones[index].check(index) if @heart_rate_zones[index]
       end
+
+      # Lengths must have a consecutively growing message index.
+      @lengths.each.with_index do |length, index|
+        length.check(index)
+        # If we have heart rate zone records, there should be one for each
+        # length
+        @heart_rate_zones[index].check(index) if @heart_rate_zones[index]
+      end
+
       @sessions.each { |s| s.check(self) }
     end
 
@@ -206,17 +222,22 @@ module Fit4Ruby
       d
     end
 
-    # Call this method to update the aggregated data fields stored in Lap and
-    # Session objects.
+    # Call this method to update the aggregated data fields stored in Lap,
+    # Length, and Session objects.
     def aggregate
       @laps.each { |l| l.aggregate }
+      @lengths.each { |l| l.aggregate }
       @sessions.each { |s| s.aggregate }
     end
 
     # Convenience method that averages the speed over all sessions.
     def avg_speed
       speed = 0.0
-      @sessions.each { |s| speed += s.avg_speed if s.avg_speed }
+      @sessions.each do |s|
+        if (spd = s.avg_speed || s.enhanced_avg_speed)
+          speed += spd
+        end
+      end
       speed / @sessions.length
     end
 
@@ -292,8 +313,8 @@ module Fit4Ruby
        @device_infos + @sensor_settings +
        @data_sources + @user_profiles +
        @physiological_metrics + @events +
-       @sessions + @laps + @records + @heart_rate_zones +
-       @personal_records).sort.each do |s|
+       @sessions + @laps + @records + @lengths +
+       @heart_rate_zones + @personal_records).sort.each do |s|
         s.write(io, id_mapper)
       end
       super
@@ -404,6 +425,16 @@ module Fit4Ruby
       new_fit_data_record('lap', field_values)
     end
 
+    # Add a new Length to the Activity. All previoulsy added Record objects are
+    # associated with this Length unless they have been associated with another
+    # Length before.
+    # @param field_values [Hash] A Hash that provides initial values for
+    #        certain fields of the FitDataRecord.
+    # @return [Length]
+    def new_length(field_values = {})
+      new_fit_data_record('length', field_values)
+    end
+
     # Add a new HeartRateZones record to the Activity.
     # @param field_values [Heash] A Hash that provides initial values for
     #        certain fields of the FitDataRecord.
@@ -496,8 +527,12 @@ module Fit4Ruby
         @cur_session_laps = []
       when 'lap'
         record = create_new_lap(field_values)
+      when 'length'
+        record = create_new_length(field_values)
       when 'record'
-        @cur_lap_records << (record = Record.new(field_values))
+        record = Record.new(field_values)
+        @cur_lap_records << record
+        @cur_length_records << record
         @records << record
       when 'hrv'
         @hrv << (record = HRV.new(field_values))
@@ -515,16 +550,29 @@ module Fit4Ruby
     private
 
     def create_new_lap(field_values)
-      lap = Lap.new(@cur_lap_records, @laps.last, field_values)
+      lap = Lap.new(@cur_lap_records, @laps.last,
+                    field_values,
+                    @length_counter, @cur_lap_lengths)
       lap.message_index = @lap_counter - 1
       @lap_counter += 1
       @cur_session_laps << lap
       @laps << lap
       @cur_lap_records = []
+      @cur_lap_lengths = []
 
       lap
     end
 
+    def create_new_length(field_values)
+      length = Length.new(@cur_length_records, @lengths.last, field_values)
+      length.message_index = @length_counter - 1
+      @length_counter += 1
+      @cur_lap_lengths << length
+      @lengths << length
+      @cur_length_records = []
+
+      length
+    end
   end
 
 end

data/lib/fit4ruby/FitDataRecord.rb

@@ -21,7 +21,7 @@ module Fit4Ruby
 
     RecordOrder = [ 'user_data', 'user_profile',
                     'device_info', 'data_sources', 'event',
-                    'record', 'lap', 'session', 'heart_rate_zones',
+                    'record', 'lap', 'length', 'session', 'heart_rate_zones',
                     'personal_records' ]
 
     attr_reader :message

data/lib/fit4ruby/GlobalFitDictionaries.rb

@@ -355,6 +355,7 @@ module Fit4Ruby
     entry 2697, 'fenix5'
     entry 2957, 'fenix5_gps_galileo' # Just a guess
     entry 3111, 'fenix5x_plus'
+    entry 3126, 'instinct'
     entry 10007, 'sdm4'
     entry 20119, 'training_center'
     entry 65532, 'android_antplus_plugin'
@@ -593,7 +594,7 @@ module Fit4Ruby
     dict 'swim_stroke'
     entry 0, 'freestyle'
     entry 1, 'backstroke'
-    entry 2, 'breaststrike'
+    entry 2, 'breaststroke'
     entry 3, 'butterfly'
     entry 4, 'drill'
     entry 5, 'mixed'

data/lib/fit4ruby/GlobalFitMessages.rb

@@ -131,6 +131,7 @@ module Fit4Ruby
     field 144, 'enum', 'true_up_enabled'
     field 148, 'enum', 'undocumented_field_148'
     field 149, 'enum', 'undocumented_field_149'
+    field 168, 'enum', 'undocumented_field_168'
 
     message 3, 'user_profile'
     field 0, 'string', 'friendly_name'
@@ -161,7 +162,7 @@ module Fit4Ruby
     field 34, 'uint16', 'undocumented_field_34'
     field 35, 'uint32', 'undocumented_field_35'
     field 36, 'uint8', 'undocumented_field_36'
-    field 37, 'uint16', 'undocumented_field_37'
+    field 37, 'uint16', 'functional_threshold_speed', :scale => 36, :unit => 'm/s'
     field 38, 'uint16', 'undocumented_field_38'
     field 39, 'float32', 'undocumented_field_39'
     field 40, 'float32', 'undocumented_field_40'
@@ -372,7 +373,7 @@ module Fit4Ruby
     field 44, 'uint16', 'pool_length', :scale => 100, :unit => 'm'
     field 45, 'uint16', 'undefined_value_45'
     field 46, 'enum', 'pool_length_unit', :dict => 'display_measure'
-    field 47, 'uint16', 'num_active_length', :unit => 'lengths'
+    field 47, 'uint16', 'num_active_lengths', :unit => 'lengths'
     field 48, 'uint32', 'total_work', :unit => 'J'
     field 57, 'sint8', 'avg_temperature', :unit => 'C'
     field 58, 'sint8', 'max_temperature', :unit => 'C'
@@ -445,6 +446,8 @@ module Fit4Ruby
     field 185, 'uint8', 'undocumented_field_185'
     field 187, 'float32', 'undocumented_field_187'
     field 188, 'enum', 'undocumented_field_188'
+    field 189, 'uint16', 'undocumented_field_189'
+    field 190, 'uint16', 'undocumented_field_190'
     field 253, 'uint32', 'timestamp', :type => 'date_time'
     field 254, 'uint16', 'message_index'
 
@@ -496,7 +499,7 @@ module Fit4Ruby
     field 37, 'uint16', 'avg_stroke_distance', :scale => 100, :unit => 'm'
     field 38, 'enum', 'swim_stroke', :dict => 'swim_stroke'
     field 39, 'enum', 'sub_sport', :dict => 'sub_sport'
-    field 40, 'uint16', 'num_active_length', :unit => 'lengths'
+    field 40, 'uint16', 'num_active_lengths', :unit => 'lengths'
     field 41, 'uint32', 'total_work', :unit => 'J'
     field 50, 'sint8', 'avg_temperature', :unit => 'C'
     field 51, 'sint8', 'max_temperature', :unit => 'C'
@@ -808,7 +811,7 @@ module Fit4Ruby
     field 10, 'uint8', 'avg_resting_heart_rate', :unit => 'bpm'
     field 11, 'uint16', 'running_lactate_threshold_heart_rate', :unit => 'bpm'
     field 12, 'uint16', 'functional_threshold_power', :unit => 'W'
-    field 13, 'uint16', 'undocumented_field_13'
+    field 13, 'uint16', 'functional_threshold_speed', :scale => 36, :unit => 'm/s'
     field 14, 'uint8', 'undocumented_field_14'
     field 15, 'uint8', 'undocumented_field_15'
     field 16, 'uint32', 'undocumented_field_16'
@@ -821,7 +824,7 @@ module Fit4Ruby
     message 101, 'length'
     field 0, 'enum', 'event', :dict => 'event'
     field 1, 'enum', 'event_type', :dict => 'event_type'
-    field 2, 'uint32', 'date_time', :type => 'date_time'
+    field 2, 'uint32', 'start_time', :type => 'date_time'
     field 3, 'uint32', 'total_elapsed_time', :scale => 1000, :unit => 's'
     field 4, 'uint32', 'total_timer_time', :scale => 1000, :unit => 's'
     field 5, 'uint16', 'total_strokes', :unit => 'strokes'
@@ -833,6 +836,8 @@ module Fit4Ruby
     field 12, 'enum', 'length_type', :dict => 'length_type'
     field 18, 'uint16', 'player_score'
     field 19, 'uint16', 'opponent_score'
+    field 20, 'uint16', 'stroke_count', :unit => 'counts'
+    field 21, 'uint16', 'zone_count', :unit => 'counts'
     field 253, 'uint32', 'timestamp', :type => 'date_time'
     field 254, 'uint16', 'message_index'
 
@@ -901,8 +906,8 @@ module Fit4Ruby
     field 12, 'enum', 'undocumented_field_12'
     field 13, 'uint8', 'undocumented_field_13'
     field 14, 'uint16', 'running_lactate_threshold_heart_rate', :unit => 'bpm'
-    field 15, 'uint16', 'running_lactate_threshold_speed', :scale => 1000, :unit => 'm/s'
-    field 16, 'uint16', 'undocumented_field_16' # very correlated to 14 and 15
+    field 15, 'uint16', 'undocumented_field_15'
+    field 16, 'uint16', 'running_lactate_threshold_speed', :scale => 36, :unit => 'm/s'
     field 17, 'sint8', 'performance_condition'
     field 18, 'uint8', 'undocumented_field_18'
     field 19, 'uint8', 'undocumented_field_19'
@@ -1008,6 +1013,7 @@ module Fit4Ruby
     field 65, 'uint32', 'undocumented_field_65'
     field 70, 'uint32', 'undocumented_field_70'
     field 71, 'enum', 'undocumented_field_71'
+    field 73, 'uint16z', 'undocumented_field_73'
     field 254, 'uint16', 'message_index'
 
     # Not part of the official ANT SDK doc.
@@ -1120,6 +1126,7 @@ module Fit4Ruby
     message 269, 'undocumented_269'
     field 0, 'uint8', 'undocumented_field_0'
     field 1, 'uint8', 'undocumented_field_1'
+    field 2, 'uint8', 'undocumented_field_2'
     field 253, 'uint32', 'timestamp', :type => 'date_time'
 
     # Not part of the official ANT SDK doc.

data/lib/fit4ruby/Lap.rb

@@ -19,13 +19,24 @@ module Fit4Ruby
 
     include RecordAggregator
 
-    attr_reader :records
+    attr_reader :records, :lengths
 
-    def initialize(records, previous_lap, field_values)
+    # Create a new Lap object.
+    # @param records [Array of Records] Records to associate with the Lap.
+    # @param lengths [Array of Lengths] Lengths to associate with the Lap.
+    # @param first_length_index [Fixnum] Index of the first Length in this Lap.
+    # @param previous_lap [Lap] Previous Lap on same Session.
+    # @param field_values [Hash] Hash that provides initial values for certain
+    #        fields.
+    def initialize(records, previous_lap, field_values, first_length_index, lengths)
       super('lap')
+      @lengths = lengths
       @meta_field_units['avg_stride_length'] = 'm'
       @records = records
       @previous_lap = previous_lap
+      @lengths.each { |length| @records += length.records }
+      @first_length_index = first_length_index
+      @num_lengths = @lengths.length
 
       if previous_lap && previous_lap.records && previous_lap.records.last
         # Set the start time of the new lap to the timestamp of the last record
@@ -43,10 +54,25 @@ module Fit4Ruby
       set_field_values(field_values)
     end
 
-    def check(index)
+    def check(index, activity)
       unless @message_index == index
         Log.fatal "message_index must be #{index}, not #{@message_index}"
       end
+
+      return if @num_lengths.zero?
+
+      unless @first_length_index
+        Log.fatal 'first_length_index is not set'
+      end
+
+      @first_length_index.upto(@first_length_index - @num_lengths) do |i|
+        if (length = activity.lengths[i])
+          @lengths << length
+        else
+          Log.fatal "Lap references length #{i} which is not contained in "
+          "the FIT file."
+        end
+      end
     end
 
     # Compute the average stride length for this Session.

data/lib/fit4ruby/Length.rb

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = Length.rb -- Fit4Ruby - FIT file processing library for Ruby
+#
+# Copyright (c) 2014, 2015 by Chris Schlaeger <cs@taskjuggler.org>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of version 2 of the GNU General Public License as
+# published by the Free Software Foundation.
+#
+
+require 'fit4ruby/FitDataRecord'
+require 'fit4ruby/RecordAggregator'
+
+module Fit4Ruby
+
+  class Length < FitDataRecord
+
+    include RecordAggregator
+
+    attr_reader :records
+
+    def initialize(records, previous_length, field_values)
+      super('length')
+      @records = records
+      @previous_length = previous_length
+
+      if previous_length && previous_length.records && previous_length.records.last
+        # Set the start time of the new length to the timestamp of the last record
+        # of the previous length.
+        @start_time = previous_length.records.last.timestamp
+      elsif records.first
+        # Or to the timestamp of the first record.
+        @start_time = records.first.timestamp
+      end
+
+      if records.last
+        @total_elapsed_time = records.last.timestamp - @start_time
+      end
+
+      set_field_values(field_values)
+    end
+
+    def check(index)
+      unless @message_index == index
+        Log.fatal "message_index must be #{index}, not #{@message_index}"
+      end
+    end
+
+  end
+
+end

data/lib/fit4ruby/version.rb

@@ -1,4 +1,4 @@
 module Fit4Ruby
   # The version number of the library.
-  VERSION = '3.3.0'
+  VERSION = '3.4.0'
 end

data/spec/FitFile_spec.rb

@@ -17,9 +17,10 @@ require 'fit4ruby'
 ENV['TZ'] = 'UTC'
 
 describe Fit4Ruby do
-
-  before(:each) do
-    ts = Time.now
+  let(:fit_file) { 'test.fit' }
+  let(:timestamp) { Time.now }
+  let(:activity) do
+    ts = timestamp
     a = Fit4Ruby::Activity.new
     a.total_timer_time = 30 * 60.0
     a.new_user_data({ :age => 33, :height => 1.78, :weight => 73.0,
@@ -99,20 +100,65 @@ describe Fit4Ruby do
                   :event_type => 'marker', :recovery_hr => 132 })
 
     a.aggregate
+    a
+  end
 
-    @activity = a
+  before do
+    File.delete(fit_file) if File.exist?(fit_file)
+    expect(File.exist?(fit_file)).to be false
   end
 
-  it 'should write an Activity FIT file and read it back' do
-    fit_file = 'test.fit'
+  after { File.delete(fit_file) }
 
-    File.delete(fit_file) if File.exists?(fit_file)
-    Fit4Ruby.write(fit_file, @activity)
-    expect(File.exists?(fit_file)).to be true
+  it 'should write an Activity FIT file and read it back' do
+    Fit4Ruby.write(fit_file, activity)
+    expect(File.exist?(fit_file)).to be true
 
     b = Fit4Ruby.read(fit_file)
-    expect(b.inspect).to eq(@activity.inspect)
-    File.delete(fit_file)
+    expect(b.laps.count).to eq 6
+    expect(b.lengths.count).to eq 0
+    expect(b.inspect).to eq(activity.inspect)
+  end
+
+  context 'activity with Lengths' do
+    let(:activity) do
+      ts = timestamp
+      laps = 0
+      lengths = 0
+      a = Fit4Ruby::Activity.new
+
+      a.total_timer_time = 30 * 60.0
+      a.new_device_info({ :timestamp => ts,
+        :device_index => 0, :manufacturer => 'garmin',
+        :serial_number => 123456789 })
+
+      0.upto(a.total_timer_time / 60) do |mins|
+        ts += 60
+        if mins > 0 && mins % 5 == 0
+          a.new_lap({ :timestamp => ts, :sport => 'swimming',
+            :message_index => laps, :total_cycles => 195 })
+          laps += 1
+
+          a.new_length({ :timestamp => ts, :event => 'length',
+            :message_index => lengths, :total_strokes => 45 })
+          lengths += 1
+        end
+      end
+      a
+    end
+
+    it 'should write an Activity FIT file and read it back' do
+      Fit4Ruby.write(fit_file, activity)
+      expect(File.exist?(fit_file)).to be true
+
+      b = Fit4Ruby.read(fit_file)
+      expect(b.laps.count).to eq 6
+      expect(b.lengths.count).to eq 6
+      expect(b.laps.select { |l| l.sport == 'swimming' }.count).to eq 6
+      expect(b.lengths.select { |l| l.total_strokes == 45 }.count).to eq 6
+      expect(b.inspect).to eq(activity.inspect)
+    end
+
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fit4ruby
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Chris Schlaeger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-03 00:00:00.000000000 Z
+date: 2019-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata
@@ -66,6 +66,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.4
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.12'
 description: |
   This library can read and write FIT files and convert them into a Ruby data
   structure for easy processing. This library was written for Garmin devices
@@ -118,6 +146,7 @@ files:
 - lib/fit4ruby/HRV.rb
 - lib/fit4ruby/HeartRateZones.rb
 - lib/fit4ruby/Lap.rb
+- lib/fit4ruby/Length.rb
 - lib/fit4ruby/Log.rb
 - lib/fit4ruby/Metrics.rb
 - lib/fit4ruby/Monitoring.rb
@@ -161,7 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Library to read and write GARMIN FIT files.