logstats 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+pkg/*
+*.gem
+.bundle
+scratch/
+logstats.html

data/.rvmrc

@@ -0,0 +1,7 @@
+
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+  && -s "${rvm_path:-$HOME/.rvm}/environments/ruby-1.8.7-p299@logstats" ]] ; then
+  \. "${rvm_path:-$HOME/.rvm}/environments/ruby-1.8.7-p299@logstats"
+else
+  rvm --create use  "ruby-1.8.7-p299@logstats"
+fi

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in logstats.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,21 @@
+GIT
+  remote: git://github.com/jstirk/tail_from_sentinel.git
+  revision: def3003aa61a46dfd239cad938700d8ad26c2988
+  specs:
+    tail_from_sentinel (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    haml (3.0.25)
+    ruby-fsevent (0.2.1)
+    watchr (0.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  haml
+  ruby-fsevent
+  tail_from_sentinel!
+  watchr

data/README

@@ -0,0 +1,71 @@
+LogStats
+========
+
+Generates a simple HTML file based upon my custom timesheet format.
+
+I can then embed this on my OSX Dashboard to be able to see how I'm
+progressing throughout the day/week/month.
+
+It's probably not so useful to you, unless you happen to like my
+worklog format.
+
+I run the script every 5 minutes with cron so as that the HTML stays
+up-to-date. The page is set to auto-refresh every 2.5 minutes.
+
+The colours change when I have done at least 5 hours of work per day,
+and 25 hours per week.
+
+Requirements
+============
+ * HAML
+ * tail_from_sentinel
+
+Usage
+=====
+
+  logstats INPUTFILE.txt OUTPUTFILE.html
+
+
+Worklog Format
+==============
+
+I use a text based worklog format for all my timekeeping.
+
+This is a simple text file that sits in my Dropbox, and it symlinked to
+my home. I keep it open in an editor all day so as that I can quickly jot
+down when my task changes.
+
+It works great for unexpected interruptions, as I can quickly update it
+when I am back, or even while I am on the phone (only need to type the time
+I answer the call).
+
+The format looks like this :
+
+  01Jan2011
+  0900 ABC 1234567 1012
+  1015 ABC 9876543 1100
+  1100 ABC Deploy 1110
+
+  03Jan
+  1200 XY1 2345678 1230
+
+Each day has a simple header in DDMMMYYYY format, where YYYY is
+optional where it is the same as the record before.
+
+Within the day, each line follows a simple format :
+ * the start time (in 24hr)
+
+ * a message, which starts with a 3-character project code (if billable).
+   I usually follow this with a Pivotal Tracker Story ID, or a note
+   about what I was doing.
+   If it's not billable work, I might use this space to log an
+   unexpected call for instance.
+   This field is freeform, with the project picked up if it's there.
+
+ * the end time (in 24hr). It's fine for this to be in the next day.
+   Eg: 2330 ABC allnighter 0230
+
+TODO
+====
+ * Tests!
+ * Make it more customizable. Not everyone has the same thresholds that I keep.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/bin/logstats

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'logstats'
+
+ls=LogStats::Base.new(ARGV[0], ARGV[1])
+ls.generate!

data/examples/example.haml

@@ -0,0 +1,128 @@
+!!!
+%html
+  %head
+    %title Log Stats @ 2011-01-18 07:09
+    %style
+      :sass
+        $background_color_light: #454342
+        $background_color_dark: #333335
+        $text_color: white 
+        $link_color: #a9c743
+        $border_color: #272b3b
+      
+        body
+          :font-size 62.5%
+          :font-family Helvetica, sans-serif
+          :background $background_color_light
+          :color $text_color
+
+        #logstats
+          :width 400px
+          :height 241px
+          :background $background_color_dark
+          :border 1px solid $border_color
+          :text-align center
+
+          h1
+            :font-size 120%
+            :text-decoration underline
+            :font-variant small-caps
+            :text-align center
+            :margin 0 0 10px 0
+            :padding 0
+
+          ul
+            :list-style-type none
+            :margin 0
+            :padding 0
+            :text-align left
+
+            li
+              :margin 0
+              :padding 0
+
+          .duration
+            :font-size 200%
+            :color #cacaca
+
+            span
+              :color $text_color
+
+          .remaining, .average
+            :margin-top 5px
+          
+          .recent, .history
+            :width 200px
+            :float left
+
+          .recent
+            .current, .today
+              :padding 5px
+
+            .current
+              :height 50px
+              :border-bottom 1px solid $border-color
+
+          .history
+            .today, .week, .month
+              :height 70px
+              :padding 5px
+              :border-left 1px solid $border_color
+
+            .today, .week
+              :border-bottom 1px solid $border-color
+              
+
+  %body
+    #logstats
+      .recent
+        .current
+          %h1 Current
+          %span.duration
+            %span.minute 45
+            min
+        .today
+          %h1 Projects
+          %ul.projects
+            %li
+              %span.project MB1
+              %span.duration
+                %span.hour 1
+                hr
+                %span.minute 57
+                min
+            %li
+              %span.project MY1
+              %span.duration
+                %span.hour 2
+                hr
+                %span.minute 30
+                min
+      .history
+        .today
+          %h1 Today
+          %span.duration
+            %span.hour 5
+            hr
+            %span.minute 57
+            min
+          .remaining
+            (target met!)
+        .week
+          %h1 Week
+          %span.duration
+            %span.hour 5
+            hr
+            %span.minute 57
+            min
+          .remaining
+            (20 hr 3 min remaining)
+        .month
+          %h1 Month
+          %span.duration
+            %span.hour 35
+            hr
+            %span.minute 57
+            min
+          .average
+            (6 hr 12 min average)

data/lib/logstats/haml/helpers.rb

@@ -0,0 +1,46 @@
+module LogStats
+module Helpers
+  # NOTE: Because of the way I'm calling this (as the HAML context) these all need to be class methods
+
+  # Turns a number of seconds into a pretty HTML string
+  def self.time_to_html(seconds, options={})
+    hrs=(seconds / 3600).floor
+    min=(seconds % 3600).floor / 60
+    o=[]
+    o << "<span class=\"hour\">#{hrs}</span> hr" if hrs.to_i > 0
+    o << "<span class=\"minute\">#{min}</span> min" if min.to_i > 0
+    o.join(' ')
+  end
+
+  # Options:
+  #   :class : The CSS class to apply to the top element (default: duration)
+  def self.duration_tag(seconds, options={})
+    options[:class]='duration' if options[:class].nil?
+    "<span class=\"#{options[:class]}\">#{self.time_to_html(seconds)}</span>"
+  end
+
+  def self.remaining_tag(seconds_so_far, period)
+    seconds_required=case period
+      when :day
+        # 5 hrs per day
+        5 * 3600
+      when :week
+        # 5 hrs per day, 5 days per week
+        5 * 5 * 3600
+      else
+        raise "Unknown period: #{period}"
+    end
+
+    seconds=seconds_required - seconds_so_far
+
+    css_class=[ 'remaining ']
+    if seconds.nil? || seconds < 0 then
+      content=self.time_to_html(seconds.abs) + ' over!'
+      css_class << 'met'
+    else
+      content=self.time_to_html(seconds) + ' remaining'
+    end
+    "<div class=\"#{css_class.join(' ')}\">(#{content})</div>"
+  end
+end
+end

data/lib/logstats/template.haml

@@ -0,0 +1,123 @@
+!!!
+%html
+  %head
+    %title Log Stats @ #{Time.now.strftime('%a, %e %b %Y %H:%M')}
+    %meta{ "http-equiv" => "refresh", :content => "150" }
+    %style
+      :sass
+        $background_color_light: #454342
+        $background_color_dark: #333335
+        $text_color: white 
+        $text_faded_color: #cacaca
+        $link_color: #a9c743
+        $border_color: #272b3b
+        $success_color: #a9c743
+        $success_faded_color: #7D9231
+      
+        body
+          :font-size 62.5%
+          :font-family Helvetica, sans-serif
+          :background $background_color_light
+          :color $text_color
+
+        #logstats
+          :width 400px
+          :height 241px
+          :background $background_color_dark
+          :border 1px solid $border_color
+          :text-align center
+
+          h1
+            :font-size 120%
+            :text-decoration underline
+            :font-variant small-caps
+            :text-align center
+            :margin 0
+            :padding 0
+
+          ul
+            :list-style-type none
+            :margin 0
+            :padding 0
+            :text-align left
+
+            li
+              :margin 0
+              :padding 0
+
+          .duration
+            :font-size 200%
+            :color $text_faded_color
+            :line-height 40px
+
+            span
+              :color $text_color
+
+          .met
+            :color $success_color
+
+            .duration
+              :color $success_faded_color
+
+              span
+                :color $success_color
+
+          //.remaining, .average
+          
+          .recent, .history
+            :width 200px
+            :float left
+
+          .recent
+            .current, .today
+              :padding 5px
+
+            .current
+              :height 50px
+              :border-bottom 1px solid $border-color
+
+            .today ul
+              .duration
+                :line-height 30px
+
+          .history
+            .today, .week, .month
+              :height 70px
+              :padding 5px
+              :border-left 1px solid $border_color
+
+            .today, .week
+              :border-bottom 1px solid $border-color
+              
+
+  %body
+    #logstats
+      .recent
+        .current
+          %h1 Current Task
+          - if current then
+            = duration_tag(current)
+          - else
+            N/A
+        .today
+          %h1 Projects
+          %ul.projects
+            - today[:projects].each do |project, time|
+              %li
+                %span.project= project
+                = duration_tag(time)
+      .history
+        .today{ :class => (today[:remaining].nil? ? 'met' : nil )}
+          %h1 Today
+          = duration_tag(today[:total])
+          = remaining_tag(today[:total], :day)
+
+        .week{ :class => (week[:remaining].nil? ? 'met' : nil )}
+          %h1 Week
+          = duration_tag(week[:total])
+          = remaining_tag(week[:total], :week)
+        .month
+          %h1 Month
+          = duration_tag(month[:total])
+          .average
+            (#{time_to_html(month[:average])} average)

data/lib/logstats/version.rb

@@ -0,0 +1,3 @@
+module Logstats
+  VERSION = "0.0.1"
+end

data/lib/logstats/worklog.rb

@@ -0,0 +1,154 @@
+require 'tail_from_sentinel'
+require 'time'
+require 'date'
+
+# Parses my own WorkLog file format and extracts the stats for the past month
+module LogStats
+class WorkLog < TailFromSentinel::Base
+  DATE_SENTINEL_REGEX=/(\d+)([A-Z]+)(\d{4})?$/i
+  WORKLOG_RECORD_REGEX=/(\d{2})(\d{2}) (.*) (\d{2})(\d{2})$/i
+  OPEN_WORKLOG_RECORD_REGEX=/(\d{2})(\d{2}) (.*)$/i
+
+  DATE_SENTINEL_PROC=Proc.new do |line|
+    if line =~ DATE_SENTINEL_REGEX then
+      # It's a date marker - parse it to see whether it's close enough to when we want
+      day,month,year=self.parse_sentinel($1, $2, $3)
+      (month.downcase == self.now.strftime('%b').downcase) && (year.to_i == self.now.year)
+    end
+  end
+
+  def self.now
+    @@now ||= Time.now
+  end
+
+  def self.last_seen_year
+    @@last_seen_year
+  end
+
+  def self.last_seen_year=(year)
+    @@last_seen_year=year
+  end
+
+  def self.parse_sentinel(d,m,y)
+    year=y || self.last_seen_year
+    self.last_seen_year=year
+    [ d, m, year ]
+  end
+
+  def initialize(filename)
+    @last_seen_year=nil
+    @stas=nil
+    super(File.open(filename, 'r'), &DATE_SENTINEL_PROC)
+  end
+
+  # TODO: Document this
+  def stats
+    return @stats unless @stats.nil?
+
+    days={}
+    now=WorkLog.now
+    current_time=nil
+
+    data.each do |line|
+      line=line.strip
+      case line
+        when DATE_SENTINEL_REGEX
+          # It's a date marker - set current_time
+          current_time=Time.parse(WorkLog.parse_sentinel($1,$2,$3).reverse.join('-'))
+          days[current_time]={ :total => 0, :projects => {} }
+
+        when WORKLOG_RECORD_REGEX
+          # It's a worklog record - parse it, and add it to the relevant buckets
+          duration, project=parse_worklog_record(current_time, $1, $2, $3, $4, $5)
+
+          days[current_time][:total] += duration
+          days[current_time][:projects][project] ||= 0
+          days[current_time][:projects][project] += duration
+
+        when OPEN_WORKLOG_RECORD_REGEX
+          duration, project=parse_worklog_record(current_time, $1, $2, $3)
+          days[:current]=duration
+          
+        when /^\s*$/
+          # Blank line - ignore
+        else
+         puts "Warning: Unknown format of \"#{line}\""
+      end
+    end
+    @stats=compile_day_data(days)
+  end
+
+  def parse_worklog_record(current_time, sh,sm,msg,eh=nil,em=nil)
+    start_time=current_time + (sh.to_i * 3600) + (sm.to_i * 60)
+
+    if eh && em then
+      end_time=current_time + (eh.to_i * 3600) + (em.to_i * 60)
+      end_time += (24 * 3600) if end_time < start_time
+    else
+      end_time=Time.now
+    end
+    duration=end_time - start_time
+
+    if msg.match(/^([A-Z0-9]{3})/) then
+      project=$1
+    else
+      project='MISC'
+    end
+    [ duration, project ]
+  end
+
+  def compile_day_data(days)
+    stats={ :current => days[:current],
+            :today  => { :total => 0,
+                         :projects => { }
+                       },
+            :week   => { :total => 0,
+                         :average => 0,
+                         :projects => { }
+                       },
+            :month  => { :total => 0,
+                         :average => 0,
+                         :days_logged => 0,
+                         :projects => { }
+                       }
+          }
+
+    now=WorkLog.now
+    today=Date.today
+
+    days.each do |time, data|
+      next if time == :current
+
+      # It's data for today - use it
+      stats[:today]=data if time.day == now.day
+
+      if time_to_date(time).cweek == today.cweek then
+        stats[:week][:total] += data[:total]
+        stats[:week][:average] = (stats[:week][:total] / time_to_date(time).wday.to_f)
+        data[:projects].each do |project, duration|
+          stats[:week][:projects][project] ||= 0
+          stats[:week][:projects][project] += duration
+        end
+      end
+
+      # Everything is included in this month
+      stats[:month][:total] += data[:total]
+      stats[:month][:days_logged] += 1
+      stats[:month][:average] = (stats[:month][:total] / stats[:month][:days_logged])
+      data[:projects].each do |project, duration|
+        stats[:month][:projects][project] ||= 0
+        stats[:month][:projects][project] += duration
+      end
+    end
+
+    stats[:today][:total] += days[:current]
+    #stats[:today][:projects]['WIP'] = days[:current]
+
+    return stats
+  end
+
+  def time_to_date(time)
+    Date.new(time.year, time.month, time.day)
+  end
+end
+end

data/lib/logstats.rb

@@ -0,0 +1,40 @@
+require 'haml'
+require 'logstats/haml/helpers'
+require 'logstats/worklog'
+module LogStats
+class Base
+  attr_reader :worklog
+
+  def initialize(source_file, output_path)
+    @worklog=WorkLog.new(source_file)
+    @output_path=output_path
+    @base_path=File.dirname(__FILE__)
+  end
+
+  def generate!
+    # Calculate the stats from the file
+    locals={}
+    @worklog.stats.each { |key, data| locals[key]=data }
+    process_haml(locals)
+    return true
+  end
+
+private
+
+  def process_haml(locals)
+    # Inject them into the HAML layout
+    haml=nil
+    File.open(File.join(@base_path, 'logstats', 'template.haml'), 'r') do |f|
+      haml=f.read
+    end
+    engine = Haml::Engine.new(haml)
+    html=engine.render(LogStats::Helpers, locals)
+
+    # Save the HAML to a file
+    File.open(@output_path, 'w') do |f|
+      f << html
+    end
+    return true
+  end
+end
+end

data/logstats.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "logstats/version"
+
+Gem::Specification.new do |s|
+  s.name        = "logstats"
+  s.version     = Logstats::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jason Stirk"]
+  s.email       = ["jstirk@oobleyboo.com"]
+  s.homepage    = "http://github.com/jstirk/logstats"
+  s.summary     = "Generates a simple HTML file based upon my custom timesheet format."
+  s.description = "Generates a simple HTML file based upon my custom timesheet format."
+
+  s.rubyforge_project = "logstats"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency('tail_from_sentinel', '>= 0.0.1')
+  s.add_dependency('haml', '~> 3.0.25')
+end

data/watchr/all.watchr

@@ -0,0 +1 @@
+watch( 'examples/.*\.haml' )  {|md| system("haml #{md[0]} #{md[0].gsub(/haml$/,'html')}") }

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: logstats
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jason Stirk
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-08 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: tail_from_sentinel
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 0
+        - 0
+        - 1
+        version: 0.0.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: haml
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 53
+        segments: 
+        - 3
+        - 0
+        - 25
+        version: 3.0.25
+  type: :runtime
+  version_requirements: *id002
+description: Generates a simple HTML file based upon my custom timesheet format.
+email: 
+- jstirk@oobleyboo.com
+executables: 
+- logstats
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- README
+- Rakefile
+- bin/logstats
+- examples/example.haml
+- lib/logstats.rb
+- lib/logstats/haml/helpers.rb
+- lib/logstats/template.haml
+- lib/logstats/version.rb
+- lib/logstats/worklog.rb
+- logstats.gemspec
+- watchr/all.watchr
+has_rdoc: true
+homepage: http://github.com/jstirk/logstats
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: logstats
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Generates a simple HTML file based upon my custom timesheet format.
+test_files: []
+