tasklogger 0.0.2

data/Rakefile

@@ -0,0 +1,80 @@
+require "rake/testtask"
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+require "rubygems"
+require "rake/gempackagetask"
+require "rake/rdoctask"
+
+# This builds the actual gem. For details of what all these options
+# mean, and other ones you can add, check the documentation here:
+#
+#   http://rubygems.org/read/chapter/20
+#
+spec = Gem::Specification.new do |s|
+
+  # Change these as appropriate
+  s.name              = "tasklogger"
+  s.version           = "0.0.2"
+  s.summary           = "A simple task/time logging utility"
+  s.author            = "Chris Roos"
+  s.email             = "chris@seagul.co.uk"
+  s.homepage          = "http://chrisroos.co.uk"
+
+  s.has_rdoc          = true
+  # You should probably have a README of some kind. Change the filename
+  # as appropriate
+  # s.extra_rdoc_files  = %w(README)
+  # s.rdoc_options      = %w(--main README)
+
+  # Add any extra files to include in the gem (like your README)
+  s.files             = %w(Rakefile) + Dir.glob("{bin,test,lib/**/*}")
+  s.executables       = FileList["bin/**"].map { |f| File.basename(f) }
+  s.require_paths     = ["lib"]
+
+  # If you want to depend on other gems, add them here, along with any
+  # relevant versions
+  # s.add_dependency("some_other_gem", "~> 0.1.0")
+  s.add_dependency 'fastercsv'
+
+  # If your tests use any gems, include them here
+  # s.add_development_dependency("mocha") # for example
+  s.add_development_dependency 'mocha'
+end
+
+# This task actually builds the gem. We also regenerate a static
+# .gemspec file, which is useful if something (i.e. GitHub) will
+# be automatically building a gem for this project. If you're not
+# using GitHub, edit as appropriate.
+#
+# To publish your gem online, install the 'gemcutter' gem; Read more
+# about that here: http://gemcutter.org/pages/gem_docs
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Build the gemspec file #{spec.name}.gemspec"
+task :gemspec do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, "w") {|f| f << spec.to_ruby }
+end
+
+task :package => :gemspec
+
+# Generate documentation
+Rake::RDocTask.new do |rd|
+
+  rd.rdoc_files.include("lib/**/*.rb")
+  rd.rdoc_dir = "rdoc"
+end
+
+desc 'Clear out RDoc and generated packages'
+task :clean => [:clobber_rdoc, :clobber_package] do
+  rm "#{spec.name}.gemspec"
+end

data/bin/tasklogger

@@ -0,0 +1,161 @@
+#! /usr/bin/env ruby
+
+$: << File.join(File.dirname(__FILE__), '..', 'lib')
+require 'rubygems'
+require 'fastercsv'
+require 'task_logger'
+
+unless description = ARGV[0]
+  puts "Please enter a description for this task."
+  exit 1
+end
+
+default_timelog = File.join(ENV['HOME'], 'timelog.csv')
+timelog = ENV['TIMELOG_DATA'] ? ENV['TIMELOG_DATA'] : default_timelog
+
+# puts "Logging task data to #{timelog}"
+
+time_format = "%Y-%m-%d %H:%M"
+
+if description == 'open'
+  `mate #{timelog}`
+  exit
+end
+
+if description == 'stop'
+  entries    = FasterCSV.read(timelog)
+  last_entry = entries.last
+  if last_entry[1]
+    puts "The last entry already has an end time and I'm not going to overwrite it."
+    exit 1
+  end
+  last_entry[1] = Time.now.strftime(time_format)
+  File.open(timelog, 'w') do |file|
+    entries.each do |entry|
+      file.puts entry.to_csv
+    end
+  end
+  `mate #{timelog}`
+  exit
+end
+
+def hms(duration)
+  hours   = duration.to_i / 3600
+  seconds = duration.to_i % 3600
+  minutes = seconds / 60
+  seconds = seconds % 60
+  [hours, minutes, seconds].join(":")
+end
+
+def decimal_hours(seconds)
+  minutes = seconds / 60.0
+  minutes / 60.0
+end
+
+if description == 'report'
+  require 'time'
+
+  if project_filter = ARGV[1]
+    csv_data = File.read(timelog)
+    total_duration = 0
+
+    puts ''
+    header = 'Start'.ljust(23) + 'End'.ljust(23) + 'Seconds'.ljust(8) + 'H:M:S'.ljust(8) + "Hours".ljust(8) + 'Project'.ljust(12) + 'Description'
+    puts header
+    puts '=' * header.length
+
+    previous_day, day_duration = nil, 0
+
+    rows = FasterCSV.parse(csv_data)
+    matching_entries = rows.select do |row|
+      start_time, end_time, project_name, description = row
+      project_name == project_filter
+    end
+
+    matching_entries.each do |row|
+      start_time, end_time, project_name, description = row
+
+      duration = 0
+      if end_time
+        start_time = Time.parse(start_time)
+        end_time   = Time.parse(end_time)
+        duration   = (end_time - start_time)
+      end
+
+      if (row != matching_entries.first and previous_day != start_time.send(:to_date))
+        # We're on a new day
+        puts '                                              ' + '-'*7 + ' ' + '-'*7 + ' ' + '-'*7
+        print '                                              '
+        print day_duration.to_s.ljust(8)
+        print hms(day_duration).ljust(8)
+        print format("%0.2f", decimal_hours(day_duration)).ljust(8)
+        puts ''
+        puts ''
+        day_duration = 0
+      end
+      previous_day = start_time.send(:to_date)
+      day_duration += duration
+
+      total_duration += duration
+      row.insert(2, duration)
+      row.insert(3, hms(duration))
+      row.insert(4, decimal_hours(duration))
+
+      print Time.parse(row[0]).strftime("%a %d %b %Y %H:%M").ljust(23)
+      print Time.parse(row[1]).strftime("%a %d %b %Y %H:%M").ljust(23)
+      print row[2].to_s.ljust(8)
+      print row[3].to_s.ljust(8)
+      print format("%0.2f", row[4]).ljust(8)
+      print row[5].to_s.ljust(12)
+      puts row[6]
+
+      if row == matching_entries.last
+        # We're on the last day
+        print '                                              '
+        print day_duration.to_s.ljust(8)
+        print hms(day_duration).ljust(8)
+        print format("%0.2f", decimal_hours(day_duration)).ljust(8)
+        puts ''
+        puts ''
+        day_duration = 0
+      end
+
+    end
+    puts ''
+    puts 'Total duration (H:M:S): ' + hms(total_duration)
+    puts "Total duration (decimal hours): #{decimal_hours(total_duration)}"
+    puts ''
+
+  else
+    d = Hash.new(0)
+
+    csv_data = File.read(timelog)
+    FasterCSV.parse(csv_data).each do |row|
+      start_time, end_time, project_name, description = row
+      if end_time
+        start_time = Time.parse(start_time)
+        end_time   = Time.parse(end_time)
+        duration   = (end_time - start_time)
+        d[project_name] += duration
+      end
+    end
+
+    d.each_pair do |project_name, duration|
+      p [project_name, hms(duration)]
+    end
+  end
+  exit
+end
+
+if description == 'resume'
+  TaskLogger.new(timelog).resume
+  exit
+end
+
+if description == 'list'
+  TaskLogger.new(timelog).list
+  exit
+end
+
+# Otherwise we're starting a new task
+TaskLogger.new(timelog).start description

data/lib/task.rb

@@ -0,0 +1,53 @@
+require 'time'
+
+class Task
+  
+  TIME_FORMAT     = "%Y-%m-%d %H:%M"
+  DEFAULT_PROJECT = '<project-name>'
+  
+  attr_reader   :started_at, :finished_at
+  attr_accessor :project, :description
+  
+  def self.from_array(task_data)
+    description = task_data[3]
+    started_at  = Time.parse(task_data[0]) if task_data[0]
+    finished_at = Time.parse(task_data[1]) if task_data[1]
+    project     = task_data[2]
+    new(description, started_at, finished_at, project)
+  end
+  
+  def initialize(description, started_at = nil, finished_at = nil, project = nil)
+    @started_at  = started_at || Time.now
+    @finished_at = finished_at
+    @project     = project || DEFAULT_PROJECT
+    @description = description
+  end
+  
+  def restart!
+    @started_at  = Time.now
+    @finished_at = nil
+  end
+  
+  def finish!
+    @finished_at = Time.now unless finished?
+  end
+  
+  def to_a
+    [formatted_started_at, formatted_finished_at, @project, @description]
+  end
+  
+  private
+  
+    def finished?
+      @finished_at
+    end
+    
+    def formatted_started_at
+      @started_at.strftime(TIME_FORMAT) if @started_at
+    end
+
+    def formatted_finished_at
+      @finished_at.strftime(TIME_FORMAT) if @finished_at
+    end
+    
+end

data/lib/task_logger.rb

@@ -0,0 +1,68 @@
+require 'task'
+
+class TaskLogger
+  
+  TIME_FORMAT = "%Y-%m-%d %H:%M"
+  
+  def initialize(tasks_path)
+    @tasks_path = tasks_path
+  end
+  
+  def start(task_description)
+    task = Task.new(task_description)
+    if last_task_data = tasks.pop
+      last_task = Task.from_array(last_task_data)
+      last_task.finish!
+      tasks << last_task.to_a
+    end
+    tasks << task.to_a
+    write_tasks
+  end
+  
+  def resume
+    exit_if_missing_data
+    
+    last_task_data        = tasks.pop
+    last_task             = Task.from_array(last_task_data)
+    last_task.finish!
+
+    penultimate_task_data = tasks.last
+    penultimate_task      = Task.from_array(penultimate_task_data)
+    penultimate_task.restart!
+
+    tasks << last_task.to_a
+    tasks << penultimate_task.to_a
+
+    write_tasks
+  end
+  
+  def list
+    exit_if_missing_data
+    
+    tasks[-5, 5].each do |task|
+      puts task.to_csv
+    end
+  end
+  
+  private
+  
+    def tasks
+      @tasks ||= File.exists?(@tasks_path) ? FasterCSV.read(@tasks_path) : []
+    end
+    
+    def exit_if_missing_data
+      if tasks.empty?
+        puts "Error. The timelog data cannot be found."
+        exit 1
+      end
+    end
+    
+    def write_tasks
+      File.open(@tasks_path, 'w') do |file|
+        tasks.each do |task|
+          file.puts task.to_csv
+        end
+      end
+    end
+    
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: tasklogger
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Chris Roos
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-26 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: fastercsv
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: chris@seagul.co.uk
+executables: 
+- tasklogger
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- lib/task.rb
+- lib/task_logger.rb
+has_rdoc: true
+homepage: http://chrisroos.co.uk
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A simple task/time logging utility
+test_files: []
+