fit4ruby 3.3.0 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c76d1a2e0091c4aa84e7e26a381630def4b5e5b0
-  data.tar.gz: 21814b487808a93810dfedf2fe4908d7f9ecf246
+SHA256:
+  metadata.gz: 29f7e7354dfe1a0b9cfa30849b6131693deba24858f7cf6ec0745b923bcbd86a
+  data.tar.gz: 24aa3e37347db57f6e26078118bc20da45692097c395a21ad480702ebb66f0c6
 SHA512:
-  metadata.gz: fbb6bf23b5adadb57b114444de5d067b13273bb73537e76b6a8b6436e61a5fea69af8f619625369ac5c6c9fd13018a31514e3e1662d8437f33ba71b8a52b949e
-  data.tar.gz: 5404ca45effe3b389041a036711c55006c95f304f4afa91a888c2dfda4f38ad2fc55faf450e23791cfd571c6b0c9373865161b881e87e53e268af36e93f130a3
+  metadata.gz: 2638207885da4f16185df8ef71d7999855b2f9199be60d1156727473a855a01039ce0fd36faaa7093696f4576247f78c208c2628df200da2d5761832ebc46142
+  data.tar.gz: a7fd64132dba6d6594e9ade153e1596d66ef7f47c7846f79ad7971240ac8b6dfb0b457474e80dcd369faadc88dc79fee17233a3c3cc4cfe2d40f40f01df28e47

data/Gemfile.lock

@@ -1,15 +1,34 @@
 PATH
   remote: .
   specs:
-    fit4ruby (0.0.1)
-      bindata (>= 2.0.0)
+    fit4ruby (3.3.0)
+      bindata (= 2.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    bindata (2.1.0)
+    bindata (2.3.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
     rake (0.9.6)
-    yard (0.8.7.4)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    yard (0.9.20)
 
 PLATFORMS
   ruby
@@ -17,5 +36,10 @@ PLATFORMS
 DEPENDENCIES
   bundler (>= 1.6.4)
   fit4ruby!
-  rake
-  yard
+  pry (>= 0.12)
+  rake (~> 12.0.0)
+  rspec (>= 3.8)
+  yard (~> 0.9.20)
+
+BUNDLED WITH
+   2.0.2

data/fit4ruby.gemspec

@@ -24,8 +24,10 @@ 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', '~>0.9.6')
+  spec.add_development_dependency('rake', '~>12.0.0')
   spec.add_development_dependency('bundler', '>=1.6.4')
+  spec.add_development_dependency('rspec', '>=3.8')
+  spec.add_development_dependency('pry', '>=0.12')
 end

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
@@ -24,6 +24,7 @@ require 'fit4ruby/UserProfile'
 require 'fit4ruby/PhysiologicalMetrics'
 require 'fit4ruby/Session'
 require 'fit4ruby/Lap'
+require 'fit4ruby/Length'
 require 'fit4ruby/Record'
 require 'fit4ruby/HRV'
 require 'fit4ruby/HeartRateZones'
@@ -32,48 +33,74 @@ require 'fit4ruby/PersonalRecords'
 
 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, :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,
+      :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 = []
-      @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 = []
+      @cur_lap_lengths = []
+
+      @cur_length_records = []
 
       @lap_counter = 1
+      @length_counter = 1
 
       set_field_values(field_values)
     end
@@ -92,11 +119,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')
@@ -141,11 +163,20 @@ module Fit4Ruby
 
       # Laps must have a consecutively growing message index.
       @laps.each.with_index do |lap, index|
-        lap.check(index)
+        lap.check(index, self)
         # If we have heart rate zone records, there should be one for each
         # lap
         @heart_rate_zones[index].check(index) if @heart_rate_zones[index]
       end
+
+      # Lengths must have a consecutively growing message index.
+      @lengths.each.with_index do |length, index|
+        length.check(index)
+        # If we have heart rate zone records, there should be one for each
+        # length
+        @heart_rate_zones[index].check(index) if @heart_rate_zones[index]
+      end
+
       @sessions.each { |s| s.check(self) }
     end
 
@@ -206,17 +237,22 @@ module Fit4Ruby
       d
     end
 
-    # Call this method to update the aggregated data fields stored in Lap and
-    # Session objects.
+    # Call this method to update the aggregated data fields stored in Lap,
+    # Length, and Session objects.
     def aggregate
       @laps.each { |l| l.aggregate }
+      @lengths.each { |l| l.aggregate }
       @sessions.each { |s| s.aggregate }
     end
 
     # Convenience method that averages the speed over all sessions.
     def avg_speed
       speed = 0.0
-      @sessions.each { |s| speed += s.avg_speed if s.avg_speed }
+      @sessions.each do |s|
+        if (spd = s.avg_speed || s.enhanced_avg_speed)
+          speed += spd
+        end
+      end
       speed / @sessions.length
     end
 
@@ -287,13 +323,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
 
-      (@field_descriptions + @developer_data_ids +
-       @device_infos + @sensor_settings +
-       @data_sources + @user_profiles +
-       @physiological_metrics + @events +
-       @sessions + @laps + @records + @heart_rate_zones +
-       @personal_records).sort.each do |s|
+      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
+
+      ary_ivars.sort.each do |s|
         s.write(io, id_mapper)
       end
       super
@@ -404,6 +444,16 @@ module Fit4Ruby
       new_fit_data_record('lap', field_values)
     end
 
+    # Add a new Length to the Activity. All previoulsy added Record objects are
+    # associated with this Length unless they have been associated with another
+    # Length before.
+    # @param field_values [Hash] A Hash that provides initial values for
+    #        certain fields of the FitDataRecord.
+    # @return [Length]
+    def new_length(field_values = {})
+      new_fit_data_record('length', field_values)
+    end
+
     # Add a new HeartRateZones record to the Activity.
     # @param field_values [Heash] A Hash that provides initial values for
     #        certain fields of the FitDataRecord.
@@ -433,18 +483,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.
@@ -490,14 +539,17 @@ 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 = []
       when 'lap'
         record = create_new_lap(field_values)
+      when 'length'
+        record = create_new_length(field_values)
       when 'record'
-        @cur_lap_records << (record = Record.new(field_values))
+        record = Record.new(self, field_values)
+        @cur_lap_records << record
+        @cur_length_records << record
         @records << record
       when 'hrv'
         @hrv << (record = HRV.new(field_values))
@@ -512,19 +564,54 @@ 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, field_values)
+      lap = Lap.new(self, @cur_lap_records, @laps.last,
+                    field_values,
+                    @length_counter, @cur_lap_lengths)
       lap.message_index = @lap_counter - 1
       @lap_counter += 1
       @cur_session_laps << lap
       @laps << lap
       @cur_lap_records = []
+      @cur_lap_lengths = []
 
       lap
     end
 
+    def create_new_length(field_values)
+      length = Length.new(@cur_length_records, @lengths.last, field_values)
+      length.message_index = @length_counter - 1
+      @length_counter += 1
+      @cur_lap_lengths << length
+      @lengths << length
+      @cur_length_records = []
+
+      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/DeviceInfo.rb

@@ -32,6 +32,43 @@ module Fit4Ruby
         @timestamp <=> fdr.timestamp
     end
 
+    def numeric_manufacturer
+      if @manufacturer && @manufacturer.is_a?(String)
+        if @manufacturer[0..17] == 'Undocumented value'
+          return @manufacturer[18..-1].to_i
+        else
+          return GlobalFitDictionaries['manufacturer'].
+            value_by_name(@manufacturer)
+        end
+      end
+
+      Log.fatal "Unexpected @manufacturer (#{@manufacturer}) value"
+    end
+
+    def numeric_product
+      # The numeric product ID must be an integer or nil. In case the
+      # dictionary did not contain an entry for the numeric ID in the fit file
+      # the @garmin_product or @product variables contain a String starting
+      # with 'Undocumented value ' followed by the ID.
+      if @garmin_product && @garmin_product.is_a?(String)
+        if @garmin_product[0..17] == 'Undocumented value'
+          return @garmin_product[18..-1].to_i
+        else
+          return GlobalFitDictionaries['garmin_product'].
+            value_by_name(@garmin_product)
+        end
+      elsif @product && @product.is_a?(String)
+        if @product[0..17] == 'Undocumented value'
+          return @product[18..-1].to_i
+        else
+          return GlobalFitDictionaries['product'].value_by_name(@product)
+        end
+      end
+
+      Log.fatal "Unexpected @product (#{@product}) or " +
+        "@garmin_product (#{@garmin_product}) values"
+    end
+
     def check(index)
       unless @device_index
         Log.fatal 'device info record must have a device_index'