fit4ruby 3.3.0 → 3.8.0

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,18 +53,18 @@ 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
         Log.error "fit_base_type_id #{@fit_base_type_id} is too large"
         return
       end
+
+      # A fit file may include multiple definitions of the same field. We
+      # ignore all subsequent definitions.
+      return if msg.has_field?(full_field_name(fit_entity.top_level_record.
+                                               developer_data_ids))
+
       options = {}
       options[:scale] = @scale if @scale
       options[:offset] = @offset if @offset
@@ -54,7 +72,7 @@ module Fit4Ruby
       options[:unit] = @units
       msg.field(@field_definition_number,
                 FIT_TYPE_DEFS[@fit_base_type_id & 0x7F][1],
-                "_#{@developer_data_index}_#{@field_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

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 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',
                     'device_info', 'data_sources', 'event',
-                    'record', 'lap', 'session', 'heart_rate_zones',
+                    '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.
@@ -50,14 +53,15 @@ module Fit4Ruby
     def set(name, value)
       ivar_name = '@' + name
       unless instance_variable_defined?(ivar_name)
-        Log.warn("Unknown FIT record field '#{name}' in global message " +
-                 "#{@message.name} (#{@message.number}).")
+        Log.debug("Unknown FIT record field '#{name}' in global message " +
+                  "#{@message.name} (#{@message.number}).")
         return
       end
       instance_variable_set(ivar_name, value)
     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
@@ -54,8 +54,8 @@ module Fit4Ruby
       else
         @name = "field#{field_definition_number.snapshot}"
         @type = nil
-        Log.warn { "Unknown field number #{field_definition_number} " +
-                   "in global message #{@global_message_number}" }
+        Log.debug { "Unknown field number #{field_definition_number} " +
+                    "in global message #{@global_message_number}" }
       end
     end
 
@@ -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