timr 0.5.0 → 0.6.0

data/lib/timr/command/reset_command.rb

@@ -0,0 +1,75 @@
+
+require 'set'
+
+module TheFox
+	module Timr
+		module Command
+			
+			# Remove current running Track. Paused commands will not be deleted.
+			# 
+			# Man page: [timr-reset(1)](../../../../man/timr-reset.1.html)
+			class ResetCommand < BasicCommand
+				
+				include TheFox::Timr::Error
+				
+				# Path to man page.
+				MAN_PATH = 'man/timr-reset.1'
+				
+				def initialize(argv = Array.new)
+					super()
+					
+					@help_opt = false
+					@stack_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 '-s', '--stack'
+							@stack_opt = true
+						else
+							raise ResetCommandError, "Unknown argument '#{arg}'. See 'timr report --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 && track.running?
+						puts '--- RESET ---'
+						puts track.to_compact_str
+						puts
+					end
+					
+					@timr.reset({:stack => @stack_opt})
+					
+					puts @timr.stack
+				end
+				
+				private
+				
+				def help
+					puts 'usage: timr reset [-s|--stack]'
+					puts
+					puts 'Options'
+					puts '    -s, --stack    Clean the Stack.'
+					puts
+				end
+				
+			end # class TrackCommand
+			
+		end # module Command
+	end # module Timr
+end # module TheFox

data/lib/timr/duration.rb

@@ -45,7 +45,11 @@ module TheFox
 					:units => 2,
 				}
 				h = ChronicDuration.output(@seconds, dur_opt)
-				
+			end
+			
+			# Convert to_human to a String when nil.
+			def to_human_s
+				h = to_human
 				h ? h : '---'
 			end
 			

data/lib/timr/exception/timr_error.rb

@@ -22,6 +22,7 @@ module TheFox
 		# 		- PopCommandError
 		# 		- PushCommandError
 		# 		- ReportCommandError
+		# 		- ResetCommandError
 		# 		- StartCommandError
 		# 		- StatusCommandError
 		# 		- StopCommandError
@@ -82,6 +83,9 @@ module TheFox
 			class ReportCommandError < CommandError
 			end
 			
+			class ResetCommandError < CommandError
+			end
+			
 			class StartCommandError < CommandError
 			end
 			

data/lib/timr/model/stack.rb

@@ -82,6 +82,14 @@ module TheFox
 					changed
 				end
 				
+				# Remove all Tracks from Stack.
+				def reset
+					@tracks = Array.new
+					
+					# Mark Stack as changed.
+					changed
+				end
+				
 				# Check Track on Stack.
 				def on_stack?(track)
 					unless track.is_a?(Track)

data/lib/timr/model/task.rb

@@ -124,6 +124,15 @@ module TheFox
 					true
 				end
 				
+				def reset
+					if @current_track
+						@current_track = nil
+						
+						# Mark Task as changed.
+						changed
+					end
+				end
+				
 				# Select Track by Time Range and/or Status.
 				# 
 				# Options:
@@ -464,7 +473,7 @@ module TheFox
 				# Get estimation as String.
 				def estimation_s
 					if @estimation
-						@estimation.to_human
+						@estimation.to_human_s
 					else
 						'---'
 					end
@@ -630,9 +639,8 @@ module TheFox
 				# 
 				# Options:
 				# 
-				# - `:billed`
+				# - `:billed` (Boolean)
 				def duration(options = Hash.new)
-					
 					billed_opt = options.fetch(:billed, nil)
 					
 					duration = Duration.new
@@ -678,7 +686,7 @@ module TheFox
 				def remaining_time_s
 					rmt = remaining_time
 					if rmt
-						rmt.to_human
+						rmt.to_human_s
 					else
 						'---'
 					end
@@ -804,7 +812,7 @@ module TheFox
 						to_ax << 'Description: %s' % [self.description]
 					end
 					if self.estimation
-						to_ax << 'Estimation: %s' % [self.estimation.to_human]
+						to_ax << 'Estimation: %s' % [self.estimation.to_human_s]
 					end
 					to_ax
 				end
@@ -839,7 +847,7 @@ module TheFox
 					end
 					
 					# Duration
-					duration_human = self.duration.to_human
+					duration_human = self.duration.to_human_s
 					to_ax << 'Duration: %s' % [duration_human]
 					
 					duration_man_days = self.duration.to_man_days
@@ -937,18 +945,42 @@ module TheFox
 				
 				# Return formatted String.
 				# 
+				# Options:
+				# 
+				# - `:format`
+				# - `:prefix` - Default: `%`
+				# 
+				# Format:
+				# 
 				# - `%id` - ID
 				# - `%sid` - Short ID
 				# - `%fid` - Foreign ID
 				# - `%n` - Name
 				# - `%d` - Description
-				def formatted(format, prefix = '%')
-					format
+				# - `%ds` - Duration Seconds
+				# - `%dh` - Duration Human Format
+				def formatted(options = Hash.new)
+					format = options.fetch(:format, '')
+					prefix = options.fetch(:prefix, '%')
+					
+					formatted_s = format
 						.gsub("#{prefix}id", self.id)
 						.gsub("#{prefix}sid", self.short_id ? self.short_id : '')
 						.gsub("#{prefix}fid", self.foreign_id ? self.foreign_id : '')
 						.gsub("#{prefix}n", self.name ? self.name : '')
-						.gsub("#{prefix}d", self.description ? self.description : '')
+						.gsub("#{prefix}ds", self.duration(options).to_s)
+					
+					duration_human = self.duration(options).to_human
+					if duration_human
+						formatted_s.gsub!('%dh', duration_human)
+					else
+						formatted_s.gsub!('%dh', '')
+					end
+					
+					# Must not before %dh and %ds.
+					formatted_s.gsub!("#{prefix}d", self.description ? self.description : '')
+					
+					formatted_s
 				end
 				
 				def inspect

data/lib/timr/model/track.rb

@@ -223,9 +223,17 @@ module TheFox
 				# 
 				# - `:from` (Time), `:to` (Time)  
 				#   Limit the begin and end datetimes to a specific range.
+				# - `:billed` (Boolean)
 				def duration(options = Hash.new)
 					from_opt = options.fetch(:from, nil)
 					to_opt = options.fetch(:to, nil)
+					billed_opt = options.fetch(:billed, nil)
+					
+					unless billed_opt.nil?
+						if @is_billed != billed_opt
+							return Duration.new(0)
+						end
+					end
 					
 					if @begin_datetime
 						bdt = @begin_datetime.utc
@@ -258,20 +266,12 @@ module TheFox
 				
 				# Alias method.
 				def billed_duration(options = Hash.new)
-					if self.is_billed
-						duration(options)
-					else
-						Duration.new(0)
-					end
+					duration(options.merge({:billed => true}))
 				end
 				
 				# Alias method.
 				def unbilled_duration(options = Hash.new)
-					if !self.is_billed
-						duration(options)
-					else
-						Duration.new(0)
-					end
+					duration(options.merge({:billed => false}))
 				end
 				
 				# When begin_datetime is `2017-01-01 01:15`  
@@ -312,6 +312,11 @@ module TheFox
 					Status.new(short_status)
 				end
 				
+				# Is the Track running?
+				def running?
+					status.short_status == 'R' # running
+				end
+				
 				# Is the Track stopped?
 				def stopped?
 					status.short_status == 'S' # stopped
@@ -434,7 +439,7 @@ module TheFox
 					end
 					
 					if self.duration && self.duration.to_i > 0
-						to_ax << 'Duration: %s' % [self.duration.to_human]
+						to_ax << 'Duration: %s' % [self.duration.to_human_s]
 					end
 					
 					to_ax << 'Status: %s' % [self.status.colorized]
@@ -479,7 +484,7 @@ module TheFox
 					end
 					
 					if self.duration && self.duration.to_i > 0
-						duration_human = self.duration.to_human
+						duration_human = self.duration.to_human_s
 						to_ax << 'Duration: %s' % [duration_human]
 						
 						duration_man_days = self.duration.to_man_days
@@ -511,6 +516,12 @@ module TheFox
 				
 				# Return formatted String.
 				# 
+				# Options:
+				# 
+				# - `:format`
+				# 
+				# Format:
+				# 
 				# - `%id` - ID
 				# - `%sid` - Short ID
 				# - `%t` - Title generated from message.
@@ -521,7 +532,13 @@ module TheFox
 				# - `%edt` - End DateTime
 				# - `%ed` - End Date
 				# - `%et` - End Time
-				def formatted(format)
+				# - `%ds` - Duration Seconds
+				# - `%dh` - Duration Human Format
+				# - `%bi` - Billed Integer
+				# - `%bh` - Billed Human Format (YES, NO)
+				def formatted(options = Hash.new)
+					format = options.fetch(:format, '')
+					
 					formatted_s = format
 						.gsub('%id', self.id)
 						.gsub('%sid', self.short_id)
@@ -533,14 +550,29 @@ module TheFox
 						.gsub('%edt', self.end_datetime ? self.end_datetime.strftime('%F %H:%M') : '')
 						.gsub('%ed', self.end_datetime ? self.end_datetime.strftime('%F') : '')
 						.gsub('%et', self.end_datetime ? self.end_datetime.strftime('%H:%M') : '')
+						.gsub('%ds', self.duration.to_s)
+						.gsub('%bi', self.is_billed.to_i.to_s)
+						.gsub('%bh', self.is_billed ? 'YES' : 'NO')
+					
+					duration_human = self.duration.to_human
+					if duration_human
+						formatted_s.gsub!('%dh', self.duration.to_human)
+					else
+						formatted_s.gsub!('%dh', '')
+					end
+					
+					task_formating_options = {
+						:format => formatted_s,
+						:prefix => '%T',
+					}
 					
 					if @task
-						formatted_s = @task.formatted(formatted_s, '%T')
+						formatted_s = @task.formatted(task_formating_options)
 					else
 						tmp_task = Task.new
 						tmp_task.id = ''
 						
-						formatted_s = tmp_task.formatted(formatted_s, '%T')
+						formatted_s = tmp_task.formatted(task_formating_options)
 					end
 					
 					formatted_s

data/lib/timr/timr.rb

@@ -157,7 +157,7 @@ module TheFox
 						# Task Path
 						task_file_path = BasicModel.create_path_by_id(@tasks_path, task.id)
 						
-						# Save Track to file.
+						# Save Task to file.
 						task.save_to_file(task_file_path)
 						
 						@stack.start(track)
@@ -341,7 +341,7 @@ module TheFox
 						# Task Path
 						task_file_path = BasicModel.create_path_by_id(@tasks_path, task.id)
 						
-						# Save Track to file.
+						# Save Task to file.
 						task.save_to_file(task_file_path)
 						
 						@stack.push(track)
@@ -359,6 +359,48 @@ module TheFox
 				continue(options)
 			end
 			
+			# Remove current running Track.
+			# 
+			# Options:
+			# 
+			# - `:stack` (Boolean) Reset the Stack.
+			def reset(options = Hash.new)
+				stack_opt = options.fetch(:stack, false)
+				
+				track = @stack.current_track
+				if track && track.running?
+					task = track.task
+					if task
+						task.reset
+					end
+					
+					track.remove
+					
+					# Save Task to file.
+					task.save_to_file
+					
+					@stack.remove(track)
+				end
+				
+				if stack_opt
+					@stack.tracks.each do |track|
+						task = track.task
+						if task
+							task.reset
+							
+							# Save Task to file.
+							task.save_to_file
+						end
+					end
+					
+					@stack.reset
+				end
+				
+				@stack.save_to_file
+				
+				nil
+			end
+			
 			# Create a new [Task](rdoc-ref:TheFox::Timr::Model::Task) based on the `options` Hash. Will not be started or something else.
 			# 
 			# Uses [Task#create_task_from_hash](rdoc-ref:TheFox::Timr::Model::Task::create_task_from_hash) to create a new Task instance and [BasicModel#create_path_by_id](rdoc-ref:TheFox::Timr::Model::BasicModel.create_path_by_id) to create a new file path.
@@ -383,7 +425,7 @@ module TheFox
 				# Task Path
 				task_file_path = BasicModel.create_path_by_id(@tasks_path, task.id)
 				
-				# Save Track to file.
+				# Save Task to file.
 				task.save_to_file(task_file_path)
 				
 				# Leave Stack untouched.

data/lib/timr/version.rb

@@ -2,8 +2,8 @@
 module TheFox
 	module Timr
 		NAME = 'Timr'
-		VERSION = '0.5.0'
-		DATE = '2017-04-16'
+		VERSION = '0.6.0'
+		DATE = '2017-04-17'
 		HOMEPAGE = 'https://github.com/TheFox/timr'
 		
 		MODEL_DATETIME_FORMAT = '%FT%T%z'

data/man/index.txt

@@ -6,6 +6,7 @@ timr-pause(1) timr-pause.1.ronn
 timr-pop(1) timr-pop.1.ronn
 timr-push(1) timr-push.1.ronn
 timr-report(1) timr-report.1.ronn
+timr-reset(1) timr-reset.1.ronn
 timr-start(1) timr-start.1.ronn
 timr-status(1) timr-status.1.ronn
 timr-stop(1) timr-stop.1.ronn