fit4ruby 0.0.1

data/lib/fit4ruby/Log.rb

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = Log.rb -- Fit4Ruby - FIT file processing library for Ruby
+#
+# 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 'logger'
+
+module Fit4Ruby
+
+  # This is the Exception type that will be thrown for all unrecoverable
+  # errors.
+  class Error < StandardError ; end
+
+  class ILogger < Logger
+
+    def fatal(msg)
+      super
+      exit 1
+    end
+
+    def critical(msg, exception = nil)
+      if exception
+        raise Error, "#{msg}: #{exception.message}", exception.backtrace
+      else
+        raise Error, msg
+      end
+    end
+
+  end
+
+  Log = ILogger.new(STDOUT)
+  Log.level = Logger::WARN
+  Log.formatter = proc do |severity, time, progname, msg|
+    msg + "\n"
+  end
+
+end
+

data/lib/fit4ruby/Record.rb

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = Record.rb -- Fit4Ruby - FIT file processing library for Ruby
+#
+# 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.
+#
+
+module Fit4Ruby
+
+  class Record
+
+    attr_reader :timestamp, :latitude, :longitude, :altitude, :distance,
+                :speed, :vertical_oscillation, :cadence, :stance_time
+
+    def initialize
+    end
+
+    def set(field, value)
+      case field
+      when 'timestamp'
+        @timestamp = value
+      when 'position_lat'
+        @latitude = value
+      when 'position_long'
+        @longitude = value
+      when 'altitude'
+        @altitude = value
+      when 'distance'
+        @distance = value
+      when 'speed'
+        @speed = value
+      when 'vertical_oscillation'
+        @vertical_oscillation = value
+      when 'cadence'
+        @cadence = 2 * value
+      when 'fractional_cadence'
+        @cadence += 2 * value if @cadence
+      when 'stance_time'
+        @stance_time = value
+      else
+      end
+    end
+
+    def pace
+      1000.0 / (@speed * 60.0)
+    end
+
+  end
+
+end
+

data/lib/fit4ruby/Session.rb

@@ -0,0 +1,110 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = Session.rb -- Fit4Ruby - FIT file processing library for Ruby
+#
+# 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/Converters'
+
+module Fit4Ruby
+
+  class Session
+
+    include Converters
+
+    attr_reader :start_time, :duration, :distance, :strides, :ascend,
+                :descent, :calories, :avg_speed, :avg_heart_rate,
+                :max_heart_rate, :avg_vertical_oscillation, :avg_stance_time,
+                :avg_running_cadence, :avg_running_cadence, :training_effect,
+                :first_lap_index, :num_laps
+
+    def initialize
+      @laps = []
+    end
+
+    def check(activity)
+      @first_lap_index.upto(@first_lap_index - @num_laps) do |i|
+        if (lap = activity.lap[i])
+          @laps << lap
+        else
+          Log.error "Session references lap #{i} which is not contained in "
+                    "the FIT file."
+        end
+      end
+    end
+
+    def set(field, value)
+      return unless value
+
+      case field
+      when 'start_time'
+        @start_time = value
+      when 'total_timer_time'
+        @duration = value
+      when 'total_distance'
+        @distance = value
+      when 'total_strides'
+        @strides = value
+      when 'total_ascent'
+        @ascend = value
+      when 'total_descent'
+        @descent = value
+      when 'total_calories'
+        @calories = value
+      when 'avg_speed'
+        @avg_speed = value
+      when 'avg_heart_rate'
+        @avg_heart_rate = value
+      when 'max_heart_rate'
+        @max_heart_rate = value
+      when 'avg_vertical_oscillation'
+        @avg_vertical_oscillation = value
+      when 'avg_stance_time'
+        @avg_stance_time = value
+      when 'avg_running_cadence'
+        @avg_running_cadence = 2 * value
+      when 'avg_fraction_cadence'
+        @avg_running_cadence += 2 * value
+      when 'total_training_effect'
+        @training_effect = value
+      when 'first_lap_index'
+        @first_lap_index = value
+      when 'num_laps'
+        @num_laps = value
+      else
+      end
+    end
+
+    def avg_stride_length
+      @distance / @strides
+    end
+
+    def to_s
+      <<"EOT"
+Date:                     #{@start_time}
+Distance:                 #{'%.2f' % (@distance / 1000.0)} km
+Time:                     #{secsToHMS(@duration)}
+Avg Pace:                 #{speedToPace(@avg_speed)} min/km
+Total Ascend:             #{@ascend} m
+Total Descend:            #{@descent} m
+Calories:                 #{@calories} kCal
+Avg HR:                   #{@avg_heart_rate} bpm
+Max HR:                   #{@max_heart_rate} bpm
+Training Effect:          #{@training_effect}
+Avg Run Cadence:          #{@avg_running_cadence.round} spm
+Avg Vertical Oscillation: #{'%.1f' % (@avg_vertical_oscillation / 10)} cm
+Avg Ground Contact Time:  #{@avg_stance_time.round} ms
+Avg Stride Length:        #{'%.2f' % (avg_stride_length / 2)} m
+EOT
+    end
+
+  end
+
+end
+

data/lib/fit4ruby/version.rb

@@ -0,0 +1,3 @@
+module Fit4Ruby
+  VERSION = '0.0.1'
+end

data/tasks/changelog.rake

@@ -0,0 +1,169 @@
+require 'time'
+
+desc 'Generate the CHANGELOG file'
+task :changelog do
+
+  class Entry
+
+    attr_reader :type
+
+    def initialize(ref, author, time, message)
+      @ref = ref
+      @author = author
+      @time = time
+      @message = message
+      if (m = /New: (.*)/.match(@message))
+        @type = :feature
+        @message = m[1]
+      elsif (m = /Fix: (.*)/.match(@message))
+        @type = :bugfix
+        @message = m[1]
+      else
+        @type = :other
+      end
+    end
+
+    def to_s
+      "  * #{@message}\n"
+    end
+
+  end
+
+  class Release
+
+    attr_reader :date, :version, :tag
+
+    def initialize(tag, predecessor)
+      @tag = tag
+      # We only support release tags in the form X.X.X
+      @version = /\d+\.\d+\.\d+/.match(tag)
+
+      # Construct a Git range.
+      interval = predecessor ? "#{predecessor.tag}..#{@tag}" : @tag
+
+      # Get the date of the release
+      date = Time.parse(/Date: (.*)/.match(`git show #{tag}`)[1]).utc
+      @date = date.strftime("%Y-%m-%d")
+
+      @entries = []
+      # Use -z option for git-log to get 0 bytes as separators.
+      `git log -z #{interval}`.split("\0").each do |commit|
+        # We ignore merges.
+        next if commit =~ /^Merge: \d*/
+
+        ref, author, time, _, message = commit.split("\n", 5)
+        ref = ref[/commit ([0-9a-f]+)/, 1]
+        author = author[/Author: (.*)/, 1].strip
+        time = Time.parse(time[/Date: (.*)/, 1]).utc
+        # Eleminate git-svn-id: lines
+        message.gsub!(/git-svn-id: .*\n/, '')
+        # Eliminate Signed-off-by: lines
+        message.gsub!(/Signed-off-by: .*\n/, '')
+        message.strip!
+        @entries << Entry.new(ref, author, time, message)
+      end
+    end
+
+    def empty?
+      @entries.empty?
+    end
+
+    def to_s
+      s = ''
+      if hasFeatures? || hasFixes?
+        if hasFeatures?
+          s << "== New Features\n\n"
+          @entries.each do |entry|
+            s << entry.to_s if entry.type == :feature
+          end
+          s << "\n"
+        end
+        if hasFixes?
+          s << "== Bug Fixes\n\n"
+          @entries.each do |entry|
+            s << entry.to_s if entry.type == :bugfix
+          end
+          s << "\n"
+        end
+      else
+        @entries.each do |entry|
+          s << entry.to_s
+        end
+      end
+      s
+    end
+
+    private
+
+    def hasFeatures?
+      @entries.each do |entry|
+        return true if entry.type == :feature
+      end
+      false
+    end
+
+    def hasFixes?
+      @entries.each do |entry|
+        return true if entry.type == :bugfix
+      end
+      false
+    end
+
+  end
+
+  class ChangeLog
+
+    def initialize
+      @releases = []
+      predecessor = nil
+      getReleaseVersions.each do |version|
+        @releases << (predecessor = Release.new(version, predecessor))
+      end
+    end
+
+    def to_s
+      s = ''
+      @releases.reverse.each do |release|
+        next if release.empty?
+
+        # We use RDOC markup syntax to generate a title
+        if release.version
+          s << "= Release #{release.version} (#{release.date})\n\n"
+        else
+          s << "= Next Release (Some Day)\n\n"
+        end
+        s << release.to_s + "\n"
+      end
+      s
+    end
+
+    private
+
+    # 'git tag' is not sorted numerically. This function implements a
+    # numerical comparison for tag versions of the format 'release-X.X.X'. X
+    # can be a multi-digit number.
+    def compareTags(a, b)
+
+      def versionToComparable(v)
+        /\d+\.\d+\.\d+/.match(v)[0].split('.').map{ |l| sprintf("%03d", l.to_i)}.
+                                                             join('.')
+      end
+
+      versionToComparable(a) <=> versionToComparable(b)
+    end
+
+    def getReleaseVersions
+      # Get list of release tags from Git repository
+      releaseVersions = `git tag`.split("\n").map { |r| r.chomp }.
+        delete_if { |r| ! (/release-\d+\.\d+\.\d+/ =~ r) }.
+        sort{ |a, b| compareTags(a, b) }
+      releaseVersions << 'HEAD'
+    end
+
+  end
+
+  File.open('CHANGELOG', 'w+') do |changelog|
+    changelog.puts ChangeLog.new.to_s
+  end
+
+end

data/tasks/gem.rake

@@ -0,0 +1,52 @@
+# GEM TASK
+require 'find'
+require 'rubygems'
+require 'rubygems/package'
+
+# Unfortunately Rake::GemPackageTest cannot deal with files that are generated
+# by Rake targets. So we have to write our own packaging task.
+desc 'Build the gem package'
+task :gem => [:clobber] do
+  Rake::Task[:changelog].invoke
+  Rake::Task[:permissions].invoke
+
+  load 'fit4ruby.gemspec';
+
+  # Build the gem file according to the loaded spec.
+  if RUBY_VERSION >= "2.0.0"
+    Gem::Package.build(GEM_SPEC)
+  else
+    Gem::Builder.new(GEM_SPEC).build
+  end
+  pkgBase = "#{GEM_SPEC.name}-#{GEM_SPEC.version}"
+  # Create a pkg directory if it doesn't exist already.
+  FileUtils.mkdir_p('pkg')
+  # Move the gem file into the pkg directory.
+  verbose(true) { FileUtils.mv("#{pkgBase}.gem", "pkg/#{pkgBase}.gem")}
+end
+
+desc 'Make sure all files and directories are readable'
+task :permissions do
+  # Find the bin and test directories relative to this file.
+  baseDir = File.expand_path('..', File.dirname(__FILE__))
+
+  execs = Dir.glob("#{baseDir}/bin/*") +
+          Dir.glob("#{baseDir}/test/**/genrefs")
+
+  Find.find(baseDir) do |f|
+    # Ignore the whoke pkg directory as it may contain links to the other
+    # directories.
+    next if Regexp.new("#{baseDir}/pkg/*").match(f)
+
+    FileUtils.chmod_R((FileTest.directory?(f) ||
+                       execs.include?(f) ? 0755 : 0644), f)
+  end
+end
+
+desc 'Run all tests and build scripts and create the gem package'
+task :release do
+  Rake::Task[:test].invoke
+  Rake::Task[:yard].invoke
+  Rake::Task[:gem].invoke
+end
+

data/tasks/rdoc.rake

@@ -0,0 +1,14 @@
+if RUBY_VERSION < '1.9.3'
+  require 'rake/rdoctask'
+else
+  require 'rdoc/task'
+end
+
+# RDOC TASK
+Rake::RDocTask.new(:rdoc) do |t|
+  t.rdoc_files = %w( README.rdoc COPYING CHANGELOG ) +
+                 `git ls-files -- lib`.split("\n")
+  t.title = "TaskJuggler API documentation"
+  t.main = 'README.rdoc'
+  t.rdoc_dir = 'doc'
+end