timr 0.3.0 → 0.4.0

data/lib/timr/version.rb

@@ -2,22 +2,11 @@
 module TheFox
 	module Timr
 		NAME = 'Timr'
-		VERSION = '0.3.0'
-		DATE = '2016-06-01'
+		VERSION = '0.4.0'
+		DATE = '2017-04-13'
 		HOMEPAGE = 'https://github.com/TheFox/timr'
 		
-		COL = 1
-		MIN_COLS = 20
-		TIMEOUT = 250
-		
-		# Reserved Lines
-		# - Title
-		# - Status Time Line
-		# - Status Text Line
-		RESERVED_LINES = 3
-		
-		TIME_FORMAT_FILE = '%FT%T%z'
-		
-		TASK_NO_TASK_LOADED_CHAR = ?-
+		MODEL_DATETIME_FORMAT = '%FT%T%z'
+		HUMAN_DATETIME_FOMRAT = '%F %T %z'
 	end
 end

data/man/.gitignore

@@ -0,0 +1,2 @@
+*.html
+*.tmp

data/man/_footer

@@ -0,0 +1,3 @@
+## TIMR
+
+This is part of timr(1).

data/man/timr-continue.1

@@ -0,0 +1,48 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "TIMR\-CONTINUE" "1" "April 2017" "FOX21.at" "Timr Manual"
+.
+.SH "NAME"
+\fBtimr\-continue\fR \- Continue the previous paused Track\.
+.
+.SH "SYNOPSIS"
+timr continue [\fIoptions\fR]
+.
+.SH "DESCRIPTION"
+When a Track will be continued (or \fIrestarted\fR) it\'s actual a copy using the same message\.
+.
+.SH "TRACK OPTIONS"
+.
+.TP
+\-d, \-\-date \fIdate\fR
+Start Date for the new Track\. See timr\-ftime(7)\.
+.
+.TP
+\-t, \-\-time \fItime\fR
+Start Time for the new Track\. See timr\-ftime(7)\.
+.
+.SH "GENERAL OPTIONS"
+.
+.TP
+\-h, \-\-help
+Displays the help page\.
+.
+.SH "EXAMPLES"
+.
+.nf
+
+timr continue
+timr continue \-\-time 11:00
+timr continue \-\-date 2017\-01\-02 \-\-time 11:00
+.
+.fi
+.
+.SH "API REFERENCE"
+\fIhttps://timr\.fox21\.at/api/TheFox/Timr/Command/ContinueCommand\.html\fR
+.
+.SH "SEE ALSO"
+timr\-pause(1), timr\-ftime(7)
+.
+.SH "TIMR"
+This is part of timr(1)\.

data/man/timr-continue.1.ronn

@@ -0,0 +1,39 @@
+timr-continue(1) -- Continue the previous paused Track.
+===
+
+## SYNOPSIS
+
+timr continue [<options>]
+
+## DESCRIPTION
+
+When a Track will be continued (or *restarted*) it's actual a copy using the same message.
+
+## TRACK OPTIONS
+
+* -d, --date <date>:
+	Start Date for the new Track. See timr-ftime(7).
+
+* -t, --time <time>:
+	Start Time for the new Track. See timr-ftime(7).
+
+## GENERAL OPTIONS
+
+* -h, --help:
+	Displays the help page.
+
+## EXAMPLES
+
+```
+timr continue
+timr continue --time 11:00
+timr continue --date 2017-01-02 --time 11:00
+```
+
+## API REFERENCE
+
+<https://timr.fox21.at/api/TheFox/Timr/Command/ContinueCommand.html>
+
+## SEE ALSO
+
+timr-pause(1), timr-ftime(7)

data/man/timr-ftime.7

@@ -0,0 +1,77 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "TIMR\-FTIME" "7" "April 2017" "FOX21.at" "Timr Manual"
+.
+.SH "NAME"
+\fBtimr\-ftime\fR \- Date/Time Format
+.
+.SH "SYNOPSIS"
+timr *
+.
+.SH "DESCRIPTION"
+This document is about date, time and estimation Strings\.
+.
+.SH "DATETIME FORMATS"
+.
+.TP
+\fIdate_time\fR
+A DateTime is one single string representing \fB\'<date> <time>\'\fR\. Must be in quotes\.
+.
+.TP
+\fIdate\fR
+Formats: \fBYYYYMMDD\fR, \fBYYYY\-MM\-DD\fR, \fBMM/DD/YYYY\fR, \fBDD\.MM\.YYYY\fR
+.
+.TP
+\fItime\fR
+Formats: \fBHH:MM\fR, \fBHH:MM:SS\fR
+.
+.P
+All dates and times are handled by Ruby Time \fIhttps://ruby\-doc\.org/stdlib\-2\.4\.0/libdoc/time/rdoc/Time\.html\fR class\.
+.
+.SH "DURATION"
+Most used by Estimation (command\-line option \fB\-e\fR)\.
+.
+.SS "Examples"
+Sets Estimation to 2h 10m 5s:
+.
+.IP "\(bu" 4
+\fB\-e 2:10:5\fR
+.
+.IP "\(bu" 4
+\fB\-e \'2h 10m 5s\'\fR
+.
+.IP "" 0
+.
+.P
+Use \'+\' or \'\-\' to calculate with Estimation times\.
+.
+.P
+Subtracts 45 minutes from the original Estimation:
+.
+.P
+\fB\-e \'\-45m\'\fR
+.
+.P
+Adds 1 hour 30 minutes to the original Estimation:
+.
+.P
+\fB\-e \'+1h 30m\'\fR
+.
+.P
+This format is also called \fIHuman Format\fR\.
+.
+.SS "chronic_duration"
+Duration is parsed by chronic_duration\.
+.
+.P
+See chronic_duration for more examples:
+.
+.br
+\fIhttps://github\.com/henrypoydar/chronic_duration\fR
+.
+.SH "SEE ALSO"
+timr\-continue(1), timr\-log(1), timr\-pause(1), timr\-pop(1), timr\-report(1), timr\-start(1), timr\-stop(1), timr\-task(1), timr\-track(1)
+.
+.SH "TIMR"
+This is part of timr(1)\.

data/man/timr-ftime.7.ronn

@@ -0,0 +1,57 @@
+timr-ftime(7) -- Date/Time Format
+===
+
+## SYNOPSIS
+
+timr *
+
+## DESCRIPTION
+
+This document is about date, time and estimation Strings.
+
+## DATETIME FORMATS
+
+* <date_time>:
+	A DateTime is one single string representing `'<date> <time>'`. Must be in quotes.
+
+* <date>:
+	Formats: `YYYYMMDD`, `YYYY-MM-DD`, `MM/DD/YYYY`, `DD.MM.YYYY`
+
+* <time>:
+	Formats: `HH:MM`, `HH:MM:SS`
+
+All dates and times are handled by [Ruby Time](https://ruby-doc.org/stdlib-2.4.0/libdoc/time/rdoc/Time.html) class.
+
+## DURATION
+
+Most used by Estimation (command-line option `-e`).
+
+### Examples
+
+Sets Estimation to 2h 10m 5s:
+
+- `-e 2:10:5`
+- `-e '2h 10m 5s'`
+
+Use '+' or '-' to calculate with Estimation times.
+
+Subtracts 45 minutes from the original Estimation:
+
+`-e '-45m'`
+
+Adds 1 hour 30 minutes to the original Estimation:
+
+`-e '+1h 30m'`
+
+This format is also called *Human Format*.
+
+### chronic_duration
+
+Duration is parsed by chronic_duration.
+
+See chronic_duration for more examples:  
+<https://github.com/henrypoydar/chronic_duration>
+
+## SEE ALSO
+
+timr-continue(1), timr-log(1), timr-pause(1), timr-pop(1), timr-report(1), timr-start(1), timr-stop(1), timr-task(1), timr-track(1)

data/man/timr-log.1

@@ -0,0 +1,109 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "TIMR\-LOG" "1" "April 2017" "FOX21.at" "Timr Manual"
+.
+.SH "NAME"
+\fBtimr\-log\fR \- Show recent Tracks\.
+.
+.SH "SYNOPSIS"
+timr log [\fIoptions\fR]
+.
+.SH "DESCRIPTION"
+By default this command prints all todays Tracks\.
+.
+.SH "TOTAL FILTER OPTIONS"
+.
+.TP
+\-s, \-\-from \'\fIdate_time\fR\'
+From Date/Time\. Must be in quotes to be one single string\. Default: today 00:00:00\. See timr\-ftime(7)\.
+.
+.TP
+\-e, \-\-to \'\fIdate_time\fR\'
+To Date/Time\. Must be in quotes to be one single string\. Default: today 23:59:59\. See timr\-ftime(7)\.
+.
+.TP
+\-d, \-\-day \fIdate\fR
+A single day from 00:00 to 23:59\. See timr\-ftime(7)\.
+.
+.TP
+\-m, \-\-month \fI[YYYY\-]MM\fR
+A single month from 01 to 31\.
+.
+.TP
+\-y, \-\-year [\fIYYYY\fR]
+A single year from 01\-01 to 12\-31\.
+.
+.TP
+\-a, \-\-all
+Show all Tracks\.
+.
+.SH "DAY TIME FILTER OPTIONS"
+.
+.TP
+\-\-sd, \-\-start\-date \fIdate\fR
+Start Date\. See timr\-ftime(7)\.
+.
+.TP
+\-\-ed, \-\-end\-date \fIdate\fR
+End Date\. See timr\-ftime(7)\.
+.
+.TP
+\-\-st, \-\-start\-time \fItime\fR
+Start Time\. See timr\-ftime(7)\.
+.
+.TP
+\-\-et, \-\-end\-time \fItime\fR
+End Time\. See timr\-ftime(7)\.
+.
+.SH "GENERAL OPTIONS"
+.
+.TP
+\-h, \-\-help
+Displays the help page\.
+.
+.SH "EXAMPLES"
+.
+.nf
+
+timr log
+timr log \-\-from \'2017\-01\-02 10:00\' \-\-to \'2017\-01\-09 17:00\'
+timr log \-\-day 2017\-01\-03
+timr log \-\-month 2017\-01
+timr log \-\-year 2017
+timr log \-\-all
+timr log \-\-start\-date 2017\-01\-01 \-\-end\-date 2017\-01\-05 \e
+    \-\-start\-time 08:00 \-\-end\-time 17:00
+.
+.fi
+.
+.SH "COLUMNS"
+.
+.TP
+START
+Track Start Date
+.
+.TP
+END
+Track End Date
+.
+.TP
+DUR
+Track Duration
+.
+.TP
+TASK
+Task ID
+.
+.TP
+TRACK
+Track ID and Title\.
+.
+.SH "API REFERENCE"
+\fIhttps://timr\.fox21\.at/api/TheFox/Timr/Command/LogCommand\.html\fR
+.
+.SH "SEE ALSO"
+timr\-report(1), timr\-ftime(7)
+.
+.SH "TIMR"
+This is part of timr(1)\.

data/man/timr-log.1.ronn

@@ -0,0 +1,87 @@
+timr-log(1) -- Show recent Tracks.
+===
+
+## SYNOPSIS
+
+timr log [<options>]
+
+## DESCRIPTION
+
+By default this command prints all todays Tracks.
+
+## TOTAL FILTER OPTIONS
+
+* -s, --from '<date_time>':
+	From Date/Time. Must be in quotes to be one single string. Default: today 00:00:00. See timr-ftime(7).
+
+* -e, --to '<date_time>':
+	To Date/Time. Must be in quotes to be one single string. Default: today 23:59:59. See timr-ftime(7).
+
+* -d, --day <date>:
+	A single day from 00:00 to 23:59. See timr-ftime(7).
+
+* -m, --month <[YYYY-]MM>:
+	A single month from 01 to 31.
+
+* -y, --year [<YYYY>]:
+	A single year from 01-01 to 12-31.
+
+* -a, --all:
+	Show all Tracks.
+
+## DAY TIME FILTER OPTIONS
+
+* --sd, --start-date <date>:
+	Start Date. See timr-ftime(7).
+
+* --ed, --end-date <date>:
+	End Date. See timr-ftime(7).
+
+* --st, --start-time <time>:
+	Start Time. See timr-ftime(7).
+
+* --et, --end-time <time>:
+	End Time. See timr-ftime(7).
+
+## GENERAL OPTIONS
+
+* -h, --help:
+	Displays the help page.
+
+## EXAMPLES
+
+```
+timr log
+timr log --from '2017-01-02 10:00' --to '2017-01-09 17:00'
+timr log --day 2017-01-03
+timr log --month 2017-01
+timr log --year 2017
+timr log --all
+timr log --start-date 2017-01-01 --end-date 2017-01-05 \
+	--start-time 08:00 --end-time 17:00
+```
+
+## COLUMNS
+
+* START:
+	Track Start Date
+
+* END:
+	Track End Date
+
+* DUR:
+	Track Duration
+
+* TASK:
+	Task ID
+
+* TRACK:
+	Track ID and Title.
+
+## API REFERENCE
+
+<https://timr.fox21.at/api/TheFox/Timr/Command/LogCommand.html>
+
+## SEE ALSO
+
+timr-report(1), timr-ftime(7)