timr 0.3.0 → 0.4.0

data/lib/timr/command/log_command.rb

@@ -0,0 +1,297 @@
+
+require 'date'
+require 'time'
+
+module TheFox
+	module Timr
+		module Command
+			
+			# By default this Command prints all todays [Tracks](rdoc-ref:TheFox::Timr::Model::Track).
+			# 
+			# Man page: [timr-log(1)](../../../../man/timr-log.1.html)
+			class LogCommand < BasicCommand
+				
+				include TheFox::Timr::Helper
+				include TheFox::Timr::Error
+				
+				# Path to man page.
+				MAN_PATH = 'man/timr-log.1'
+				
+				def initialize(argv = Array.new)
+					super()
+					
+					@help_opt = false
+					
+					@from_opt = nil
+					@to_opt = nil
+					
+					@start_date = nil
+					@end_date = nil
+					
+					@start_time = nil
+					@end_time = nil
+					
+					loop_c = 0 # Limit the loop.
+					while loop_c < 1024 && argv.length > 0
+						loop_c += 1
+						arg = argv.shift
+						
+						case arg
+						when '-h', '--help'
+							@help_opt = true
+						
+						when '-s', '--from'
+							@from_opt = Time.parse(argv.shift)
+						when '-e', '--to'
+							@to_opt = Time.parse(argv.shift)
+						
+						when '-d', '--day'
+							@from_opt, @to_opt = DateTimeHelper.parse_day_argv(argv)
+						when '-m', '--month'
+							@from_opt, @to_opt = DateTimeHelper.parse_month_argv(argv)
+						when '-y', '--year'
+							@from_opt, @to_opt = DateTimeHelper.parse_year_argv(argv)
+						
+						when '-a', '--all'
+							@from_opt = Time.parse('1970-01-01 00:00:00')
+							@to_opt   = Time.parse('2099-12-31 23:59:59')
+						
+						when '--sd', '--start-date'
+							@start_date = Time.parse(argv.shift)
+						when '--ed', '--end-date'
+							@end_date = Time.parse(argv.shift)
+						when '--st', '--start-time'
+							@start_time = Time.parse(argv.shift)
+						when '--et', '--end-time'
+							@end_time = Time.parse(argv.shift)
+						
+						else
+							raise LogCommandError, "Unknown argument '#{arg}'. See 'timr log --help'."
+						end
+					end
+					
+					@daytime_filter = false
+					if @start_date && @end_date && @start_time && @end_time
+						@from_opt = Time.parse("#{@start_date.strftime('%F')} #{@start_time.strftime('%T')}")
+						@to_opt   = Time.parse("#{@end_date.strftime('%F')} #{@end_time.strftime('%T')}")
+						
+						@daytime_filter = true
+					end
+					
+					today = Date.today
+					unless @from_opt
+						@from_opt = Time.new(today.year, today.month, today.day, 0, 0, 0)
+					end
+					unless @to_opt
+						@to_opt = Time.new(today.year, today.month, today.day, 23, 59, 59)
+					end
+					
+					@filter_options = {:from => @from_opt, :to => @to_opt}
+				end
+				
+				# See BasicCommand#run.
+				def run
+					if @help_opt
+						help
+						return
+					end
+					
+					@timr = Timr.new(@cwd)
+					
+					print_small_table
+				end
+				
+				private
+				
+				def print_small_table
+					puts 'Selected datetime range:'
+					if @daytime_filter
+						puts "On every day from #{@start_date.strftime('%F')}"
+						puts "               to #{@end_date.strftime('%F')}"
+						puts "          between #{@start_time.strftime('%T %z')}"
+						puts "              and #{@end_time.strftime('%T %z')}"
+					else
+						puts " From #{@from_opt.strftime('%F %T %z')}"
+						puts "   To #{@to_opt.strftime('%F %T %z')}"
+					end
+					puts
+					
+					table_options = {
+						:headings => [
+							{:format => '%3s', :label => '###'},
+							{:format => '%-14s', :label => 'START', :padding_left => ' ', :padding_right => ' '},
+							{:format => '%-14s', :label => 'END', :padding_left => ' ', :padding_right => ' '},
+							{:format => '%7s', :label => 'DUR', :padding_left => ' ', :padding_right => ' '},
+							{:format => '%-6s', :label => 'TASK', :padding_right => ' '},
+							{:format => '%s', :label => 'TRACK'},
+						],
+					}
+					table = Table.new(table_options)
+					
+					totals = {
+						:duration => Duration.new,
+						:task_c => 0,
+						
+						:begin_datetime => nil,
+						:end_datetime   => nil,
+					}
+					
+					tmp_begin_options = {:format => '%y-%m-%d %H:%M'}
+					tmp_end_options = {:format => '%H:%M %y-%m-%d'}
+					
+					glob_begin_options = {
+						:format => tmp_begin_options[:format],
+						:from => @from_opt,
+					}
+					glob_end_options = {
+						:format => tmp_end_options[:format],
+						:to => @to_opt,
+					}
+					
+					table_has_rows = false
+					@timr.tracks(@filter_options).each do |track_id, track|
+						table_has_rows = true
+						
+						task = track.task
+						
+						if @daytime_filter
+							track.days.each do |track_day|
+								from = Time.parse("#{track_day.strftime('%F')} #{@start_time.strftime('%T')}")
+								to   = Time.parse("#{track_day.strftime('%F')} #{@end_time.strftime('%T')}")
+								
+								# Skip out-of-scope Tracks.
+								if track.end_datetime < from || track.begin_datetime > to
+									next
+								end
+								
+								totals[:task_c] += 1
+								
+								bdt = track.begin_datetime(@filter_options)
+								edt = track.end_datetime(@filter_options)
+								if bdt && (!totals[:begin_datetime] || bdt < totals[:begin_datetime])
+									totals[:begin_datetime] = bdt
+								end
+								if edt && (!totals[:end_datetime] || edt > totals[:end_datetime])
+									totals[:end_datetime] = edt
+								end
+								
+								tmp_begin_options[:from] = from
+								tmp_end_options[:to] = to
+								begin_datetime_s = track.begin_datetime_s(tmp_begin_options)
+								end_datetime_s   = track.end_datetime_s(tmp_end_options)
+								
+								duration = track.duration({:from => from, :to => to})
+								if duration
+									totals[:duration] += duration
+								end
+								
+								table << [
+									track_c,
+									begin_datetime_s,
+									end_datetime_s,
+									duration ? duration.to_human : '---',
+									task.short_id,
+									'%s %s' % [track.short_id, track.title(15)],
+								]
+							end
+						else
+							totals[:task_c] += 1
+							
+							bdt = track.begin_datetime(@filter_options)
+							edt = track.end_datetime(@filter_options)
+							
+							if bdt && (!totals[:begin_datetime] || bdt < totals[:begin_datetime])
+								totals[:begin_datetime] = bdt
+							end
+							if edt && (!totals[:end_datetime] || edt > totals[:end_datetime])
+								totals[:end_datetime] = edt
+							end
+							
+							begin_datetime_s = track.begin_datetime_s(glob_begin_options)
+							end_datetime_s   = track.end_datetime_s(glob_end_options)
+							
+							duration = track.duration(@filter_options)
+							if duration
+								totals[:duration] += duration
+							end
+							
+							table << [
+								totals[:task_c],
+								begin_datetime_s,
+								end_datetime_s,
+								duration ? duration.to_human : '---',
+								task.short_id,
+								'%s %s' % [track.short_id, track.title(15)],
+							]
+						end
+					end
+					
+					table << []
+					
+					totals[:begin_datetime_s] = totals[:begin_datetime] ? totals[:begin_datetime].localtime.strftime(glob_begin_options[:format]) : '---'
+					
+					totals[:end_datetime_s] = totals[:end_datetime] ? totals[:end_datetime].localtime.strftime(glob_end_options[:format]) : '---'
+					
+					# Add totals to the bottom.
+					table << [
+						nil,        # track_c
+						totals[:begin_datetime_s],
+						totals[:end_datetime_s],
+						totals[:duration] ? totals[:duration].to_human : '---', # duration
+						'TOTAL',    # task
+						nil,        # track
+					]
+					
+					if table_has_rows
+						puts table
+					else
+						puts 'No tracks found.'
+					end
+				end
+				
+				def help
+					puts 'usage: timr log [-s|--from <date_time>] [-e|--to <date_time>]'
+					puts '   or: timr log --sd <date> --ed <date> --st <time> --et <time>'
+					puts '   or: timr log -d|--day <date>'
+					puts '   or: timr log -m|--month <YYYY-MM>'
+					puts '   or: timr log -y|--year <YYYY>'
+					puts '   or: timr log -a|--all'
+					puts '   or: timr log [-h|--help]'
+					puts
+					puts 'Total Filter'
+					puts "    -s, --from '<date_time>'     From Date/Time. Must be in quotes."
+					puts '                                 Default: today 00:00:00'
+					puts "    -e, --to   '<date_time>'     To Date/Time. Must be in quotes."
+					puts '                                 Default: today 23:59:59'
+					puts '    -d, --day   <date>           A single day from 00:00 to 23:59.'
+					puts '    -m, --month <[YYYY-]MM>      A single month from 01 to 31.'
+					puts '    -y, --year  [<YYYY>]         A single year from 01-01 to 12-31.'
+					puts '    -a, --all                    Show all Tracks.'
+					puts
+					puts 'Day Time Filter'
+					puts '    --sd, --start-date <date>    Start Date'
+					puts '    --ed,   --end-date <date>    End Date'
+					puts '    --st, --start-time <time>    Start Time'
+					puts '    --et,   --end-time <time>    End Time'
+					puts
+					puts 'If you would like to filter everything between 09:00 and 17:00 on every day'
+					puts 'in the range from Mon 2017-03-06 to Fri 2017-03-10:'
+					puts
+					puts '    timr log --sd 2017-03-06 --ed 2017-03-10 --st 09:00 --et 17:00'
+					puts
+					puts 'Columns'
+					puts '    START    Track Start Date'
+					puts '    END      Track End Date'
+					puts '    DUR      Track Duration'
+					puts '    TASK     Task ID'
+					puts '    TRACK    Track ID and Title.'
+					puts
+					HelpCommand.print_datetime_help
+					puts
+				end
+				
+			end # class LogCommand
+			
+		end # module Command
+	end # module Timr
+end # module TheFox

data/lib/timr/command/pause_command.rb

@@ -0,0 +1,89 @@
+
+module TheFox
+	module Timr
+		module Command
+			
+			# Pause the current running [Track](rdoc-ref:TheFox::Timr::Model::Track).
+			# 
+			# Man page: [timr-pause(1)](../../../../man/timr-pause.1.html)
+			class PauseCommand < BasicCommand
+				
+				include TheFox::Timr::Helper
+				include TheFox::Timr::Error
+				
+				# Path to man page.
+				MAN_PATH = 'man/timr-pause.1'
+				
+				def initialize(argv = Array.new)
+					super()
+					
+					@help_opt = false
+					
+					@end_date_opt = nil
+					@end_time_opt = nil
+					
+					loop_c = 0 # Limit the loop.
+					while loop_c < 1024 && argv.length > 0
+						loop_c += 1
+						arg = argv.shift
+						
+						case arg
+						when '-h', '--help'
+							@help_opt = true
+						when '--ed', '--end-date', '-d', '--date'
+							@end_date_opt = argv.shift
+						when '--et', '--end-time', '-t', '--time'
+							@end_time_opt = argv.shift
+						else
+							raise PauseCommandError, "Unknown argument '#{arg}'. See 'timr pause --help'."
+						end
+					end
+				end
+				
+				# See BasicCommand.
+				def run
+					if @help_opt
+						help
+						return
+					end
+					
+					@timr = Timr.new(@cwd)
+					
+					options = {
+						:end_date => @end_date_opt,
+						:end_time => @end_time_opt,
+					}
+					
+					track = @timr.pause(options)
+					unless track
+						puts 'No running Track to pause.'
+						return
+					end
+					
+					puts '--- PAUSED ---'
+					puts track.to_compact_str
+					puts @timr.stack
+				end
+				
+				private
+				
+				def help
+					puts 'usage: timr pause [-d|--date <date>] [-t|--time <time>]'
+					puts '   or: timr pause [-h|--help]'
+					puts
+					puts 'Track Options'
+					puts '    --ed, --end-date <date>    Track End Date'
+					puts '    --et, --end-time <time>    Track End Time'
+					puts
+					puts '    -d, --date <date>          --end-date alias.'
+					puts '    -t, --time <time>          --end-time alias.'
+					puts
+					HelpCommand.print_datetime_help
+					puts
+				end
+				
+			end # class PauseCommand
+			
+		end # module Command
+	end # module Timr
+end # module TheFox

data/lib/timr/command/pop_command.rb

@@ -0,0 +1,176 @@
+
+module TheFox
+	module Timr
+		module Command
+			
+			# This command pops the Top [Track](rdoc-ref:TheFox::Timr::Model::Track), makes a duplication
+			# of the next Track on the [Stack](rdoc-ref:TheFox::Timr::Model::Stack), pops the next,
+			# and pushes the duplication Track back on the Stack. There are at least 3 Tracks involved.
+			# 
+			# Man page: [timr-pop(1)](../../../../man/timr-pop.1.html)
+			# 
+			# ### Example
+			# 
+			# Example Stack before pop:
+			# 
+			# ```
+			# Track 1234 stopped
+			# Track 2345 stopped
+			# Track 3456 running
+			# ```
+			# 
+			# Pop Execution
+			# 
+			# 1. Make duplication of Track `3456` -> new Track `4567`.  
+			#   Because Track `3456` is the latest Track on the Stack. Sometimes call *Top Track*.
+			# 2. Pop Track `3456` from Stack.
+			# 3. Push new Track `4567` to Stack.
+			# 
+			# Example Stack after pop:
+			# 
+			# ```
+			# Track 1234 stopped
+			# Track 2345 stopped
+			# Track 4567 running
+			# ```
+			class PopCommand < BasicCommand
+				
+				include TheFox::Timr::Helper
+				include TheFox::Timr::Error
+				
+				# Path to man page.
+				MAN_PATH = 'man/timr-pop.1'
+				
+				def initialize(argv = Array.new)
+					super()
+					
+					@help_opt = false
+					
+					@start_date_opt = nil
+					@start_time_opt = nil
+					@end_date_opt = nil
+					@end_time_opt = nil
+					
+					@date_opt = nil
+					@time_opt = nil
+					
+					loop_c = 0 # Limit the loop.
+					while loop_c < 1024 && argv.length > 0
+						loop_c += 1
+						arg = argv.shift
+						
+						case arg
+						when '-h', '--help'
+							@help_opt = true
+						
+						when '--sd', '--start-date'
+							@start_date_opt = argv.shift
+						when '--st', '--start-time'
+							@start_time_opt = argv.shift
+						when '--ed', '--end-date'
+							@end_date_opt = argv.shift
+						when '--et', '--end-time'
+							@end_time_opt = argv.shift
+						
+						when '-d', '--date'
+							@date_opt = argv.shift
+						when '-t', '--time'
+							@time_opt = argv.shift
+						
+						else
+							raise PopCommandError, "Unknown argument '#{arg}'. See 'timr pop --help'."
+						end
+					end
+					
+					if @date_opt
+						@start_date_opt = @date_opt
+						@end_date_opt = @date_opt
+					end
+					if @time_opt
+						@start_time_opt = @time_opt
+						@end_time_opt = @time_opt
+					end
+				end
+				
+				# See BasicCommand#run.
+				def run
+					if @help_opt
+						help
+						return
+					end
+					
+					@timr = Timr.new(@cwd)
+					
+					# Stop
+					options = {
+						:date => @end_date_opt,
+						:time => @end_time_opt,
+					}
+					
+					track = @timr.stop(options)
+					unless track
+						puts 'No running Track to pop/stop.'
+						return
+					end
+					
+					task = track.task
+					unless task
+						raise TrackError, "Track #{track.id} has no Task."
+					end
+					
+					puts '--- POPED ---'
+					puts track.to_compact_str
+					puts
+					
+					# Continue
+					options = {
+						:date => @start_date_opt,
+						:time => @start_time_opt,
+					}
+					
+					track = @timr.continue(options)
+					unless track
+						puts 'No running Track left on Stack to continue.'
+						return
+					end
+					
+					task = track.task
+					unless task
+						raise TrackError, "Track #{track.id} has no Task."
+					end
+					
+					puts '--- CONTINUED ---'
+					puts track.to_compact_str
+					puts
+					puts @timr.stack
+				end
+				
+				private
+				
+				def help
+					puts 'usage: timr pop [--sd|--start-date <date>] [--st|--start-time <time>]'
+					puts '                [--ed|--end-date <date>] [--et|--end-time <time>]'
+					puts '   or: timr pop [-d|--date <date>] [-t|--time <time>]'
+					puts '   or: timr pop [-h|--help]'
+					puts
+					puts 'Track Options'
+					puts '    --sd, --start-date <date>    Start Date for the next underlying Track.'
+					puts '    --st, --start-time <time>    Start Time for the next underlying Track.'
+					puts
+					puts '    --ed, --end-date <date>      End Date for the current running Track.'
+					puts '    --et, --end-time <time>      End Time for the current running Track.'
+					puts
+					puts "    -d, --date <date>            Alias for"
+					puts "                                 '--end-date <date> --start-date <date>'."
+					puts "    -t, --time <time>            Alias for"
+					puts "                                 '--end-time <time> --start-time <time>'."
+					puts
+					HelpCommand.print_datetime_help
+					puts
+				end
+				
+			end # class PopCommand
+			
+		end # module Command
+	end # module Timr
+end # module TheFox