Class: LogStats::WorkLog

Inherits:
TailFromSentinel::Base
  • Object
show all
Defined in:
lib/logstats/worklog.rb

Constant Summary collapse

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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(filename) ⇒ WorkLog

Returns a new instance of WorkLog.



38
39
40
41
42
 
# File 'lib/logstats/worklog.rb', line 38

def initialize(filename)
  @last_seen_year=nil
  @stas=nil
  super(File.open(filename, 'r'), &DATE_SENTINEL_PROC)
end

Class Method Details

.last_seen_year ⇒ Object 



24
25
26
 
# File 'lib/logstats/worklog.rb', line 24

def self.last_seen_year
  @@last_seen_year
end

.last_seen_year=(year) ⇒ Object 



28
29
30
 
# File 'lib/logstats/worklog.rb', line 28

def self.last_seen_year=(year)
  @@last_seen_year=year
end

.now ⇒ Object 



20
21
22
 
# File 'lib/logstats/worklog.rb', line 20

def self.now
  @@now ||= Time.now
end

.parse_sentinel(d, m, y) ⇒ Object 



32
33
34
35
36
 
# File 'lib/logstats/worklog.rb', line 32

def self.parse_sentinel(d,m,y)
  year=y || self.last_seen_year
  self.last_seen_year=year
  [ d, m, year ]
end

Instance Method Details

#compile_day_data(days) ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/logstats/worklog.rb', line 102

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 => { }
                     }
        }

  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][: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|
        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|
      if project then
        stats[:month][:projects][project] ||= 0
        stats[:month][:projects][project] += duration
      end
    end
  end

  # 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

#parse_worklog_record(current_time, sh, sm, msg, eh = nil, em = nil) ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/logstats/worklog.rb', line 83

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=false
  end
  [ duration, project ]
end

#stats ⇒ Object

TODO: Document this



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/logstats/worklog.rb', line 45

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, :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]={ :total => duration, :billable => 0 }
        days[:current][:billable] = duration if project
        
      when /^\s*$/
        # Blank line - ignore
      else
       puts "Warning: Unknown format of \"#{line}\""
    end
  end
  @stats=compile_day_data(days)
end

#time_to_date(time) ⇒ Object 



172
173
174
 
# File 'lib/logstats/worklog.rb', line 172

def time_to_date(time)
  Date.new(time.year, time.month, time.day)
end