teich-hrmparser 0.2.1

data/History.txt

@@ -0,0 +1,9 @@
+== 0.2.0 2009-04-29
+* Importer takes a string of data now instead of file handle
+== 0.1.1 2009-04-29
+* Added support for Polar HRM
+* Actually making a gem
+
+== 0.0.1 2009-04-28
+
+ * Initial release

data/Manifest.txt

@@ -0,0 +1,20 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/hrmparser.rb
+lib/hrmparser/arraymath.rb
+lib/hrmparser/workout.rb
+lib/hrmparser/version.rb
+lib/hrmparser/trackpoint.rb
+lib/hrmparser/importer.rb
+lib/hrmparser/importer/garmin.rb
+lib/hrmparser/importer/polar.rb
+script/console
+script/destroy
+script/generate
+spec/hrmparser_spec.rb
+spec/arraymath_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake

data/README.rdoc

@@ -0,0 +1,42 @@
+= hrmparser
+
+* http://github.com/teich/hrmparser/tree/master
+
+== DESCRIPTION:
+
+A ruby parser for polar and garmin hrm
+
+== FEATURES/PROBLEMS:
+
+* Imports garmin 405.  Generates a workout object with some averages calculated.
+* Not the fastest right now.  
+* Very very early.  
+
+== REQUIREMENTS:
+
+* hpricot
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Oren Teich
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,27 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/hrmparser'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('hrmparser', HRMParser::VERSION::STRING) do |p|
+  p.developer('Oren Teich', 'oren@teich.net')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.rubyforge_name       = p.name # TODO this is default value
+  # p.extra_deps         = [
+  #   ['activesupport','>= 2.0.2'],
+  # ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+task :default => [:spec, :features]

data/lib/hrmparser/arraymath.rb

@@ -0,0 +1,25 @@
+require 'enumerator'
+
+# Set of basic array math functions.  
+module ArrayMath
+
+  def aaverage
+    accum = self.asum
+    return nil if accum.nil? || self.size == 0
+    accum.to_f / self.size
+  end
+
+  def asum
+    self.map {|i| return nil if i.is_a?(String)}
+    inject(0){ |sum,item| sum + item }
+  end
+  
+  ## Retun array FACTOR smaller.  Average values to get smaller
+  def smoothed(factor)
+    self.enum_for(:each_slice, factor).map { |snipit| snipit.compact.aaverage }
+  end  
+end
+
+class Array
+  include ArrayMath
+end

data/lib/hrmparser/importer/garmin.rb

@@ -0,0 +1,66 @@
+module Importer
+  class Garmin
+    def initialize(opts = {:data => nil})
+      @data = opts[:data]
+    end
+    
+    def restore
+      workout = HRMParser::Workout.new(:duration => 0)
+      #data = Importer.read_in_file(@file_name)
+      
+      @xml = Hpricot::XML(@data)
+      workout.time = Time.parse((@xml/:Id).innerHTML)
+
+      (@xml/:Lap).each do |lap|
+        f_time =  (lap/:TotalTimeSeconds).innerHTML
+        workout.duration += Float f_time
+      end
+
+      found = false
+      trackpoints = Array.new
+      distance_one = nil
+      time_one = nil
+      
+      (@xml/:Trackpoint).each do |t| 
+        found = true
+        trackpoint = HRMParser::TrackPoint.new
+        next if ((t/:HeartRateBpm/:Value).innerHTML == "")
+        trackpoint.hr = (t/:HeartRateBpm/:Value).innerHTML.to_i
+        trackpoint.lat = (t/:Position/:LatitudeDegrees).innerHTML.to_f
+        trackpoint.lng = (t/:Position/:LongitudeDegrees).innerHTML.to_f
+        trackpoint.time = Time.parse((t/:Time).innerHTML)
+        trackpoint.altitude = (t/:AltitudeMeters).innerHTML.to_f
+        trackpoint.distance = (t/:DistanceMeters).innerHTML.to_f
+        trackpoints << trackpoint
+        
+    
+        if distance_one.nil?
+          distance_one = trackpoint.distance
+          time_one = trackpoint.time
+        else
+          distance_two = trackpoint.distance
+          time_two = trackpoint.time
+          time_delta = time_two - time_one
+          distance_delta = distance_two - distance_one
+          if (distance_delta > 0 && time_delta > 0)
+            trackpoint.speed = distance_delta / time_delta  
+            distance_one = distance_two
+            time_one = time_two
+          else trackpoint.speed = nil
+          end      
+        end
+      end 
+      
+      if found
+        workout.trackpoints = trackpoints
+        workout.distance = trackpoints.last.distance if !trackpoints.last.distance.nil?
+        workout.calc_average_speed! 
+        workout.calc_altitude_gain!
+        workout.calc_average_hr!
+      end
+
+      return workout
+    end
+    
+  end
+end

data/lib/hrmparser/importer/polar.rb

@@ -0,0 +1,105 @@
+module Importer
+  class Polar
+    
+    attr_reader :time_zone
+    
+    def initialize(opts = {:data => nil, :time_zone => "UTC"})
+      @data = opts[:data]
+      @time_zone = opts[:time_zone]
+    end      
+    
+    def restore
+      workout = HRMParser::Workout.new(:duration => 0)
+      #filehandle = Importer.read_in_file(@file_name)
+      #@data = @file.read
+      
+      params = parse_params
+
+      date = params["Date"] + " " + params["StartTime"] + " " + @time_zone
+
+      length_array = params["Length"].split(/:/)
+      workout.duration = (length_array[0].to_f * 3600) + (length_array[1].to_f * 60) + (length_array[2].to_f)
+      workout.time = Time.parse(date)
+      
+      workout.trackpoints = get_trackpoints(workout.time, params["Interval"].to_i)
+      
+      workout.calc_average_hr!
+
+      return workout
+    end
+    
+    
+    
+    private
+    
+    # def parse_tabbed_blocks
+    #   # This is the list of tabbed blocks
+    #   tabbed_blocks = %w[IntTimes ExtraData Sumary-123 Summary-TH]
+    #   tabbed_blocks.each do |block_name|
+    #     @polarHash[block_name] = []
+    #     block_text = find_block(block_name)
+    #     block_text.each do |block_line|
+    #       @polarHash[block_name] << block_line.split(/\t/)
+    #     end
+    #   end
+    # end
+
+    # Params is the only "ini" style block
+    def parse_params
+      hash = {}
+      param_block = find_block("Params")
+      param_block.each do |param|
+        # /=/ in case that doesn't work
+        key, value = param.split("=", 2)
+        key = key.strip unless key.nil?
+        value = value.strip unless value.nil?
+        hash[key] = value unless key.nil?
+      end
+      return hash
+    end
+
+    # Polar file has [Foo] blocks.  Return the data in the block
+    def find_block(header)
+      found = false
+      block = []
+      @data.each do |line|
+        line.chomp!
+        found = false if line =~ /^\[.*\]$/
+        block << line if found
+        found = true if line =~ /\[#{header}\]/
+      end
+      return block
+    end
+    
+    def parse_hrdata
+      hrdata = []
+      block_text = find_block("HRData")
+      block_text.each do |block_line|
+        hrdata << block_line.chomp
+      end
+      return hrdata
+    end
+    
+    def get_trackpoints(start_time, interval)
+      trackpoints = []
+      rrcounter = 0
+      
+      hrdata = parse_hrdata
+      hrdata.each do |hrd|
+        tp = HRMParser::TrackPoint.new
+        
+        if (interval == 238)
+          rrcounter += hrd.to_i
+          tp.hr = 60000 / hrd.to_i
+          tp.time = start_time + (rrcounter/1000)
+        else
+          tp.hr = hrd.to_i
+          tp.time = start_time + (interval * trackpoints.size)
+        end
+        
+        trackpoints << tp
+      end
+      return trackpoints
+    end
+  end
+end

data/lib/hrmparser/importer.rb

@@ -0,0 +1,20 @@
+require 'importer/garmin'
+require 'importer/polar'
+
+module Importer
+  def Importer.file_type(name)
+    if name =~ /\.tcx$/i
+      "GARMIN_XML" 
+    elsif name =~ /\.hrm$/i
+      "POLAR_HRM"
+    end
+  end
+  
+  def Importer.read_in_file(name)
+    if File.readable?(name)
+      return open(name, "r")
+    else 
+      puts "FILE ERROR, can't read #{name}"
+    end
+  end
+end

data/lib/hrmparser/trackpoint.rb

@@ -0,0 +1,15 @@
+module HRMParser
+  class TrackPoint
+    attr_accessor :lat, :lng, :altitude, :speed, :hr, :distance, :time, :cadence
+    def initialize(opts = {:lat => nil, :lng => nil, :altitude => nil, :speed => nil, :hr => nil, :distance => nil, :cadence => nil, :time => Time.now})
+      @lat = opts[:lat]
+      @lng = opts[:lng]
+      @altitude = opts[:altitude]
+      @speed = opts[:speed]
+      @hr = opts[:hr]
+      @distance = opts[:distance]
+      @time = opts[:time]
+      @cadence = opts[:cadence]    
+    end
+  end
+end

data/lib/hrmparser/version.rb

@@ -0,0 +1,13 @@
+module HRMParser # :nodoc:
+  module VERSION # :nodoc:
+    unless defined? MAJOR
+      MAJOR  = 0
+      MINOR  = 2
+      TINY   = 1
+      
+      STRING = [MAJOR, MINOR, TINY].compact.join('.')
+
+      SUMMARY = "HRMParser #{STRING}"
+    end
+  end
+end

data/lib/hrmparser/workout.rb

@@ -0,0 +1,55 @@
+module HRMParser
+  class Workout
+    attr_accessor :duration, :distance, :time, :name, :file_name, :trackpoints
+    attr_reader :average_hr, :data, :average_speed, :altitude_gain
+    
+    def initialize(opts = {:duration => nil, :distance => nil, :time => Time.now, :name => nil, :file_name => nil})
+      @duration = opts[:duration]
+      @name = opts[:name]
+      @time = opts[:time]
+      @distance = opts[:distance]
+      @file_name = opts[:file_name]
+      
+      @data = nil
+      @trackpoints = {}
+    end
+    
+    
+    def calc_average_hr!
+      @average_hr = heart_rates.compact.aaverage
+    end
+    
+    def calc_average_speed! 
+      @average_speed = speeds.compact.aaverage
+    end
+    
+    def calc_altitude_gain!
+      gain = 0
+      smoothed_altitude = altitudes.smoothed(10)
+      start = smoothed_altitude.first
+      smoothed_altitude.each do |alt|
+       diff = alt - start
+       if (diff > 0)
+         gain += diff
+       end
+       start = alt
+      end
+      @altitude_gain = gain
+      
+    end
+    
+    
+    ## Some helper functions that return specific files from trackpoint as array
+    def heart_rates
+      @trackpoints.map {|tp| tp.hr }
+    end
+    
+    def speeds
+      @trackpoints.map {|tp| tp.speed }
+    end
+    
+    def altitudes
+      @trackpoints.map { |tp| tp.altitude }
+    end 
+  end
+end

data/lib/hrmparser.rb

@@ -0,0 +1,13 @@
+require 'rubygems' 
+require 'hpricot'
+require 'time'
+
+module HRMParser; end
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/hrmparser')
+
+require 'arraymath'
+require 'version'
+require 'trackpoint'
+require 'workout'
+require 'importer'

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/hrmparser.rb'}"
+puts "Loading hrmparser gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/arraymath_spec.rb

@@ -0,0 +1,26 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+module ArrayMath
+  describe "ArrayMath" do
+    context "Sum" do
+      it "sums an array" do
+        array = [1,2,3,4,5]
+        array.asum.should == 15
+      end
+      it "can not sum an array of strings" do
+        array = ["hello", "goodbye"]
+        array.asum.should == nil
+      end
+    end
+    context "average" do
+      it "averages an array of integers and returns a float" do
+        array = [2,3,4,3,2]
+        array.aaverage.should == 2.8
+      end
+      it "averages an array of floats" do
+        array = [1.5,2.5,3.5,2.5,1.5]
+        array.aaverage.should == 2.3
+      end
+    end
+  end
+end

data/spec/hrmparser_spec.rb

@@ -0,0 +1,124 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+# Time to add your specs!
+# http://rspec.info/
+module HRMParser
+    describe "TrackPoint" do
+      context "new trackpoint" do
+        it "has no variables set" do
+          hrm = TrackPoint.new
+          hrm.speed == nil
+          hrm.distance == nil
+          hrm.lat.should == nil
+          hrm.lng.should == nil
+          hrm.altitude.should == nil
+          hrm.hr.should == nil
+        end
+      end
+    end
+    
+    describe "Workout" do
+      context "new workout" do
+        it "has no variables set" do
+          workout = Workout.new
+          workout.distance.should == nil
+          workout.duration.should == nil
+          workout.average_hr.should == nil
+          workout.name.should == nil
+          workout.file_name.should == nil
+        end
+        it "set name through initializer" do
+          workout = Workout.new(:name => "test workout")
+          workout.name.should == "test workout"
+        end
+        it "can not set average_hr during init" do
+          workout = Workout.new(:average_hr => 150)
+          workout.average_hr.should == nil
+        end
+      end
+      
+      context "Identifies files" do
+        it "identify file as garmin" do
+          type = Importer.file_type("spec/samples/small-garmin.TCX")
+          type.should == "GARMIN_XML"
+        end
+        it "identification returns nil if no file specified" do
+          type = Importer.file_type("")
+          type.should == nil
+        end
+        it "identify file as polar" do
+          type = Importer.file_type("spec/samples/polarRS200.hrm")
+          type.should == "POLAR_HRM"
+        end
+      end
+
+      context "Parse garmin file" do
+        it "finds workout start time on a short workout" do
+          filename = "spec/samples/indoor-garmin-405.TCX"
+          data = File.read(filename)
+          importer = Importer::Garmin.new(:data => data)
+          workout = importer.restore
+          workout.time.should == Time.parse("Fri Aug 22 01:04:55 UTC 2008")
+        end
+        it "finds the duration on a short workout" do
+          filename = "spec/samples/indoor-garmin-405.TCX"
+          data = File.read(filename)
+          importer = Importer::Garmin.new(:data => data)
+          workout = importer.restore
+          workout.duration.should be_close(755, 1)
+        end
+        it "indoor workout has no trackpoints" do
+          filename = "spec/samples/indoor-garmin-405.TCX"
+          data = File.read(filename)
+          importer = Importer::Garmin.new(:data => data)
+          workout = importer.restore
+          workout.distance.should == nil
+          workout.average_hr.should == nil
+          workout.average_speed.should == nil
+          workout.altitude_gain.should == nil
+          workout.trackpoints == nil
+        end
+        
+        ## Parsing the full XML is just slow.  Commenting out for now.
+        it "gets workout level settings for outdoor workout" do
+          filename = "spec/samples/outdoor-garmin-405.TCX"
+          data = File.read(filename)
+          importer = Importer::Garmin.new(:data => data)
+          workout = importer.restore
+          workout.distance.should be_close(11740, 5)
+          workout.average_hr.should be_close(149.7, 0.5)
+          workout.average_speed.should be_close(1.5, 0.2)
+          workout.altitude_gain.should be_close(572, 1.0)
+        end
+      end
+      
+      context "Parse polar RS200 file" do
+        it "finds the duration and time" do
+          filename ="spec/samples/polarRS200.hrm"
+          data = File.read(filename)
+          importer = Importer::Polar.new(:data => data, :time_zone => "UTC")
+          workout = importer.restore
+          workout.duration.should be_close(3569,1)
+          workout.time.should == Time.parse("Thu Apr 16 12:01:55 UTC 2009")
+        end
+        it "calculates the average heartrate" do
+          filename ="spec/samples/polarRS200.hrm"          
+          data = File.read(filename)
+          importer = Importer::Polar.new(:data => data, :time_zone => "UTC")
+          workout = importer.restore
+          workout.average_hr.should be_close(145, 1)
+        end
+      end
+      context "Parse a Polar RR file" do
+        it "calculates the heart rate from RR" do
+          filename ="spec/samples/polarRS800-RR.hrm"         
+          data = File.read(filename)
+          importer = Importer::Polar.new(:data => data, :time_zone => "UTC")
+          workout = importer.restore
+          workout.trackpoints.each {|tp| tp.hr.should < 220 && tp.hr.should > 30}
+          workout.average_hr.should be_close(115, 1)
+          workout.average_speed.should == nil
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+dir = File.dirname(__FILE__)
+lib_path = File.expand_path("#{dir}/../lib")
+$LOAD_PATH.unshift lib_path unless $LOAD_PATH.include?(lib_path)
+$_spec_spec = true # Prevents Kernel.exit in various places
+
+require 'spec'
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'hrmparser'

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/*_spec.rb']
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: teich-hrmparser
+version: !ruby/object:Gem::Version 
+  version: 0.2.1
+platform: ruby
+authors: 
+- Oren Teich
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-29 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: A ruby parser for polar and garmin hrm
+email: 
+- oren@teich.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/hrmparser.rb
+- lib/hrmparser/arraymath.rb
+- lib/hrmparser/workout.rb
+- lib/hrmparser/version.rb
+- lib/hrmparser/trackpoint.rb
+- lib/hrmparser/importer.rb
+- lib/hrmparser/importer/garmin.rb
+- lib/hrmparser/importer/polar.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/hrmparser_spec.rb
+- spec/arraymath_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+has_rdoc: true
+homepage: http://github.com/teich/hrmparser/tree/master
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: hrmparser
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A ruby parser for polar and garmin hrm
+test_files: []
+