tracking 1.0.0 → 1.1.0

data/lib/tracking/config.rb

@@ -1,29 +1,35 @@
-#utilities for tracking's config file
+require 'fileutils'
+require 'yaml'
 
-#imports
-require "yaml"
-
-#config module methods
 module Tracking
+	# Contains methods to interface with tracking's config file.
+	#
 	# similar to Sam Goldstein's config.rb for timetrap
 	# @see https://github.com/samg/timetrap/
 	module Config
-
 		extend self
 
-		PATH = File.join(ENV["HOME"], ".tracking", "config.yml")
-		
-		#default values
+		# The path to the config file
+		PATH = File.join(ENV['HOME'], '.tracking', 'config.yml')
+
+		# The path to the config file's parent directory
+		DIR = File.join(ENV['HOME'], '.tracking')
+
+		# Default config hash
+		#
+		# @return [Hash<Symbol,Object>] the default config in a hash
 		def defaults
 			{
 				# path to the data file (string, ~ can be used)
-				:data_file => "~/.tracking/data.csv",
+				:data_file => '~/.tracking/data.csv',
 				# number of lines to be displayed at once by default (integer)
 				:lines => 10,
 				# width of the task name column, in characters (integer)
 				: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)
@@ -31,30 +37,43 @@ module Tracking
 			}
 		end
 
-		#accessor for values in the config
+		# Overloading [] operator
+		#
+		# Accessor for values in the config
+		#
+		# @param [Symbol] key the key in the config hash
+		# @return [Object] the value associated with that key
 		def [] key
+			write unless File.exist? PATH
 			data = YAML.load_file PATH
 			defaults.merge(data)[key]
 		end
 
-		#setter for keys in config
+		# Overloading []= operator
+		#
+		# Setter for values in the config
+		#
+		# @param [Symbol] key the key you are setting a value for
+		# @param [Object] value the value you associated with the key
 		def []= key, value
+			write unless File.exist? PATH
 			data = YAML.load_file PATH
 			configs = defaults.merge(data)
 			configs[key] = value
-			File.open(PATH, "w") do |fh|
+			File.open(PATH, 'w') do |fh|
 				fh.puts(configs.to_yaml)
 			end
 		end
 
-		#writes the config file path
+		# Writes the configs to the file config.yml
 		def write
 			configs = if File.exist? PATH
 				defaults.merge(YAML.load_file PATH)
 			else 
 				defaults
 			end
-			File.open(PATH, "w") do |fh|
+			FileUtils.mkdir DIR unless File.directory? DIR
+			File.open(PATH, 'w') do |fh|
 				fh.puts configs.to_yaml
 			end
 		end

data/lib/tracking/list.rb

@@ -1,76 +1,96 @@
-#tracking's core
+require 'fileutils'
+require 'yaml'
+require 'time'
+require 'csv'
 
-#imports
-require "yaml"
-require "time"
-require "csv"
-
-#model/controller module methods
 module Tracking
+	# Tracking's core. Contains methods for manipulating tasks in the data file
+	# and preparing its data for a user interface.
 	module List
-
 		extend self
 
-		Config = YAML.load_file(ENV["HOME"] + "/.tracking/config.yml")
-		$data_file = File.expand_path(Config[:data_file])
-		$csv_options = { :col_sep => "\t" }
+		# The path to tracking's data file
+		@data_file = File.expand_path(Config[:data_file])
 
-		#adds an item to the list
-		def add item
-			date = Time.now.to_s
-			File.open($data_file, "a") do |file|
-					file << [ date, item ].to_csv($csv_options)
-			end
-		end
+		# The options tracking uses for Ruby's CSV interface
+		@csv_options = { :col_sep => "\t" }
 
-		#deletes an item from the list
-		def delete
-			lines = File.readlines $data_file
-			lines.pop #or delete specific lines in the future
-			File.open($data_file, "w") do |file| 
-				lines.each do |line|
-					file << line
+		# Reads part of the data file and creates Task objects from that data
+		#
+		# @param [Integer] max the maximum number of items to get from the end of
+		# the data file
+		#
+		# @return [Array] an array of Task objects
+		def get max=Config[:lines]
+			if File.exist? @data_file
+				all_lines = CSV.read(@data_file, @csv_options)
+				lines = all_lines[-max..-1]
+				lines = all_lines if lines.nil?
+
+				tasks = []
+				lines.each_with_index do |line, i|
+					tasks << create_task_from_data(line, lines[i+1])
 				end
+				return tasks
+			else
+				return []
 			end
 		end
 
-		#clears the entire list
-		def clear
-			FileUtils.rm $data_file
-			FileUtils.touch $data_file
+		# Generates a Task object from one or two lines of semi-parsed CSV data
+		#
+		# @param [Array] line the line of semi-parsed CSV data to use
+		# @param [Array] next_line the next line of data, if it exists
+		#
+		# @return [Task] the generated Task object
+		def create_task_from_data(line, next_line=nil)
+			name = line[1]
+			start_time = Time.parse line[0]
+			end_time = next_line.nil? ? Time.now : Time.parse(next_line[0])
+
+			return Task.new(name, start_time, end_time)
 		end
 
-		#gets and formats the amount of time passed between two times
-		def get_elapsed_time(time1, time2)
-			#calculate the elapsed time and break it down into different units
-			seconds = (time2 - time1).floor
-			minutes = hours = days = 0
-			if seconds >= 60
-				minutes = seconds / 60
-				seconds = seconds % 60
-				if minutes >= 60
-					hours = minutes / 60
-					minutes = minutes % 60
-					if hours >= 24
-						days = hours / 24
-						hours = hours % 24
+		# Adds a task to the list
+		#
+		# @param [String] name the name of the task to add to the list
+		def add name, time=Time.now
+			FileUtils.touch @data_file unless File.exist? @data_file
+			File.open(@data_file, 'a') do |file|
+				file << [ time.to_s, name ].to_csv(@csv_options)
+			end
+		end
+
+		# Deletes the last task from the list
+		def delete
+			if File.exist? @data_file
+				lines = File.readlines @data_file
+				lines.pop # Or delete specific lines in the future
+				File.open(@data_file, 'w') do |file| 
+					lines.each do |line|
+						file << line
 					end
 				end
 			end
-			#return a string of the formatted elapsed time
-			case Config[:elapsed_format]
-			when :colons
-				if Config[:show_elapsed_seconds]
-					return "%02d:%02d:%02d:%02d" % [days, hours, minutes, seconds]
-				else
-					return "%02d:%02d:%02d" % [days, hours, minutes]
-				end
-			when :letters
-				if Config[:show_elapsed_seconds]
-					return "%02dd %02dh %02dm %02ds" % [days, hours, minutes, seconds]
-				else
-					return "%02dd %02dh %02dm" % [days, hours, minutes]
-				end
+		end
+
+		# Renames the last task in the list
+		#
+		# @param [String] name the new name for the last task
+		def rename name
+			# get task data
+			old_task = get(1).first
+			# delete last task
+			delete
+			# add new task with old time
+			add(name, old_task.raw(:start_time))
+		end
+
+		# Clears the entire list
+		def clear
+			if File.exist? @data_file
+				FileUtils.rm @data_file
+				FileUtils.touch @data_file
 			end
 		end
 

data/lib/tracking/task.rb

@@ -0,0 +1,99 @@
+module Tracking
+	# The class for all Task objects created by List and passed to interfaces.
+	# Holds all relevant data for Tasks, as well as methods for computing new Task
+	# data as needed. Tasks internally save data (in their appropriate types) to
+	# intance variables, while public accessors return data in strings for
+	# display.
+	class Task
+
+		# Creates a new Task object. Data passed into its arguments is kept
+		# (unchanged) in instance variables.
+		#
+		# @param [String] name the tasks's name
+		# @param [Time] start_time the tasks's start time
+		# @param [Time] end_time the tasks's end time
+		def initialize(name, start_time, end_time)
+			@name = name
+			@start_time = start_time
+			@end_time = end_time
+		end
+
+		# Gets raw data from the task object, without doing any conversions or
+		# formatting
+		#
+		# @param [Symbol] key the key of the desired value
+		#
+		# @return the value of the requested key
+		def raw key
+			case key
+			when :name
+				return @name
+			when :start_time
+				return @start_time
+			when :end_time
+				return @end_time
+			end
+		end
+
+		# Converts the task object into a string (for debugging)
+		def to_s
+			return "name: #{name}; start: #{@start_time}; end: #{@end_time};"
+		end
+
+		# Calculates the length of strings from Task#elapsed_time (using the current
+		# elapsed time format).
+		#
+		# @return [String] the length of strings from Task#elapsed_time
+		def self.elapsed_time_length
+			test_task = Task.new('test', Time.now, Time.now)
+			return test_task.elapsed_time.length
+		end
+
+		# Accessor for this tasks's name (read/write)
+		attr_accessor :name
+
+		# Formats and returns the start time of this task.
+		#
+		# @return [String] the formatted start time of this task
+		def start_time
+			return @start_time.strftime('%H:%M')
+		end
+
+		# Calculates, formats, and returns the elapsed time of this task.
+		#
+		# @return [String] the formatted elapsed time of this task
+		def elapsed_time
+			# Calculate the elapsed time and break it down into different units
+			seconds = (@end_time - @start_time).floor
+			minutes = hours = days = 0
+			if seconds >= 60
+				minutes = seconds / 60
+				seconds = seconds % 60
+				if minutes >= 60
+					hours = minutes / 60
+					minutes = minutes % 60
+					if hours >= 24
+						days = hours / 24
+						hours = hours % 24
+					end
+				end
+			end
+			# Return a string of the formatted elapsed time
+			case Config[:elapsed_format]
+			when :colons
+				if Config[:show_elapsed_seconds]
+					return '%02d:%02d:%02d:%02d' % [days, hours, minutes, seconds]
+				else
+					return '%02d:%02d:%02d' % [days, hours, minutes]
+				end
+			when :letters
+				if Config[:show_elapsed_seconds]
+					return '%02dd %02dh %02dm %02ds' % [days, hours, minutes, seconds]
+				else
+					return '%02dd %02dh %02dm' % [days, hours, minutes]
+				end
+			end
+		end
+
+	end
+end

data/spec/cli_spec.rb

@@ -0,0 +1,36 @@
+require 'helper'
+require 'fileutils'
+
+describe Tracking::CLI do
+
+	before :each do
+		FileUtils.cd File.expand_path('~/.tracking')
+		FileUtils.mkdir 'test_backup'
+		%w(config.yml data.csv).each do |f|
+			FileUtils.mv(f, 'test_backup') if File.exist? f
+		end
+	end
+
+	after :each do
+		FileUtils.cd File.expand_path('~/.tracking/test_backup')
+		%w(config.yml data.csv).each do |f|
+			FileUtils.mv(f, File.expand_path('..')) if File.exist? f
+		end
+		FileUtils.cd File.expand_path('..')
+		FileUtils.rmdir 'test_backup'
+	end
+
+	it 'performs a few operations on a new list and then clears it' do
+		capture_output do
+			Tracking::List.clear
+			Tracking::CLI.display
+			Tracking::List.add 'first task'
+			Tracking::List.add 'second task'
+			Tracking::List.rename 'second task, renamed'
+			Tracking::CLI.display
+			Tracking::List.delete
+			Tracking::List.clear
+		end
+	end
+
+end

data/spec/helper.rb

@@ -0,0 +1,21 @@
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
+require_relative '../lib/tracking'
+
+def capture_output &block
+	original_stdout = $stdout
+	$stdout = fake = StringIO.new
+	begin
+		yield
+	ensure
+		$stdout = original_stdout
+	end
+	fake.string
+end

data/tracking.gemspec

@@ -0,0 +1,81 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "tracking"
+  s.version = "1.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nicolas McCurdy"]
+  s.date = "2012-09-10"
+  s.description = "See README for more information."
+  s.email = "thenickperson@gmail.com"
+  s.executables = ["tracking"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".travis.yml",
+    "CHANGELOG.md",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "bin/tracking",
+    "lib/tracking.rb",
+    "lib/tracking/cli.rb",
+    "lib/tracking/config.rb",
+    "lib/tracking/list.rb",
+    "lib/tracking/task.rb",
+    "spec/cli_spec.rb",
+    "spec/helper.rb",
+    "tracking.gemspec"
+  ]
+  s.homepage = "http://github.com/thenickperson/tracking"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "A simple and configurable command line time tracker."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<colorize>, ["~> 0.5"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<redcarpet>, [">= 0"])
+      s.add_development_dependency(%q<kramdown>, [">= 0"])
+    else
+      s.add_dependency(%q<colorize>, ["~> 0.5"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<redcarpet>, [">= 0"])
+      s.add_dependency(%q<kramdown>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<colorize>, ["~> 0.5"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<redcarpet>, [">= 0"])
+    s.add_dependency(%q<kramdown>, [">= 0"])
+  end
+end
+