fit4ruby 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e5c32929d16d07a0fe95c04cd7699e56a8067a4
-  data.tar.gz: 2315ae4059cf64dc4cd7d0eeb02c6c42ec5cde26
+  metadata.gz: 2b2445f82a3a5c423df2e01cf21fdddd2c77322e
+  data.tar.gz: 5e51fe986b7b3fa1435a5b6f0dd8b475d6091c47
 SHA512:
-  metadata.gz: 66f5efa6875e7a10f79d304730a767c6bf0d330c3c4e0ce6adf297ff3ea8e440281c548f1064f0c42bf27891a001d70caf3a06980b8dfd7a15bc1536f36a78e6
-  data.tar.gz: 4cb6346d5f3bfee72c1f23f3d7c567612731824842896cf64302549f39e1b7285aca67a3e8298826befb3a7c54af66dd1309f3298cea2c184cbc3af1d9afe9e4
+  metadata.gz: f11797d8a21e49791b04b5299d76e5ae7a14f110f38a7841aaffd5fc0b4e5d3471143c75b1b4f8d8f7e03051759e97bf96b8b370bedcfecee168f7240bad2cd0
+  data.tar.gz: 695da88503d5a491f5a4b50d6ed0334f18cf53fbdeaeba0a6a6c7f4ed1de501dea491745ffb8e86415fd858691f2cd02612f1abd778765657dbde47632d69fae

data/lib/fit4ruby.rb

@@ -18,8 +18,8 @@ module Fit4Ruby
     FitFile.new.read(file, filter)
   end
 
-  def self.write(file, activity)
-    FitFile.new.write(file, activity)
+  def self.write(file, top_level_record)
+    FitFile.new.write(file, top_level_record)
   end
 
 end

data/lib/fit4ruby/Activity.rb

@@ -99,7 +99,7 @@ module Fit4Ruby
     # @return recovery time in seconds.
     def recovery_time
       @events.each do |e|
-        return e.data if e.event == 'recovery_time'
+        return e.recovery_time if e.event == 'recovery_time'
       end
 
       nil
@@ -109,7 +109,7 @@ module Fit4Ruby
     # based on multiple previous activities.
     def vo2max
       @events.each do |e|
-        return e.data if e.event == 'vo2max'
+        return e.vo2max if e.event == 'vo2max'
       end
 
       nil
@@ -120,6 +120,11 @@ module Fit4Ruby
       @sessions[0].sport
     end
 
+    # Returns the sport subtype of this activity.
+    def sub_sport
+      @sessions[0].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

data/lib/fit4ruby/FitDataRecord.rb

@@ -24,9 +24,12 @@ module Fit4Ruby
 
       # Create instance variables that correspond to every field of the
       # corresponding FIT data record.
-      @message.fields.each do |field_number, field|
-        create_instance_variable(field.name)
+      @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.
       @meta_field_units = {}
       @timestamp = Time.now
     end
@@ -40,17 +43,18 @@ module Fit4Ruby
     def set(name, value)
       ivar_name = '@' + name
       unless instance_variable_defined?(ivar_name)
-        Log.warn("Unknown FIT record field '#{ivar_name}'")
+        Log.warn("Unknown FIT record field '#{name}' in global message " +
+                 "#{@message.name} (#{@message.number}).")
         return
       end
-      instance_variable_set('@' + name, value)
+      instance_variable_set(ivar_name, value)
     end
 
     def get(name)
       ivar_name = '@' + name
       return nil unless instance_variable_defined?(ivar_name)
 
-      instance_variable_get('@' + name)
+      instance_variable_get(ivar_name)
     end
 
     def get_as(name, to_unit)
@@ -60,7 +64,7 @@ module Fit4Ruby
       if @meta_field_units.include?(name)
         unit = @meta_field_units[name]
       else
-        field = @message.find_by_name(name)
+        field = @message.fields_by_name[name]
         unless (unit = field.opts[:unit])
           Log.fatal "Field #{name} has no unit"
         end
@@ -70,15 +74,15 @@ module Fit4Ruby
     end
 
     def ==(fdr)
-      @message.fields.each do |field_number, field|
-        ivar_name = '@' + field.name
+      @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)))
 
         unless v1 == v2
-          Log.error "#{field.name}: #{v1} != #{v2}"
+          Log.error "#{name}: #{v1} != #{v2}"
           return false
         end
       end
@@ -91,16 +95,22 @@ module Fit4Ruby
     end
 
     def write(io, id_mapper)
-      global_message_number = @message.number
+      # 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)
 
       # Map the global message number to the current local message number.
-      unless (local_message_number = id_mapper.get_local(global_message_number))
+      unless (local_message_number = id_mapper.get_local(global_fit_message))
         # If the current dictionary does not contain the global message
         # number, we need to create a new entry for it. The index in the
         # dictionary is the local message number.
-        local_message_number = id_mapper.add_global(global_message_number)
+        local_message_number = id_mapper.add_global(global_fit_message)
         # Write the definition of the global message number to the file.
-        @message.write(io, local_message_number)
+        global_fit_message.write(io, local_message_number)
       end
 
       # Write data record header.
@@ -112,7 +122,7 @@ module Fit4Ruby
 
       # Create a BinData::Struct object to store the data record.
       fields = []
-      @message.fields.each do |field_number, field|
+      global_fit_message.fields_by_number.each do |field_number, field|
         bin_data_type = FitDefinitionField.fit_type_to_bin_data(field.type)
         fields << [ bin_data_type, field.name ]
       end
@@ -120,7 +130,7 @@ module Fit4Ruby
 
       # Fill the BinData::Struct object with the values from the corresponding
       # instance variables.
-      @message.fields.each do |field_number, field|
+      global_fit_message.fields_by_number.each do |field_number, field|
         iv = "@#{field.name}"
         if instance_variable_defined?(iv) &&
            !(iv_value = instance_variable_get(iv)).nil?
@@ -139,7 +149,7 @@ module Fit4Ruby
 
     def inspect
       fields = {}
-      @message.fields.each do |field_number, field|
+      @message.fields_by_name.each do |name, field|
         ivar_name = '@' + field.name
         fields[field.name] = instance_variable_get(ivar_name)
       end

data/lib/fit4ruby/FitDefinition.rb

@@ -15,6 +15,13 @@ require 'fit4ruby/FitDefinitionField'
 
 module Fit4Ruby
 
+  # The FitDefinition contains the blueprints for FitMessageRecord segments of
+  # FIT files. Before a message record can occur in a FIT file, its definition
+  # must be included in the FIT file. The definition holds enough information
+  # about the message record to define its size. It also contains some basic
+  # information how to interpret the data in the record. To fully understand
+  # the message record data the full definition in the GlobalFitMessage is
+  # required.
   class FitDefinition < BinData::Record
 
     hide :reserved
@@ -33,11 +40,14 @@ module Fit4Ruby
     end
 
     def check
+      if architecture.snapshot > 1
+        Log.error "Illegal architecture value #{architecture.snapshot}"
+      end
       fields.each { |f| f.check }
     end
 
     def setup(fit_message_definition)
-      fit_message_definition.fields.each do |number, f|
+      fit_message_definition.fields_by_number.each do |number, f|
         fdf = FitDefinitionField.new
         fdf.field_definition_number = number
         fdf.set_type(f.type)

data/lib/fit4ruby/FitDefinitionField.rb

@@ -17,6 +17,11 @@ require 'fit4ruby/GlobalFitMessage'
 
 module Fit4Ruby
 
+  # The FitDefinitionField models the part of the FIT file that contains the
+  # template definition for a field of a FitMessageRecord. It should match the
+  # corresponding definition in GlobalFitMessages. In case we don't have a
+  # known entry in GlobalFitMessages we can still read the file since we know
+  # the exact size of the binary records.
   class FitDefinitionField < BinData::Record
 
     @@TypeDefs = [
@@ -28,7 +33,7 @@ module Fit4Ruby
       [ 'uint16', 'uint16', 0xFFFF, 2 ],
       [ 'sint32', 'int32', 0x7FFFFFFF, 4 ],
       [ 'uint32', 'uint32', 0xFFFFFFFF, 4 ],
-      [ 'string', 'stringz', '', 0 ],
+      [ 'string', 'string', '', 0 ],
       [ 'float32', 'float', 0xFFFFFFFF, 4 ],
       [ 'float63', 'double', 0xFFFFFFFF, 4 ],
       [ 'uint8z', 'uint8', 0, 1 ],
@@ -62,9 +67,10 @@ module Fit4Ruby
       @global_message_definition = GlobalFitMessages[@global_message_number]
       field_number = field_definition_number.snapshot
       if @global_message_definition &&
-         (field = @global_message_definition.fields[field_number])
-         @name = field.name
-         @type = field.type
+         (field = @global_message_definition.fields_by_number[field_number])
+         @name = field.respond_to?('name') ? field.name :
+                                             "choice_#{field_number}"
+         @type = field.respond_to?('type') ? field.type : nil
 
          if @type && (td = @@TypeDefs[base_type_number]) && td[0] != @type
            Log.warn "#{@global_message_number}:#{@name} must be of type " +
@@ -88,11 +94,19 @@ module Fit4Ruby
       value = nil if value == undefined_value
 
       field_number = field_definition_number.snapshot
-      if @global_message_definition &&
-         (field = @global_message_definition.fields[field_number])
-        field.to_machine(value)
+      if value.kind_of?(Array)
+        ary = []
+        value.each { |v| ary << to_machine(v) }
+        ary
       else
-        value
+        if @global_message_definition &&
+           (field = @global_message_definition.
+            fields_by_number[field_number]) &&
+           field.respond_to?('to_machine')
+          field.to_machine(value)
+        else
+          value
+        end
       end
     end
 
@@ -100,12 +114,18 @@ module Fit4Ruby
       init unless @global_message_number
       value = nil if value == undefined_value
 
-      field_number = field_definition_number.snapshot
-      if @global_message_definition &&
-         (field = @global_message_definition.fields[field_number])
-        field.to_s(value)
+      if value.kind_of?(Array)
+        s = '[ '
+        value.each { |v| s << to_s(v) + ' ' }
+        s + ']'
       else
-        "[#{value.to_s}]"
+        field_number = field_definition_number.snapshot
+        if @global_message_definition &&
+           (field = @global_message_definition.fields_by_number[field_number])
+          field.to_s(value)
+        else
+          "[#{value.to_s}]"
+        end
       end
     end
 
@@ -117,19 +137,41 @@ module Fit4Ruby
     end
 
     def type(fit_type = false)
-      if @@TypeDefs.length <= base_type_number.snapshot
-        Log.fatal "Unknown FIT Base type #{base_type_number.snapshot}"
+      check_fit_base_type
+      @@TypeDefs[base_type_number.snapshot][fit_type ? 0 : 1]
+    end
+
+    def is_array?
+      if total_bytes > base_type_bytes
+        if total_bytes % base_type_bytes != 0
+          Log.fatal "Total bytes (#{total_bytes}) must be multiple of " +
+                    "base type bytes (#{base_type_bytes})."
+        end
+        return true
       end
+      false
+    end
 
-      @@TypeDefs[base_type_number.snapshot][fit_type ? 0 : 1]
+    def total_bytes
+      self.byte_count.snapshot
+    end
+
+    def base_type_bytes
+      check_fit_base_type
+      @@TypeDefs[base_type_number.snapshot][3]
     end
 
     def undefined_value
+      check_fit_base_type
+      @@TypeDefs[base_type_number.snapshot][2]
+    end
+
+    private
+
+    def check_fit_base_type
       if @@TypeDefs.length <= base_type_number.snapshot
         Log.fatal "Unknown FIT Base type #{base_type_number.snapshot}"
       end
-
-      @@TypeDefs[base_type_number.snapshot][2]
     end
 
   end

data/lib/fit4ruby/FitFile.rb

@@ -3,7 +3,7 @@
 #
 # = FitFile.rb -- Fit4Ruby - FIT file processing library for Ruby
 #
-# Copyright (c) 2014 by Chris Schlaeger <cs@taskjuggler.org>
+# Copyright (c) 2014, 2015 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,6 +12,7 @@
 
 require 'fit4ruby/Log'
 require 'fit4ruby/FitHeader'
+require 'fit4ruby/FitFileEntity'
 require 'fit4ruby/FitRecord'
 require 'fit4ruby/FitFilter'
 require 'fit4ruby/FitMessageIdMapper'
@@ -39,7 +40,7 @@ module Fit4Ruby
 
       check_crc(io, header.end_pos)
 
-      activity = Activity.new
+      entity = FitFileEntity.new
       # This Array holds the raw data of the records that may be needed to
       # dump a human readable form of the FIT file.
       records = []
@@ -48,7 +49,7 @@ module Fit4Ruby
       record_counters = Hash.new { 0 }
       while io.pos < header.end_pos
         record = FitRecord.new(definitions)
-        record.read(io, activity, filter, record_counters)
+        record.read(io, entity, filter, record_counters)
         records << record if filter
       end
 
@@ -57,11 +58,11 @@ module Fit4Ruby
       header.dump if filter && filter.record_numbers.nil?
       dump_records(records) if filter
 
-      activity.check
-      activity
+      entity.check
+      entity.top_level_record
     end
 
-    def write(file_name, activity)
+    def write(file_name, top_level_record)
       begin
         io = ::File.open(file_name, 'wb+')
       rescue StandardError => e
@@ -74,7 +75,7 @@ module Fit4Ruby
       # Move the pointer behind the header section.
       io.seek(start_pos)
       id_mapper = FitMessageIdMapper.new
-      activity.write(io, id_mapper)
+      top_level_record.write(io, id_mapper)
       end_pos = io.pos
 
       crc = write_crc(io, start_pos, end_pos)

data/lib/fit4ruby/FitFileEntity.rb

@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = FitMessageRecord.rb -- Fit4Ruby - FIT file processing library for Ruby
+#
+# Copyright (c) 2015 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.
+#
+
+require 'fit4ruby/Activity'
+
+module Fit4Ruby
+
+  # The FIT file is a generic container for all kinds of data. This could be
+  # activity data, config files, workout definitions, etc. All data is stored
+  # in FIT message records. Also the information what kind of FIT file this is
+  # is stored in such a record. When we start reading the file, we actually
+  # don't know what kind of file it is until we find the right record to tell
+  # us. Since we already need to have gathered some information at this point,
+  # we use this utility class to store the read data until we know what Ruby
+  # objec we need to use to store it for later consumption.
+  class FitFileEntity
+
+    attr_reader :top_level_record
+
+    # Create a FitFileEntity.
+    def initialize
+      @top_level_record = nil
+    end
+
+    # Set what kind of FIT file we are dealing with.
+    # @return The Ruby object that will hold the content of the FIT file. It's
+    # a derivative of FitDataRecord.
+    def set_type(type)
+      if @top_level_record
+        Log.fatal "FIT file type has already been set to " +
+                  "#{@top_level_record.class}"
+      end
+      case type
+      when 4, 'activity'
+        @top_level_record = Activity.new
+        @type = 'activity'
+      else
+        Log.error "Unsupported FIT file type #{type}"
+        return nil
+      end
+
+      @top_level_record
+    end
+
+    # Add a new data record to the top-level object.
+    def new_fit_data_record(type)
+      return nil unless @top_level_record
+
+      # We already have a record for the top-level type. Just return it.
+      return @top_level_record if type == @type
+
+      # For all other types, we need to create a new record inside the
+      # top-level record.
+      @top_level_record.new_fit_data_record(type)
+    end
+
+    # Check the consistency of the top-level object.
+    def check
+      return false unless @top_level_record
+      @top_level_record.check
+    end
+
+    # Write the top-level object into a IO stream.
+    def write(io, id_mapper)
+      return unless @top_level_record
+      @top_level_record.write(io, id_mapper)
+    end
+
+  end
+
+end