timestream 0.0.3 → 0.1.0

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+.*.swp

data/bin/timestream

@@ -1,8 +1,65 @@
 #!/usr/bin/env ruby
 
 require 'rubygems'
+
+require 'chronic'
+require 'optparse'
 require 'timestream/employee_activity_report'
+require 'timestream/hamster'
+require 'timestream/version'
+
+options = {}
+
+option_parser = OptionParser.new do |option_parser|
+  option_parser.banner = "Usage: timestream [--date-format=DATE_FORMAT] [--week YYYY-MM-DD]"
+  
+  options[:date_format] = :day_of_week
+  option_parser.on('-d',
+          '--date-format DATE_FORMAT',
+          "Format dates according to DATE_FORMAT.  Supports DATE_FORMAT of 'day_of_week', or 'erp'.") do |date_format|
+    options[:date_format] = date_format.to_sym
+  end
+  
+  option_parser.on_tail('-h', '--help', 'Show this message') do
+    puts option_parser
+    exit
+  end
+  
+  option_parser.on_tail('--version', 'Show version') do
+    puts Timestream::VERSION
+    exit
+  end
+  
+  option_parser.on('--week WEEK',
+                   "Read in data from Hamster and write it out to EAR for WEEK " \
+                   "beginning on Saturday.  Use Chronic gem for parsing WEEK, " \
+                   "so you do strings like 'last saturday'") do |week|
+    time = Chronic.parse(week, :context => :past)
+    options[:saturday] = Date.new(time.year, time.month, time.day)
+  end
+end
+
+option_parser.parse!
 
 employee_activity_report = Timestream::EmployeeActivityReport.new ARGV[0]
 
-puts employee_activity_report.to_text_table
+DAYS_PER_WEEK = 7
+HOURS_PER_DAY = 24
+MINUTES_PER_HOUR = 60
+SECONDS_PER_MINUTE = 60
+HOURS_PER_WEEK = DAYS_PER_WEEK * HOURS_PER_DAY
+MINUTES_PER_WEEK = HOURS_PER_WEEK * MINUTES_PER_HOUR
+SECONDS_PER_WEEK = MINUTES_PER_WEEK * SECONDS_PER_MINUTE 
+
+if options[:saturday]
+  saturday_date = options[:saturday]
+  saturday_time = Time.local(saturday_date.year, saturday_date.month, saturday_date.day)
+  # next saturday - 1 second for 23:59 on Friday
+  friday_time = saturday_time + (SECONDS_PER_WEEK) - 1
+  hamster = Timestream::Hamster.new(saturday_time, friday_time)
+  
+  employee_activity_report.updateFromHamster!(hamster)
+end
+
+puts employee_activity_report.to_text_table(options[:date_format])
+

data/lib/timestream/employee_activity_report.rb

@@ -4,25 +4,33 @@ require 'terminal-table/import'
 
 module Timestream
   class EmployeeActivityReport
-    class Cell
-      attr_reader :column
-      
-      def initialize(row, column)
-        @column = column
-        @row = row
-      end
-      
-      attr_reader :row
-    end
+    ACTIVITY_COLUMN = 2
     
-    def cell(location)
-      worksheet.row(location.row)[location.column]
-    end
-    
-    DATE_CELL = Cell.new(2, 1)
+    DATE_COLUMN = 1
+    DATE_ROW = 2
     
     DAY_COLUMN_SPAN = 3
     
+    def date_column(date)
+      slot = date_slot(date)
+      slot_column(slot)
+    end
+    
+    def date_slot(date)
+      day_delta = (date - saturday).to_i
+      
+      case day_delta
+        # Saturday and Sunday map to weekend
+        when 0..1
+          0
+        # All others map to their own day
+        when 2..6
+          day_delta - 1
+        else
+          raise ArgumentError, "#{date} is not in the same week as #{saturday}"
+      end
+    end
+    
     def initialize(path)
       @path = path
     end
@@ -33,6 +41,14 @@ module Timestream
       worksheet.row(index)
     end
     
+    def saturday
+      @saturday ||= worksheet.row(DATE_ROW)[DATE_COLUMN]
+    end
+    
+    def slot_column(slot)
+      9 + (slot * DAY_COLUMN_SPAN)
+    end
+    
     def spreadsheet
       @spreadsheet ||= Spreadsheet.open path
     end
@@ -79,13 +95,26 @@ module Timestream
       @timestream_by_project_number
     end
     
-    def to_text_table
+    def to_text_table(date_format=:day_of_week)
       employee_activity_report = self
+      
       table {
         self.headings = ['Project Number']
-        self.headings.concat Timestream::SLOT_NAMES.collect { |name|
-          name.to_s.capitalize
-        }
+        
+        case date_format
+          when :day_of_week
+            date_format = "%A"
+          when :erp
+            date_format = "%a %m/%d"
+        end
+         
+        Timestream::SLOT_NAMES.each_index do |sunday_offset|
+          # XXX assign weekend activity to sunday to simplify math
+          sunday = employee_activity_report.saturday + 1
+          slot_date = sunday + sunday_offset
+           
+          self.headings << slot_date.strftime(date_format)
+        end
         
         employee_activity_report.timestream_by_project_number.each do |project_number, timestream|
           row = [project_number]
@@ -98,6 +127,37 @@ module Timestream
       }
     end
     
+    def updateFromHamster(hamster)
+      # Categories in Hamster are mapped to Activities in EAR
+      
+      hamster.timestream_by_category.each do |category, timestream|
+        # XXX should this been creating EAR Timestreams instead of updating rows directly?
+        (12 .. 36).each do |row_index|
+          row = self.row(row_index)
+          activity = row[ACTIVITY_COLUMN]
+          
+          # XXX Category is assumed to be a substring of Activity since Activity is very wordy.
+          if activity and activity.include? category
+            timestream.each do |date, hours|
+              column = self.date_column(date)
+              row[column] ||= 0
+              row[column] += hours
+            end
+          end
+        end
+      end
+    end
+    
+    def updateFromHamster!(hamster)
+      updateFromHamster(hamster)
+      
+      # spreadsheet library recommends not writing back to same file, write to
+      # temporary file and then rename that file to original.
+      temporary_path = "#{path}.timestream"
+      spreadsheet.write(temporary_path)
+      File.rename(temporary_path, path)
+    end
+    
     def worksheet
       @worksheet ||= spreadsheet.worksheet "EAR - Current Week"
     end

data/lib/timestream/hamster.rb

@@ -0,0 +1,101 @@
+require 'rubygems'
+
+require 'date'
+require 'dbus'
+require 'terminal-table/import'
+require 'time'
+
+module Timestream
+  class Hamster
+    class Fact
+      attr_reader :category_name
+      attr_reader :date
+      attr_reader :delta_in_seconds
+      
+      def initialize(id, start_timestamp, end_timestamp, description, activity_name, activity_id, category_name, tag_list, date_timestamp, delta_in_seconds)
+        @id = id
+        
+        # Convert start and end to Times
+        @start_time = Time.at(start_timestamp)
+        @end_time = Time.at(end_timestamp)
+        
+        @description = description
+        @activity_name = activity_name
+        @activity_id = activity_id
+        @category_name = category_name
+        @tag_list = tag_list
+        
+        # Convert date to a Date
+        date_time = Time.at(date_timestamp)
+        date = Date.new(date_time.year, date_time.month, date_time.day)
+        @date = date
+        
+        @delta_in_seconds = delta_in_seconds
+      end
+    end
+    
+    def facts
+      dbus_facts = proxy.GetFacts(@start_time.to_i, @end_time.to_i, '')
+      # XXX for some reason GetFacts returns facts in a one-element array
+      dbus_facts = dbus_facts[0]
+      
+      # convert dbus facts into instances
+      dbus_facts.collect { |dbus_fact|
+        Fact.new(*dbus_fact)
+      }
+    end
+    
+    def initialize(start_time, end_time)
+      @start_time = start_time
+      @end_time = end_time
+    end
+    
+    def proxy
+      @proxy ||= begin
+        session_bus = DBus::SessionBus.instance
+        hamster_service = session_bus.service('org.gnome.Hamster')
+        hamster = hamster_service.object('/org/gnome/Hamster')
+        # interfaces and therefore methods won't work if not first introspected
+        hamster.introspect
+        # set interface so methods can be called directly on object
+        hamster.default_iface = 'org.gnome.Hamster'
+        
+        hamster
+      end
+    end
+    
+    class Timestream
+      def [](date)
+        @hours_by_date[date]
+      end
+      
+      def []=(date, hours)
+        @hours_by_date[date] = hours
+      end
+      
+      def initialize
+        @hours_by_date = Hash.new(0)
+      end
+      
+      def each(&block)
+        @hours_by_date.sort.each(&block)
+      end
+    end
+    
+    def timestream_by_category
+      if @timestream_by_category.nil?
+        @timestream_by_category = Hash.new { |hash, category|
+          hash[category] = Timestream.new
+        }
+        
+        facts.each do |fact|
+          timestream = @timestream_by_category[fact.category_name]
+          # convert seconds to fractional hours
+          timestream[fact.date] += fact.delta_in_seconds.fdiv(60 * 60)
+        end 
+      end
+      
+      @timestream_by_category
+    end
+  end
+end

data/lib/timestream/version.rb

@@ -1,3 +1,3 @@
 module Timestream
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/timestream.gemspec

@@ -14,6 +14,8 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "timestream"
   
+  s.add_dependency("chronic")
+  s.add_dependency("ruby-dbus")
   s.add_dependency("spreadsheet")
   s.add_dependency("terminal-table")
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: timestream
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 27
   prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 3
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors: 
 - Luke Imhoff
@@ -15,11 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-12 00:00:00 -05:00
+date: 2011-05-16 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: spreadsheet
+  name: chronic
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -33,7 +33,7 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: terminal-table
+  name: ruby-dbus
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -46,6 +46,34 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: spreadsheet
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: terminal-table
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
 description: Converts Hamster report to EAR to JDE Timecard
 email: 
 - luke@cray.com
@@ -62,6 +90,7 @@ files:
 - bin/timestream
 - lib/timestream.rb
 - lib/timestream/employee_activity_report.rb
+- lib/timestream/hamster.rb
 - lib/timestream/version.rb
 - timestream.gemspec
 has_rdoc: true