tracking 1.0.0 → 1.1.0

data/.travis.yml

@@ -1,5 +1,8 @@
 language: ruby
 rvm:
 - 1.9.3
-- jruby-19mode #JRuby in 1.9 mode
-- rbx-19mode #Rubinius in 1.9 mode
+- jruby-19mode # JRuby in 1.9 mode
+- rbx-19mode # Rubinius in 1.9 mode
+branches:
+  only:
+    - master

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+1.1
+- Color coding for the current (last) task (can be disabled)
+- Rename command, lets you rename the last task (tracking -r)
+- Fully documented source code
+- Test improvements
+- More source code improvements
+
+1.0
+- Initial release

data/Gemfile

@@ -1,14 +1,21 @@
-source "http://rubygems.org"
+source :rubygems
 
 # Add dependencies required to use your gem here.
+gem 'colorize', '~> 0.5'
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "shoulda", ">= 0"
-  gem "rdoc", "~> 3.12"
-  gem "bundler", ">= 1.0.0"
-  gem "jeweler", "~> 1.8.4"
-  gem "simplecov", ">= 0"
-  gem "yard", ">= 0"
+	gem 'rdoc', '~> 3.12'
+	gem 'bundler', '>= 1.0.0'
+	gem 'jeweler', '~> 1.8.4'
+	gem 'simplecov'
+	gem 'yard'
+	gem 'rspec'
+	platforms :ruby do
+		gem 'redcarpet'
+	end
+	platforms :jruby do
+		gem 'kramdown'
+	end
 end

data/README.md

@@ -1,11 +1,13 @@
-#tracking [![Build Status](https://secure.travis-ci.org/thenickperson/tracking.png?branch=master)](http://travis-ci.org/thenickperson/tracking)
+#tracking [![Build Status](https://secure.travis-ci.org/thenickperson/tracking.png?branch=master)](http://travis-ci.org/thenickperson/tracking) [![Dependency Status](https://gemnasium.com/thenickperson/tracking.png)](https://gemnasium.com/thenickperson/tracking) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/thenickperson/tracking)
 A simple and configurable command line time tracker.
 
 ##Installation
 
 `gem install tracking`
 
-If you're on Windows, you should set up [Ruby Installer](http://rubyinstaller.org/downloads/) and [DevKit](https://github.com/oneclick/rubyinstaller/wiki/Development-Kit) first.
+If you're on Windows, you should set up
+[Ruby Installer](http://rubyinstaller.org/downloads/) and
+[DevKit](https://github.com/oneclick/rubyinstaller/wiki/Development-Kit) first.
 
 Also, tracking does not work on Ruby 1.8 (yet). Please upgrade to Ruby 1.9.3.
 
@@ -73,6 +75,8 @@ The default settings are listed below, along with a description of each setting.
 :task_width: 40
 # format to use for elapsed time display (:colons or :letters)
 :elapsed_format: :colons
+# toggle colored display of the current (last) task
+:color_current_task: true
 # toggle header describing tracking's display columns (true or false)
 :show_header: true
 # toggle display of seconds in elapsed time (true of false)
@@ -80,7 +84,8 @@ The default settings are listed below, along with a description of each setting.
 ```
 
 ##Elapsed Time Formats
-Elapsed times are displayed in this order: days, hours, minutes, seconds (if enabled)
+Elapsed times are displayed in this order: days, hours, minutes, seconds (if
+enabled)
 - hide elapsed seconds
 	- colons: `01:02:03` (default)
 	- letters: `01d 02h 03m`
@@ -89,18 +94,28 @@ Elapsed times are displayed in this order: days, hours, minutes, seconds (if ena
 	- letters: `01d 02h 03m 04s`
 
 ##Contributing to tracking
-- Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-- Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+- Check out the latest master to make sure the feature hasn't been implemented
+or the bug hasn't been fixed yet.
+- Check out the issue tracker to make sure someone already hasn't requested it
+and/or contributed it.
 - Fork the project.
 - Start a feature/bugfix branch.
 - Commit and push until you are happy with your contribution.
-- Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-- Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+- Make sure to add tests for it. This is important so I don't break it in a
+future version unintentionally.
+- Please try not to mess with the Rakefile, version, or history. If you want to
+have your own version, or is otherwise necessary, that is fine, but please
+isolate to its own commit so I can cherry-pick around it.
 
 ##Similar Projects
 - [timetrap](https://github.com/samg/timetrap)
 - [d-time-tracker](https://github.com/DanielVF/d-time-tracker)
+- [to-do](http://github.com/kristenmills/to-do) if you want a good command line
+todo manager to complement tracking
+
+##Special Thanks
+- [to-do](http://github.com/kristenmills/to-do) and
+[timetrap](https://github.com/samg/timetrap) for letting me borrow some code
 
 ##Copyright
-Copyright (c) 2012 Nicolas McCurdy. See LICENSE.txt for
-further details.
+Copyright (c) 2012 Nicolas McCurdy. See LICENSE.txt for further details.

data/Rakefile

@@ -6,7 +6,7 @@ begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
   $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
+  $stderr.puts 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
 require 'rake'
@@ -14,13 +14,13 @@ require 'rake'
 require 'jeweler'
 Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "tracking"
-  gem.homepage = "http://github.com/thenickperson/tracking"
-  gem.license = "MIT"
-  gem.summary = "A simple and configurable command line time tracker."
-  gem.description = "See README for more information."
-  gem.email = "thenickperson@gmail.com"
-  gem.authors = ["Nicolas McCurdy"]
+  gem.name = 'tracking'
+  gem.homepage = 'http://github.com/thenickperson/tracking'
+  gem.license = 'MIT'
+  gem.summary = 'A simple and configurable command line time tracker.'
+  gem.description = 'See README for more information.'
+  gem.email = 'thenickperson@gmail.com'
+  gem.authors = ['Nicolas McCurdy']
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new
@@ -32,9 +32,9 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = true
 end
 
-desc "Code coverage detail"
+desc 'Code coverage detail'
 task :simplecov do
-	ENV['COVERAGE'] = "true"
+	ENV['COVERAGE'] = 'true'
 	Rake::Task['spec'].execute
 end
 

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/bin/tracking

@@ -6,6 +6,6 @@ else
 	File.dirname __FILE__
 end
 
-require File.join(File.expand_path("..", current_directory), "lib", "tracking")
+require File.join(File.expand_path('..', current_directory), 'lib', 'tracking')
 
 Tracking::CLI.parse

data/lib/tracking.rb

@@ -1,21 +1,10 @@
-require "fileutils"
-
-require File.join(File.dirname(__FILE__), "tracking", "config")
-
-#create ~/.tracking
-if not File.exist? File.join(ENV["HOME"], ".tracking")
-	Dir.mkdir File.join(ENV["HOME"], ".tracking")
-end
-
-#create config file
-if not File.exist? File.join(ENV["HOME"], ".tracking", "config.yml")
-	Tracking::Config.write
+# Require all of tracking's stuff
+require File.join(File.dirname(__FILE__), 'tracking', 'config')
+require File.join(File.dirname(__FILE__), 'tracking', 'list')
+require File.join(File.dirname(__FILE__), 'tracking', 'task')
+require File.join(File.dirname(__FILE__), 'tracking', 'cli')
+
+# Tracking is the main namespace that all of the other modules and classes are a
+# part of
+module Tracking
 end
-
-#create data file
-if not File.exist? File.expand_path Tracking::Config[:data_file]
-	FileUtils.touch File.expand_path Tracking::Config[:data_file]
-end
-
-require File.join(File.dirname(__FILE__), "tracking", "list")
-require File.join(File.dirname(__FILE__), "tracking", "cli")

data/lib/tracking/cli.rb

@@ -1,152 +1,153 @@
-#tracking's command line interface (view)
+require 'optparse'
+require 'colorize'
 
-#imports
-require "optparse"
-
-#view module methods
 module Tracking
+	# Contains methods for displaying the list in a command line and parsing
+	# command line arguments.
 	module CLI
-
 		extend self
 
-		#displays the entire list
-		def display
-			#length of strings produced by the current elapsed time format
-			elapsed_time_length = List.get_elapsed_time(Time.now, Time.now).length
-			#horizontal border for the top or bottom of tracking's display
-			horizontal_border = "+-------+-#{"-"*Config[:task_width]}-+-#{"-"*elapsed_time_length}-+"
-			#header row describing tracking's display columns
-			header = "| start | #{pad("task", Config[:task_width], :center)} | #{pad("elapsed", elapsed_time_length, :center)} |"
-			#intro message, displayed when no valid tasks are found
-			introduction = <<EOF
-+---------------------------------------+
-| You haven't started any tasks yet! :( |
-|                                       |
-| Run this to begin your first task:    |
-|     tracking starting some work       |
-+---------------------------------------+
-EOF
-			#read data file
-			data = []
-			valid_lines = 0
-			invalid_lines = 0
-			data_file = CSV.open($data_file, "r", $csv_options)
-			file_length = data_file.readlines.size
-			data_file.seek(0)
-			data_file.each_with_index do |line, index|
-				if index+1 > file_length - Config[:lines]
-					data << line
-				end
-			end
-			#display data
-			for i in 0..data.length-1
-				if data[i].length == 2
-					begin
-						#grab and reformat data
-						time_string = Time.parse(data[i][0]).strftime("%H:%M")
-						task_string = data[i][1].chomp
-						start_time = Time.parse(data[i][0])
-						end_time = i<data.length-1 ? Time.parse(data[i+1][0]) : Time.now
-						elapsed_string = List.get_elapsed_time(start_time,end_time)
-						#format data into lines
-						lines = []
-						split_task(task_string).each_with_index do |task_line, i|
-							col_1 = pad(i==0 ? time_string : nil, 5)
-							col_2 = pad(task_line, Config[:task_width])
-							col_3 = pad(i==0 ? elapsed_string : nil, elapsed_time_length)
-							lines << "| #{col_1} | #{col_2} | #{col_3} |"
-						end
-						#display lines
-						if valid_lines == 0
-							puts horizontal_border
-							if Config[:show_header]
-								puts header
-								puts horizontal_border
-							end
+		# Width of the first column (start time)
+		@start_time_width = 5
+
+		# Width of the second column (name)
+		@name_width = Config[:task_width]
+
+		# Width of the third column (elapsed time)
+		@elapsed_time_width = Task.elapsed_time_length
+
+		# Displays part of the list in the command line
+		#
+		# @param [Integer] max the maximum number of items to display
+		def display max=Config[:lines]
+			display_object :top
+			tasks = List.get max
+			if tasks.length > 0
+				tasks.each_with_index do |task, task_index|
+					current_task = (task_index + 1 == tasks.length)
+					split_task(task.name).each_with_index do |name_line, line_index|
+						col_1 = pad(line_index==0 ? task.start_time : nil, 5)
+						col_2 = pad(name_line, @name_width)
+						col_3 = pad(line_index==0 ? task.elapsed_time : nil, @elapsed_time_width)
+						if current_task and Config[:color_current_task]
+							col_1,col_2,col_3 = col_1.yellow,col_2.yellow,col_3.yellow
 						end
-						lines.each { |line| puts line }
-						valid_lines += 1
-					rescue
-						invalid_lines += 1
+						puts "| #{col_1} | #{col_2} | #{col_3} |"
 					end
-				else
-					invalid_lines += 1
 				end
-			end
-			#display intro, if needed
-			if valid_lines > 0
-				puts horizontal_border
 			else
-				puts introduction
+				display_object :intro
 			end
-			#display a warning, if needed
+			display_object :bottom
+			# Display a warning, if needed
+=begin
 			if invalid_lines > 0
-				warn "Error: #{invalid_lines} invalid line#{"s" if invalid_lines > 1} found in data file."
+				warn "Error: #{invalid_lines} invalid line#{'s' if invalid_lines > 1} found in data file."
 			end
+=end
 		end
 
-		#pads tasks with whitespace to align them for display
+		# Displays commonly used text objects in the command line
+		#
+		# @param type the type of text object to display (:top/:bottom/:intro)
+		def display_object type
+			horizontal_border = "+-------+-#{'-'*@name_width}-+-#{'-'*@elapsed_time_width}-+"
+			case type
+			when :top
+				puts horizontal_border
+				if Config[:show_header]
+					puts "| start | #{pad('task', @name_width, :center)} | #{pad('elapsed', @elapsed_time_width, :center)} |"
+					puts horizontal_border
+				end
+			when :bottom
+				puts horizontal_border
+			when :intro
+				intro_text = <<-EOF
+You haven't started any tasks yet! :(
+
+Run this to begin your first task:
+  tracking starting some work
+				EOF
+				intro_text.each_line do |line|
+					puts "|       | #{pad(line.chomp, @name_width)} | #{pad(nil, @elapsed_time_width)} |"
+				end
+			end
+		end
+
+		# Pads tasks with whitespace to align them for display
+		#
+		# @param [String] string the string to pad
+		# @param [Integer] length the length of the resultant string
+		# @param [Symbol] align the alignment of the start string within the end
+		# string (:left/:right/:center)
+		# @return [String] the padded string
 		def pad(string, length, align=:left)
 			if string == nil
-				return " " * length
+				return ' ' * length
 			elsif string.length >= length
 				return string
 			else
 				difference = (length - string.length).to_f
 				case align
 				when :left
-					return string + " " * difference
+					return string + ' ' * difference
 				when :right
-					return " " * difference + string
+					return ' ' * difference + string
 				when :center
-					return " "*(difference/2).floor + string + " "*(difference/2).ceil
+					return ' '*(difference/2).floor + string + ' '*(difference/2).ceil
 				else
 					return string
 				end
 			end
 		end
 
-		#word wraps tasks for display
+		# Word wraps tasks into multiple lines for display (based on the user's task
+		# width setting)
+		#
+		# @param [String] task the task string to split up
+		# @return [Array] an array of strings, each containing an individual line of
+		# wrapped text
 		def split_task task
 
-			#if the task fits
+			# If the task fits
 			if task.length <= Config[:task_width]
 				return [task]
 
-			#if the task needs to be split
+			# If the task needs to be split
 			else
-				words = task.split(" ")
+				words = task.split(' ')
 				split = []
-				line = ""
+				line = ''
 				words.each do |word|
 
-					#if the word needs to be split
+					# If the word needs to be split
 					if word.length > Config[:task_width]
-						#add the start of the word onto the first line (even if it has already started)
+						# Add the start of the word onto the first line (even if it has
+						# already started)
 						while line.length < Config[:task_width]
 							line += word[0]
 							word = word[1..-1]
 						end
 						split << line
-						#split the rest of the word up onto new lines
+						# Split the rest of the word up onto new lines
 						split_word = word.scan(%r[.{1,#{Config[:task_width]}}])
 						split_word[0..-2].each do |word_section|
 							split << word_section
 						end
 						line = split_word.last
 
-					#if the word would fit on a new line
+					# If the word would fit on a new line
 					elsif (line + word).length > Config[:task_width]
 						split << line.chomp
 						line = word
 
-					#if the word can be added to this line
+					# If the word can be added to this line
 					else
 						line += word
 					end
 
-					#add a space to the end of the last word, if it would fit
-					line += " " if line.length != Config[:task_width]
+					# Add a space to the end of the last word, if it would fit
+					line += ' ' if line.length != Config[:task_width]
 
 				end
 				split << line
@@ -154,47 +155,54 @@ EOF
 			end
 		end
 
-		#use option parser to parse command line arguments
+		# Use option parser to parse command line arguments and run the selected
+		# command with its selected options
 		def parse
 			#options = {}
 			done = false
 
 			OptionParser.new do |opts|
-				#setup
-				version_path = File.expand_path("../../VERSION", File.dirname(__FILE__))
-				opts.version = File.exist?(version_path) ? File.read(version_path) : ""
-				#start of help text
-				opts.banner = "Usage: tracking [mode]"
-				opts.separator "                                     display tasks"
-				opts.separator "    <task description>               start a new task with the given text (spaces allowed)"
-				#modes
-				opts.on("-c", "--clear", "delete all tasks") do
-					List.clear
-					puts "List cleared."
+				# Setup
+				version_path = File.expand_path('../../VERSION', File.dirname(__FILE__))
+				opts.version = File.exist?(version_path) ? File.read(version_path) : ''
+				# Start of help text
+				opts.banner = 'Usage: tracking [mode]'
+				opts.separator '                                     display tasks'
+				opts.separator '    <task description>               start a new task with the given text (spaces allowed)'
+				# Modes
+				opts.on('-r', '--rename', 'rename the last task') do
+					List.rename ARGV.join(' ').gsub("\t",'')
+					display
 					done = true
 					return
 				end
-				opts.on("-d", "--delete", "delete the last task") do
+				opts.on('-d', '--delete', 'delete the last task') do
 					List.delete
 					display
 					done = true
 					return
 				end
-				opts.on("-h", "--help", "display this help information") do
+				opts.on('-c', '--clear', 'delete all tasks') do
+					List.clear
+					puts 'List cleared.'
+					done = true
+					return
+				end
+				opts.on('-h', '--help', 'display this help information') do
 					puts opts
 					done = true
 					return
 				end
 			end.parse!
 
-			#basic modes (display and add)
-			if not done
+			# Basic modes (display and add)
+			unless done
 				if ARGV.count == 0
-					#display all tasks
+					# Display all tasks
 					display
 				else
-					#start a new task
-					List.add ARGV.join(" ").gsub("\t","")
+					# Start a new task
+					List.add ARGV.join(' ').gsub("\t",'')
 					display
 				end
 			end