timr 0.3.0 → 0.4.0

data/bin/uninstall.sh

@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+
+# Uninstall gem.
+
+SCRIPT_BASEDIR=$(dirname "$0")
+
+
+set -e
+which gem &> /dev/null || { echo 'ERROR: gem not found in PATH'; exit 1; }
+
+cd "${SCRIPT_BASEDIR}/.."
+
+# Load Environment Variables
+[[ -f .env ]] && source .env
+
+if [[ -z "${GEM_NAME}" ]] ; then
+	echo 'ERROR: one of the environment variables is missing'
+	
+	echo "GEM_NAME: '${GEM_NAME}'"
+	
+	exit 1
+fi
+
+gem uninstall "${GEM_NAME}" --all --executables

data/lib/timr.rb

@@ -1,11 +1,39 @@
 
 require 'timr/version'
+#require 'timr/simple_opt_parser'
+
+require 'timr/ext/time'
+
+require 'timr/exception/timr_error'
+
+require 'timr/helper/datetime_helper'
+require 'timr/helper/translation_helper'
+require 'timr/helper/terminal_helper'
+
+require 'timr/model/basic_model'
+require 'timr/model/track'
+require 'timr/model/task'
+require 'timr/model/stack'
+require 'timr/model/config'
+require 'timr/model/foreign_id_db'
+require 'timr/duration'
+require 'timr/status'
+require 'timr/table'
+require 'timr/progressbar'
+
+require 'timr/command/basic_command'
+require 'timr/command/continue_command'
+require 'timr/command/help_command'
+require 'timr/command/log_command'
+require 'timr/command/pause_command'
+require 'timr/command/pop_command'
+require 'timr/command/push_command'
+require 'timr/command/report_command'
+require 'timr/command/start_command'
+require 'timr/command/status_command'
+require 'timr/command/stop_command'
+require 'timr/command/task_command'
+require 'timr/command/track_command'
+require 'timr/command/version_command'
+
 require 'timr/timr'
-require 'timr/stack'
-require 'timr/task'
-require 'timr/track'
-require 'timr/window'
-require 'timr/window_help'
-require 'timr/window_tasks'
-require 'timr/window_timeline'
-require 'timr/window_test'

data/lib/timr/command/basic_command.rb

@@ -0,0 +1,170 @@
+
+require 'pathname'
+
+module TheFox
+	module Timr
+		module Command
+			
+			# Basic Class
+			class BasicCommand
+				
+				include TheFox::Timr::Helper
+				include TheFox::Timr::Error
+				
+				# Current Working Directory
+				attr_accessor :cwd
+				
+				def initialize(argv = Array.new)
+					@cwd = nil
+					@timr = nil
+				end
+				
+				# This is the actual execution of the Command.
+				def run
+					raise NotImplementedError
+				end
+				
+				# Should be executed after `run` to gently save everything.
+				def shutdown
+					if @timr
+						@timr.shutdown
+					end
+				end
+				
+				# All methods in this block are static.
+				class << self
+					
+					include TheFox::Timr::Error
+					
+					# Creates a new Command instance for each command string.
+					# 
+					# For example, it returns a new StopCommand instance when `stop` String is provided by `argv` Array.
+					# 
+					# Primary used by `bin/timr`.
+					def create_command_from_argv(argv)
+						# -C <path>
+						cwd_opt = Pathname.new("#{Dir.home}/.timr/defaultc").expand_path # Default Client
+						
+						command_name = nil
+						command_argv = Array.new
+						loop_c = 0
+						while loop_c < 1024 && argv.length > 0
+							loop_c += 1
+							arg = argv.shift
+							
+							if command_name
+								command_argv << arg
+							else
+								case arg
+								when '-h', '--help', 'help'
+									command_name = 'help'
+								when '-V', '--version'
+									command_name = 'version'
+								when '-C'
+									cwd_opt = Pathname.new(argv.shift).expand_path
+								when '--install-basepath'
+									timr_gem = Gem::Specification.find_by_name('timr')
+									print timr_gem.gem_dir
+									exit
+								else
+									if arg[0] == '-'
+										raise CommandError, "Unknown argument '#{arg}'. See 'timr --help'."
+									else
+										command_name = arg
+									end
+								end
+							end
+						end
+						
+						command_class = get_command_class_by_name(command_name)
+						command = command_class.new(command_argv)
+						command.cwd = cwd_opt
+						command
+					end
+					
+					# Get the Class for each command string.
+					def get_command_class_by_name(name)
+						case name
+						when 'help', '', nil
+							command = HelpCommand
+						when 'version'
+							command = VersionCommand
+						
+						when 'status', 's'
+							command = StatusCommand
+						when 'start'
+							command = StartCommand
+						when 'stop'
+							command = StopCommand
+						when 'push'
+							command = PushCommand
+						when 'pop'
+							command = PopCommand
+						when 'continue', 'cont', 'c'
+							command = ContinueCommand
+						when 'pause', 'p'
+							command = PauseCommand
+						when 'log'
+							command = LogCommand
+						when 'task'
+							command = TaskCommand
+						when 'track'
+							command = TrackCommand
+						when 'report'
+							command = ReportCommand
+						else
+							raise CommandError, "'%s' is not a timr command. See 'timr --help'." % [name]
+						end
+					end
+					
+				end
+				
+				private
+				
+				# Uses
+				#   @timr
+				#   @edit_opt
+				#   @task_id_opt
+				#   @track_id_opt
+				def run_edit(task_id = nil, track_id = nil)
+					task_id ||= @task_id_opt
+					track_id ||= @track_id_opt
+					
+					if @timr && @edit_opt
+						edit_text = Array.new
+						
+						if @message_opt
+							edit_text << @message_opt.clone
+						else
+							track = @timr.get_track_by_task_id(task_id, track_id)
+							
+							if track && track.message
+								edit_text << track.message.clone
+							else
+								edit_text << @message_opt.clone
+							end
+						end
+						
+						TerminalHelper.external_editor_help(edit_text)
+						
+						editor_message = TerminalHelper.run_external_editor(edit_text)
+						
+						if editor_message.length > 0
+							@message_opt = editor_message
+						end
+					end
+				end
+				
+				def check_foreign_id(foreign_id)
+					if foreign_id && foreign_id.match(/ /)
+						foreign_id_without_spaces = foreign_id.gsub(' ', '')
+						
+						raise ForeignIdError, "Foreign ID (--id) cannot include spaces. Maybe you want to use '#{foreign_id_without_spaces}' instead."
+					end
+				end
+				
+			end # class Command
+			
+		end # module Command
+	end # module Timr
+end # module TheFox

data/lib/timr/command/continue_command.rb

@@ -0,0 +1,86 @@
+
+module TheFox
+	module Timr
+		module Command
+			
+			# Continue the previous paused [Track](rdoc-ref:TheFox::Timr::Model::Track).
+			# 
+			# Man page: [timr-continue(1)](../../../../man/timr-continue.1.html)
+			class ContinueCommand < BasicCommand
+				
+				include TheFox::Timr::Helper
+				include TheFox::Timr::Error
+				
+				# Path to man page.
+				MAN_PATH = 'man/timr-continue.1'
+				
+				def initialize(argv = Array.new)
+					super()
+					
+					@help_opt = false
+					
+					@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 '-d', '--date'
+							@date_opt = argv.shift
+						when '-t', '--time'
+							@time_opt = argv.shift
+						else
+							raise ContinueCommandError, "Unknown argument '#{arg}'. See 'timr continue --help'."
+						end
+					end
+				end
+				
+				# See BasicCommand#run.
+				def run
+					if @help_opt
+						help
+						return
+					end
+					
+					@timr = Timr.new(@cwd)
+					
+					options = {
+						:date => @date_opt,
+						:time => @time_opt,
+					}
+					
+					track = @timr.continue(options)
+					unless track
+						puts 'No running Track to continue.'
+						return
+					end
+					
+					puts '--- CONTINUED ---'
+					puts track.to_compact_str
+					puts @timr.stack
+				end
+				
+				private
+				
+				def help
+					puts 'usage: timr continue [-d|--date <date>] [-t|--time <time>]'
+					puts '   or: timr continue [-h|--help]'
+					puts
+					puts 'Track Options'
+					puts '    -d, --date <date>    Track Start Date'
+					puts '    -t, --time <time>    Track Start Time'
+					puts
+					HelpCommand.print_datetime_help
+					puts
+				end
+				
+			end # class ContinueCommand
+			
+		end # module Command
+	end # module Timr
+end # module TheFox

data/lib/timr/command/help_command.rb

@@ -0,0 +1,137 @@
+
+module TheFox
+	module Timr
+		module Command
+			
+			# Print the overview help page.
+			class HelpCommand < BasicCommand
+				
+				def initialize(argv = Array.new)
+					# puts "help #{argv}"
+					
+					super()
+					
+					@command_opt = nil
+					
+					loop_c = 0 # Limit the loop.
+					while loop_c < 1024 && argv.length > 0
+						loop_c += 1
+						
+						unless @command_opt
+							@command_opt = argv.shift
+						end
+					end
+				end
+				
+				# See BasicCommand#run.
+				def run
+					if @command_opt
+						command_class = BasicCommand.get_command_class_by_name(@command_opt)
+						
+						if defined?(command_class::MAN_PATH)
+							system("man #{command_class::MAN_PATH}")
+						else
+							raise HelpCommandError, "No manual page found for '#{@command_opt}'. See 'timr --help'."
+						end
+					else
+						help
+					end
+				end
+				
+				# All methods in this block are static.
+				class << self
+					
+					# Alias
+					def print_id_help
+						print_task_id_help
+						puts
+						print_track_id_help
+					end
+					
+					# Print help about Task ID.
+					def print_task_id_help
+						puts '    <task_id>     Task ID (SHA1 hex)'
+						puts '                  If not specified a new Task will be created.'
+					end
+					
+					# Print help about Track ID.
+					def print_track_id_help
+						puts '    <track_id>    Track ID (SHA1 hex)'
+						puts '                  If specified a new Track with the same'
+						puts '                  message will be created.'
+					end
+					
+					# Print DateTime help.
+					def print_datetime_help
+						puts 'DateTime Formats'
+						puts "    <date_time>    A DateTime is one single string"
+						puts "                   representing '<date> <time>'."
+						puts '    <date>         Formats: YYYYMMDD, YYYY-MM-DD, MM/DD/YYYY, DD.MM.YYYY'
+						puts '    <time>         Formats: HH:MM, HH:MM:SS'
+					end
+					
+					# Print Estimation help.
+					def print_estimation_help(ext = false)
+						puts 'Duration'
+						puts '    Duration is parsed by chronic_duration.'
+						puts '    Examples:'
+						puts "        -e 2:10:5         # Sets Estimation to 2h 10m 5s."
+						puts "        -e '2h 10m 5s'    # Sets Estimation to 2h 10m 5s."
+						puts
+						if ext
+							puts "    Use '+' or '-' to calculate with Estimation Times:"
+							puts "        -e '-45m'         # Subtracts 45 minutes from the original Estimation."
+							puts "        -e '+1h 30m'      # Adds 1 hour 30 minutes to the original Estimation."
+							puts
+						end
+						puts '    See chronic_duration for more examples.'
+						puts '    https://github.com/henrypoydar/chronic_duration'
+					end
+					
+					# Print Man Units help.
+					def print_man_units_help
+						puts 'Man Units'
+						puts '    8 hours are 1 man-day.'
+						puts '    5 man-days are 1 man-week, and so on.'
+					end
+					
+				end
+				
+				private
+				
+				def help
+					puts 'usage: timr [-V|--version] [-h|--help] [-C <path>] <command> [<args>]'
+					puts
+					puts '    -V, --version    Show version.'
+					puts '    -h, --help       Show help.'
+					puts '    -C <path>        Set path to the project base directory.'
+					puts '                     Default: ~/.timr/defaultc'
+					puts
+					puts 'Commands'
+					puts '    start            Start working on a Task.'
+					puts '    stop             Stop the current running Task/Track.'
+					puts
+					puts '    pause            Pause the Top Track of the Stack.'
+					puts '    continue         Continue the Top Track of the Stack.'
+					puts
+					puts '    push             Push a new Track on the Stack and pause the old one.'
+					puts '    pop              Pop the Top Track and continue the old one.'
+					puts
+					puts '    status           Show the current Stack.'
+					puts '    log              Show recent Tracks.'
+					puts
+					puts "    task             Task related commands. See 'timr task --help'."
+					puts "    track            Track related commands. See 'timr track --help'."
+					puts
+					puts '    report           Generate a report.'
+					puts
+					puts "See 'timr <command> --help' to read details about a specific command,"
+					puts " or 'timr help <command>' to open the man page for this command."
+					puts "Also see 'man' directory for available man pages."
+				end
+				
+			end # class HelpCommand
+			
+		end # module Command
+	end # module Timr
+end # module TheFox