fitreader 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b13b0e9cec601a2943828f9244d10076e753da43
-  data.tar.gz: cd90d88a3e5013561aa54bd5095a783e8e12f610
+  metadata.gz: 1f3601df4b0943ee9cc67d891b2b33b1fc642a00
+  data.tar.gz: 5da9b76426c0ca8a66faba6e86ebbc07bb3fe5b0
 SHA512:
-  metadata.gz: ad56d3370783f45ddea0a4efd35d63a671a92f3142a8c37433ea03c46e3560974d9d0a5f0b35333c6fe2140daac2809746350b4df259cedcaffd2f9002927c9d
-  data.tar.gz: 1eafd2e2412dcaa5922213cda04c24ab491a562539293800da3fdb3ae51a1f9581a327b53594e460f97e858352b1ba8887e24fee730a5a07f738cd6c4a7a9be5
+  metadata.gz: f6103759deab65b385a2e9df51f2ebc842e0a5c7f2dcb51325ecc74c8b20949a14995af44efd96c36dcbfba884f603d8f72685ce86fa730219f641b6e907e83b
+  data.tar.gz: 2ddc4c63af6a6056462defd4e7c29e3e48ff5a5c265bd6360b8333fbd257b1df80c6025445a1a5d0323a0b50e46aec1184641267cd148370eafe75005ece891a

data/fitreader.gemspec

@@ -31,5 +31,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.5"
-  spec.add_development_dependency "pry", '~> 0.10.4'
 end

data/lib/fitreader/data_field.rb

@@ -21,10 +21,15 @@ class DataField < FitObject
 
   attr_reader :raw, :valid
 
-  def initialize(io, d, arch)
-    base = TYPES[d.base_num]
-    char = d.endianness.zero? ? base[:unpack_type] : base[:unpack_type][arch]
-    @raw = read_multiple(io, char, d.size, base[:size])
+  def initialize(io, options)
+    base_num = options[:base_num]
+    size = options[:size]
+    arch = options[:arch]
+
+    base = TYPES[base_num]
+    char = base[:unpack_type]
+    char = char[arch] if char.is_a?(Hash)
+    @raw = read_multiple(io, char, size, base[:size])
     @valid = check(@raw, base[:invalid])
   end
 

data/lib/fitreader/data_record.rb

@@ -4,11 +4,30 @@ class DataRecord < FitObject
   def initialize(io, definition)
     @global_num = definition.global_msg_num
     @fields = Hash[definition.field_definitions.map do |f|
-      [f.field_def_num, DataField.new(io, f, definition.endian)]
+      opts = {base_num: f.base_num,
+              size: f.size,
+              arch: definition.endian}
+      [f.field_def_num, DataField.new(io, opts)]
     end]
+    if definition.dev_defs
+      @dev_fields = Hash[definition.dev_defs.map do |f|
+        opts = {base_num: f.field_def[:base_type_id].raw,
+                size: f.size,
+                arch: definition.endian}
+        [f.field_def[:field_name].raw.to_sym, DataField.new(io, opts)]
+      end]
+    end
   end
 
   def valid
     @fields.select { |_, v| v.valid }
   end
+
+  def dev_fields
+    if defined? @dev_fields
+      @dev_fields
+    else
+      Hash.new
+    end
+  end
 end

data/lib/fitreader/definition_record.rb

@@ -1,16 +1,26 @@
 require_relative 'field_definition.rb'
+require_relative 'dev_field_definition.rb'
 
 class DefinitionRecord < FitObject
-  attr_reader :reserved, :architecture, :global_msg_num, :num_fields, :field_definitions, :data_records, :local_num
+  attr_reader :reserved, :global_msg_num, :num_fields, :field_definitions, :data_records, :local_num, :dev_defs
 
-  def initialize(io, local_num)
+  def initialize(io, local_num, dev_field_defs = nil)
     @local_num = local_num
+
+    # read record
     @reserved = io.readbyte
     @architecture = io.readbyte
     char = @architecture.zero? ? 'v' : 'n'
     @global_msg_num = readbytes(io, char, 2)
-    @num_fields = io.readbyte
+    num_fields = io.readbyte
+
+    # read fields
     @field_definitions = Array.new(num_fields) { FieldDefinition.new(io) }
+
+    unless dev_field_defs.nil?
+      num_fields = io.readbyte
+      @dev_defs = Array.new(num_fields) { DevFieldDefinition.new(io, dev_field_defs) }
+    end
     @data_records = []
   end
 
@@ -22,7 +32,7 @@ class DefinitionRecord < FitObject
     fd = Sdk.fields(@global_msg_num)
     return if fd.nil?
     @data_records.map do |d|
-      d.valid.select { |k, _| fd.keys.include? k }
+      d.valid.select { |k, _| fd.keys.include? k }.merge(d.dev_fields)
     end
   end
 end

data/lib/fitreader/dev_field_definition.rb

@@ -0,0 +1,10 @@
+class DevFieldDefinition < FitObject
+  attr_reader :field_num, :size, :developer_data_index, :field_def
+
+  def initialize(io, field_defs)
+    @field_num = io.readbyte
+    @size = io.readbyte
+    @developer_data_index = io.readbyte
+    @field_def = field_defs[@developer_data_index]
+  end
+end

data/lib/fitreader/fit.rb

@@ -7,6 +7,7 @@ require_relative 'data_field.rb'
 require_relative 'data_record.rb'
 require_relative 'message.rb'
 require_relative 'sdk/sdk.rb'
+require 'pry'
 
 class Fit
   attr_reader :header, :messages
@@ -16,27 +17,40 @@ class Fit
     finished = []
     begin
       defs = {}
-      until (io.pos - 14) >= header.num_record_bytes
+      dev_field_defs = {}
+      # until (io.pos - 14) >= header.num_record_bytes
+      until ((@header.num_record_bytes + 14) - io.pos) == 0
         h = RecordHeader.new(io)
         if h.definition?
-          d = DefinitionRecord.new(io, h.local_message_type)
+          if h.has_dev_defs?
+            d = DefinitionRecord.new(io, h.local_message_type, dev_field_defs)
+          else
+            d = DefinitionRecord.new(io, h.local_message_type)
+          end
           finished << defs[d.local_num] if defs.key? d.local_num
           defs[d.local_num] = d
         elsif h.data?
-          d = defs[h.local_message_type] if d.local_num != h.local_message_type
-          d.data_records << DataRecord.new(io, d)
+          d = defs[h.local_message_type]
+          data_record = DataRecord.new(io, d)
+          if d.global_msg_num == 206
+            dev_field = make_developer_fields(data_record.fields)
+            dev_field_defs[dev_field[:dev_data_idx].raw] = dev_field
+          else
+            d.data_records << data_record
+          end
         else
           # TODO implement timestamps
         end
       end
       finished.push(*defs.values)
+      io.close
+      @messages = finished.group_by(&:global_msg_num)
+                          .map { |x| Message.new x }
+                          .reject { |x| x.data.nil? }
     rescue => e
+      binding.pry
       puts "error: #{e}\n#{e.backtrace}"
     end
-    io.close
-    @messages = finished.group_by(&:global_msg_num)
-                        .map { |x| Message.new x }
-                        .reject { |x| x.data.nil? }
   end
 
   def digest
@@ -46,4 +60,14 @@ class Fit
   def type(name)
     messages.find { |x| x.name == name }
   end
+
+  def make_developer_fields(data_records)
+    lookup = {0 => :dev_data_idx, 1 => :field_def_num, 2 => :base_type_id, 3 => :field_name, 8 => :units}
+    map = {}
+    data_records.each do |k,v|
+      key = lookup[k]
+      map[key] = v
+    end
+    map
+  end
 end

data/lib/fitreader/message.rb

@@ -15,14 +15,16 @@ class Message
   def make_message(definition, fields)
     return if definition.valid.nil?
     definition.valid.map do |d|
-      h = Hash[d.map { |k, v| process_value(fields[k], v.raw) }]
+      sdk_fields = d.select { |k, v| fields.has_key?(k) }
+      h = Hash[sdk_fields.map { |k, v| process_value(fields[k], v.raw) }]
       case @global_num
       when 21
         h = process_event(h)
       when 0, 23
         h = process_deviceinfo(h)
       end
-      h
+      dev_fields = Hash[d.select { |k, v| k.is_a?(Symbol) }.map {|k,v| [k, v.raw]}]
+      h.merge(dev_fields)
     end
   end
 

data/lib/fitreader/record_header.rb

@@ -24,6 +24,10 @@ class RecordHeader < FitObject
     @header_type.zero? && @message_type.zero?
   end
 
+  def has_dev_defs?
+    @message_type_specific == 1
+  end
+
   def timestamp?
     @header_type == 1
   end

data/lib/fitreader/unpack.rb

@@ -1,6 +1,8 @@
 module Unpack
   def readbytes(io, char, len)
-    io.read(len).unpack(char).first
+    d = io.read(len)
+    # binding.pry if char == 'Z*'
+    d.unpack(char).first
   end
 
   def read_multiple(io, char, len, size)

data/lib/fitreader/version.rb

@@ -1,3 +1,3 @@
 module Fitreader
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 end

data/test/fitreader_test.rb

@@ -5,7 +5,62 @@ class FitreaderTest < Minitest::Test
     refute_nil ::Fitreader::VERSION
   end
 
-  def test_it_does_something_useful
-    assert false
+  def test_reads_a_garmin_file
+    path = "test/files/working_garmin.fit"
+    file = File.open(path, "r")
+    fit = Fit.new file
+    digest = {file_id: 1,
+              file_creator: 1,
+              device_settings: 1,
+              user_profile: 1,
+              sensor_info: 5,
+              sport: 1,
+              zones_target: 1,
+              record: 4988,
+              event: 120,
+              device_info: 30,
+              source: 43,
+              segment_lap: 2,
+              lap: 1,
+              session: 1,
+              activity: 1,
+              battery_info: 20}
+    assert_equal fit.digest, digest
+  end
+
+  def test_reads_a_wahoo_file
+    path = "test/files/working_wahoo.fit"
+    file = File.open(path, "r")
+    fit = Fit.new file
+    digest = {file_id: 1,
+              event: 12,
+              device_info: 10,
+              sport: 1,
+              workout: 1,
+              record: 715,
+              mfg_range_min: 5,
+              lap: 1,
+              session: 1,
+              activity: 1}
+    assert_equal fit.digest, digest
+  end
+
+  def test_reads_a_wahoo_file_with_dev_fields
+    path = "test/files/working_wahoo_dev_fields.fit"
+    file = File.open(path, "r")
+    fit = Fit.new file
+    digest = {file_id: 1,
+              developer_data_id: 1,
+              field_description: 1,
+              event: 288,
+              device_info: 139,
+              sport: 1,
+              workout: 1,
+              record: 5652,
+              mfg_range_min: 30,
+              lap: 1,
+              session: 1,
+              activity: 1}
+    assert_equal fit.digest, digest
   end
 end

data/test/manual.rb

@@ -1,6 +1,24 @@
-require 'pry'
 require_relative '../lib/fitreader/fit'
+require 'benchmark/ips'
 
-# f = File.open("../spec/2016-04-09-13-19-18.fit", "r")
-f = File.open("../spec/1471568492.fit", "r")
-fit = Fit.new f
+p = "test/files/working_garmin.fit"
+Benchmark.ips do |x|
+  # Configure the number of seconds used during
+  # the warmup phase (default 2) and calculation phase (default 5)
+  x.config(:time => 30, :warmup => 2)
+
+  # Typical mode, runs the block as many times as it can
+  # x.report("addition") { 1 + 2 }
+
+  # To reduce overhead, the number of iterations is passed in
+  # and the block must run the code the specific number of times.
+  # Used for when the workload is very small and any overhead
+  # introduces incorrectable errors.
+  x.report("single_run") do |times|
+    f = File.open(p, "r")
+    Fit.new f
+  end
+
+  # Compare the iterations per second of the various reports!
+  x.compare!
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fitreader
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Richard Brodie
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-09 00:00:00.000000000 Z
+date: 2017-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.10.4
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.10.4
 description: 
 email:
 - richard@samsari.org
@@ -88,6 +74,7 @@ files:
 - lib/fitreader/data_field.rb
 - lib/fitreader/data_record.rb
 - lib/fitreader/definition_record.rb
+- lib/fitreader/dev_field_definition.rb
 - lib/fitreader/field_definition.rb
 - lib/fitreader/file_header.rb
 - lib/fitreader/fit.rb
@@ -100,8 +87,9 @@ files:
 - lib/fitreader/sdk/sdk.rb
 - lib/fitreader/unpack.rb
 - lib/fitreader/version.rb
-- spec/1471568492.fit
-- spec/2016-04-09-13-19-18.fit
+- test/files/working_garmin.fit
+- test/files/working_wahoo.fit
+- test/files/working_wahoo_dev_fields.fit
 - test/fitreader_test.rb
 - test/manual.rb
 - test/test_helper.rb
@@ -130,8 +118,9 @@ signing_key:
 specification_version: 4
 summary: Library for reading FIT files generated by Garmin devices.
 test_files:
-- spec/1471568492.fit
-- spec/2016-04-09-13-19-18.fit
+- test/files/working_garmin.fit
+- test/files/working_wahoo.fit
+- test/files/working_wahoo_dev_fields.fit
 - test/fitreader_test.rb
 - test/manual.rb
 - test/test_helper.rb