trak 0.0.3 → 0.0.4

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Change log
 
+## v0.0.4 (2012-05-01)
+
+Changed:
+
+* (ca1da2d): Use TRAK_DEBUG environment var instead of --debug
+* (d00089a): Moved todos into github issue tracker
+* (5cb50db): Fix for report format
+
+Closed:
+
+* (a6669ca): #11 - Refactor command-line specific code into bin/trak +
+  refactor Trak module
+* (f5fd613): Add -h|--help switch. Fixes #6
+* (a113869): Added version info. Fixes #7
+
 ## v0.0.3 (2012-04-30)
 
 Changed:

data/README.md

@@ -1,14 +1,14 @@
 # Trak: track chunks of time from the command line
 
-Trak, v0.0.3 (Apr 30, 2012)  
+Trak, v0.0.4 (May 1, 2012)
 Written by Adam Sharp
 
 ## Notice
 
-Trak was recently (i.e., last week) a Perl script. It has been ported to
-Ruby, but the code really looks like it's taken a beating and is
-definitely NOT what I want it to ultimately look like. Much more
-ruby-fying to happen yet, as well as support for the excellent
+Trak was recently a Perl script. It has been ported to Ruby, but the
+code really looks like it's taken a beating and is definitely NOT what I
+want it to ultimately look like. Much more ruby-fying to happen yet, as
+well as support for the excellent
 [Chronic](https://github.com/mojombo/chronic) gem for natural language
 date parsing in the pipeline.
 
@@ -19,8 +19,8 @@ Stay tuned.
 
 ## Description
 
-Trak is a utility for Mac OS X that allows you to quickly make a record
-of how much time you've spent on various tasks throughout the day.
+Trak is a utility that allows you to quickly make a record of how much
+time you've spent on various tasks throughout the day.
 
 Work logs are stored in `/Users/yourusername/Documents/Tracker/` with
 the format `YEAR-MONTH-DAY-time-log.txt`.
@@ -62,7 +62,7 @@ Where:
 You can use either
 
     $ trak 30 "Foo bar"
-    
+
 or
 
     $ trak 30 Foo bar
@@ -78,29 +78,3 @@ These are all valid commands:
     $ trak 30min Rewrite trak documentation  # => 30 minutes
     $ trak 4hours Refactor trak              # => 4 hours
     $ trak 15 Lunch                          # => 15 minutes
-
-## To do
-
-* Proper handling of incorrectly formatted dates
-* Write a report that gives a weekly breakdown given a date in that week
-* Add a `-h` usage/help switch
-* Make the personal time search more configurable by putting keywords to
-  search in an array
-* Have the different types of reports, and keywords for those reports,
-  completely stored in a configuration file. The last category in the
-  file is the default report. Because keywords for custom reports would
-  work on a whitelist system, everything that doesn't match goes into
-  the default. For example:
-
-        # Personal
-        lunch
-        uni
-        news
-        # Default
-        Work
-
-* Have the keywords in the configuration file actually be regexes. When
-  reading the config file, any empty lines or whitespace are ignored.
-* Give an estimate of completion time, with a configurable default for
-  the length of the work day. Also take into account the default length
-  of lunch break (configurable) if lunch hasn't yet been logged.

data/bin/trak

@@ -1,2 +1,180 @@
 #!/usr/bin/env ruby
+require 'trollop'
 require 'trak'
+require 'trak/exit'
+require 'trak/core_ext/time'
+
+# place where data is stored
+datadir = "#{ENV['HOME']}/Documents/Tracker/"
+%x[mkdir -p #{datadir}]
+
+# define command line options
+opts = Trollop::options do
+  version "trak version 0.0.4"
+  banner <<-BANNER
+Trak: log chunks of time from the command line
+Usage:
+    trak [-d|--date] <time> <message> # tracking mode
+    trak [-d|--date] [-r|--report]    # reporting mode
+    trak [-d|--date] -e|--edit        # opens time log in EDITOR
+
+Tracking time:
+    The <time> argument is the amount of time spent on the task, in
+    minutes. Append "h" for hours, e.g., 1.5h. Examples:
+
+        $ trak 15 email       # minimum 15 minutes
+        $ trak 25 lunch       # rounded to nearest 15m, i.e. 30
+        $ trak 1.5h bug 2345  # everything after <time> is the message
+
+Reporting:
+    The -r|--report option is optional, just typing `trak` with no
+    arguments will cause Trak to print a report for today. Use -d|--date
+    to print the report for another day.
+
+Dates:
+    Trak currently accepts dates in the format YYYY-MM-DD. All modes
+    accept the date argument (defaults to today).
+
+See http://github.com/sharplet/trak for more information.
+
+Options:
+BANNER
+  opt :date, "Specify the date of the log to work with",
+      :type => String, :short => "-d"
+  opt :report, "Print a report for the specified date", :short => "-l"
+  opt :edit, "Open the log for the specified date in EDITOR"
+end
+
+# all valid options have been processed, so figure out which mode
+# we're in...
+#
+# if we found a -r or -l option, ignore everything else
+Trak::breakpoint
+if opts[:report]
+  MODE = 'report'
+# now check if the user wants edit mode
+elsif opts[:edit]
+  MODE = 'edit'
+# if there are still unprocessed args (that didn't look like switches),
+# we're in insert mode
+elsif ARGV.length > 0
+  MODE = 'insert'
+# if all else fails, there were probably no args to begin with, so we're
+# in report mode
+else
+  MODE = 'report'
+end
+
+today = Time.now.strftime '%F'
+
+# did the user supply a date argument that isn't today?
+if opts[:date] && opts[:date] != today
+  fdate = opts[:date]
+# otherwise use today's date, formatted, and set date_arg to be false
+else
+  fdate = today
+  opts[:date] = nil
+end
+
+# set the output file name
+filename = "#{datadir}#{fdate}-time-log.txt"
+
+if MODE == 'report'
+  if File.exist? filename
+    # open the file and get it as an array
+    begin
+      file = File.open(filename).readlines.map &:chomp
+    rescue
+      Exit::exit_err "#{__FILE__}: #{$!}"
+    end
+
+    # The keys for each hash are the titles of the various tasks logged.
+    # The values are the total time spent on the task.
+    work = {}
+    personal = {}
+
+    # find the start time for the day we're reporting on
+    startTime = file.first.split[1]
+
+    # process each line of the file
+    file[1..file.size].each do |line|
+      minutes, text = line.split(': ')
+      unless text =~ /personal|uni|lunch|home/
+        work[text] = 0 unless work.include? text
+        work[text] += minutes.to_i
+      else
+        personal[text] = 0 unless personal.include? text
+        personal[text] += minutes.to_i
+      end
+    end
+
+    # print the report
+    if opts[:date]
+        puts "# Logged work for #{fdate}"
+    else
+        puts "# Today's logged work"
+    end
+
+    workTotal = Trak::printSubReport(work, "Work")
+    personalTotal = Trak::printSubReport(personal, "Personal")
+
+    newTimeString = Trak::to12HourTime(Trak::newTimeWithMinutes(startTime, workTotal + personalTotal))
+    print "Hours logged until #{newTimeString} (since #{Trak::to12HourTime(startTime)}). "
+
+    # if we're reporting for today, print the current time
+    puts (!opts[:date]) ? "Currently #{Trak::to12HourTime(Time.now.strftime(Trak::TIME_FORMAT_24HOUR))}." : nil
+  else
+    if opts[:date]
+      STDERR.puts "No time log for #{fdate}. Track some time first."
+    else
+      STDERR.puts "No time log for today. Track some time first.\n"
+    end
+  end
+
+elsif MODE == 'edit'
+  if File.exist? filename
+    if ENV['EDITOR']
+      exec "#{ENV['EDITOR']} #{filename}"
+    else
+      exec "open", filename
+    end
+    exit
+  else
+    Exit::exit_err "#{__FILE__}: #{filename} does not exist or unable to open."
+  end
+
+elsif MODE == 'insert'
+  if opts[:date]
+    puts "WARNING: Adding time to a day other than today is not recommended."
+    print "Continue? (y/n) "
+    input = STDIN.readline.chomp
+    unless input =~ /^y(es)?/i
+        Exit::exit_err "Timelog update cancelled."
+    end
+  end
+
+  # process arguments
+  Trak::breakpoint
+  minutes = Trak::processTimeArgument ARGV.shift
+  message = ARGV.join(" ")
+
+  # open the output file
+  first_time = !File.exist?(filename)
+  Trak::breakpoint
+  begin
+    File.open filename, 'a', :autoclose => true do |file|
+      if first_time
+        Trak::breakpoint
+        currentTimeInMinutes = Time.now.to_minutes
+        startTime = Trak::minutesToTime((currentTimeInMinutes - minutes).round_to_nearest 15)
+        file.puts "#{fdate} #{startTime}"
+      end
+      file.puts "#{minutes}: #{message}"
+    end
+  rescue
+    Exit::exit_err "Couldn't open #{filename}: #{$!}"
+  end
+
+else
+    Exit::exit_err "Couldn't determine the correct mode (I was given '#{MODE}'): #{$!}"
+end

data/lib/trak.rb

@@ -1,166 +1,97 @@
-#!/usr/bin/env ruby
+module Trak
+  require 'trak/core_ext/blank'
+  require 'trak/core_ext/round_to_nearest'
+  require 'debugger'
 
-# command:
-#   $ trak 30 work on trak
-#   $ trak 1h work really hard on trak
-#
-# format:
-#   - First arg is how much time spent
-#   - Second arg is a description
+  TIME_FORMAT_12HOUR = "%l:%M %p"
+  TIME_FORMAT_24HOUR = "%k:%M"
 
-require 'trollop'
-require 'debugger'
-
-require 'trak/trak'
-require 'trak/exit'
-require 'trak/core_ext/time'
-
-# place where data is stored
-datadir = "#{ENV['HOME']}/Documents/Tracker/"
-%x[mkdir -p #{datadir}]
-
-# define command line options
-opts = Trollop::options do
-  opt :report, "Reporting mode", :short => "-l"
-  opt :edit, "Edit mode"
-  opt :date, "The date", :type => String, :short => "-d"
-  opt :debug, "Debugging mode", :short => "-i"
-end
-
-$g_opts = opts
-def debug(steps = 1)
-  debugger(steps) if $g_opts[:debug]
-end
-
-# all valid options have been processed, so figure out which mode
-# we're in...
-#
-# if we found a -r or -l option, ignore everything else
-if opts[:report]
-  MODE = 'report'
-# now check if the user wants edit mode
-elsif opts[:edit]
-  MODE = 'edit'
-# if there are still unprocessed args (that didn't look like switches),
-# we're in insert mode
-elsif ARGV.length > 0
-  MODE = 'insert'
-# if all else fails, there were probably no args to begin with, so we're
-# in report mode
-else
-  MODE = 'report'
-end
-
-today = Time.now.strftime '%F'
+  def self.breakpoint(steps = 1)
+    debugger(steps) if ENV['TRAK_DEBUG'] == "1"
+  end
 
-# did the user supply a date argument that isn't today?
-if opts[:date] && opts[:date] != today
-  fdate = opts[:date]
-# otherwise use today's date, formatted, and set date_arg to be false
-else
-  fdate = today
-  opts[:date] = nil
-end
+  # expects a hash of tasks mapped to time spent, and a sub-report name
+  #   (e.g., work, personal)
+  # prints a formatted sub-report
+  # returns the total hours worked
+  def self.printSubReport(report_hash, report_title)
+    total = 0
+    unless report_hash.empty?
+      count = 0
+      report_out = ""
+      report_hash.each do |title, minutes|
+        total += minutes.to_i
+        count += 1
+        report_out += "=> #{timeString(minutes)}: #{title}"
+        report_out += "\n" unless count == report_hash.size
+      end
+      puts "# #{report_title} time (#{timeString(total)})"
+      puts report_out
+    end
+    total
+  end
 
-# set the output file name
-filename = "#{datadir}#{fdate}-time-log.txt"
+  def self.time_with_hours_minutes(*hm)
+    dmy = Time.now.to_a[3..5].reverse
+    Time.new(*dmy, *hm)
+  end
 
-if MODE == 'report'
-  if File.exist? filename
-    # open the file and get it as an array
-    begin
-      file = File.open(filename).readlines.map &:chomp
-    rescue
-      Exit::exit_err "#{__FILE__}: #{$!}"
-    end
-    
-    # The keys for each hash are the titles of the various tasks logged.
-    # The values are the total time spent on the task.
-    work = {}
-    personal = {}
-    
-    # find the start time for the day we're reporting on
-    startTime = file.first.split[1]
-    
-    # process each line of the file
-    file[1..file.size].each do |line|
-      minutes, text = line.split(': ')
-      unless text =~ /personal|uni|lunch|home/
-        work[text] = 0 unless work.include? text
-        work[text] += minutes.to_i
-      else
-        personal[text] = 0 unless personal.include? text
-        personal[text] += minutes.to_i
+  # expects a number of minutes
+  # if less than 60 returns the number with an "m"
+  # otherwise converts to hours and adds an "h"
+  def self.timeString(minutes)
+    if minutes >= 60
+      hours = minutes/60.0
+      if hours % 1 == 0
+        hours = hours.to_i
       end
-    end
-    
-    # print the report
-    if opts[:date]
-        puts "# Logged work for #{fdate}"
+      "#{hours}h"
     else
-        puts "# Today's logged work"
-    end
-    
-    workTotal = Trak::printSubReport(work, "Work")
-    personalTotal = Trak::printSubReport(personal, "Personal")
-    
-    newTimeString = Trak::to12HourTime(Trak::newTimeWithMinutes(startTime, workTotal + personalTotal))
-    puts "Hours logged until #{newTimeString} (since #{Trak::to12HourTime(startTime)}). "
-    
-    # if we're reporting for today, print the current time
-    puts "Currently #{Trak::to12HourTime(Time.now.strftime(Trak::TIME_FORMAT_24HOUR))}." unless opts[:date]
-  else
-    if opts[:date]
-      STDERR.puts "No time log for #{fdate}. Track some time first."
-    else
-      STDERR.puts "No time log for today. Track some time first.\n"
+      "#{minutes}m"
     end
   end
 
-elsif MODE == 'edit'
-  if File.exist? filename
-    if ENV['EDITOR']
-      exec "#{ENV['EDITOR']} #{filename}"
-    else
-      exec "open", filename
-    end
-    exit
-  else
-    Exit::exit_err "#{__FILE__}: #{filename} does not exist or unable to open."
+  def self.newTimeWithMinutes(start_time, minutes)
+    hm = start_time.split ':'
+    Time.at(time_with_hours_minutes(*hm).to_i + minutes.to_i*60).strftime(TIME_FORMAT_24HOUR).strip
   end
 
-elsif MODE == 'insert'
-  if opts[:date]
-    puts "WARNING: Adding time to a day other than today is not recommended."
-    print "Continue? (y/n) "
-    input = STDIN.readline.chomp
-    unless input =~ /^y(es)?/i
-        Exit::exit_err "Timelog update cancelled."
+  def self.to12HourTime(time)
+    unless time.blank?
+      hm = time.split ':'
+      time_with_hours_minutes(*hm).strftime(TIME_FORMAT_12HOUR).strip
     end
   end
-  
-  # process arguments
-  debug
-  minutes = Trak::processTimeArgument ARGV.shift
-  message = ARGV.join(" ")
-  
-  # open the output file
-  first_time = !File.exist?(filename)
-  # debug
-  begin
-    File.open filename, 'a', :autoclose => true do |file|
-      if first_time
-        debug
-        currentTimeInMinutes = Time.now.to_minutes
-        startTime = Trak::minutesToTime((currentTimeInMinutes - minutes).round_to_nearest 15)
-        file.puts "#{fdate} #{startTime}"
+
+  # expects a single argument - the time argument in the format ##m or ##h
+  # if argument has no m/h qualifier, assume m
+  # returns a number of minutes
+  def self.processTimeArgument(time_string)
+    if time_string =~ /^(\d*\.?\d+)((m|min|minute|minutes)|(h|hr|hour|hours))?$/i
+      time = $1.to_f
+      modifier = $2
+      minutes = (modifier =~ /h.*/) ? time * 60 : time
+
+      # check enough time has been logged
+      if minutes < 15
+        STDERR.puts "You must log at least 15 minutes."
+        exit 1
       end
-      file.puts "#{minutes}: #{message}"
+
+      minutes.round_to_nearest 15
+    else
+      STDERR.puts "Incorrectly formatted argument."
+      exit 1
     end
-  rescue
-    Exit::exit_err "Couldn't open #{filename}: #{$!}"
   end
 
-else
-    Exit::exit_err "Couldn't determine the correct mode (I was given '#{MODE}'): #{$!}"
+  # expects an integer
+  def self.minutesToTime(minutes)
+    time_with_hours_minutes(minutes / 60, minutes % 60).strftime(TIME_FORMAT_24HOUR).strip
+  end
+
+  # expects an integer which is the amount of minutes logged
+  def self.startTimeInMinutes(minutes)
+    Time.now.to_minutes.round_to_nearest(15) - minutes
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trak
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-30 00:00:00.000000000 Z
+date: 2012-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
@@ -53,7 +53,6 @@ files:
 - lib/trak/core_ext/round_to_nearest.rb
 - lib/trak/core_ext/time.rb
 - lib/trak/exit.rb
-- lib/trak/trak.rb
 - lib/trak.rb
 - bin/trak
 - CHANGELOG.md

data/lib/trak/trak.rb

@@ -1,92 +0,0 @@
-require "trak/core_ext/blank"
-require "trak/core_ext/round_to_nearest"
-
-module Trak
-  TIME_FORMAT_12HOUR = "%l:%M %p"
-  TIME_FORMAT_24HOUR = "%k:%M"
-  
-  # expects a hash of tasks mapped to time spent, and a sub-report name
-  #   (e.g., work, personal)
-  # prints a formatted sub-report
-  # returns the total hours worked
-  def self.printSubReport(report_hash, report_title)
-    total = 0
-    unless report_hash.empty?
-      count = 0
-      report_out = ""
-      report_hash.each do |title, minutes|
-        total += minutes.to_i
-        count += 1
-        report_out += "=> #{timeString(minutes)}: #{title}"
-        report_out += "\n" unless count == report_hash.size
-      end
-      puts "# #{report_title} time (#{timeString(total)})"
-      puts report_out
-    end
-    total
-  end
-  
-  def self.time_with_hours_minutes(*hm)
-    dmy = Time.now.to_a[3..5].reverse
-    Time.new(*dmy, *hm)
-  end
-  
-  # expects a number of minutes
-  # if less than 60 returns the number with an "m"
-  # otherwise converts to hours and adds an "h"
-  def self.timeString(minutes)
-    if minutes >= 60
-      hours = minutes/60.0
-      if hours % 1 == 0
-        hours = hours.to_i
-      end
-      "#{hours}h"
-    else
-      "#{minutes}m"
-    end
-  end
-  
-  def self.newTimeWithMinutes(start_time, minutes)
-    hm = start_time.split ':'
-    Time.at(time_with_hours_minutes(*hm).to_i + minutes.to_i*60).strftime(TIME_FORMAT_24HOUR).strip
-  end
-  
-  def self.to12HourTime(time)
-    unless time.blank?
-      hm = time.split ':'
-      time_with_hours_minutes(*hm).strftime(TIME_FORMAT_12HOUR).strip
-    end
-  end
-  
-  # expects a single argument - the time argument in the format ##m or ##h
-  # if argument has no m/h qualifier, assume m
-  # returns a number of minutes
-  def self.processTimeArgument(time_string)
-    if time_string =~ /^(\d*\.?\d+)((m|min|minute|minutes)|(h|hr|hour|hours))?$/i
-      time = $1.to_f
-      modifier = $2
-      minutes = (modifier =~ /h.*/) ? time * 60 : time
-
-      # check enough time has been logged
-      if minutes < 15
-        STDERR.puts "You must log at least 15 minutes."
-        exit 1
-      end
-
-      minutes.round_to_nearest 15
-    else
-      STDERR.puts "Incorrectly formatted argument."
-      exit 1
-    end
-  end
-
-  # expects an integer
-  def self.minutesToTime(minutes)
-    time_with_hours_minutes(minutes / 60, minutes % 60).strftime(TIME_FORMAT_24HOUR).strip
-  end
-
-  # expects an integer which is the amount of minutes logged
-  def self.startTimeInMinutes(minutes)
-    Time.now.to_minutes.round_to_nearest(15) - minutes
-  end
-end