fit4ruby 3.7.0 → 3.10.0

data/lib/fit4ruby/FitDataRecord.rb

@@ -3,7 +3,7 @@
 #
 # = FitDataRecord.rb -- Fit4Ruby - FIT file processing library for Ruby
 #
-# Copyright (c) 2014, 2015 by Chris Schlaeger <cs@taskjuggler.org>
+# Copyright (c) 2014, 2015, 2020, 2021 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,19 +12,21 @@
 
 require 'fit4ruby/FitMessageIdMapper'
 require 'fit4ruby/GlobalFitMessages.rb'
+require 'fit4ruby/BDFieldNameTranslator'
 
 module Fit4Ruby
 
   class FitDataRecord
 
     include Converters
+    include BDFieldNameTranslator
 
-    RecordOrder = [ 'user_data', 'user_profile',
+    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
+    attr_reader :message, :timestamp
 
     def initialize(record_id)
       @message = GlobalFitMessages.find_by_name(record_id)
@@ -34,6 +36,7 @@ module Fit4Ruby
       @message.fields_by_name.each do |name, field|
         create_instance_variable(name)
       end
+
       # Meta fields are additional fields that are not part of the FIT
       # specification but are convenient to have. These are typcially
       # aggregated or converted values of regular fields.
@@ -58,6 +61,7 @@ module Fit4Ruby
     end
 
     def get(name)
+      # This is a request for a native FIT field.
       ivar_name = '@' + name
       return nil unless instance_variable_defined?(ivar_name)
 
@@ -73,8 +77,7 @@ module Fit4Ruby
       if @meta_field_units.include?(name)
         unit = @meta_field_units[name]
       else
-        field = @message.fields_by_name[name]
-        unless (unit = field.opts[:unit])
+        unless (unit = get_unit_by_name(name))
           Log.fatal "Field #{name} has no unit"
         end
       end
@@ -83,12 +86,13 @@ module Fit4Ruby
     end
 
     def ==(fdr)
-      @message.fields_by_name.each do |name, field|
-        ivar_name = '@' + name
-        v1 = field.fit_to_native(field.native_to_fit(
-          instance_variable_get(ivar_name)))
-        v2 = field.fit_to_native(field.native_to_fit(
-          fdr.instance_variable_get(ivar_name)))
+      @message.each_field(field_values_as_hash) do |number, 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))
 
         return false unless v1 == v2
       end
@@ -104,13 +108,8 @@ module Fit4Ruby
     end
 
     def write(io, id_mapper)
-      # Construct a GlobalFitMessage object that matches exactly the provided
-      # set of fields. It does not contain any AltField objects.
-      fields = {}
-      @message.fields_by_name.each_key do |name|
-        fields[name] = instance_variable_get('@' + name)
-      end
-      global_fit_message = @message.construct(fields)
+      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))
@@ -131,42 +130,96 @@ module Fit4Ruby
 
       # Create a BinData::Struct object to store the data record.
       fields = []
-      global_fit_message.fields_by_number.each do |field_number, field|
-        bin_data_type = FitDefinitionFieldBase.fit_type_to_bin_data(field.type)
-        fields << [ bin_data_type, field.name ]
-      end
-      bd = BinData::Struct.new(:endian => :little, :fields => fields)
+      values = {}
 
       # Fill the BinData::Struct object with the values from the corresponding
       # instance variables.
-      global_fit_message.fields_by_number.each do |field_number, field|
+      global_fit_message.each_field(field_values) do |number, 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 ]
+
         iv = "@#{field.name}"
         if instance_variable_defined?(iv) &&
            !(iv_value = instance_variable_get(iv)).nil?
-          value = field.native_to_fit(iv_value)
+          values[field.name] = field.native_to_fit(iv_value)
         else
           # 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 ] :
+            field.type == 'string' ? '' : value
         end
-        bd[field.name] = value
+
+        # Some field types need special handling.
+        if field.type == 'string'
+          # Zero terminate the string.
+          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 } ]
+        end
+        fields << field_def
+      end
+      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|
+        bd[to_bd_field_name(field.name)] = values[field.name]
       end
 
       # Write the data record to the file.
       bd.write(io)
     end
 
-    def inspect
-      fields = {}
-      @message.fields_by_name.each do |name, field|
+    def export
+      message = {
+        'message' => @message.name,
+        'number' => @message.number,
+        'fields' => {}
+      }
+
+      @message.each_field(field_values_as_hash) do |number, field|
         ivar_name = '@' + field.name
-        fields[field.name] = instance_variable_get(ivar_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),
+            '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
-      fields.inspect
+
+      message
+    end
+
+    def get_unit_by_name(name)
+      field = @message.fields_by_name[name]
+      field.opts[:unit]
     end
 
     private
 
+    def field_values_as_hash
+      # Construct a GlobalFitMessage object that matches exactly the provided
+      # 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)
+      end
+
+      field_values
+    end
+
     def create_instance_variable(name)
       # Create a new instance variable for 'name'. We initialize it with a
       # provided default value or nil.

data/lib/fit4ruby/FitDefinition.rb

@@ -63,9 +63,7 @@ module Fit4Ruby
       super(io)
     end
 
-    def FitDefinitionField::write(io)
-      # We don't support writing developer data fields yet.
-      @@has_developer_data = false
+    def write(io)
       super(io)
     end
 
@@ -77,11 +75,20 @@ module Fit4Ruby
       @@fit_entity
     end
 
-    def setup(fit_message_definition)
+    def setup(fit_message_definition, field_values_by_name)
       fit_message_definition.fields_by_number.each do |number, f|
         fdf = FitDefinitionField.new
         fdf.field_definition_number = number
         fdf.set_type(f.type)
+        value = field_values_by_name[f.name]
+        # For String and Array fields we must adjust the length in the
+        # definition message.
+        if value.is_a?(String) && f.is_string?
+          # String plus 0 byte
+          fdf.set_length(value.bytes.length + 1)
+        elsif value.is_a?(Array) && f.is_array?
+          fdf.set_length(value.length)
+        end
 
         data_fields << fdf
       end

data/lib/fit4ruby/FitDefinitionField.rb

@@ -3,7 +3,7 @@
 #
 # = FitDefinitionField.rb -- Fit4Ruby - FIT file processing library for Ruby
 #
-# Copyright (c) 2014, 2017, 2018 by Chris Schlaeger <cs@taskjuggler.org>
+# Copyright (c) 2014, 2017, 2018, 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
@@ -72,15 +72,15 @@ module Fit4Ruby
       if value.kind_of?(Array)
         ary = []
         value.each { |v| ary << to_machine(v) }
-        ary
+        return ary
       else
         if @global_message_definition &&
            (field = @global_message_definition.
             fields_by_number[field_number]) &&
            field.respond_to?('to_machine')
-          field.to_machine(value)
+          return field.to_machine(value)
         else
-          value
+          return value
         end
       end
     end

data/lib/fit4ruby/FitDefinitionFieldBase.rb

@@ -3,7 +3,7 @@
 #
 # = FitDefinitionFieldBase.rb -- Fit4Ruby - FIT file processing library for Ruby
 #
-# Copyright (c) 2014, 2017 by Chris Schlaeger <cs@taskjuggler.org>
+# Copyright (c) 2014, 2017, 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,7 +30,7 @@ module Fit4Ruby
 
     def set_type(fit_type)
       idx = FIT_TYPE_DEFS.index { |x| x[0] == fit_type }
-      raise "Unknown type #{fit_type}" unless idx
+      raise ArgumentError, "Unknown type #{fit_type}" unless idx
       self.base_type_number = idx
       self.byte_count = FIT_TYPE_DEFS[idx][3]
     end
@@ -39,13 +39,22 @@ module Fit4Ruby
       FIT_TYPE_DEFS[checked_base_type_number][fit_type ? 0 : 1]
     end
 
+    def set_length(count)
+      if (byte_count = FIT_TYPE_DEFS[self.base_type_number][3] * count) > 255
+        raise ArgumentError,
+          "FitDefinitionField byte count too large (#{byte_count})"
+      end
+      self.byte_count = byte_count
+    end
+
     def is_array?
       if total_bytes > base_type_bytes
         if total_bytes % base_type_bytes != 0
-          Log.error "Total bytes (#{total_bytes}) must be multiple of " +
-                    "base type bytes (#{base_type_bytes}) of type " +
-                    "#{base_type_number.snapshot} in Global FIT " +
-                    "Message #{name}."
+          raise RuntimeError,
+            "Total bytes (#{total_bytes}) must be multiple of " +
+            "base type bytes (#{base_type_bytes}) of type " +
+            "#{base_type_number.snapshot} in Global FIT " +
+            "Message #{name}."
         end
         return true
       end

data/lib/fit4ruby/FitDeveloperDataFieldDefinition.rb

@@ -48,7 +48,7 @@ module Fit4Ruby
     def find_field_definition
       return @field_definition if @field_definition
 
-      tlr = parent.parent.fit_entity.top_level_record
+      tlr = parent.parent.fit_entity
       @field_definition = tlr.field_descriptions.find do |fd|
         fd.field_definition_number == field_number.snapshot &&
           fd.developer_data_index == developer_data_index.snapshot

data/lib/fit4ruby/FitFile.rb

@@ -81,6 +81,8 @@ module Fit4Ruby
         io.close
       end
 
+      return nil if entities.empty?
+
       entities[0].top_level_record
     end
 

data/lib/fit4ruby/FitMessageRecord.rb

@@ -3,7 +3,8 @@
 #
 # = FitMessageRecord.rb -- Fit4Ruby - FIT file processing library for Ruby
 #
-# Copyright (c) 2014, 2015, 2018, 2019 by Chris Schlaeger <cs@taskjuggler.org>
+# Copyright (c) 2014, 2015, 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
@@ -15,6 +16,7 @@ require 'fit4ruby/Log'
 require 'fit4ruby/GlobalFitMessage'
 require 'fit4ruby/FitFileEntity'
 require 'fit4ruby/DumpedField'
+require 'fit4ruby/BDFieldNameTranslator'
 
 module Fit4Ruby
 
@@ -26,6 +28,8 @@ module Fit4Ruby
   # decendents are used.
   class FitMessageRecord
 
+    include BDFieldNameTranslator
+
     attr_reader :global_message_number, :name, :message_record
 
     def initialize(definition)
@@ -44,15 +48,9 @@ module Fit4Ruby
     def read(io, entity, filter = nil, fields_dump = nil, fit_entity)
       @message_record.read(io)
 
-      # Check if we have a developer defined message for this global message
-      # number.
-      if fit_entity.top_level_record
-        developer_fields = fit_entity.top_level_record.field_descriptions
-        @dfm = developer_fields[@global_message_number]
-      end
-
       if @name == 'file_id'
-        unless (entity_type = @message_record['type'].snapshot)
+        # Caveat: 'type' is used as '_type' in BinData fields!
+        unless (entity_type = @message_record['_type'].snapshot)
           Log.fatal "Corrupted FIT file: file_id record has no type definition"
         end
         entity.set_type(entity_type)
@@ -70,14 +68,18 @@ module Fit4Ruby
           f1alt ? 1 : -1
       end
 
-      #(sorted_fields + @definition.developer_fields).each do |field|
       sorted_fields.each do |field|
-        value = @message_record[field.name].snapshot
+        value = @message_record[to_bd_field_name(field.name)].snapshot
         # Strings are null byte terminated. There may be more bytes in the
         # file, but we have to discard all bytes from the first null byte
         # onwards.
-        if value.is_a?(String) && (null_byte = value.index("\0"))
-          value = null_byte == 0 ? '' : value[0..(null_byte - 1)]
+        if value.is_a?(String)
+          if (null_byte = value.index("\0"))
+            value = null_byte == 0 ? '' : value[0..(null_byte - 1)]
+          end
+          if value.empty?
+            value = nil
+          end
         end
 
         field_name, field_def = get_field_name_and_global_def(field, obj)
@@ -86,8 +88,8 @@ module Fit4Ruby
         if filter && fields_dump &&
            (filter.field_names.nil? ||
             filter.field_names.include?(field_name)) &&
-           !(((value.respond_to?('count') &&
-               (value.count(field.undefined_value) == value.length)) ||
+           !(((value.is_a?(String) &&
+               (value.count(field.undefined_value.chr) == value.length)) ||
               value == field.undefined_value) && filter.ignore_undef)
           fields_dump << DumpedField.new(
             @global_message_number,
@@ -109,7 +111,7 @@ module Fit4Ruby
           next
         end
 
-        field_name = field_description.field_name
+        field_name = field_description.full_field_name(fit_entity)
         units = field_description.units
         type = field.type
         native_message_number = field_description.native_mesg_num
@@ -118,6 +120,8 @@ module Fit4Ruby
         value = @message_record[field.name].snapshot
         value = nil if value == field.undefined_value
 
+        obj.set(field_name, value) if obj
+
         if filter && fields_dump &&
            (filter.field_names.nil? ||
             filter.field_names.include?(field_name)) &&
@@ -178,7 +182,8 @@ module Fit4Ruby
       fields = []
       (definition.data_fields.to_a +
        definition.developer_fields.to_a).each do |field|
-        field_def = [ field.type, field.name ]
+        field_name = to_bd_field_name(field.name)
+        field_def = [ field.type, field_name ]
 
         # Some field types need special handling.
         if field.type == 'string'
@@ -186,7 +191,7 @@ module Fit4Ruby
           field_def << { :read_length => field.total_bytes }
         elsif field.is_array?
           # For Arrays we have to break them into separte fields.
-          field_def = [ :array, field.name,
+          field_def = [ :array, field_name,
                         { :type => field.type.intern,
                           :initial_length =>
                             field.total_bytes / field.base_type_bytes } ]

data/lib/fit4ruby/FitRecord.rb

@@ -49,7 +49,8 @@ module Fit4Ruby
       if header.normal? && header.message_type.snapshot == 1
         # process definition message
         definition = FitDefinition.read(
-          io, entity, header.developer_data_flag.snapshot, @fit_entity)
+          io, entity, header.developer_data_flag.snapshot,
+          @fit_entity.top_level_record)
         @definitions[local_message_type] = FitMessageRecord.new(definition)
       else
         # process data message

data/lib/fit4ruby/FitTypeDefs.rb

@@ -21,9 +21,9 @@ module Fit4Ruby
     [ 'uint16', 'uint16', 0xFFFF, 2 ],
     [ 'sint32', 'int32', 0x7FFFFFFF, 4 ],
     [ 'uint32', 'uint32', 0xFFFFFFFF, 4 ],
-    [ 'string', 'string', '', 0 ],
+    [ 'string', 'string', 0, 1 ],
     [ 'float32', 'float', 0xFFFFFFFF, 4 ],
-    [ 'float63', 'double', 0xFFFFFFFF, 4 ],
+    [ 'float64', 'double', 0xFFFFFFFFFFFFFFFF, 8 ],
     [ 'uint8z', 'uint8', 0, 1 ],
     [ 'uint16z', 'uint16', 0, 2 ],
     [ 'uint32z', 'uint32', 0, 4 ],