postrunner 0.3.0 → 0.4.0

data/lib/postrunner/SleepCycle.rb

@@ -0,0 +1,198 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = SleepCycle.rb -- PostRunner - Manage the data from your Garmin sport devices.
+#
+# Copyright (c) 2016 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 PostRunner
+
+  # A SleepPhase is a segment of a sleep cycle. It captures the start and
+  # end time as well as the kind of phase.
+  class SleepPhase
+
+    attr_reader :from_time, :to_time, :phase
+
+    # Create a new sleep phase.
+    # @param from_time [Time] Start time of the phase
+    # @param to_time [Time] End time of the phase
+    # @param phase [Symbol] The kind of phase [ :rem, :nrem1, :nrem2, :nrem3 ]
+    def initialize(from_time, to_time, phase)
+      @from_time = from_time
+      @to_time = to_time
+      @phase = phase
+    end
+
+    # Duration of the phase in seconds.
+    # @return [Fixnum] duration
+    def duration
+      @to_time - @from_time
+    end
+
+  end
+
+  # A sleep cycle consists of several sleep phases. This class is used to
+  # gather and store the relevant data of a sleep cycle. Data is analzyed and
+  # stored with a one minute granularity. Time values are stored as minutes
+  # past the zero_idx_time.
+  class SleepCycle
+
+    attr_reader :total_seconds, :totals
+    attr_accessor :start_idx, :end_idx,
+                  :high_low_trans_idx, :low_high_trans_idx,
+                  :prev_cycle, :next_cycle
+
+    # Create a new SleepCycle record.
+    # @param zero_idx_time [Time] This is the time of the 0-th minute. All
+    #        time values are stored as minutes past this time.
+    # @param start_idx [Fixnum] Time when the sleep cycle starts. We may start
+    #        with an appromated value that gets fine tuned later on.
+    # @param prev_cycle [SleepCycle] A reference to the preceding sleep cycle
+    #        or nil if this is the first cycle of the analyzed period.
+    def initialize(zero_idx_time, start_idx, prev_cycle = nil)
+      @zero_idx_time = zero_idx_time
+      @start_idx = start_idx
+      # These values will be determined later.
+      @end_idx = nil
+      # Every sleep cycle has at most one high/low heart rate transition and
+      # one low/high transition. These variables store the time of these
+      # transitions or nil if the transition does not exist. Every cycle must
+      # have at least one of these transitions to be a valid cycle.
+      @high_low_trans_idx = @low_high_trans_idx = nil
+      @prev_cycle = prev_cycle
+      # Register this cycle as successor of the previous cycle.
+      prev_cycle.next_cycle = self if prev_cycle
+      @next_cycle = nil
+      # Array holding the sleep phases of this cycle
+      @phases = []
+      # A hash with the total durations (in secods) of the various sleep
+      # phases.
+      @total_seconds = Hash.new(0)
+    end
+
+    # The start time of the cycle as Time object
+    # @return [Time]
+    def from_time
+      idx_to_time(@start_idx)
+    end
+
+    # The end time of the cycle as Time object.
+    # @return [Time]
+    def to_time
+      idx_to_time(@end_idx + 1)
+    end
+
+    # Remove this cycle from the cycle chain.
+    def unlink
+      @prev_cycle.next_cycle = @next_cycle if @prev_cycle
+      @next_cycle.prev_cycle = @prev_cycle if @next_cycle
+    end
+
+    # Initially, we use the high/low heart rate transition to mark the end
+    # of the cycle. But it's really the end of the REM phase that marks the
+    # end of a sleep cycle. If we find a REM phase, we use its end to adjust
+    # the sleep cycle boundaries.
+    # @param phases [Array] List of symbols that describe the sleep phase at
+    #        at the minute corresponding to the Array index.
+    def adjust_cycle_boundaries(phases)
+      end_of_rem_phase_idx = nil
+      @start_idx.upto(@end_idx) do |i|
+        end_of_rem_phase_idx = i if phases[i] == :rem
+      end
+      if end_of_rem_phase_idx
+        # We have found a REM phase. Adjust the end_idx of this cycle
+        # accordingly.
+        @end_idx = end_of_rem_phase_idx
+        if @next_cycle
+          # If we have a successor phase, we also adjust the start.
+          @next_cycle.start_idx = end_of_rem_phase_idx + 1
+        end
+      end
+    end
+
+    # Gather a list of SleepPhase objects that describe the sequence of sleep
+    # phases in the provided Array.
+    # @param phases [Array] List of symbols that describe the sleep phase at
+    #        at the minute corresponding to the Array index.
+    def detect_phases(phases)
+      @phases = []
+      current_phase = phases[0]
+      current_phase_start = @start_idx
+
+      @start_idx.upto(@end_idx) do |i|
+        if (current_phase && current_phase != phases[i]) || i == @end_idx
+          # We found a transition in the sequence. Create a SleepPhase object
+          # that describes the prepvious segment and add it to the @phases
+          # list.
+          @phases << (p = SleepPhase.new(idx_to_time(current_phase_start),
+                                         idx_to_time(i == @end_idx ? i + 1 : i),
+                                         current_phase))
+          # Add the duration of the phase to the corresponding sum in the
+          # @total_seconds Hash.
+          @total_seconds[current_phase] += p.duration
+
+          # Update the variables that track the start and kind of the
+          # currently read phase.
+          current_phase_start = i
+          current_phase = phases[i]
+        end
+      end
+    end
+
+    # Check if this cycle is really a sleep cycle or not. A sleep cycle must
+    # have at least one deep sleep phase or must be part of a directly
+    # attached series of cycles that contain a deep sleep phase.
+    # @return [Boolean] True if not a sleep cycle, false otherwise.
+    def is_wake_cycle?
+      !has_deep_sleep_phase? && !has_leading_deep_sleep_phase? &&
+        !has_trailing_deep_sleep_phase?
+    end
+
+
+    # Check if the cycle has a deep sleep phase.
+    # @return [Boolean] True of one of the phases is NREM3 phase. False
+    #         otherwise.
+    def has_deep_sleep_phase?
+      # A real deep sleep phase must be at least 10 minutes long.
+      @phases.each do |p|
+        return true if p.phase == :nrem3 && p.duration > 10 * 60
+      end
+
+      false
+    end
+
+    # Check if any of the previous cycles that are directly attached have a
+    # deep sleep cycle.
+    # @return [Boolean] True if it has a leading sleep cycle.
+    def has_leading_deep_sleep_phase?
+      return false if @prev_cycle.nil? || @start_idx != @prev_cycle.end_idx + 1
+
+      @prev_cycle.has_deep_sleep_phase? ||
+        @prev_cycle.has_leading_deep_sleep_phase?
+    end
+
+    # Check if any of the trailing cycles that are directly attached have a
+    # deep sleep cycle.
+    # @return [Boolean] True if it has a trailing sleep cycle.
+    def has_trailing_deep_sleep_phase?
+      return false if @next_cycle.nil? || @end_idx + 1 != @next_cycle.start_idx
+
+      @next_cycle.has_deep_sleep_phase? ||
+        @next_cycle.has_trailing_deep_sleep_phase?
+    end
+
+    private
+
+    def idx_to_time(idx)
+      return nil unless idx
+      @zero_idx_time + 60 * idx
+    end
+
+  end
+
+end

data/lib/postrunner/version.rb

@@ -11,5 +11,5 @@
 #
 
 module PostRunner
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/postrunner.gemspec

@@ -9,7 +9,15 @@ GEM_SPEC = Gem::Specification.new do |spec|
   spec.authors       = ["Chris Schlaeger"]
   spec.email         = ["cs@taskjuggler.org"]
   spec.summary       = %q{Application to manage and analyze Garmin FIT files.}
-  spec.description   = %q{This application will allow you to manage and analyze .FIT files such as those generated by Garmin GPS devices. The application was developed and tested with the Garmin Forerunner 620 and Fenix 3. Other devices may work as well. They need to export the data as USB Mass Storage devices. It is an offline alternative to Garmin Connect.}
+  spec.description   = %q{PostRunner is an application to manage FIT files
+such as those produced by Garmin products like the Forerunner 620 (FR620) and
+Fenix 3 or Fenix 3HR. It allows you to import the files from the device and
+analyze the data. In addition to the common features like plotting pace, heart
+rates, elevation and other captured values it also provides a heart rate
+variability (HRV) analysis. It can also update satellite orbit prediction
+(EPO) data on the device to speed-up GPS fix times. It is an offline alternative
+to Garmin Connect. The software has been developed and tested on Linux but
+should work on other operating systems as well.}
   spec.homepage      = 'https://github.com/scrapper/postrunner'
   spec.license       = "GNU GPL version 2"
 
@@ -19,7 +27,7 @@ GEM_SPEC = Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.required_ruby_version = '>=2.0'
 
-  spec.add_dependency 'fit4ruby', '~> 1.0.0'
+  spec.add_dependency 'fit4ruby', '~> 1.1.0'
   spec.add_dependency 'perobs', '~> 2.2'
   spec.add_dependency 'nokogiri', '~> 1.6'
 

data/spec/PostRunner_spec.rb

@@ -209,5 +209,13 @@ describe PostRunner::Main do
     expect(list.index(File.basename(@file3))).to be_nil
   end
 
+  it 'should support the daily command' do
+    postrunner([ 'daily' ])
+  end
+
+  it 'should supoprt the monthly command' do
+    postrunner([ 'monthly' ])
+  end
+
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: postrunner
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Chris Schlaeger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-17 00:00:00.000000000 Z
+date: 2016-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fit4ruby
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: perobs
   requirement: !ruby/object:Gem::Requirement
@@ -108,11 +108,16 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.7
-description: This application will allow you to manage and analyze .FIT files such
-  as those generated by Garmin GPS devices. The application was developed and tested
-  with the Garmin Forerunner 620 and Fenix 3. Other devices may work as well. They
-  need to export the data as USB Mass Storage devices. It is an offline alternative
-  to Garmin Connect.
+description: |-
+  PostRunner is an application to manage FIT files
+  such as those produced by Garmin products like the Forerunner 620 (FR620) and
+  Fenix 3 or Fenix 3HR. It allows you to import the files from the device and
+  analyze the data. In addition to the common features like plotting pace, heart
+  rates, elevation and other captured values it also provides a heart rate
+  variability (HRV) analysis. It can also update satellite orbit prediction
+  (EPO) data on the device to speed-up GPS fix times. It is an offline alternative
+  to Garmin Connect. The software has been developed and tested on Linux but
+  should work on other operating systems as well.
 email:
 - cs@taskjuggler.org
 executables:
@@ -135,6 +140,7 @@ files:
 - lib/postrunner/ActivityView.rb
 - lib/postrunner/BackedUpFile.rb
 - lib/postrunner/ChartView.rb
+- lib/postrunner/DailyMonitoringAnalyzer.rb
 - lib/postrunner/DailySleepAnalyzer.rb
 - lib/postrunner/DataSources.rb
 - lib/postrunner/DeviceList.rb
@@ -152,6 +158,7 @@ files:
 - lib/postrunner/Log.rb
 - lib/postrunner/Main.rb
 - lib/postrunner/MonitoringDB.rb
+- lib/postrunner/MonitoringStatistics.rb
 - lib/postrunner/NavButtonRow.rb
 - lib/postrunner/PagingButtons.rb
 - lib/postrunner/Percentiles.rb
@@ -160,7 +167,7 @@ files:
 - lib/postrunner/RecordListPageView.rb
 - lib/postrunner/RuntimeConfig.rb
 - lib/postrunner/Schema.rb
-- lib/postrunner/SleepStatistics.rb
+- lib/postrunner/SleepCycle.rb
 - lib/postrunner/TrackView.rb
 - lib/postrunner/UserProfileView.rb
 - lib/postrunner/View.rb

data/lib/postrunner/SleepStatistics.rb

@@ -1,117 +0,0 @@
-#!/usr/bin/env ruby -w
-# encoding: UTF-8
-#
-# = SleepStatistics.rb -- PostRunner - Manage the data from your Garmin sport devices.
-#
-# Copyright (c) 2016 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'
-
-require 'postrunner/DailySleepAnalyzer'
-require 'postrunner/FlexiTable'
-
-module PostRunner
-
-  # This class can be used to generate reports for sleep data. It uses the
-  # DailySleepAnalyzer class to compute the data and generates the report for
-  # a certain time period.
-  class SleepStatistics
-
-    include Fit4Ruby::Converters
-
-    # Create a new SleepStatistics object.
-    # @param monitoring_files [Array of Fit4Ruby::Monitoring_B] FIT files
-    def initialize(monitoring_files)
-      @monitoring_files = monitoring_files
-    end
-
-    # Generate a report for a certain day.
-    # @param day [String] Date of the day as YYYY-MM-DD string.
-    def daily(day)
-      analyzer = DailySleepAnalyzer.new(@monitoring_files, day)
-
-      if analyzer.sleep_intervals.empty?
-        return 'No sleep data available for this day'
-      end
-
-      ti = FlexiTable.new
-      ti.head
-      ti.row([ 'From', 'To', 'Sleep phase' ])
-      ti.body
-      utc_offset = analyzer.utc_offset
-      analyzer.sleep_intervals.each do |i|
-        ti.cell(i[:from_time].localtime(utc_offset).strftime('%H:%M'))
-        ti.cell(i[:to_time].localtime(utc_offset).strftime('%H:%M'))
-        ti.cell(i[:phase])
-        ti.new_row
-      end
-
-      tt = FlexiTable.new
-      tt.head
-      tt.row([ 'Total Sleep', 'Deep Sleep', 'Light Sleep' ])
-      tt.body
-      tt.cell(secsToHM(analyzer.total_sleep), { :halign => :right })
-      tt.cell(secsToHM(analyzer.deep_sleep), { :halign => :right })
-      tt.cell(secsToHM(analyzer.light_sleep), { :halign => :right })
-      tt.new_row
-
-      "Sleep Statistics for #{day}\n\n#{ti}\n#{tt}"
-    end
-
-    def monthly(day)
-      day_as_time = Time.parse(day)
-      year = day_as_time.year
-      month = day_as_time.month
-      last_day_of_month = Date.new(year, month, -1).day
-
-      t = FlexiTable.new
-      left = { :halign => :left }
-      right = { :halign => :right }
-      t.set_column_attributes([ left, right, right, right ])
-      t.head
-      t.row([ 'Date', 'Total Sleep', 'Deep Sleep', 'Light Sleep' ])
-      t.body
-      totals = Hash.new(0)
-      counted_days = 0
-
-      1.upto(last_day_of_month).each do |dom|
-        day_str = Time.new(year, month, dom).strftime('%Y-%m-%d')
-        t.cell(day_str)
-
-        analyzer = DailySleepAnalyzer.new(@monitoring_files, day_str)
-
-        if analyzer.sleep_intervals.empty?
-          t.cell('-')
-          t.cell('-')
-          t.cell('-')
-        else
-          totals[:total_sleep] += analyzer.total_sleep
-          totals[:deep_sleep] += analyzer.deep_sleep
-          totals[:light_sleep] += analyzer.light_sleep
-          counted_days += 1
-
-          t.cell(secsToHM(analyzer.total_sleep))
-          t.cell(secsToHM(analyzer.deep_sleep))
-          t.cell(secsToHM(analyzer.light_sleep))
-        end
-        t.new_row
-      end
-      t.foot
-      t.cell('Averages')
-      t.cell(secsToHM(totals[:total_sleep] / counted_days))
-      t.cell(secsToHM(totals[:deep_sleep] / counted_days))
-      t.cell(secsToHM(totals[:light_sleep] / counted_days))
-      t.new_row
-
-      "Sleep Statistics for #{day_as_time.strftime('%B')} #{year}\n\n#{t}"
-    end
-
-  end
-
-end
-