logstats 0.0.2 → 0.0.3

data/.gitignore

@@ -2,4 +2,7 @@ pkg/*
 *.gem
 .bundle
 scratch/
+examples/
+watchr/
 logstats.html
+.rvmrc

data/CHANGELOG

@@ -1,4 +1,8 @@
+0.0.3 (08Dec2011)
+  BUGFIX: Update to correctly distinguish between billable (with project code) and non-billable (without project code).
+  Added basic "% billable" statistic, and total time for the period. Default display is now billable.
+  Tweaked styles to work better with the additional data.
 0.0.2 (08Dec2011)
-  BUGFIX: Failed to calculate today's time when there wasn't an open task
+  BUGFIX: Failed to calculate today's time when there wasn't an open task.
 0.0.1 (08Dec2011)
-  Initial Release
+  Initial Release.

data/lib/logstats/haml/helpers.rb

@@ -9,6 +9,9 @@ module Helpers
     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
+    if o.size == 0 then
+      o << "<span class=\"none\">NONE :(</span>"
+    end
     o.join(' ')
   end
 
@@ -19,8 +22,40 @@ module Helpers
     "<span class=\"#{options[:class]}\">#{self.time_to_html(seconds)}</span>"
   end
 
+  def self.threshold_met?(seconds, period)
+    (self.threshold_for_period(period) - seconds) < 0
+  end
+
   def self.remaining_tag(seconds_so_far, period)
-    seconds_required=case period
+    seconds=self.threshold_for_period(period) - seconds_so_far
+
+    css_class=[ 'remaining ']
+    if 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
+
+  # Outputs some basic productivity statistics
+  def self.productivity_tag(data)
+    o=[]
+    css_classes=[ 'productivity' ]
+
+    if data[:total] > 0 then
+      o << self.time_to_html(data[:total]) if data[:total] > 0
+      percent=((data[:billable] / data[:total]) * 100).ceil
+      o << "#{percent}% billable"
+    end
+
+    "<div class=\"#{css_classes.join(' ')}\">#{o.join(' | ')}</div>"
+  end
+
+  # Returns the threshold number of seconds that need to be attained each period
+  def self.threshold_for_period(period)
+    case period
       when :day
         # 5 hrs per day
         5 * 3600
@@ -30,17 +65,6 @@ module Helpers
       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

@@ -46,23 +46,30 @@
               :padding 0
 
           .duration
-            :font-size 200%
             :color $text_faded_color
             :line-height 40px
+            :font-variant small-caps
+            :font-size 150%
 
             span
               :color $text_color
+              // 1.5x bigger than the HR/MIN
+              :font-size 150%
 
           .met
             :color $success_color
 
+            .remaining
+              :color $success_color
+
             .duration
               :color $success_faded_color
 
               span
                 :color $success_color
 
-          //.remaining, .average
+          .remaining
+            :color red
           
           .recent, .history
             :width 200px
@@ -86,6 +93,9 @@
               :padding 5px
               :border-left 1px solid $border_color
 
+              .duration
+                :line-height 35px
+
             .today, .week
               :border-bottom 1px solid $border-color
               
@@ -96,28 +106,31 @@
         .current
           %h1 Current Task
           - if current then
-            = duration_tag(current)
+            = duration_tag(current[:total])
           - else
             N/A
         .today
-          %h1 Projects
+          %h1 Today's Projects
           %ul.projects
             - today[:projects].each do |project, time|
               %li
-                %span.project= project
+                %span.project= project || "Misc."
                 = duration_tag(time)
       .history
-        .today{ :class => (today[:remaining].nil? ? 'met' : nil )}
+        .today{ :class => (threshold_met?(today[:billable], :day) ? 'met' : nil )}
           %h1 Today
-          = duration_tag(today[:total])
-          = remaining_tag(today[:total], :day)
+          = duration_tag(today[:billable])
+          = remaining_tag(today[:billable], :day)
+          = productivity_tag(today)
 
-        .week{ :class => (week[:remaining].nil? ? 'met' : nil )}
+        .week{ :class => (threshold_met?(week[:billable], :week) ? 'met' : nil )}
           %h1 Week
-          = duration_tag(week[:total])
-          = remaining_tag(week[:total], :week)
+          = duration_tag(week[:billable])
+          = remaining_tag(week[:billable], :week)
+          = productivity_tag(week)
         .month
           %h1 Month
-          = duration_tag(month[:total])
+          = duration_tag(month[:billable])
           .average
-            (#{time_to_html(month[:average])} average)
+            #{time_to_html(month[:average])} / day avg.
+          = productivity_tag(month)

data/lib/logstats/version.rb

@@ -1,3 +1,3 @@
 module Logstats
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/logstats/worklog.rb

@@ -55,19 +55,21 @@ class WorkLog < TailFromSentinel::Base
         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 => {} }
+          days[current_time]={ :total => 0, :billable => 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][:billable] += duration if project
           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
+          days[:current]={ :total => duration, :billable => 0 }
+          days[:current][:billable] = duration if project
           
         when /^\s*$/
           # Blank line - ignore
@@ -92,7 +94,7 @@ class WorkLog < TailFromSentinel::Base
     if msg.match(/^([A-Z0-9]{3})/) then
       project=$1
     else
-      project='MISC'
+      project=false
     end
     [ duration, project ]
   end
@@ -100,14 +102,19 @@ class WorkLog < TailFromSentinel::Base
   def compile_day_data(days)
     stats={ :current => days[:current],
             :today  => { :total => 0,
+                         :billable => 0,
                          :projects => { }
                        },
             :week   => { :total => 0,
+                         :billable => 0,
                          :average => 0,
+                         :average_billable => 0,
                          :projects => { }
                        },
             :month  => { :total => 0,
+                         :billable => 0,
                          :average => 0,
+                         :average_billable => 0,
                          :days_logged => 0,
                          :projects => { }
                        }
@@ -124,25 +131,40 @@ class WorkLog < TailFromSentinel::Base
 
       if time_to_date(time).cweek == today.cweek then
         stats[:week][:total] += data[:total]
+        stats[:week][:billable] += data[:billable]
         stats[:week][:average] = (stats[:week][:total] / time_to_date(time).wday.to_f)
+        stats[:week][:average_billable] = (stats[:week][:billable] / time_to_date(time).wday.to_f)
         data[:projects].each do |project, duration|
-          stats[:week][:projects][project] ||= 0
-          stats[:week][:projects][project] += duration
+          if project then
+            stats[:week][:projects][project] ||= 0
+            stats[:week][:projects][project] += duration
+          end
         end
       end
 
       # Everything is included in this month
       stats[:month][:total] += data[:total]
+      stats[:month][:billable] += data[:billable]
       stats[:month][:days_logged] += 1
       stats[:month][:average] = (stats[:month][:total] / stats[:month][:days_logged])
+      stats[:month][:average_billable] = (stats[:month][:billable] / stats[:month][:days_logged])
       data[:projects].each do |project, duration|
-        stats[:month][:projects][project] ||= 0
-        stats[:month][:projects][project] += duration
+        if project then
+          stats[:month][:projects][project] ||= 0
+          stats[:month][:projects][project] += duration
+        end
       end
     end
 
-    stats[:today][:total] += days[:current] unless days[:current].nil?
-    #stats[:today][:projects]['WIP'] = days[:current]
+    # Now add in the current task, if it is present
+    if days[:current] then
+      stats[:today][:total] += days[:current][:total]
+      stats[:today][:billable] += days[:current][:billable]
+      stats[:week][:total] += days[:current][:total]
+      stats[:week][:billable] += days[:current][:billable]
+      stats[:month][:total] += days[:current][:total]
+      stats[:month][:billable] += days[:current][:billable]
+    end
 
     return stats
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: logstats
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Jason Stirk
@@ -61,21 +61,18 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
-- .rvmrc
 - CHANGELOG
 - 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: []

data/.rvmrc

@@ -1,7 +0,0 @@
-
-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/examples/example.haml

@@ -1,128 +0,0 @@
-!!!
-%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/watchr/all.watchr

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