tracking 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+# Add dependencies required to use your gem here.
+
+# 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"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Nicolas McCurdy
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,106 @@
+#tracking [![Build Status](https://secure.travis-ci.org/thenickperson/tracking.png?branch=master)](http://travis-ci.org/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.
+
+Also, tracking does not work on Ruby 1.8 (yet). Please upgrade to Ruby 1.9.3.
+
+##Features
+- concise and configurable display
+- simple syntax
+- portable data
+
+##Ideas (future)
+- hashtag-like tags for organizing tasks
+- different ways to view your data
+
+##Tutorial
+```
+$ tracking essay for English class
++-------+------------------------------------------+----------+
+| start |                   task                   | elapsed  |
++-------+------------------------------------------+----------+
+| 12:00 | essay for English class                  | 00:00:00 |
++-------+------------------------------------------+----------+
+$ tracking getting distracted on Reddit
++-------+------------------------------------------+----------+
+| start |                   task                   | elapsed  |
++-------+------------------------------------------+----------+
+| 12:00 | essay for English class                  | 00:00:20 |
+| 12:20 | getting distracted on Reddit             | 00:00:00 |
++-------+------------------------------------------+----------+
+$ tracking
++-------+------------------------------------------+----------+
+| start |                   task                   | elapsed  |
++-------+------------------------------------------+----------+
+| 12:00 | essay for English class                  | 00:00:20 |
+| 12:20 | getting distracted on Reddit             | 00:00:05 |
++-------+------------------------------------------+----------+
+$ tracking back to work
++-------+------------------------------------------+----------+
+| start |                   task                   | elapsed  |
++-------+------------------------------------------+----------+
+| 12:00 | essay for English class                  | 00:00:20 |
+| 12:20 | getting distracted on Reddit             | 00:00:10 |
+| 12:30 | back to work                             | 00:00:00 |
++-------+------------------------------------------+----------+
+```
+
+##Usage
+```
+Usage: tracking [mode]
+                                     display all tasks
+    <task>                           start a new task with the given text
+    -c, --clear                      delete all tasks
+    -d, --delete                     delete the last task
+    -h, --help                       displays this help information
+```
+
+##Configuration
+The config file for tracking is located in `~/.tracking/config.yml`.
+
+The default settings are listed below, along with a description of each setting.
+```ruby
+# path to the data file (string, ~ can be used)
+: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 header describing tracking's display columns (true or false)
+:show_header: true
+# toggle display of seconds in elapsed time (true of false)
+:show_elapsed_seconds: false
+```
+
+##Elapsed Time Formats
+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`
+- show elapsed seconds
+	- colons: `01:02:03:04`
+	- 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.
+- 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.
+
+##Similar Projects
+- [timetrap](https://github.com/samg/timetrap)
+- [d-time-tracker](https://github.com/DanielVF/d-time-tracker)
+
+##Copyright
+Copyright (c) 2012 Nicolas McCurdy. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+require 'rubygems'
+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 '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"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+	ENV['COVERAGE'] = "true"
+	Rake::Task['spec'].execute
+end
+
+task :default => :test
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/bin/tracking

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+current_directory = if File.symlink? __FILE__
+	File.dirname File.readlink __FILE__
+else
+	File.dirname __FILE__
+end
+
+require File.join(File.expand_path("..", current_directory), "lib", "tracking")
+
+Tracking::CLI.parse

data/lib/tracking/cli.rb

@@ -0,0 +1,204 @@
+#tracking's command line interface (view)
+
+#imports
+require "optparse"
+
+#view module methods
+module Tracking
+	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
+						end
+						lines.each { |line| puts line }
+						valid_lines += 1
+					rescue
+						invalid_lines += 1
+					end
+				else
+					invalid_lines += 1
+				end
+			end
+			#display intro, if needed
+			if valid_lines > 0
+				puts horizontal_border
+			else
+				puts introduction
+			end
+			#display a warning, if needed
+			if invalid_lines > 0
+				warn "Error: #{invalid_lines} invalid line#{"s" if invalid_lines > 1} found in data file."
+			end
+		end
+
+		#pads tasks with whitespace to align them for display
+		def pad(string, length, align=:left)
+			if string == nil
+				return " " * length
+			elsif string.length >= length
+				return string
+			else
+				difference = (length - string.length).to_f
+				case align
+				when :left
+					return string + " " * difference
+				when :right
+					return " " * difference + string
+				when :center
+					return " "*(difference/2).floor + string + " "*(difference/2).ceil
+				else
+					return string
+				end
+			end
+		end
+
+		#word wraps tasks for display
+		def split_task task
+
+			#if the task fits
+			if task.length <= Config[:task_width]
+				return [task]
+
+			#if the task needs to be split
+			else
+				words = task.split(" ")
+				split = []
+				line = ""
+				words.each do |word|
+
+					#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)
+						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_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
+					elsif (line + word).length > Config[:task_width]
+						split << line.chomp
+						line = word
+
+					#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]
+
+				end
+				split << line
+				return split
+			end
+		end
+
+		#use option parser to parse command line arguments
+		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."
+					done = true
+					return
+				end
+				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
+					puts opts
+					done = true
+					return
+				end
+			end.parse!
+
+			#basic modes (display and add)
+			if not done
+				if ARGV.count == 0
+					#display all tasks
+					display
+				else
+					#start a new task
+					List.add ARGV.join(" ").gsub("\t","")
+					display
+				end
+			end
+		end
+
+	end
+end

data/lib/tracking/config.rb

@@ -0,0 +1,63 @@
+#utilities for tracking's config file
+
+#imports
+require "yaml"
+
+#config module methods
+module Tracking
+	# 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
+		def defaults
+			{
+				# path to the data file (string, ~ can be used)
+				: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 header describing tracking's display columns (true or false)
+				:show_header => true,
+				# toggle display of seconds in elapsed time (true of false)
+				:show_elapsed_seconds => false
+			}
+		end
+
+		#accessor for values in the config
+		def [] key
+			data = YAML.load_file PATH
+			defaults.merge(data)[key]
+		end
+
+		#setter for keys in config
+		def []= key, value
+			data = YAML.load_file PATH
+			configs = defaults.merge(data)
+			configs[key] = value
+			File.open(PATH, "w") do |fh|
+				fh.puts(configs.to_yaml)
+			end
+		end
+
+		#writes the config file path
+		def write
+			configs = if File.exist? PATH
+				defaults.merge(YAML.load_file PATH)
+			else 
+				defaults
+			end
+			File.open(PATH, "w") do |fh|
+				fh.puts configs.to_yaml
+			end
+		end
+
+	end
+end

data/lib/tracking/list.rb

@@ -0,0 +1,78 @@
+#tracking's core
+
+#imports
+require "yaml"
+require "time"
+require "csv"
+
+#model/controller module methods
+module Tracking
+	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" }
+
+		#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
+
+		#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
+				end
+			end
+		end
+
+		#clears the entire list
+		def clear
+			FileUtils.rm $data_file
+			FileUtils.touch $data_file
+		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
+					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/lib/tracking.rb

@@ -0,0 +1,21 @@
+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
+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/test/helper.rb

@@ -0,0 +1,39 @@
+require 'rubygems'
+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 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'tracking'
+
+class Test::Unit::TestCase
+
+	@tracking_path = File.join(File.dirname(__FILE__), "..", "bin", "tracking")
+	@tracking_command = "ruby #{@tracking_path}"
+
+	def capture_output &block
+		original_stdout = $stdout
+		$stdout = fake = StringIO.new
+		begin
+			yield
+		ensure
+			$stdout = original_stdout
+		end
+		fake.string
+	end
+
+	def test_command args=""
+		capture_output do
+			system "#{@tracking_command} #{args}"
+		end
+	end
+
+end

data/test/test_cli.rb

@@ -0,0 +1,47 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'helper'
+
+class TestCLI < Test::Unit::TestCase
+	context "Tracking's CLI" do
+
+		should "clear list (to prepare for other tests)" do
+			#test_command "-c"
+			capture_output { Tracking::List.clear }
+		end
+
+		should "display empty list" do
+			#test_command
+			capture_output { Tracking::CLI.display }
+		end
+
+		should "add a task" do
+			#test_command "first task"
+			capture_output { Tracking::List.add "first task" }
+		end
+
+		should "add another task" do
+			#test_command "second task"
+			capture_output { Tracking::List.add "second task" }
+		end
+
+		should "display list with two items" do
+			#test_command
+			capture_output { Tracking::CLI.display }
+		end
+
+		should "delete the second task" do
+			#test_command "-d"
+			capture_output { Tracking::List.delete }
+		end
+
+		should "clear list" do
+			#test_command "-c"
+			capture_output { Tracking::List.clear }
+		end
+
+		should "display help information (run from the system's shell)" do
+			test_command "-h"
+		end
+
+	end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: tracking
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Nicolas McCurdy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &16314220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *16314220
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &16311500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *16311500
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &16252580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *16252580
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &16248240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: *16248240
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &16261600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *16261600
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &16260300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *16260300
+description: See README for more information.
+email: thenickperson@gmail.com
+executables:
+- tracking
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- bin/tracking
+- lib/tracking.rb
+- lib/tracking/cli.rb
+- lib/tracking/config.rb
+- lib/tracking/list.rb
+- test/helper.rb
+- test/test_cli.rb
+homepage: http://github.com/thenickperson/tracking
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1085094097203907066
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: A simple and configurable command line time tracker.
+test_files: []