timr 0.3.0 → 0.4.0

data/lib/timr/command/start_command.rb

@@ -0,0 +1,172 @@
+
+require 'tempfile'
+
+module TheFox
+	module Timr
+		module Command
+			
+			# Start a new [Track](rdoc-ref:TheFox::Timr::Model::Track).
+			# 
+			# Man page: [timr-start(1)](../../../../man/timr-start.1.html)
+			class StartCommand < BasicCommand
+				
+				include TheFox::Timr::Model
+				include TheFox::Timr::Helper
+				include TheFox::Timr::Error
+				
+				# Path to man page.
+				MAN_PATH = 'man/timr-start.1'
+				
+				def initialize(argv = Array.new)
+					super()
+					
+					@help_opt = false
+					
+					@foreign_id_opt = nil
+					@name_opt = nil
+					@description_opt = nil
+					@estimation_opt = nil
+					
+					@hourly_rate_opt = nil
+					@has_flat_rate_opt = nil
+					
+					@date_opt = nil
+					@time_opt = nil
+					@message_opt = nil
+					@edit_opt = false
+					
+					@task_id_opt = nil
+					@track_id_opt = nil
+					@id_opts = Array.new
+					
+					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 '--id'
+							@foreign_id_opt = argv.shift.strip
+						when '-n', '--name'
+							@name_opt = argv.shift
+						when '--desc', '--description'
+							@description_opt = argv.shift
+						when '-e', '--est', '--estimation'
+							@estimation_opt = argv.shift
+						
+						when '-r', '--hourly-rate'
+							@hourly_rate_opt = argv.shift
+						when '--fr', '--flat', '--flat-rate'
+							@has_flat_rate_opt = true
+						
+						when '-d', '--date'
+							@date_opt = argv.shift
+						when '-t', '--time'
+							@time_opt = argv.shift
+						when '-m', '--message'
+							@message_opt = argv.shift
+						when '--edit'
+							@edit_opt = true
+						else
+							if arg[0] == '-'
+								raise StartCommandError, "Unknown argument '#{arg}'. See 'timr start --help'."
+							else
+								if @id_opts.length < 2
+									@id_opts << arg
+								else
+									raise StartCommandError, "Unknown argument '#{arg}'. See 'timr start --help'."
+								end
+							end
+						end
+					end
+					
+					check_foreign_id(@foreign_id_opt)
+					
+					if @id_opts.length
+						@task_id_opt, @track_id_opt = @id_opts
+					end
+				end
+				
+				# See BasicCommand#run.
+				def run
+					if @help_opt
+						help
+						return
+					end
+					
+					@timr = Timr.new(@cwd)
+					
+					run_edit
+					
+					options = {
+						:foreign_id => @foreign_id_opt,
+						:name => @name_opt,
+						:description => @description_opt,
+						:estimation => @estimation_opt,
+						
+						:hourly_rate => @hourly_rate_opt,
+						:has_flat_rate => @has_flat_rate_opt,
+						
+						:date => @date_opt,
+						:time => @time_opt,
+						:message => @message_opt,
+						
+						:task_id => @task_id_opt,
+						:track_id => @track_id_opt,
+					}
+					
+					track = @timr.start(options)
+					unless track
+						raise TrackError, 'Could not start a new Track.'
+					end
+					
+					puts track.to_compact_str
+					puts @timr.stack
+				end
+				
+				private
+				
+				def help
+					puts 'usage: timr start [--id <str>]'
+					puts '                  [-n|--name <name>] [--desc|--description <description>]'
+					puts '                  [[-d|--date <date>] -t|--time <time>]'
+					puts '                  [-m|--message <message>] [--edit] [--estimation <time>]'
+					puts '                  [--hourly-rate <value>] [--flat-rate]'
+					puts '                  [<task_id> [<track_id>]]'
+					puts '   or: timr start [-h|--help]'
+					puts
+					puts "Note: 'timr push' uses the same options."
+					puts
+					puts 'Task Options'
+					puts '    --id <str>                        Your ID to identify the Task.'
+					puts '    -n, --name <name>                 The name of the new Task.'
+					puts '    --desc, --description <str>       Longer description of the new Task.'
+					puts '    -e, --est, --estimation <time>    Task Estimation. See details below.'
+					puts '    -r, --hourly-rate <float>         Set the Hourly Rate.'
+					puts '    --fr, --flat-rate, --flat         Has Task a Flat Rate?'
+					puts
+					puts 'Track Options'
+					puts '    -m, --message <message>    Track Message. What have you done?'
+					puts '                               You can overwrite this on stop command.'
+					puts '    --edit                     Edit Track Message when providing <track_id>.'
+					puts '                               EDITOR environment variable must be set.'
+					puts '    -d, --date <date>          Track Start Date. Default: today'
+					puts '    -t, --time <time>          Track Start Time. Default: now'
+					puts
+					puts 'Arguments'
+					HelpCommand.print_id_help
+					puts
+					HelpCommand.print_datetime_help
+					puts
+					HelpCommand.print_estimation_help
+					puts
+				end
+				
+			end # class StartCommand
+			
+		end # module Command
+	end # module Timr
+end # module TheFox

data/lib/timr/command/status_command.rb

@@ -0,0 +1,198 @@
+
+require 'thefox-ext'
+
+module TheFox
+	module Timr
+		module Command
+			
+			# Print [Stack](rdoc-ref:TheFox::Timr::Model::Stack) Status.
+			# 
+			# Man page: [timr-status(1)](../../../../man/timr-status.1.html)
+			class StatusCommand < BasicCommand
+				
+				include TheFox::Timr::Error
+				
+				# Path to man page.
+				MAN_PATH = 'man/timr-status.1'
+				
+				def initialize(argv = Array.new)
+					super()
+					
+					@help_opt = false
+					
+					@verbose_opt = false
+					@full_opt = false
+					@reverse_opt = false
+					
+					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 '-v', '--verbose'
+							@verbose_opt = true
+						when '-f', '--full'
+							@full_opt = true
+						when '-r', '--reverse'
+							@reverse_opt = true
+						else
+							raise StatusCommandError, "Unknown argument '#{arg}'. See 'timr stop --help'."
+						end
+					end
+				end
+				
+				# See BasicCommand#run.
+				def run
+					if @help_opt
+						help
+						return
+					end
+					
+					@timr = Timr.new(@cwd)
+					
+					if @full_opt
+						print_full_table
+					else
+						print_small_table
+					end
+				end
+				
+				private
+				
+				def print_small_table
+					headings = Array.new
+					headings << {:format => '%2s', :label => '##'}
+					headings << {:format => '%1s', :label => 'S'}
+					headings << {:format => '%-5s', :label => 'START', :padding_left => ' '}
+					headings << {:format => '%-5s', :label => 'END'}
+					headings << {:format => '%8s', :label => 'DUR', :padding_right => ' '}
+					if @verbose_opt
+						headings << {:format => '%7s', :label => 'EST', :padding_right => ' '}
+						headings << {:format => '%7s', :label => 'ETR', :padding_right => ' '}
+						headings << {:format => '%7s', :label => 'ETR%', :padding_right => ' '}
+					end
+					headings << {:format => '%-6s', :label => 'TASK', :padding_right => ' '}
+					headings << {:format => '%s', :label => 'TRACK'}
+					
+					table_options = {
+						:headings => headings,
+					}
+					table = Table.new(table_options)
+					
+					table_has_rows = false
+					track_c = 0
+					get_tracks.each do |track|
+						track_c += 1
+						table_has_rows = true
+						
+						task = track.task
+						
+						status = track.status.short_status
+						duration = track.duration
+						estimation_s = task.estimation_s
+						remaining_time_s = task.remaining_time_s
+						remaining_time_percent_s = task.remaining_time_percent_s
+						
+						if track.begin_datetime
+							begin_datetime_s = track.begin_datetime_s({:format => '%H:%M'})
+						end
+						
+						if track.end_datetime
+							end_datetime_s = track.end_datetime_s({:format => '%H:%M'})
+						end
+						
+						row = Array.new
+						row << track_c
+						row << status
+						row << begin_datetime_s
+						row << end_datetime_s
+						row << duration.to_human
+						if @verbose_opt
+							row << estimation_s
+							row << remaining_time_s
+							row << remaining_time_percent_s
+						end
+						row << task.short_id
+						
+						if @verbose_opt
+							row << '%s %s' % [track.short_id, track.title]
+						else
+							row << '%s %s' % [track.short_id, track.title(12)]
+						end
+						
+						table << row
+					end
+					
+					if table_has_rows
+						puts table
+					else
+						print_no_tracks
+					end
+				end
+				
+				def print_full_table
+					tracks = Array.new
+					track_c = 0
+					get_tracks.each do |track|
+						track_c += 1
+						
+						track_s = Array.new
+						track_s << '--- #%d ---' % [track_c]
+						track_s.concat(track.to_detailed_array)
+						tracks << track_s
+					end
+					
+					if tracks.count > 0
+						puts tracks.map{ |track_s| track_s.join("\n") }.join("\n\n")
+					else
+						print_no_tracks
+					end
+				end
+				
+				def print_no_tracks
+					puts 'There is no running Track.'
+				end
+				
+				def get_tracks
+					if @reverse_opt
+						@timr.stack.tracks.reverse
+					else
+						@timr.stack.tracks
+					end
+				end
+				
+				def help
+					puts 'usage: timr status [-h|--help] [-f|--full] [-r|--reverse]'
+					puts
+					puts 'Options'
+					puts '    -v, --verbose    Show more columns in table view.'
+					puts '    -f, --full       Show full status.'
+					puts '    -r, --reverse    Reverse the list.'
+					puts
+					puts 'Columns'
+					puts '    S        Status'
+					puts '    START    Track Start Date'
+					puts '    END      Track End Date'
+					puts '    DUR      Track Duration'
+					puts '    EST      Task Estimation'
+					puts '    ETR      Task Estimated Time Remaining'
+					puts '    ETR%     Task Estimated Time Remaining in percent.'
+					puts '    TASK     Task ID'
+					puts '    TRACK    Track ID and Title.'
+					puts
+					puts 'Status'
+					puts '    R    Running'
+					puts '    S    Stopped'
+					puts '    U    Unknown'
+					puts '    -    Not started yet.'
+					puts
+				end
+				
+			end # class StatusCommand
+			
+		end # module Command
+	end # module Timr
+end # module TheFox

data/lib/timr/command/stop_command.rb

@@ -0,0 +1,127 @@
+
+module TheFox
+	module Timr
+		module Command
+			
+			# Stop the current running [Track](rdoc-ref:TheFox::Timr::Model::Track).
+			# 
+			# Man page: [timr-stop(1)](../../../../man/timr-stop.1.html)
+			class StopCommand < BasicCommand
+				
+				include TheFox::Timr::Helper
+				include TheFox::Timr::Error
+				
+				# Path to man page.
+				MAN_PATH = 'man/timr-stop.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
+					
+					@message_opt = nil
+					@edit_opt = false
+					
+					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', '-d', '--date'
+							@end_date_opt = argv.shift
+						when '--et', '--end-time', '-t', '--time'
+							@end_time_opt = argv.shift
+						
+						when '-m', '--message'
+							@message_opt = argv.shift
+						when '--edit'
+							@edit_opt = true
+						else
+							raise StopCommandError, "Unknown argument '#{arg}'. See 'timr stop --help'."
+						end
+					end
+				end
+				
+				# See BasicCommand#run.
+				def run
+					if @help_opt
+						help
+						return
+					end
+					
+					@timr = Timr.new(@cwd)
+					
+					track = @timr.stack.current_track
+					if track
+						task = track.task
+						if task
+							run_edit(task.id, track.id)
+						end
+					end
+					
+					options = {
+						:start_date => @start_date_opt,
+						:start_time => @start_time_opt,
+						
+						:end_date => @end_date_opt,
+						:end_time => @end_time_opt,
+						
+						:message => @message_opt,
+					}
+					
+					track = @timr.stop(options)
+					unless track
+						puts 'No running Track to stop.'
+						return
+					end
+					
+					puts track.to_compact_str
+					puts @timr.stack
+				end
+				
+				private
+				
+				def help
+					puts 'usage: timr stop [-m|--message <message>] [--edit]'
+					puts '                 [[--start-date <date>] --start-time <time>]'
+					puts '                 [-d|--date <date>] [-t|--time <time>]'
+					puts '   or: timr stop [-h|--help]'
+					puts
+					puts 'Track Options'
+					puts '    -m, --message <message>    Track Message. What have you done? This will'
+					puts '                               overwrite the start message. See --edit option.'
+					puts '    --edit                     Edit Track Message.'
+					puts '                               EDITOR environment variable must be set.'
+					puts
+					puts '    --sd, --start-date <date>    Overwrite the Start date.'
+					puts '    --st, --start-time <time>    Overwrite the Start time.'
+					puts
+					puts '    --ed, --end-date <date>      Track End Date. Default: today'
+					puts '    --et, --end-time <time>      Track End Time. Default: now'
+					puts
+					puts '    -d, --date <date>            --end-date alias.'
+					puts '    -t, --time <time>            --end-time alias.'
+					puts
+					HelpCommand.print_datetime_help
+					puts
+				end
+				
+			end # class StopCommand
+			
+		end # module Command
+	end # module Timr
+end # module TheFox