timr 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a52eda0ed77a6f73e3c0e039bc938fa21248a54
-  data.tar.gz: a17fe3a693f1cf2a7c544b6212f405cb3ba42e1c
+  metadata.gz: 3948415c9078720d4fa8086cc8ce9c234ddd5e88
+  data.tar.gz: ee3a6ce0a660c31fb89a343d5e34ed8502e0c6eb
 SHA512:
-  metadata.gz: 86632a136e85c82349380204a9e02d9ed9bea484ea634b85c44fed7af4ab1707470b85995c3cce4c8325562704826bb9bdf0aa526c283f3f83ed50705ad03458
-  data.tar.gz: e9be4b7834949de95f9cfcdb77a8f279dbf23d448ae83219bd169a5fd96d2ae7d2b1c02b14035e706710ab7b00f9d3ed90b4e7859bf3ab81d69969de3b63505b
+  metadata.gz: 2e36359864dc8d6004ccc34176e77902e02c4a31e419423d4bc4f2c408ca4024b4e68459e40f6a52c18a2f60c11902c2f84d2da988864510145ce70c18b663aa
+  data.tar.gz: 377b2341c3f240d688fa8b4d4e4e61c597e85086c1e296fa3e3023b238a54f178d4a1b59528c346d3d82f8cef99b38b1ba1075c333d8c09f1754869ca4d65c9c

data/README.md

@@ -158,6 +158,14 @@ Export Tasks and Tracks.
 
 See more informations on the [timr-report(1)](https://timr.fox21.at/man/timr-report.1.html) man page.
 
+### Reset Command
+
+Remove current running Track.
+
+	timr reset [<options>]
+
+See more informations on the [timr-reset(1)](https://timr.fox21.at/man/timr-reset.1.html) man page.
+
 ## Workflow Example
 
 Here is an example as shell commands how your workflow could look like while using Timr.

data/bin/.gitignore

@@ -1,2 +1,3 @@
 dev
 dev_clean.sh
+import

data/bin/build_man.sh

@@ -20,6 +20,7 @@ for file in \
 	timr-pop.1.ronn \
 	timr-push.1.ronn \
 	timr-report.1.ronn \
+	timr-reset.1.ronn \
 	timr-start.1.ronn \
 	timr-status.1.ronn \
 	timr-stop.1.ronn \

data/bin/dev_data.sh

@@ -0,0 +1,57 @@
+#!/usr/bin/env bash
+
+# Generate dev data.
+
+SCRIPT_BASEDIR=$(dirname "$0")
+
+
+set -e
+cd "${SCRIPT_BASEDIR}/.."
+
+cwd="tmp/dev"
+mkdir -p "$cwd"
+
+bundler exec ./bin/timr -C "$cwd" task add --id t1 -n t1
+bundler exec ./bin/timr -C "$cwd" task add --id t2 -n t2
+bundler exec ./bin/timr -C "$cwd" task add --id t3 -n t3
+bundler exec ./bin/timr -C "$cwd" task add --id t4 -n t4
+
+# Show Tasks
+bundler exec ./bin/timr -C "$cwd" task show t1
+bundler exec ./bin/timr -C "$cwd" task show t2
+bundler exec ./bin/timr -C "$cwd" task show t3
+bundler exec ./bin/timr -C "$cwd" task show t4
+
+# Task 1
+bundler exec ./bin/timr -C "$cwd" track add \
+	--start-date 2017-01-01 --start-time 01:00 \
+	--end-date 2017-01-01 --end-time 02:00 \
+	--billed \
+	-m 'task1_track1' t1
+
+bundler exec ./bin/timr -C "$cwd" track add \
+	--start-date 2017-01-02 --start-time 01:00 \
+	--end-date 2017-01-02 --end-time 03:00 \
+	-m 'task1_track2' t1
+
+# Task 3
+bundler exec ./bin/timr -C "$cwd" track add \
+	--start-date 2017-01-03 --start-time 01:00 \
+	--end-date 2017-01-03 --end-time 03:00 \
+	-m 'task3_track1' t3
+
+bundler exec ./bin/timr -C "$cwd" track add t3
+
+# Task 4
+bundler exec ./bin/timr -C "$cwd" track add \
+	--start-date 2017-01-04 --start-time 01:00 \
+	--end-date 2017-01-04 --end-time 04:00 \
+	-m 'task4_track1' t4
+
+bundler exec ./bin/timr -C "$cwd" track add t4
+
+bundler exec ./bin/timr -C "$cwd" start t4 -t 01:00
+bundler exec ./bin/timr -C "$cwd" stop -t 02:00
+
+bundler exec ./bin/timr -C "$cwd" start t1 -t 03:00
+bundler exec ./bin/timr -C "$cwd" push t2

data/bin/dev_setup.sh

@@ -17,3 +17,5 @@ if [[ ! -f .env ]]; then
 fi
 
 bundler install
+
+./bin/dev_data.sh

data/bin/test.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-# Run Unit Tests.
+# Run all Tests.
 
 SCRIPT_BASEDIR=$(dirname "$0")
 RUBYOPT=-w
@@ -17,3 +17,5 @@ cd "${SCRIPT_BASEDIR}/.."
 grep -r -i taks lib man test && { echo 'ERROR: Wrong word found'; exit 1; } || true
 
 bundler exec ./test/suite_all.rb
+
+./bin/test_report.sh

data/bin/test_report.sh

@@ -0,0 +1,82 @@
+#!/usr/bin/env bash
+
+# Test Report Command.
+
+DATE=$(date +"%F_%H%M%S")
+SCRIPT_BASEDIR=$(dirname "$0")
+
+
+set -e
+cd "${SCRIPT_BASEDIR}/.."
+option=$1
+
+mkdir -p tmp
+tmpdir=$(mktemp -d tmp/test_report_XXXXX)
+cwd="${tmpdir}/defaultc"
+tasks_csv_file="${tmpdir}/tasks.csv"
+tracks_csv_file="${tmpdir}/tracks.csv"
+
+bundler exec ./bin/timr -C "$cwd" task add --id t1 -n t1 # full
+bundler exec ./bin/timr -C "$cwd" task add --id t2 -n t2 # empty
+bundler exec ./bin/timr -C "$cwd" task add --id t3 -n t3 # includes a normal track and empty track
+bundler exec ./bin/timr -C "$cwd" task add --id t4 -n t4 # includes only an empty track
+
+# Show Tasks
+bundler exec ./bin/timr -C "$cwd" task show t1
+bundler exec ./bin/timr -C "$cwd" task show t2
+bundler exec ./bin/timr -C "$cwd" task show t3
+bundler exec ./bin/timr -C "$cwd" task show t4
+
+# Task 1
+bundler exec ./bin/timr -C "$cwd" track add \
+	--start-date 2017-01-01 --start-time 01:00 \
+	--end-date 2017-01-01 --end-time 02:00 \
+	--billed \
+	-m 'task1_track1' t1
+
+bundler exec ./bin/timr -C "$cwd" track add \
+	--start-date 2017-01-02 --start-time 01:00 \
+	--end-date 2017-01-02 --end-time 03:00 \
+	-m 'task1_track2' t1
+
+# Task 2 empty
+
+# Task 3
+bundler exec ./bin/timr -C "$cwd" track add \
+	--start-date 2017-01-03 --start-time 01:00 \
+	--end-date 2017-01-03 --end-time 03:00 \
+	-m 'task3_track1' t3
+
+bundler exec ./bin/timr -C "$cwd" track add t3
+
+# Task 4
+bundler exec ./bin/timr -C "$cwd" track add \
+	--start-date 2017-01-04 --start-time 01:00 \
+	--end-date 2017-01-04 --end-time 04:00 \
+	-m 'task4_track1' t4
+
+bundler exec ./bin/timr -C "$cwd" track add t4
+
+# Show Tasks
+bundler exec ./bin/timr -C "$cwd" task show t1
+bundler exec ./bin/timr -C "$cwd" task show t2
+bundler exec ./bin/timr -C "$cwd" task show t3
+bundler exec ./bin/timr -C "$cwd" task show t4
+
+# Report to STDOUT.
+bundler exec ./bin/timr -C "$cwd" report --tasks --all
+bundler exec ./bin/timr -C "$cwd" report --tasks --all --billed
+bundler exec ./bin/timr -C "$cwd" report --tasks --all --unbilled
+bundler exec ./bin/timr -C "$cwd" report --tracks --all
+bundler exec ./bin/timr -C "$cwd" report --tracks --all --billed
+bundler exec ./bin/timr -C "$cwd" report --tracks --all --unbilled
+
+# Report to files.
+bundler exec ./bin/timr -C "$cwd" report --tasks --all --csv "${tasks_csv_file}"
+bundler exec ./bin/timr -C "$cwd" report --tracks --all --csv "${tracks_csv_file}"
+
+# Open under macOS.
+if [[ "$option" = "-o" ]]; then
+	open "${tasks_csv_file}"
+	open "${tracks_csv_file}"
+fi

data/bin/timr_bash_completion.sh

@@ -12,6 +12,7 @@ function _timr_command {
 		pop
 		push
 		report
+		reset
 		start
 		status
 		stop
@@ -103,6 +104,8 @@ function _timr_report_main {
 		--all
 		--tasks
 		--tracks
+		--billed
+		--unbilled
 		--format
 		--csv
 		--force
@@ -110,6 +113,15 @@ function _timr_report_main {
 	COMPREPLY=( $(compgen -W '${timr_commands[@]}' -- "${curr_word}") )
 }
 
+function _timr_reset_main {
+	local curr_word=$1
+	local timr_commands=(
+		--help
+		--stack
+	)
+	COMPREPLY=( $(compgen -W '${timr_commands[@]}' -- "${curr_word}") )
+}
+
 function _timr_start_main {
 	local curr_word=$1
 	local timr_commands=(
@@ -308,7 +320,7 @@ function _timr_main {
 		fi
 		
 		case "${timr_command}" in
-			continue|log|pause|pop|push|report|start|status|stop)
+			continue|log|pause|pop|push|report|reset|start|status|stop)
 				"_timr_${timr_command}_main" "$curr_word"
 				;;
 			task|track)

data/lib/timr.rb

@@ -29,6 +29,7 @@ require 'timr/command/pause_command'
 require 'timr/command/pop_command'
 require 'timr/command/push_command'
 require 'timr/command/report_command'
+require 'timr/command/reset_command'
 require 'timr/command/start_command'
 require 'timr/command/status_command'
 require 'timr/command/stop_command'

data/lib/timr/command/basic_command.rb

@@ -112,6 +112,8 @@ module TheFox
 							command = TrackCommand
 						when 'report'
 							command = ReportCommand
+						when 'reset'
+							command = ResetCommand
 						else
 							raise CommandError, "'%s' is not a timr command. See 'timr --help'." % [name]
 						end

data/lib/timr/command/log_command.rb

@@ -189,7 +189,7 @@ module TheFox
 									track_c,
 									begin_datetime_s,
 									end_datetime_s,
-									duration ? duration.to_human : '---',
+									duration.to_human_s,
 									task.id_foreign_or_short,
 									'%s %s' % [track.short_id, track.title(15)],
 								]
@@ -219,7 +219,7 @@ module TheFox
 								totals[:task_c],
 								begin_datetime_s,
 								end_datetime_s,
-								duration ? duration.to_human : '---',
+								duration.to_human_s,
 								task.id_foreign_or_short,
 								'%s %s' % [track.short_id, track.title(15)],
 							]
@@ -237,7 +237,7 @@ module TheFox
 						nil,        # track_c
 						totals[:begin_datetime_s],
 						totals[:end_datetime_s],
-						totals[:duration] ? totals[:duration].to_human : '---', # duration
+						totals[:duration].to_human_s, # duration
 						'TOTAL',    # task
 						nil,        # track
 					]

data/lib/timr/command/report_command.rb

@@ -18,15 +18,14 @@ module TheFox
 				
 				def initialize(argv = Array.new)
 					super()
-					# puts "argv '#{argv}'"
 					
 					@help_opt = false
 					@tasks_opt = false
 					@tracks_opt = false
 					@from_opt = nil
 					@to_opt = nil
-					# @billed_opt = false
-					# @unbilled_opt = false
+					@billed_opt = false
+					@unbilled_opt = false
 					@format_opt = nil
 					@csv_opt = nil
 					@force_opt = false
@@ -56,10 +55,10 @@ module TheFox
 						when '-t', '--tracks'
 							@tracks_opt = true
 						
-						# when '--billed'
-						# 	@billed_opt = true
-						# when '--unbilled'
-						# 	@unbilled_opt = true
+						when '--billed'
+							@billed_opt = true
+						when '--unbilled'
+							@unbilled_opt = true
 						
 						when '--format'
 							@format_opt = argv.shift
@@ -86,20 +85,20 @@ module TheFox
 						@to_opt = Time.new(today.year, today.month, month_end.day, 23, 59, 59)
 					end
 					
-					# @billed_resolved_opt = nil
-					# if @billed_opt || @unbilled_opt
-					# 	if @billed_opt
-					# 		@billed_resolved_opt = true
-					# 	elsif @unbilled_opt
-					# 		@billed_resolved_opt = false
-					# 	end
-					# end
+					@billed_resolved_opt = nil
+					if @billed_opt || @unbilled_opt
+						if @billed_opt
+							@billed_resolved_opt = true
+						elsif @unbilled_opt
+							@billed_resolved_opt = false
+						end
+					end
 					
 					@filter_options = {
 						:format => '%y-%m-%d %H:%M',
 						:from => @from_opt,
 						:to => @to_opt,
-						# :billed => @billed_resolved_opt,
+						:billed => @billed_resolved_opt,
 					}
 					@csv_filter_options = {
 						:format => '%F %T %z',
@@ -107,6 +106,14 @@ module TheFox
 						:to => @to_opt,
 					}
 					
+					# Used by
+					# 	print_formatted_task_list
+					# 	print_formatted_track_list
+					@format_options = {
+						:format => @format_opt,
+						:billed => @billed_resolved_opt,
+					}
+					
 					if @csv_opt
 						if @csv_opt == '-'
 							# OK
@@ -224,9 +231,8 @@ module TheFox
 							totals[:task_c],
 							task.begin_datetime_s(@filter_options),
 							task.end_datetime_s(@filter_options),
-							duration.to_human,
-							unbilled_duration.to_human,
-							# tracks_c,
+							duration.to_human_s,
+							unbilled_duration.to_human_s,
 							'%s %s' % [task.id_foreign_or_short, task.name(15)]
 						]
 					end
@@ -242,9 +248,8 @@ module TheFox
 						nil, # task_c
 						totals[:begin_datetime_s],
 						totals[:end_datetime_s],
-						totals[:duration].to_human, # duration
-						totals[:unbilled_duration].to_human, # duration
-						# totals[:tracks_c],
+						totals[:duration].to_human_s, # duration
+						totals[:unbilled_duration].to_human_s, # duration
 						'TOTAL', # task
 					]
 					
@@ -256,9 +261,8 @@ module TheFox
 				end
 				
 				def print_formatted_task_list
-					puts 'print_formatted_task_list'
 					filtered_tasks.each do |task|
-						puts task.formatted(@format_opt)
+						puts task.formatted(@format_options)
 					end
 				end
 				
@@ -321,7 +325,7 @@ module TheFox
 							totals[:tracks_c],
 							track.begin_datetime_s(@filter_options),
 							track.end_datetime_s(@filter_options),
-							duration.to_human,
+							duration.to_human_s,
 							'%s' % [task.id_foreign_or_short],
 							'%s %s' % [track.short_id, track.title(15)],
 						]
@@ -338,7 +342,7 @@ module TheFox
 						nil, # task_c
 						totals[:begin_datetime_s],
 						totals[:end_datetime_s],
-						totals[:duration].to_human, # duration
+						totals[:duration].to_human_s, # duration
 						'TOTAL', # task
 						nil, # track
 					]
@@ -351,9 +355,8 @@ module TheFox
 				end
 				
 				def print_formatted_track_list
-					puts 'print_formatted_track_list'
 					@timr.tracks(@filter_options).each do |track_id, track|
-						puts track.formatted(@format_opt)
+						puts track.formatted(@format_options)
 					end
 				end
 				
@@ -478,7 +481,7 @@ module TheFox
 							totals[:end_datetime] = edt
 						end
 						
-						csv << [
+						row = [
 							totals[:row_c],
 							
 							task.id,
@@ -488,21 +491,36 @@ module TheFox
 							task.begin_datetime_s(@csv_filter_options),
 							task.end_datetime_s(@csv_filter_options),
 							
-							duration ? duration.to_human : '---',
-							duration ? duration.to_i : 0,
-							estimation ? estimation.to_human : '---',
-							estimation ? estimation.to_i : 0,
-							remaining_time ? remaining_time.to_human : '---',
-							remaining_time ? remaining_time.to_i : 0,
-							billed_duration ? billed_duration.to_human : '---',
-							billed_duration ? billed_duration.to_i : 0,
-							unbilled_duration ? unbilled_duration.to_human : '---',
-							unbilled_duration ? unbilled_duration.to_i : 0,
-							
-							tracks_c,
-							billed_tracks_c,
-							unbilled_tracks_c,
+							duration.to_human_s,
+							duration.to_i,
 						]
+						
+						if estimation
+							row << estimation.to_human_s
+							row << estimation.to_i
+						else
+							row << '---'
+							row << 0
+						end
+						
+						if remaining_time
+							row << remaining_time.to_human_s
+							row << remaining_time.to_i
+						else
+							row << '---'
+							row << 0
+						end
+						
+						row << billed_duration.to_human_s
+						row << billed_duration.to_i
+						row << unbilled_duration.to_human_s
+						row << unbilled_duration.to_i
+						
+						row << tracks_c
+						row << billed_tracks_c
+						row << unbilled_tracks_c
+						
+						csv << row
 					end
 					
 					totals[:begin_datetime_s] = totals[:begin_datetime] ? totals[:begin_datetime].localtime.strftime(@csv_filter_options[:format]) : '---'
@@ -520,18 +538,23 @@ module TheFox
 						totals[:begin_datetime_s],
 						totals[:end_datetime_s],
 						
-						totals[:duration] ? totals[:duration].to_human : '---',
-						totals[:duration] ? totals[:duration].to_i : 0,
-						totals[:estimation] ? totals[:estimation].to_human : '---',
-						totals[:estimation] ? totals[:estimation].to_i : 0,
-						totals[:remaining_time] ? totals[:remaining_time].to_human : '---',
-						totals[:remaining_time] ? totals[:remaining_time].to_i : 0,
-						totals[:billed_duration] ? totals[:billed_duration].to_human : '---',
-						totals[:billed_duration] ? totals[:billed_duration].to_i : 0,
-						totals[:unbilled_duration] ? totals[:unbilled_duration].to_human : '---',
-						totals[:unbilled_duration] ? totals[:unbilled_duration].to_i : 0,
+						totals[:duration].to_human_s,
+						totals[:duration].to_i,
+						
+						totals[:estimation].to_human_s,
+						totals[:estimation].to_i,
+						
+						totals[:remaining_time].to_human_s,
+						totals[:remaining_time].to_i,
+						
+						totals[:billed_duration].to_human_s,
+						totals[:billed_duration].to_i,
+						
+						totals[:unbilled_duration].to_human_s,
+						totals[:unbilled_duration].to_i,
 						
 						totals[:tracks_c],
+						
 						totals[:billed_tracks_c],
 						totals[:unbilled_tracks_c],
 					]
@@ -625,7 +648,7 @@ module TheFox
 							totals[:end_datetime] = edt
 						end
 						
-						csv << [
+						row = [
 							totals[:row_c],
 							
 							task.id,
@@ -637,15 +660,19 @@ module TheFox
 							track.begin_datetime_s(@csv_filter_options),
 							track.end_datetime_s(@csv_filter_options),
 							
-							duration ? duration.to_human : '---',
-							duration ? duration.to_i : 0,
-							billed_duration ? billed_duration.to_human : '---',
-							billed_duration ? billed_duration.to_i : 0,
-							unbilled_duration ? unbilled_duration.to_human : '---',
-							unbilled_duration ? unbilled_duration.to_i : 0,
+							duration.to_human_s,
+							duration.to_i,
+							
+							billed_duration.to_human_s,
+							billed_duration.to_i,
+							
+							unbilled_duration.to_human_s,
+							unbilled_duration.to_i,
 							
 							track.is_billed.to_i,
 						]
+						
+						csv << row
 					end
 					
 					totals[:begin_datetime_s] = totals[:begin_datetime] ? totals[:begin_datetime].localtime.strftime(@csv_filter_options[:format]) : '---'
@@ -653,7 +680,7 @@ module TheFox
 					totals[:end_datetime_s] = totals[:end_datetime] ? totals[:end_datetime].localtime.strftime(@csv_filter_options[:format]) : '---'
 					
 					totals[:row_c] += 1
-					csv << [
+					row = [
 						totals[:row_c],
 						'TOTAL',
 						
@@ -666,14 +693,18 @@ module TheFox
 						totals[:begin_datetime_s],
 						totals[:end_datetime_s],
 						
-						totals[:duration] ? totals[:duration].to_human : '---',
-						totals[:duration] ? totals[:duration].to_i : 0,
-						totals[:billed_duration] ? totals[:billed_duration].to_human : '---',
-						totals[:billed_duration] ? totals[:billed_duration].to_i : 0,
-						totals[:unbilled_duration] ? totals[:unbilled_duration].to_human : '---',
-						totals[:unbilled_duration] ? totals[:unbilled_duration].to_i : 0,
+						totals[:duration].to_human_s,
+						totals[:duration].to_i,
+						
+						totals[:billed_duration].to_human_s,
+						totals[:billed_duration].to_i,
+						
+						totals[:unbilled_duration].to_human_s,
+						totals[:unbilled_duration].to_i,
 					]
 					
+					csv << row
+					
 					csv.close
 				end
 				
@@ -688,7 +719,8 @@ module TheFox
 				def help
 					puts 'usage: timr report [-d|--day <date>] [-m|--month <[YYYY-]MM>]'
 					puts '                   [-y|--year [<YYYY>]] [-a|--all] [--tasks|--tracks]'
-					puts '                   [--csv <path>] [--force]'
+					puts '                   [--billed|--unbilled]'
+					puts '                   [--csv <path>] [--force] [--format <str>]'
 					puts '   or: timr report [-h|--help]'
 					puts
 					puts 'Options'
@@ -698,9 +730,9 @@ module TheFox
 					puts '    -a, --all                   All.'
 					puts '    --tasks                     Export Tasks (default)'
 					puts '    --tracks                    Export Tracks'
-					# puts '    --billed                    Filter only Tasks/Tracks which are billed.'
-					# puts '    --unbilled                  Filter only Tasks/Tracks which are not billed.'
-					puts '    --format                    Format Tasks and Tracks output.'
+					puts '    --billed                    Filter only Tasks/Tracks which are billed.'
+					puts '    --unbilled                  Filter only Tasks/Tracks which are not billed.'
+					puts '    --format <str>              Format Tasks and Tracks output.'
 					puts "    --csv <path>                Export as CSV file. Use '--csv -' to use STDOUT."
 					puts "    --force                     Force overwrite file."
 					puts
@@ -715,6 +747,8 @@ module TheFox
 					puts '    %fid    Foreign ID'
 					puts '    %n      Name'
 					puts '    %d      Description'
+					puts '    %ds     Duration Seconds'
+					puts '    %dh     Duration Human Format'
 					puts
 					puts 'Track Format'
 					puts '    %id     ID'
@@ -726,6 +760,10 @@ module TheFox
 					puts '    %edt    End DateTime'
 					puts '    %ed     End Date'
 					puts '    %et     End Time'
+					puts '    %ds     Duration Seconds'
+					puts '    %dh     Duration Human Format'
+					puts '    %bi     Billed Integer'
+					puts '    %bh     Billed Human Format (YES, NO)'
 					puts
 					puts "Use '%T' prefix for each Task attribute for Track formatting."
 					puts "For example use '%Tid' to use the Task ID."