fit4ruby 3.7.0 → 3.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1867e2f6e32d331216b372024ba0607837bb5dc3baf7daad107b5a23d6465aa6
-  data.tar.gz: 25f0423ccf5e68259f48d02f35400fa2a723a9f7209613f77eca2631d056f2d0
+  metadata.gz: d40c0fc77ae8184b42aa80643dfb6b0f036b3eab7f37bdb8ee66b76a9feaafc5
+  data.tar.gz: 6e8ce1d3472e67a3c7ba58200fdf6b395e009349e68dca0618a92b3176f8ff19
 SHA512:
-  metadata.gz: 05641db1523d5e8a9b8ab939d4b65def4e5a50ca6bbcae3fb1c727dc7d641cfeda6d7a5e892b38819b840b0a2222e0d775d20bf4f93ae4af6db2c79b4b6753b3
-  data.tar.gz: f4b7d619de81444329009c7a188f08bd4684524ecc1654a57b77df147a0e22730658d57247e30729f619a0ab2c6fbd6fce796908df05ff2d409a06a909656298
+  metadata.gz: 366a5e5b4f55ee4918c822e26eda16d6381a1e872b8af68504283def72f096e00717dc68f9bd52403d8e6662c4e2aff83d12d26e201d568794bca407513b5bd8
+  data.tar.gz: a4eda75c90f65d26b9786570ee0fa07e578a3d627996170385411305b17a7a9697b043de70b335e485f3ca5780cdb0157506d34212ab0c54947c4111fb951fbf

data/README.md

@@ -10,7 +10,7 @@ me comments and patches. It was developed to form the back-end of
 
 ## Supported Devices
 
-Tested devices: Garmin FR620
+Tested devices: Garmin FR620, Fenix 3, Fenix 5, Fenix 5X, Fenix 6X
 
 Other Garmin devices that generate FIT files may work as well. Since I
 don't have any other devices, I can't add support for them.

data/fit4ruby.gemspec

@@ -24,9 +24,9 @@ EOT
   spec.require_paths = ["lib"]
   spec.required_ruby_version = '>=2.0'
 
-  spec.add_dependency('bindata', '=2.3.0')
+  spec.add_dependency('bindata', '~>2.4.8')
   spec.add_development_dependency('yard', '~>0.9.20')
-  spec.add_development_dependency('rake', '~>12.0.0')
+  spec.add_development_dependency('rake', '~>13.0.3')
   spec.add_development_dependency('bundler', '>=1.6.4')
   spec.add_development_dependency('rspec', '>=3.8')
   spec.add_development_dependency('pry', '>=0.12')

data/lib/fit4ruby/Activity.rb

@@ -3,7 +3,7 @@
 #
 # = Activity.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
@@ -30,48 +30,72 @@ require 'fit4ruby/HRV'
 require 'fit4ruby/HeartRateZones'
 require 'fit4ruby/Event'
 require 'fit4ruby/PersonalRecords'
+require 'fit4ruby/Workout'
+require 'fit4ruby/WorkoutStep'
 
 module Fit4Ruby
 
-  # This is the most important class of this library. It holds references to
-  # all other data structures. Each of the objects it references are direct
-  # equivalents of the message record structures used in the FIT file.
+  # Activity files are arguably the most common type of FIT file. The Activity
+  # class represents the top-level structure of an activity FIT file.
+  # It holds references to all other data structures. Each of the objects it
+  # references are direct equivalents of the message record structures used in
+  # the FIT file.
   class Activity < FitDataRecord
 
-    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, :lengths, :hrv,
-                  :heart_rate_zones, :events, :personal_records
+    # These symbols are a complete list of all the sub-sections that an
+    # activity FIT file may contain. This list is used to generate accessors,
+    # instance variables and other sections of code. Some are just simple
+    # instance variables, but the majority can appear multiple times and hence
+    # are stored in an Array.
+    FILE_SECTIONS = [
+      :file_id,
+      :file_creator,
+      :events,
+      :device_infos,
+      :data_sources,
+      :epo_data,
+      :user_profiles,
+      :user_data,
+      :workouts,
+      :workout_steps,
+      :sensor_settings,
+      :developer_data_ids,
+      :field_descriptions,
+      :records,
+      :hrv,
+      :laps,
+      :lengths,
+      :heart_rate_zones,
+      :physiological_metrics,
+      :sessions,
+      :personal_records
+    ]
+
+    attr_accessor *FILE_SECTIONS
 
     # Create a new Activity object.
     # @param field_values [Hash] A Hash that provides initial values for
     #        certain fields of the FitDataRecord.
     def initialize(field_values = {})
       super('activity')
-      @meta_field_units['total_gps_distance'] = 'm'
-      @num_sessions = 0
 
-      @file_id = FileId.new
-      @field_descriptions = []
-      @developer_data_ids = []
+      # The variables hold references to other parts of the FIT file. These
+      # can either be direct references to a certain FIT file section or an
+      # Array in case the section can appear multiple times in the FIT file.
+      @file_id = new_file_id()
+      @file_creator = new_file_creator()
       @epo_data = nil
-      @file_creator = FileCreator.new
-      @device_infos = []
-      @sensor_settings = []
-      @data_sources = []
-      @user_data = []
-      @user_profiles = []
-      @physiological_metrics = []
-      @events = []
-      @sessions = []
-      @laps = []
-      @lengths = []
-      @records = []
-      @hrv = []
-      @heart_rate_zones = []
-      @personal_records = []
+      # Initialize the remaining variables as empty Array.
+      FILE_SECTIONS.each do |fs|
+        ivar_name = '@' + fs.to_s
+        unless instance_variable_defined?(ivar_name)
+          instance_variable_set(ivar_name, [])
+        end
+      end
 
+      # The following variables hold derived or auxilliary information that
+      # are not directly part of the FIT file.
+      @meta_field_units['total_gps_distance'] = 'm'
       @cur_session_laps = []
 
       @cur_lap_records = []
@@ -99,11 +123,6 @@ module Fit4Ruby
       end
       @device_infos.each.with_index { |d, index| d.check(index) }
       @sensor_settings.each.with_index { |s, index| s.check(index) }
-      unless @num_sessions == @sessions.count
-        Log.fatal "Activity record requires #{@num_sessions}, but "
-                  "#{@sessions.length} session records were found in the "
-                  "FIT file."
-      end
 
       # Records must have consecutively growing timestamps and distances.
       ts = Time.parse('1989-12-31')
@@ -308,13 +327,17 @@ module Fit4Ruby
     def write(io, id_mapper)
       @file_id.write(io, id_mapper)
       @file_creator.write(io, id_mapper)
+      @epo_data.write(io, id_mapper) if @epo_data
+
+      ary_ivars = []
+      FILE_SECTIONS.each do |fs|
+        ivar_name = '@' + fs.to_s
+        if (ivar = instance_variable_get(ivar_name)) && ivar.respond_to?(:sort)
+          ary_ivars += ivar
+        end
+      end
 
-      (@field_descriptions + @developer_data_ids +
-       @device_infos + @sensor_settings +
-       @data_sources + @user_profiles +
-       @physiological_metrics + @events +
-       @sessions + @laps + @records + @lengths +
-       @heart_rate_zones + @personal_records).sort.each do |s|
+      ary_ivars.sort.each do |s|
         s.write(io, id_mapper)
       end
       super
@@ -386,6 +409,22 @@ module Fit4Ruby
       new_fit_data_record('user_profile', field_values)
     end
 
+    # Add a new Workout to the Activity.
+    # @param field_values [Hash] A Hash that provides initial values for
+    #        certain fields of the FitDataRecord.
+    # @return [UserProfile]
+    def new_workout(field_values = {})
+      new_fit_data_record('workout', field_values)
+    end
+
+    # Add a new WorkoutSet to the Activity.
+    # @param field_values [Hash] A Hash that provides initial values for
+    #        certain fields of the FitDataRecord.
+    # @return [UserProfile]
+    def new_workout_set(field_values = {})
+      new_fit_data_record('workout_set', field_values)
+    end
+
     # Add a new PhysiologicalMetrics to the Activity.
     # @param field_values [Hash] A Hash that provides initial values for
     #        certain fields of the FitDataRecord.
@@ -464,18 +503,17 @@ module Fit4Ruby
     # @return [TrueClass/FalseClass] true if both Activities are equal,
     # otherwise false.
     def ==(a)
-      super(a) && @file_id == a.file_id &&
-        @file_creator == a.file_creator &&
-        @field_descriptions == a.field_descriptions &&
-        @developer_data_ids == a.developer_data_ids &&
-        @device_infos == a.device_infos &&
-        @sensor_settings == a.sensor_settings &&
-        @data_sources == a.data_sources &&
-        @physiological_metrics == a.physiological_metrics &&
-        @user_profiles == a.user_profiles &&
-        @heart_rate_zones == a.heart_rate_zones &&
-        @events == a.events &&
-        @sessions == a.sessions && personal_records == a.personal_records
+      return false unless super(a)
+
+      FILE_SECTIONS.each do |fs|
+        ivar_name = '@' + fs.to_s
+        ivar = instance_variable_get(ivar_name)
+        a_ivar = a.instance_variable_get(ivar_name)
+
+        return false unless ivar == a_ivar
+      end
+
+      true
     end
 
     # Create a new FitDataRecord.
@@ -504,6 +542,10 @@ module Fit4Ruby
         @data_sources << (record = DataSources.new(field_values))
       when 'user_data'
         @user_data << (record = UserData.new(field_values))
+      when 'workout'
+        @workouts << (record = Workout.new(field_values))
+      when 'workout_step'
+        @workout_steps << (record = WorkoutStep.new(field_values))
       when 'user_profile'
         @user_profiles << (record = UserProfile.new(field_values))
       when 'physiological_metrics'
@@ -521,7 +563,6 @@ module Fit4Ruby
           # Ensure that all previous records have been assigned to a lap.
           record = create_new_lap(lap_field_values)
         end
-        @num_sessions += 1
         @sessions << (record = Session.new(@cur_session_laps, @lap_counter,
                                            field_values))
         @cur_session_laps = []
@@ -530,7 +571,7 @@ module Fit4Ruby
       when 'length'
         record = create_new_length(field_values)
       when 'record'
-        record = Record.new(field_values)
+        record = Record.new(self, field_values)
         @cur_lap_records << record
         @cur_length_records << record
         @records << record
@@ -547,10 +588,31 @@ module Fit4Ruby
       record
     end
 
+    def export
+      # Collect all records in a consistent order.
+      records = []
+      FILE_SECTIONS.each do |fs|
+        ivar_name = '@' + fs.to_s
+        ivar = instance_variable_get(ivar_name)
+
+        next unless ivar
+
+        if ivar.respond_to?(:sort) and ivar.respond_to?(:empty?)
+          records += ivar.sort unless ivar.empty?
+        else
+          records << ivar if ivar
+        end
+      end
+
+      records.map do |record|
+        record.export
+      end
+    end
+
     private
 
     def create_new_lap(field_values)
-      lap = Lap.new(@cur_lap_records, @laps.last,
+      lap = Lap.new(self, @cur_lap_records, @laps.last,
                     field_values,
                     @length_counter, @cur_lap_lengths)
       lap.message_index = @lap_counter - 1
@@ -573,6 +635,7 @@ module Fit4Ruby
 
       length
     end
+
   end
 
 end

data/lib/fit4ruby/BDFieldNameTranslator.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = FitDataRecord.rb -- Fit4Ruby - FIT file processing library for Ruby
+#
+# Copyright (c) 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
+# published by the Free Software Foundation.
+#
+
+module Fit4Ruby
+
+  # Some FIT message field names conflict with BinData reserved names. We use
+  # this translation method to map the conflicting names to BinData compatible
+  # names.
+  module BDFieldNameTranslator
+
+    BD_DICT =  {
+      'array' => '_array',
+      'type' => '_type'
+    }
+
+    def to_bd_field_name(name)
+      if (bd_name = BD_DICT[name])
+        return bd_name
+      end
+
+      name
+    end
+
+  end
+
+end
+

data/lib/fit4ruby/FDR_DevField_Extension.rb

@@ -0,0 +1,81 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = FDR_DevField_Extension.rb -- Fit4Ruby - FIT file processing library for Ruby
+#
+# Copyright (c) 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
+# published by the Free Software Foundation.
+#
+
+module Fit4Ruby
+
+  # This module extends FitDataRecord derived classes in case they have
+  # developer fields.
+  module FDR_DevField_Extension
+
+    def create_dev_field_instance_variables
+      # Create instance variables for developer fields
+      @dev_field_descriptions = {}
+      @top_level_record.field_descriptions.each do |field_description|
+        # Only create instance variables if the FieldDescription is for this
+        # message number.
+        if field_description.native_mesg_num == @message.number
+          name = field_description.full_field_name(@top_level_record.
+                                                   developer_data_ids)
+          create_instance_variable(name)
+          @dev_field_descriptions[name] = field_description
+        end
+      end
+    end
+
+    def each_developer_field
+      @top_level_record.field_descriptions.each do |field_description|
+        # Only create instance variables if the FieldDescription is for this
+        # message number.
+        if field_description.native_mesg_num == @message.number
+          name = field_description.full_field_name(@top_level_record.
+                                                   developer_data_ids)
+          yield(field_description, instance_variable_get('@' + name))
+        end
+      end
+    end
+
+    def get_unit_by_name(name)
+      if /[A-Za-z_]+_[A-F0-9]{16}/ =~ name
+        @dev_field_descriptions[name].units
+      else
+        super
+      end
+    end
+
+    def export
+      message = super
+
+      each_developer_field do |field_description, ivar|
+        field = field_description.message.fields_by_number[
+          field_description.native_field_num]
+        fit_value = field.native_to_fit(ivar)
+        unless field.is_undefined?(fit_value)
+          fld = {
+            'number' => field_description.native_field_num | 128,
+            'value' => field.fit_to_native(fit_value),
+            #'human' => field.to_human(fit_value),
+            'type' => field.type
+          }
+          fld['unit'] = field.opts[:unit] if field.opts[:unit]
+          fld['scale'] = field.opts[:scale] if field.opts[:scale]
+
+          message['fields'][field.name] = fld
+        end
+      end
+
+      message
+    end
+
+  end
+
+end
+

data/lib/fit4ruby/FieldDescription.rb

@@ -3,7 +3,7 @@
 #
 # = FieldDescription.rb -- Fit4Ruby - FIT file processing library for Ruby
 #
-# Copyright (c) 2017, 2018, 2019 by Chris Schlaeger <cs@taskjuggler.org>
+# Copyright (c) 2017, 2018, 2019, 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
@@ -25,6 +25,24 @@ module Fit4Ruby
     def initialize(field_values = {})
       super('field_description')
       set_field_values(field_values)
+
+      @full_field_name = nil
+    end
+
+    def full_field_name(developer_data_ids)
+      return @full_field_name if @full_field_name
+
+      if @developer_data_index >=
+           developer_data_ids.size
+         Log.error "Developer data index #{@developer_data_index} is too large"
+         return
+      end
+
+      app_id = developer_data_ids[@developer_data_index].application_id
+      # Convert the byte array with the app ID into a 16 character hex string.
+      app_id_str = app_id.map { |i| '%02X' % i }.join('')
+      @full_field_name =
+        "#{@field_name.gsub(/[^A-Za-z0-9_]/, '_')}_#{app_id_str}"
     end
 
     def create_global_definition(fit_entity)
@@ -35,12 +53,6 @@ module Fit4Ruby
         return
       end
 
-      if @developer_data_index >=
-           fit_entity.top_level_record.developer_data_ids.size
-         Log.error "Developer data index #{@developer_data_index} is too large"
-         return
-      end
-
       msg = messages[@native_mesg_num] ||
         messages.message(@native_mesg_num, gfm.name)
       unless (@fit_base_type_id & 0x7F) < FIT_TYPE_DEFS.size
@@ -48,10 +60,10 @@ module Fit4Ruby
         return
       end
 
-      name = "_#{@developer_data_index}_#{@field_name}"
       # A fit file may include multiple definitions of the same field. We
       # ignore all subsequent definitions.
-      return if msg.has_field?(name)
+      return if msg.has_field?(full_field_name(fit_entity.top_level_record.
+                                               developer_data_ids))
 
       options = {}
       options[:scale] = @scale if @scale
@@ -60,7 +72,7 @@ module Fit4Ruby
       options[:unit] = @units
       msg.field(@field_definition_number,
                 FIT_TYPE_DEFS[@fit_base_type_id & 0x7F][1],
-                name, options)
+                @full_field_name, options)
     end
 
   end

data/lib/fit4ruby/FileId.rb

@@ -3,7 +3,7 @@
 #
 # = FileId.rb -- Fit4Ruby - FIT file processing library for Ruby
 #
-# Copyright (c) 2014 by Chris Schlaeger <cs@taskjuggler.org>
+# Copyright (c) 2014, 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
@@ -23,6 +23,7 @@ module Fit4Ruby
       @time_created = Time.at(Time.now.to_i)
       @manufacturer = 'development'
       @type = 'activity'
+      @product = 0
 
       set_field_values(field_values)
     end