postrunner 0.0.4 → 0.0.5

data/lib/postrunner/ActivitySummary.rb

@@ -0,0 +1,141 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = ActivitySummary.rb -- PostRunner - Manage the data from your Garmin sport devices.
+#
+# Copyright (c) 2014 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/FlexiTable'
+require 'postrunner/ViewWidgets'
+
+module PostRunner
+
+  class ActivitySummary
+
+    include Fit4Ruby::Converters
+    include ViewWidgets
+
+    def initialize(fit_activity, name, unit_system)
+      @fit_activity = fit_activity
+      @name = name
+      @unit_system = unit_system
+    end
+
+    def to_s
+      session = @fit_activity.sessions[0]
+
+      summary(session).to_s + "\n" + laps.to_s
+    end
+
+    def to_html(doc)
+      session = @fit_activity.sessions[0]
+
+      frame(doc, "Activity: #{@name}") {
+        summary(session).to_html(doc)
+      }
+      frame(doc, 'Laps') {
+        laps.to_html(doc)
+      }
+    end
+
+    private
+
+    def summary(session)
+      t = FlexiTable.new
+      t.enable_frame(false)
+      t.body
+      t.row([ 'Date:', session.timestamp])
+      t.row([ 'Distance:',
+              local_value(session, 'total_distance', '%.2f %s',
+                          { :metric => 'km', :statute => 'mi'}) ])
+      t.row([ 'Time:', secsToHMS(session.total_timer_time) ])
+      t.row([ 'Avg. Pace:', pace(session, 'avg_speed') ])
+      t.row([ 'Total Ascent:',
+              local_value(session, 'total_ascent', '%.0f %s',
+                          { :metric => 'm', :statute => 'ft' }) ])
+      t.row([ 'Total Descent:',
+              local_value(session, 'total_descent', '%.0f %s',
+                          { :metric => 'm', :statute => 'ft' }) ])
+      t.row([ 'Calories:', "#{session.total_calories} kCal" ])
+      t.row([ 'Avg. HR:', session.avg_heart_rate ?
+              "#{session.avg_heart_rate} bpm" : '-' ])
+      t.row([ 'Max. HR:', session.max_heart_rate ?
+              "#{session.max_heart_rate} bpm" : '-' ])
+      t.row([ 'Training Effect:', session.total_training_effect ?
+              session.total_training_effect : '-' ])
+      t.row([ 'Avg. Run Cadence:',
+              session.avg_running_cadence ?
+              "#{session.avg_running_cadence.round} spm" : '-' ])
+      t.row([ 'Avg. Vertical Oscillation:',
+              local_value(session, 'avg_vertical_oscillation', '%.1f %s',
+                          { :metric => 'cm', :statute => 'in' }) ])
+      t.row([ 'Avg. Ground Contact Time:',
+              session.avg_stance_time ?
+              "#{session.avg_stance_time.round} ms" : '-' ])
+      t.row([ 'Avg. Stride Length:',
+              local_value(session, 'avg_stride_length', '%.2f %s',
+                          { :metric => 'm', :statute => 'ft' }) ])
+      rec_time = @fit_activity.recovery_time
+      t.row([ 'Recovery Time:', rec_time ? secsToHMS(rec_time * 60) : '-' ])
+      vo2max = @fit_activity.vo2max
+      t.row([ 'VO2max:', vo2max ? vo2max : '-' ])
+
+      t
+    end
+
+    def laps
+      t = FlexiTable.new
+      t.head
+      t.row([ 'Lap', 'Duration', 'Distance', 'Avg. Pace', 'Stride', 'Cadence',
+              'Avg. HR', 'Max. HR' ])
+      t.set_column_attributes(Array.new(8, { :halign => :right }))
+      t.body
+      @fit_activity.sessions[0].laps.each.with_index do |lap, index|
+        t.cell(index + 1)
+        t.cell(secsToHMS(lap.total_timer_time))
+        t.cell(local_value(lap, 'total_distance', '%.2f',
+                           { :metric => 'km', :statute => 'mi' }))
+        t.cell(pace(lap, 'avg_speed', false))
+        t.cell(local_value(lap, 'avg_stride_length', '%.2f',
+                           { :metric => 'm', :statute => 'ft' }))
+        t.cell(lap.avg_running_cadence && lap.avg_fractional_cadence ?
+               '%.1f' % (2 * lap.avg_running_cadence +
+                         (2 * lap.avg_fractional_cadence) / 100.0) : '')
+        t.cell(lap.avg_heart_rate.to_s)
+        t.cell(lap.max_heart_rate.to_s)
+        t.new_row
+      end
+
+      t
+    end
+
+    def local_value(fdr, field, format, units)
+      unit = units[@unit_system]
+      value = fdr.get_as(field, unit)
+      return '-' unless value
+      "#{format % [value, unit]}"
+    end
+
+    def pace(fdr, field, show_unit = true)
+      speed = fdr.get(field)
+      case @unit_system
+      when :metric
+        "#{speedToPace(speed)}#{show_unit ? ' min/km' : ''}"
+      when :statute
+        "#{speedToPace(speed, 1609.34)}#{show_unit ? ' min/mi' : ''}"
+      else
+        Log.fatal "Unknown unit system #{@unit_system}"
+      end
+    end
+
+  end
+
+end
+

data/lib/postrunner/ActivityView.rb

@@ -1,7 +1,21 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = ActivityView.rb -- PostRunner - Manage the data from your Garmin sport devices.
+#
+# Copyright (c) 2014 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/HTMLBuilder'
-require 'postrunner/ActivityReport'
+require 'postrunner/ActivitySummary'
+require 'postrunner/DeviceList'
+require 'postrunner/UserProfileView'
 require 'postrunner/ViewWidgets'
 require 'postrunner/TrackView'
 require 'postrunner/ChartView'
@@ -12,61 +26,28 @@ module PostRunner
 
     include ViewWidgets
 
-    def initialize(activity, output_dir)
+    def initialize(activity, unit_system, predecessor, successor)
       @activity = activity
-      @output_dir = output_dir
+      @unit_system = unit_system
+      @predecessor = predecessor
+      @successor = successor
+      @output_dir = activity.html_dir
       @output_file = nil
 
-      ensure_output_dir
-
       @doc = HTMLBuilder.new
       generate_html(@doc)
       write_file
-      show_in_browser
     end
 
     private
 
-    def ensure_output_dir
-      unless Dir.exists?(@output_dir)
-        begin
-          Dir.mkdir(@output_dir)
-        rescue SystemCallError
-          Log.fatal "Cannot create output directory '#{@output_dir}': #{$!}"
-        end
-      end
-      create_symlink('jquery')
-      create_symlink('flot')
-      create_symlink('openlayers')
-    end
-
-    def create_symlink(dir)
-      # This file should be in lib/postrunner. The 'misc' directory should be
-      # found in '../../misc'.
-      misc_dir = File.realpath(File.join(File.dirname(__FILE__),
-                                         '..', '..', 'misc'))
-      unless Dir.exists?(misc_dir)
-        Log.fatal "Cannot find 'misc' directory under '#{misc_dir}': #{$!}"
-      end
-      src_dir = File.join(misc_dir, dir)
-      unless Dir.exists?(src_dir)
-        Log.fatal "Cannot find '#{src_dir}': #{$!}"
-      end
-      dst_dir = File.join(@output_dir, dir)
-      unless File.exists?(dst_dir)
-        begin
-          FileUtils.ln_s(src_dir, dst_dir)
-        rescue IOError
-          Log.fatal "Cannot create symbolic link to '#{dst_dir}': #{$!}"
-        end
-      end
-    end
-
-
     def generate_html(doc)
-      @report = ActivityReport.new(@activity.fit_activity)
+      @report = ActivitySummary.new(@activity.fit_activity, @activity.name,
+                                    @unit_system)
+      @device_list = DeviceList.new(@activity.fit_activity)
+      @user_profile = UserProfileView.new(@activity.fit_activity, @unit_system)
       @track_view = TrackView.new(@activity)
-      @chart_view = ChartView.new(@activity)
+      @chart_view = ChartView.new(@activity, @unit_system)
 
       doc.html {
         head(doc)
@@ -83,15 +64,19 @@ module PostRunner
                                 'initial-scale=1.0, maximum-scale=1.0, ' +
                                 'user-scalable=0' })
         doc.title("PostRunner Activity: #{@activity.name}")
-        style(doc)
         view_widgets_style(doc)
         @chart_view.head(doc)
         @track_view.head(doc)
+        style(doc)
       }
     end
 
     def style(doc)
       doc.style(<<EOT
+body {
+  font-family: verdana,arial,sans-serif;
+  margin: 0px;
+}
 .main {
   width: 1210px;
   margin: 0 auto;
@@ -104,39 +89,28 @@ module PostRunner
   float: right;
   width: 600px;
 }
-.widget_container {
-	box-sizing: border-box;
-	width: 600px;
-	padding: 10px 15px 15px 15px;
-	margin: 15px auto 15px auto;
-	border: 1px solid #ddd;
-	background: #fff;
-	background: linear-gradient(#f6f6f6 0, #fff 50px);
-	background: -o-linear-gradient(#f6f6f6 0, #fff 50px);
-	background: -ms-linear-gradient(#f6f6f6 0, #fff 50px);
-	background: -moz-linear-gradient(#f6f6f6 0, #fff 50px);
-	background: -webkit-linear-gradient(#f6f6f6 0, #fff 50px);
-	box-shadow: 0 3px 10px rgba(0,0,0,0.15);
-	-o-box-shadow: 0 3px 10px rgba(0,0,0,0.1);
-	-ms-box-shadow: 0 3px 10px rgba(0,0,0,0.1);
-	-moz-box-shadow: 0 3px 10px rgba(0,0,0,0.1);
-	-webkit-box-shadow: 0 3px 10px rgba(0,0,0,0.1);
-}
 EOT
                )
     end
 
     def body(doc)
-      doc.body({ 'onload' => 'init()' }) {
-        doc.div({ 'class' => 'main' }) {
-          doc.div({ 'class' => 'left_col' }) {
+      doc.body({ :onload => 'init()' }) {
+        prev_page = @predecessor ? @predecessor.fit_file[0..-5] + '.html' : nil
+        next_page = @successor ? @successor.fit_file[0..-5] + '.html' : nil
+        titlebar(doc, nil, prev_page, 'index.html', next_page)
+        # The main area with the 2 column layout.
+        doc.div({ :class => 'main' }) {
+          doc.div({ :class => 'left_col' }) {
             @report.to_html(doc)
             @track_view.div(doc)
+            @device_list.to_html(doc)
+            @user_profile.to_html(doc)
           }
-          doc.div({ 'class' => 'right_col' }) {
+          doc.div({ :class => 'right_col' }) {
             @chart_view.div(doc)
           }
         }
+        footer(doc)
       }
     end
 
@@ -149,10 +123,6 @@ EOT
       end
     end
 
-    def show_in_browser
-      system("firefox \"#{@output_file}\" &")
-    end
-
   end
 
 end

data/lib/postrunner/ChartView.rb

@@ -1,3 +1,15 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = ChartView.rb -- PostRunner - Manage the data from your Garmin sport devices.
+#
+# Copyright (c) 2014 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 'postrunner/ViewWidgets'
 
 module PostRunner
@@ -6,8 +18,10 @@ module PostRunner
 
     include ViewWidgets
 
-    def initialize(activity)
+    def initialize(activity, unit_system)
       @activity = activity
+      @unit_system = unit_system
+      @empty_charts = {}
     end
 
     def head(doc)
@@ -21,16 +35,29 @@ module PostRunner
     end
 
     def div(doc)
-      chart_div(doc, 'pace', 'Pace (min/km)')
-      chart_div(doc, 'altitude', 'Elevation (m)')
+      chart_div(doc, 'pace', "Pace (#{select_unit('min/km')})")
+      chart_div(doc, 'altitude', "Elevation (#{select_unit('m')})")
       chart_div(doc, 'heart_rate', 'Heart Rate (bpm)')
-      chart_div(doc, 'cadence', 'Run Cadence (spm)')
-      chart_div(doc, 'vertical_oscillation', 'Vertical Oscillation (cm)')
+      chart_div(doc, 'run_cadence', 'Run Cadence (spm)')
+      chart_div(doc, 'vertical_oscillation',
+                "Vertical Oscillation (#{select_unit('cm')})")
       chart_div(doc, 'stance_time', 'Ground Contact Time (ms)')
     end
 
     private
 
+    def select_unit(metric_unit)
+      case @unit_system
+      when :metric
+        metric_unit
+      when :statute
+        { 'min/km' => 'min/mi', 'm' => 'ft', 'cm' => 'in',
+          'bpm' => 'bpm', 'spm' => 'spm', 'ms' => 'ms' }[metric_unit]
+      else
+        Log.fatal "Unknown unit system #{@unit_system}"
+      end
+    end
+
     def style
       <<EOT
 .chart-container {
@@ -53,7 +80,7 @@ module PostRunner
 	-webkit-box-shadow: 0 3px 10px rgba(0,0,0,0.1);
 }
 .chart-placeholder {
-	width: 570px;
+	width: 580px;
 	height: 200px;
 	font-size: 14px;
 	line-height: 1.2em;
@@ -64,22 +91,22 @@ EOT
     def java_script
       s = "$(function() {\n"
 
-      s << line_graph('pace', '#0A7BEE' )
-      s << line_graph('altitude', '#5AAA44')
-      s << line_graph('heart_rate', '#900000')
-      s << point_graph('cadence',
+      s << line_graph('pace', 'min/km', '#0A7BEE' )
+      s << line_graph('altitude', 'm', '#5AAA44')
+      s << line_graph('heart_rate', 'bpm', '#900000')
+      s << point_graph('run_cadence', 'spm',
                        [ [ '#EE3F2D', 151 ],
                          [ '#F79666', 163 ],
                          [ '#A0D488', 174 ],
                          [ '#96D7DE', 185 ],
-                         [ '#A88BBB', nil ] ], 2)
-      s << point_graph('vertical_oscillation',
-                       [ [ '#A88BBB', 6.7 ],
-                         [ '#96D7DE', 8.4 ],
-                         [ '#A0D488', 10.1 ],
-                         [ '#F79666', 11.8 ],
-                         [ '#EE3F2D', nil ] ], 0.1)
-      s << point_graph('stance_time',
+                         [ '#A88BBB', nil ] ])
+      s << point_graph('vertical_oscillation', 'cm',
+                       [ [ '#A88BBB', 67 ],
+                         [ '#96D7DE', 84 ],
+                         [ '#A0D488', 101 ],
+                         [ '#F79666', 118 ],
+                         [ '#EE3F2D', nil ] ])
+      s << point_graph('stance_time', 'ms',
                        [ [ '#A88BBB', 208 ],
                          [ '#96D7DE', 241 ],
                          [ '#A0D488', 273 ],
@@ -91,18 +118,13 @@ EOT
       s
     end
 
-    def line_graph(field, color = nil)
+    def line_graph(field, unit, color = nil)
       s = "var #{field}_data = [\n"
 
-      first = true
+      data_set = []
       start_time = @activity.fit_activity.sessions[0].start_time.to_i
       @activity.fit_activity.records.each do |r|
-        if first
-          first = false
-        else
-          s << ', '
-        end
-        value = r.send(field)
+        value = r.get_as(field, select_unit(unit))
         if field == 'pace'
           if value > 20.0
             value = nil
@@ -110,17 +132,26 @@ EOT
             value = (value * 3600.0 * 1000).to_i
           end
         end
-        s << "[ #{((r.timestamp.to_i - start_time) * 1000).to_i}, " +
-             "#{value ? value : 'null'} ]"
+        data_set << [ ((r.timestamp.to_i - start_time) * 1000).to_i, value ]
       end
 
+      # We don't want to plot charts with all nil values.
+      unless data_set.find { |v| v[1] != nil }
+        @empty_charts[field] = true
+        return ''
+      end
+      s << data_set.map do |set|
+        "[ #{set[0]}, #{set[1] ? set[1] : 'null'} ]"
+      end.join(', ')
+
       s << <<"EOT"
 	  	];
 
 	  	$.plot("##{field}_chart",
              [ { data: #{field}_data,
                  #{color ? "color: \"#{color}\"," : ''}
-                 lines: { show: true#{field == 'pace' ? '' : ', fill: true'} } } ],
+                 lines: { show: true#{field == 'pace' ? '' :
+                                      ', fill: true'} } } ],
              { xaxis: { mode: "time" }
 EOT
       if field == 'pace'
@@ -131,7 +162,7 @@ EOT
       s << "});\n"
     end
 
-    def point_graph(field, colors, multiplier = 1)
+    def point_graph(field, unit, colors)
       # We need to split the field values into separate data sets for each
       # color. The max value for each color determines which set a data point
       # ends up in.
@@ -144,8 +175,7 @@ EOT
       start_time = @activity.fit_activity.sessions[0].start_time.to_i
       @activity.fit_activity.records.each do |r|
         # Undefined values will be discarded.
-        next unless (value = r.instance_variable_get('@' + field))
-        value *= multiplier
+        next unless (value = r.send(field))
 
         # Find the right set by looking at the maximum allowed values for each
         # color.
@@ -156,13 +186,19 @@ EOT
             # allowed range for this set, so add the value as x/y pair to the
             # set.
             x_val = (r.timestamp.to_i - start_time) * 1000
-            data_sets[i] << [ x_val, value ]
+            data_sets[i] << [ x_val, r.get_as(field, select_unit(unit)) ]
             # Abort the color loop since we've found the right set already.
             break
           end
         end
       end
 
+      # We don't want to plot charts with all nil values.
+      if data_sets.values.flatten.empty?
+        @empty_charts[field] = true
+        return ''
+      end
+
       # Now generate the JS variable definitions for each set.
       s = ''
       data_sets.each do |index, ds|
@@ -184,6 +220,9 @@ EOT
     end
 
     def chart_div(doc, field, title)
+      # Don't plot frame for graph without data.
+      return if @empty_charts[field]
+
       frame(doc, title) {
         doc.div({ 'id' => "#{field}_chart", 'class' => 'chart-placeholder'})
       }

data/lib/postrunner/DeviceList.rb

@@ -0,0 +1,104 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = DeviceList.rb -- PostRunner - Manage the data from your Garmin sport devices.
+#
+# Copyright (c) 2014 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/ViewWidgets'
+
+module PostRunner
+
+  class DeviceList
+
+    include ViewWidgets
+
+    def initialize(fit_activity)
+      @fit_activity = fit_activity
+    end
+
+    def to_html(doc)
+      frame(doc, 'Devices') {
+        devices.each { |d| d.to_html(doc) }
+      }
+    end
+
+    def to_s
+      devices.map { |d| d.to_s }.join("\n")
+    end
+
+    private
+
+    def devices
+      tables = []
+      seen_indexes = []
+      @fit_activity.device_infos.reverse_each do |device|
+        next if seen_indexes.include?(device.device_index) ||
+                device.manufacturer.nil? ||
+                device.manufacturer == 'Undocumented value 0' ||
+                device.device_type == 'Undocumented value 0'
+
+        tables << (t = FlexiTable.new)
+        t.set_html_attrs(:style, 'margin-bottom: 15px') if tables.length != 1
+        t.body
+
+        t.cell('Manufacturer:', { :width => '40%' })
+        t.cell(device.manufacturer, { :width => '60%' })
+        t.new_row
+
+        if (product = device.product)
+          t.cell('Product:')
+          rename = { 'fr620' => 'FR620', 'sdm4' => 'SDM4',
+                     'hrm_run_single_byte_product_id' => 'HRM Run',
+                     'hrm_run' => 'HRM Run' }
+          product = rename[product] if rename.include?(product)
+          t.cell(product)
+          t.new_row
+        end
+        if (type = device.device_type)
+          rename = { 'heart_rate' => 'Heart Rate Sensor',
+                     'stride_speed_distance' => 'Footpod',
+                     'running_dynamics' => 'Running Dynamics' }
+          type = rename[type] if rename.include?(type)
+          t.cell('Device Type:')
+          t.cell(type)
+          t.new_row
+        end
+        if device.serial_number
+          t.cell('Serial Number:')
+          t.cell(device.serial_number)
+          t.new_row
+        end
+        if device.software_version
+          t.cell('Software Version:')
+          t.cell(device.software_version)
+          t.new_row
+        end
+        if (rx_ok = device.rx_packets_ok) && (rx_err = device.rx_packets_err)
+          t.cell('Packet Errors:')
+          t.cell('%d%%' % ((rx_err.to_f / (rx_ok + rx_err)) * 100).to_i)
+          t.new_row
+        end
+        if device.battery_status
+          t.cell('Battery Status:')
+          t.cell(device.battery_status)
+          t.new_row
+        end
+
+        seen_indexes << device.device_index
+      end
+
+      tables.reverse
+    end
+
+  end
+
+end
+