fit4ruby 3.10.0 → 3.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d40c0fc77ae8184b42aa80643dfb6b0f036b3eab7f37bdb8ee66b76a9feaafc5
-  data.tar.gz: 6e8ce1d3472e67a3c7ba58200fdf6b395e009349e68dca0618a92b3176f8ff19
+  metadata.gz: 550fffeb71313287a1a1037974608c23b738da5a34c6aaca39374fea562b7426
+  data.tar.gz: 923417ab9520777208f4bd830696d7012c68b8ad2e7d39572749bad42301d560
 SHA512:
-  metadata.gz: 366a5e5b4f55ee4918c822e26eda16d6381a1e872b8af68504283def72f096e00717dc68f9bd52403d8e6662c4e2aff83d12d26e201d568794bca407513b5bd8
-  data.tar.gz: a4eda75c90f65d26b9786570ee0fa07e578a3d627996170385411305b17a7a9697b043de70b335e485f3ca5780cdb0157506d34212ab0c54947c4111fb951fbf
+  metadata.gz: 990ce2d227826d09a114e55652bbc4287dc1b8c2e1a4a534a6ade8bbcc2baed3a321a4508ca6b880a6af745c007f58a60649b0f32bf75a6782f0e7df1498f26d
+  data.tar.gz: 3e6fe4df5bda73caa364937a13b1e4a764a65a55723026260f381d9a108441a030dc8ec8ff2876e7ece8527575571933164f8c23eae485e8f1ea09c479fe6924

data/fit4ruby.gemspec

@@ -22,7 +22,7 @@ EOT
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
-  spec.required_ruby_version = '>=2.0'
+  spec.required_ruby_version = '>=2.3'
 
   spec.add_dependency('bindata', '~>2.4.8')
   spec.add_development_dependency('yard', '~>0.9.20')

data/lib/fit4ruby/Activity.rb

@@ -188,7 +188,7 @@ module Fit4Ruby
     # sessions.
     def total_distance
       d = 0.0
-      @sessions.each { |s| d += s.total_distance }
+      @sessions.each { |s| d += (s.total_distance || 0) }
       d
     end
 
@@ -315,11 +315,21 @@ module Fit4Ruby
       @sessions[0].sport
     end
 
+    # Sets the sport type of this activity.
+    def sport=(sport)
+      @sessions[0].sport = sport
+    end
+
     # Returns the sport subtype of this activity.
     def sub_sport
       @sessions[0].sub_sport
     end
 
+    # Sets the sport subtype of this activity.
+    def sub_sport=(sub_sport)
+      @sessions[0].sub_sport = sub_sport
+    end
+
     # Write the Activity data to a file.
     # @param io [IO] File reference
     # @param id_mapper [FitMessageIdMapper] Maps global FIT record types to
@@ -639,4 +649,3 @@ module Fit4Ruby
   end
 
 end
-

data/lib/fit4ruby/Converters.rb

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby -w
-# encoding: UTF-8
 #
 # = Converters.rb -- Fit4Ruby - FIT file processing library for Ruby
 #
@@ -9,34 +8,47 @@
 # it under the terms of version 2 of the GNU General Public License as
 # published by the Free Software Foundation.
 #
+# frozen_string_literal: true
 
 module Fit4Ruby
-
   module Converters
+    FACTORS = {
+      'm' => { 'km' => 0.001, 'in' => 39.3701, 'ft' => 3.28084,
+               'mi' => 0.000621371 },
+      'mm' => { 'cm' => 0.1, 'in' => 0.0393701 },
+      'm/s' => { 'km/h' => 3.6, 'mph' => 2.23694 },
+      'min/km' => { 'min/mi' => 1.60934 },
+      'kg' => { 'lbs' => 2.20462262 },
+      'C' => { 'F' => 9.0 / 5.0 }
+    }.freeze
+    OFFSETS = {
+      'C' => { 'F' => 32 }
+    }.freeze
 
     def conversion_factor(from_unit, to_unit)
-      factors = {
-        'm' => { 'km' => 0.001, 'in' => 39.3701, 'ft' => 3.28084,
-                 'mi' => 0.000621371 },
-        'mm' => { 'cm' => 0.1, 'in' => 0.0393701 },
-        'm/s' => { 'km/h' => 3.6, 'mph' => 2.23694 },
-        'min/km' => { 'min/mi' => 1.60934 },
-        'kg' => { 'lbs' => 0.453592 }
-      }
       return 1.0 if from_unit == to_unit
-      unless factors.include?(from_unit)
-        Log.fatal "No conversion factors defined for unit " +
+
+      unless FACTORS.include?(from_unit)
+        Log.fatal 'No conversion factors defined for unit ' \
                   "'#{from_unit}' to '#{to_unit}'"
       end
 
-      factor = factors[from_unit][to_unit]
+      factor = FACTORS[from_unit][to_unit]
       if factor.nil?
-        Log.fatal "No conversion factor from '#{from_unit}' to '#{to_unit}' " +
-                  "defined."
+        Log.fatal "No conversion factor from '#{from_unit}' to '#{to_unit}' " \
+                  'defined.'
       end
+
       factor
     end
 
+    def conversion_offset(from_unit, to_unit)
+      return 0.0 if from_unit == to_unit || !OFFSETS.include?(from_unit) ||
+                    !OFFSETS[from_unit].include?(to_unit)
+
+      OFFSETS[from_unit][to_unit]
+    end
+
     def speedToPace(speed, distance = 1000.0)
       if speed && speed > 0.01
         # We only show 2 fractional digits, so make sure we round accordingly
@@ -89,4 +101,3 @@ module Fit4Ruby
   end
 
 end
-

data/lib/fit4ruby/FitDataRecord.rb

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby -w
-# encoding: UTF-8
 #
 # = FitDataRecord.rb -- Fit4Ruby - FIT file processing library for Ruby
 #
@@ -9,22 +8,21 @@
 # it under the terms of version 2 of the GNU General Public License as
 # published by the Free Software Foundation.
 #
+# frozen_string_literal: true
 
 require 'fit4ruby/FitMessageIdMapper'
-require 'fit4ruby/GlobalFitMessages.rb'
+require 'fit4ruby/GlobalFitMessages'
 require 'fit4ruby/BDFieldNameTranslator'
 
 module Fit4Ruby
-
   class FitDataRecord
-
     include Converters
     include BDFieldNameTranslator
 
-    RecordOrder = [ 'user_data', 'user_profile', 'workout', 'workout_set',
-                    'device_info', 'data_sources', 'event',
-                    'record', 'lap', 'length', 'session', 'heart_rate_zones',
-                    'personal_records' ]
+    RecordOrder = ['user_data', 'user_profile', 'workout', 'workout_set',
+                   'device_info', 'data_sources', 'event',
+                   'record', 'lap', 'length', 'session', 'heart_rate_zones',
+                   'personal_records']
 
     attr_reader :message, :timestamp
 
@@ -33,7 +31,7 @@ module Fit4Ruby
 
       # Create instance variables that correspond to every field of the
       # corresponding FIT data record.
-      @message.fields_by_name.each do |name, field|
+      @message.fields_by_name.each do |name, _|
         create_instance_variable(name)
       end
 
@@ -51,9 +49,9 @@ module Fit4Ruby
     end
 
     def set(name, value)
-      ivar_name = '@' + name
+      ivar_name = "@#{name}"
       unless instance_variable_defined?(ivar_name)
-        Log.debug("Unknown FIT record field '#{name}' in global message " +
+        Log.debug("Unknown FIT record field '#{name}' in global message " \
                   "#{@message.name} (#{@message.number}).")
         return
       end
@@ -62,7 +60,7 @@ module Fit4Ruby
 
     def get(name)
       # This is a request for a native FIT field.
-      ivar_name = '@' + name
+      ivar_name = "@#{name}"
       return nil unless instance_variable_defined?(ivar_name)
 
       instance_variable_get(ivar_name)
@@ -82,17 +80,17 @@ module Fit4Ruby
         end
       end
 
-      value * conversion_factor(unit, to_unit)
+      conversion_offset(unit, to_unit) + value * conversion_factor(unit, to_unit)
     end
 
-    def ==(fdr)
-      @message.each_field(field_values_as_hash) do |number, field|
-        ivar_name = '@' + field.name
+    def ==(other)
+      @message.each_field(field_values_as_hash) do |_, field|
+        ivar_name = "@#{field.name}"
         # Comparison of values is done in the fit file format as the accuracy
         # of native formats is better and could lead to wrong results if a
         # value hasn't been read back from a fit file yet.
         v1 = field.native_to_fit(instance_variable_get(ivar_name))
-        v2 = field.native_to_fit(fdr.instance_variable_get(ivar_name))
+        v2 = field.native_to_fit(other.instance_variable_get(ivar_name))
 
         return false unless v1 == v2
       end
@@ -100,16 +98,15 @@ module Fit4Ruby
       true
     end
 
-    def <=>(fdr)
-      @timestamp == fdr.timestamp ?
+    def <=>(other)
+      @timestamp == other.timestamp ?
         RecordOrder.index(@message.name) <=>
-        RecordOrder.index(fdr.message.name) :
-        @timestamp <=> fdr.timestamp
+        RecordOrder.index(other.message.name) :
+        @timestamp <=> other.timestamp
     end
 
     def write(io, id_mapper)
-      global_fit_message = @message.construct(
-        field_values = field_values_as_hash)
+      global_fit_message = @message.construct(field_values = field_values_as_hash)
 
       # Map the global message number to the current local message number.
       unless (local_message_number = id_mapper.get_local(global_fit_message))
@@ -134,10 +131,10 @@ module Fit4Ruby
 
       # Fill the BinData::Struct object with the values from the corresponding
       # instance variables.
-      global_fit_message.each_field(field_values) do |number, field|
+      global_fit_message.each_field(field_values) do |_, field|
         bin_data_type = FitDefinitionFieldBase.fit_type_to_bin_data(field.type)
         field_name = to_bd_field_name(field.name)
-        field_def = [ bin_data_type, field_name ]
+        field_def = [bin_data_type, field_name]
 
         iv = "@#{field.name}"
         if instance_variable_defined?(iv) &&
@@ -147,7 +144,7 @@ module Fit4Ruby
           # If we don't have a corresponding variable or the variable is nil
           # we write the 'undefined' value instead.
           value = FitDefinitionFieldBase.undefined_value(field.type)
-          values[field.name] = field.opts[:array] ? [ value ] :
+          values[field.name] = field.opts[:array] ? [value] :
             field.type == 'string' ? '' : value
         end
 
@@ -157,17 +154,17 @@ module Fit4Ruby
           values[field.name] += "\0"
         elsif field.opts[:array]
           # For Arrays we use a BinData::Array to write them.
-          field_def = [ :array, field_name,
-                        { :type => bin_data_type,
-                          :initial_length => values[field.name].size } ]
+          field_def = [:array, field_name,
+                       { type: bin_data_type,
+                         initial_length: values[field.name].size }]
         end
         fields << field_def
       end
-      bd = BinData::Struct.new(:endian => :little, :fields => fields)
+      bd = BinData::Struct.new(endian: :little, fields: fields)
 
       # Fill the BinData::Struct object with the values from the corresponding
       # instance variables.
-      global_fit_message.each_field(field_values) do |number, field|
+      global_fit_message.each_field(field_values) do |_, field|
         bd[to_bd_field_name(field.name)] = values[field.name]
       end
 
@@ -183,13 +180,13 @@ module Fit4Ruby
       }
 
       @message.each_field(field_values_as_hash) do |number, field|
-        ivar_name = '@' + field.name
+        ivar_name = "@#{field.name}"
         fit_value = field.native_to_fit(instance_variable_get(ivar_name))
         unless field.is_undefined?(fit_value)
           fld = {
             'number' => number,
             'value' => field.fit_to_native(fit_value),
-            #'human' => field.to_human(fit_value),
+            # 'human' => field.to_human(fit_value),
             'type' => field.type
           }
           fld['unit'] = field.opts[:unit] if field.opts[:unit]
@@ -214,7 +211,7 @@ module Fit4Ruby
       # set of fields. It does not contain any AltField objects.
       field_values = {}
       @message.fields_by_name.each_key do |name|
-        field_values[name] = instance_variable_get('@' + name)
+        field_values[name] = instance_variable_get("@#{name}")
       end
 
       field_values
@@ -223,12 +220,9 @@ module Fit4Ruby
     def create_instance_variable(name)
       # Create a new instance variable for 'name'. We initialize it with a
       # provided default value or nil.
-      instance_variable_set('@' + name, nil)
+      instance_variable_set("@#{name}", nil)
       # And create an accessor method for it as well.
       self.class.__send__(:attr_accessor, name)
     end
-
   end
-
 end
-

data/lib/fit4ruby/GlobalFitDictionaries.rb

@@ -16,6 +16,10 @@ module Fit4Ruby
 
   GlobalFitDictionaries = GlobalFitDictList.new do
 
+    dict 'activity'
+    entry 0, 'manual'
+    entry 1, 'auto_multi_sport'
+
     dict 'activity_type'
     entry 0, 'generic'
     entry 1, 'running'
@@ -23,50 +27,8 @@ module Fit4Ruby
     entry 3, 'transition'
     entry 4, 'fitness_equipment'
     entry 5, 'swimming'
-    entry 6, 'basketball'
-    entry 7, 'soccer'
-    entry 8, 'tennis'
-    entry 9, 'american_football'
-    entry 10, 'training'
-    entry 11, 'walking'
-    entry 12, 'cross_country_skiing'
-    entry 13, 'alpine_skiing'
-    entry 14, 'snowboarding'
-    entry 15, 'rowing'
-    entry 16, 'mountaineering'
-    entry 17, 'hiking'
-    entry 18, 'multisport'
-    entry 19, 'paddling'
-    entry 20, 'flying'
-    entry 21, 'e_biking'
-    entry 22, 'motorcycling'
-    entry 23, 'boating'
-    entry 24, 'driving'
-    entry 25, 'golf'
-    entry 26, 'hang_gliding'
-    entry 27, 'horseback_riding'
-    entry 28, 'hunting'
-    entry 29, 'fishing'
-    entry 30, 'inline_skating'
-    entry 31, 'rock_climbing'
-    entry 32, 'sailing'
-    entry 33, 'ice_skating'
-    entry 34, 'sky_diving'
-    entry 35, 'snowshoeing'
-    entry 36, 'snowmobiling'
-    entry 37, 'stand_up_paddleboarding'
-    entry 38, 'surfing'
-    entry 39, 'wakeboarding'
-    entry 40, 'water_skiing'
-    entry 41, 'kayaking'
-    entry 42, 'rafting'
-    entry 43, 'windsurfing'
-    entry 44, 'kitesurfing'
-    entry 45, 'tactical'
-    entry 46, 'jumpmaster'
-    entry 47, 'boxing'
-    entry 48, 'floor_climbing'
-    entry 53, 'diving'
+    entry 6, 'walking'
+    entry 8, 'sedentary'
     entry 254, 'all'
 
     dict 'activity_level'

data/lib/fit4ruby/GlobalFitMessages.rb

@@ -642,7 +642,7 @@ module Fit4Ruby
     field 83, 'uint16', 'vertical_ratio', :scale => 100, :unit => '%' # guessed
     field 84, 'uint16', 'gct_balance', :scale => 100, :unit => '%' # guessed
     field 85, 'uint16', 'stride_length', :scale => 10000, :unit => 'm' # guessed
-    field 87, 'uint16', 'undefined_value_87' # first seen on F3 FW6.80
+    field 87, 'uint16', 'stroke_distance', :scale => 100, :unit => 'm'
     field 88, 'uint16', 'undefined_value_88' # first seen on F3HR FW3.60
     field 90, 'sint8', 'performance_condition' # guessed
     field 100, 'sint32', 'undocumented_field_100'
@@ -817,7 +817,7 @@ module Fit4Ruby
     message 34, 'activity'
     field 0, 'uint32', 'total_timer_time', :type => 'duration',  :scale => 1000
     field 1, 'uint16', 'num_sessions'
-    field 2, 'enum', 'type', :dict => 'activity_type'
+    field 2, 'enum', 'type', :dict => 'activity'
     field 3, 'enum', 'event', :dict => 'event'
     field 4, 'enum', 'event_type', :dict => 'event_type'
     field 5, 'uint32', 'local_timestamp', :type => 'date_time'
@@ -1115,14 +1115,19 @@ module Fit4Ruby
     field 73, 'uint16z', 'undocumented_field_73'
     field 254, 'uint16', 'message_index'
 
-    # Not part of the official ANT SDK doc.
-    message 160, 'undocumented_160'
-    field 3, 'uint32', 'undocumented_field_3'
-    field 4, 'uint32', 'undocumented_field_4'
+    message 160, 'gps_metadata'
+    field 0, 'uint16', 'timestamp_ms'
+    field 1, 'sint32', 'position_lat'
+    field 2, 'sint32', 'position_long'
+    field 3, 'uint32', 'enhanced_altitude', :scale => 5, :offset => 500, :unit => 'm'
+    field 4, 'uint32', 'enhanced_speed', :unit => 'm/s', :scale => 1000
+    field 5, 'uint16', 'heading', :unit => 'degrees', :scale => 100
+    field 6, 'uint32', 'utc_timestamp', :type => 'date_time'
+    field 7, 'sint16', 'velocity', :array => true, :scale => 100, :unit => 'm/s'
+    field 253, 'uint32', 'timestamp', :type => 'date_time'
 
-    # Not part of the official ANT SDK doc.
-    message 188, 'undocumented_188'
-    field 0, 'enum', 'undocumented_field_0'
+    message 188, 'ohr_settings'
+    field 0, 'enum', 'switch'
     field 253, 'uint32', 'timestamp', :type => 'date_time'
 
     message 206, 'field_description'
@@ -1263,6 +1268,24 @@ module Fit4Ruby
     field 252, 'uint8', 'undocumented_field_252'
     field 253, 'uint32', 'timestamp', :type => 'date_time'
 
+    # Not part of the official ANT SDK doc.
+    message 312, 'undocumented_312'
+    field 0, 'enum', 'undocumented_field_0'
+    field 9, 'uint32', 'interval_start', :type => 'date_time'
+    field 15, 'uint8', 'min_heart_rate', :unit => 'bpm'
+    field 16, 'uint8', 'max_heart_rate', :unit => 'bpm'
+    field 21, 'sint32', 'position_lat', :type => 'coordinate'
+    field 22, 'sint32', 'position_long', :type => 'coordinate'
+    field 27, 'uint32', 'interval_end', :type => 'date_time'
+    field 32, 'sint8', 'avg_temperature', :unit => 'C'
+    field 33, 'sint8', 'max_temperature', :unit => 'C'
+    field 34, 'sint8', 'min_temperature', :unit => 'C'
+    field 37, 'uint16', 'undocumented_field_37'
+    field 38, 'uint16', 'undocumented_field_38'
+    field 39, 'uint16', 'undocumented_field_39'
+    field 253, 'uint32', 'timestamp', :type => 'date_time'
+    field 254, 'uint16', 'message_index'
+
     # Not part of the official ANT SDK doc.
     message 325, 'undocumented_325'
     field 0, 'uint8', 'undocumented_field_0'
@@ -1305,4 +1328,3 @@ module Fit4Ruby
   end
 
 end
-

data/lib/fit4ruby/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fit4ruby
 version: !ruby/object:Gem::Version
-  version: 3.10.0
+  version: 3.11.0
 platform: ruby
 authors:
 - Chris Schlaeger
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-14 00:00:00.000000000 Z
+date: 2023-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata
@@ -178,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
@@ -186,15 +186,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
-signing_key:
+rubygems_version: 3.4.10
+signing_key: 
 specification_version: 4
 summary: Library to read and write GARMIN FIT files.
 test_files: