fit4ruby 3.7.0 → 3.10.0

data/spec/FitFile_spec.rb

@@ -3,7 +3,7 @@
 #
 # = FitFile_spec.rb -- Fit4Ruby - FIT file processing library for Ruby
 #
-# Copyright (c) 2014, 2015 by Chris Schlaeger <cs@taskjuggler.org>
+# Copyright (c) 2014, 2015, 2020 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
@@ -12,115 +12,147 @@
 
 $:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
+#require "super_diff/rspec"
 require 'fit4ruby'
 
 ENV['TZ'] = 'UTC'
 
 describe Fit4Ruby do
+  before(:each) do
+    File.delete(fit_file) if File.exist?(fit_file)
+    expect(File.exist?(fit_file)).to be false
+  end
+
+  after(:each) { File.delete(fit_file) }
+
   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,
-                      :gender => 'male', :activity_class => 4.0,
-                      :max_hr => 178 })
-
-    a.new_event({ :event => 'timer', :event_type => 'start_time' })
-    a.new_device_info({ :timestamp => ts,
-                        :device_index => 0, :manufacturer => 'garmin',
-                        :garmin_product => 'fenix3',
-                        :serial_number => 123456789 })
-    a.new_device_info({ :timestamp => ts,
-                        :device_index => 1, :manufacturer => 'garmin',
-                        :garmin_product => 'fenix3_gps'})
-    a.new_device_info({ :timestamp => ts,
-                        :device_index => 2, :manufacturer => 'garmin',
-                        :garmin_product => 'hrm_run',
-                        :battery_status => 'ok' })
-    a.new_device_info({ :timestamp => ts,
-                        :device_index => 3, :manufacturer => 'garmin',
-                        :garmin_product => 'sdm4',
-                        :battery_status => 'ok' })
-    a.new_data_sources({ :timestamp => ts, :distance => 1,
-                         :speed => 1, :cadence => 3, :elevation => 1,
-                         :heart_rate => 2 })
-    laps = 0
-    0.upto(a.total_timer_time / 60) do |mins|
-      ts += 60
-      a.new_record({
-        :timestamp => ts,
-        :position_lat => 51.5512 - mins * 0.0008,
-        :position_long => 11.647 + mins * 0.002,
-        :distance => 200.0 * mins,
-        :altitude => (100 + mins * 0.5).to_i,
-        :speed => 3.1,
-        :vertical_oscillation => 9 + mins * 0.02,
-        :stance_time => 235.0 * mins * 0.01,
-        :stance_time_percent => 32.0,
-        :heart_rate => 140 + mins,
-        :cadence => 75,
-        :activity_type => 'running',
-        :fractional_cadence => (mins % 2) / 2.0
-      })
+  # Round the timestamp to seconds. This is what the file format can store. A
+  # higher resolution would create errors during comparions.
+  let(:timestamp) { Time.at(Time.now.to_i) }
+  let(:user_data) do
+    {
+      :age => 33, :height => 1.78, :weight => 73.0,
+      :gender => 'male', :activity_class => 4.0,
+      :max_hr => 178
+    }
+  end
+  let(:user_profile) do
+    {
+      :friendly_name => 'Fast Runner',
+      :gender => 'male',
+      :age => 33,
+      :height => 1.78,
+      :weight => 73.0,
+      :resting_heart_rate => 43
+    }
+  end
+  def device_info_fenix3(ts)
+    {
+      :timestamp => ts,
+      :device_index => 0, :manufacturer => 'garmin',
+      :garmin_product => 'fenix3',
+      :serial_number => 123456789
+    }
+  end
+  def device_info_fenix3_gps(ts)
+    {
+      :timestamp => ts,
+      :device_index => 1, :manufacturer => 'garmin',
+      :garmin_product => 'fenix3_gps'
+    }
+  end
+  def device_info_hrm_run(ts, bs = 'ok')
+    {
+      :timestamp => ts,
+      :device_index => 2, :manufacturer => 'garmin',
+      :garmin_product => 'hrm_run',
+      :battery_status => bs
+    }
+  end
+  def device_info_sdm4(ts)
+    {
+      :timestamp => timestamp,
+      :device_index => 3, :manufacturer => 'garmin',
+      :garmin_product => 'sdm4',
+      :battery_status => 'ok'
+    }
+  end
+
+  context 'running activity' do
+    let(:activity) do
+      ts = timestamp
+      a = Fit4Ruby::Activity.new
+      a.total_timer_time = 30 * 60.0
+      a.new_user_data(user_data)
+      a.new_user_profile(user_profile)
+
+      a.new_event({ :event => 'timer', :event_type => 'start_time' })
+      a.new_device_info(device_info_fenix3(ts))
+      a.new_device_info(device_info_fenix3_gps(ts))
+      a.new_device_info(device_info_hrm_run(ts))
+      a.new_device_info(device_info_sdm4(ts))
+      a.new_data_sources({ :timestamp => ts, :distance => 1,
+                           :speed => 1, :cadence => 3, :elevation => 1,
+                           :heart_rate => 2 })
+      laps = 0
+      0.upto(a.total_timer_time / 60) do |mins|
+        ts += 60
+        a.new_record({
+          :timestamp => ts,
+          :position_lat => 51.5512 - mins * 0.0008,
+          :position_long => 11.647 + mins * 0.002,
+          :distance => 200.0 * mins,
+          :altitude => (100 + mins * 0.5).to_i,
+          :speed => 3.1,
+          :vertical_oscillation => 9 + mins * 0.02,
+          :stance_time => 235.0 * mins * 0.01,
+          :stance_time_percent => 32.0,
+          :heart_rate => 140 + mins,
+          :cadence => 75,
+          :activity_type => 'running',
+          :fractional_cadence => (mins % 2) / 2.0
+        })
 
-      if mins > 0 && mins % 5 == 0
-        a.new_lap({ :timestamp => ts, :sport => 'running',
-                    :message_index => laps, :total_cycles => 195 })
-        laps += 1
+        if mins > 0 && mins % 5 == 0
+          a.new_lap({ :timestamp => ts, :sport => 'running',
+                      :message_index => laps, :total_cycles => 195 })
+          laps += 1
+        end
       end
-    end
-    a.new_session({ :timestamp => ts, :sport => 'running' })
-    a.new_event({ :timestamp => ts, :event => 'recovery_time',
-                  :event_type => 'marker',
-                  :recovery_time => 2160 })
-    a.new_event({ :timestamp => ts, :event => 'vo2max',
-                  :event_type => 'marker', :vo2max => 52 })
-    a.new_event({ :timestamp => ts, :event => 'timer',
-                  :event_type => 'stop_all' })
-    ts += 1
-    a.new_device_info({ :timestamp => ts,
-                        :device_index => 0, :manufacturer => 'garmin',
-                        :garmin_product => 'fenix3',
-                        :serial_number => 123456789 })
-    a.new_device_info({ :timestamp => ts,
-                        :device_index => 1, :manufacturer => 'garmin',
-                        :garmin_product => 'fenix3_gps'})
-    a.new_device_info({ :timestamp => ts,
-                        :device_index => 2, :manufacturer => 'garmin',
-                        :garmin_product => 'hrm_run',
-                        :battery_status => 'low' })
-    a.new_device_info({ :timestamp => ts,
-                        :device_index => 3, :manufacturer => 'garmin',
-                        :garmin_product => 'sdm4',
-                        :battery_status => 'ok' })
-    ts += 120
-    a.new_event({ :timestamp => ts, :event => 'recovery_hr',
-                  :event_type => 'marker', :recovery_hr => 132 })
-
-    a.aggregate
-    a
-  end
+      a.new_session({ :timestamp => ts, :sport => 'running' })
+      a.new_event({ :timestamp => ts, :event => 'recovery_time',
+                    :event_type => 'marker',
+                    :recovery_time => 2160 })
+      a.new_event({ :timestamp => ts, :event => 'vo2max',
+                    :event_type => 'marker', :vo2max => 52 })
+      a.new_event({ :timestamp => ts, :event => 'timer',
+                    :event_type => 'stop_all' })
+      ts += 1
+      a.new_device_info(device_info_fenix3(ts))
+      a.new_device_info(device_info_fenix3_gps(ts))
+      a.new_device_info(device_info_hrm_run(ts, 'low'))
+      a.new_device_info(device_info_sdm4(ts))
+      ts += 120
+      a.new_event({ :timestamp => ts, :event => 'recovery_hr',
+                    :event_type => 'marker', :recovery_hr => 132 })
 
-  before do
-    File.delete(fit_file) if File.exist?(fit_file)
-    expect(File.exist?(fit_file)).to be false
-  end
+      a.aggregate
+      a
+    end
 
-  after { File.delete(fit_file) }
+    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
 
-  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 0
+      expect(b.export).to eq(activity.export)
+    end
 
-    b = Fit4Ruby.read(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
+  context 'swimming activity' do
     let(:activity) do
       ts = timestamp
       laps = 0
@@ -128,9 +160,7 @@ describe Fit4Ruby do
       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 })
+      a.new_device_info(device_info_fenix3(ts))
 
       0.upto(a.total_timer_time / 60) do |mins|
         ts += 60
@@ -144,6 +174,7 @@ describe Fit4Ruby do
           lengths += 1
         end
       end
+      a.aggregate
       a
     end
 
@@ -156,9 +187,76 @@ describe Fit4Ruby do
       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)
+      expect(b.export).to eq(activity.export)
+    end
+
+  end
+
+  context 'activity with developer fields' 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(device_info_fenix3(ts))
+      a.new_developer_data_id({
+        application_id: [ 24, 251, 44, 240, 26, 75, 67, 13,
+                          173, 102, 152, 140, 132, 116, 33, 244 ],
+        application_version: 77
+      })
+      a.new_field_description({
+        developer_data_index: 0,
+        field_definition_number: 0,
+        fit_base_type_id: 132,
+        field_name: 'Power',
+        units: 'Watts',
+        native_mesg_num: 20,
+        native_field_num: 7
+      })
+      a.new_data_sources({ :timestamp => ts, :distance => 1,
+                           :speed => 1, :cadence => 3, :elevation => 1,
+                           :heart_rate => 2 })
+      laps = 0
+      0.upto(a.total_timer_time / 60) do |mins|
+        ts += 60
+        a.new_record({
+          :timestamp => ts,
+          :position_lat => 51.5512 - mins * 0.0008,
+          :position_long => 11.647 + mins * 0.002,
+          :distance => 200.0 * mins,
+          :altitude => (100 + mins * 0.5).to_i,
+          :speed => 3.1,
+          :vertical_oscillation => 9 + mins * 0.02,
+          :stance_time => 235.0 * mins * 0.01,
+          :stance_time_percent => 32.0,
+          :heart_rate => 140 + mins,
+          :cadence => 75,
+          :activity_type => 'running',
+          :fractional_cadence => (mins % 2) / 2.0,
+          :Power_18FB2CF01A4B430DAD66988C847421F4 => 240
+        })
+
+        if mins > 0 && mins % 5 == 0
+          a.new_lap({ :timestamp => ts, :sport => 'running',
+                      :message_index => laps, :total_cycles => 195 })
+          laps += 1
+        end
+      end
+      a.aggregate
+      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
+
+      # This currently does not work as the saving of developer fields is not
+      # yet implemented.
+      #b = Fit4Ruby.read(fit_file)
+      #expect(b.export).to eq(activity.export)
+    end
   end
 
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: fit4ruby
 version: !ruby/object:Gem::Version
-  version: 3.7.0
+  version: 3.10.0
 platform: ruby
 authors:
 - Chris Schlaeger
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-01 00:00:00.000000000 Z
+date: 2022-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.4.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.4.8
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.0.0
+        version: 13.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.0.0
+        version: 13.0.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -112,6 +112,7 @@ files:
 - fit4ruby.gemspec
 - lib/fit4ruby.rb
 - lib/fit4ruby/Activity.rb
+- lib/fit4ruby/BDFieldNameTranslator.rb
 - lib/fit4ruby/CRC16.rb
 - lib/fit4ruby/Converters.rb
 - lib/fit4ruby/DataSources.rb
@@ -120,6 +121,7 @@ files:
 - lib/fit4ruby/DumpedField.rb
 - lib/fit4ruby/EPO_Data.rb
 - lib/fit4ruby/Event.rb
+- lib/fit4ruby/FDR_DevField_Extension.rb
 - lib/fit4ruby/FieldDescription.rb
 - lib/fit4ruby/FileCreator.rb
 - lib/fit4ruby/FileId.rb
@@ -162,6 +164,8 @@ files:
 - lib/fit4ruby/TrainingStatus.rb
 - lib/fit4ruby/UserData.rb
 - lib/fit4ruby/UserProfile.rb
+- lib/fit4ruby/Workout.rb
+- lib/fit4ruby/WorkoutStep.rb
 - lib/fit4ruby/version.rb
 - spec/FileNameCoder_spec.rb
 - spec/FitFile_spec.rb
@@ -174,7 +178,7 @@ homepage: https://github.com/scrapper/fit4ruby
 licenses:
 - GNU GPL version 2
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -189,9 +193,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Library to read and write GARMIN FIT files.
 test_files: