timr 0.3.0 → 0.4.0

data/bin/build_coverage.sh

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+
+# Build code coverage for https://timr.fox21.at/coverage/.
+
+SCRIPT_BASEDIR=$(dirname "$0")
+RUBYOPT=-w
+TZ=Europe/Vienna
+export COVERAGE=1
+
+
+set -e
+which bundler &> /dev/null || { echo 'ERROR: bundler not found in PATH'; exit 1; }
+
+cd "${SCRIPT_BASEDIR}/.."
+
+is_local=$1
+
+if [[ "$is_local" = -l ]]; then
+	echo 'use local SimpleCov PHPUnit Formatter'
+	SIMPLECOV_PHPUNIT_LOAD_PATH=../simplecov-phpunit
+fi
+
+bundler exec ./test/suite_all.rb

data/bin/build_info.sh

@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+
+# Build build.txt file for https://timr.fox21.at/build.txt.
+
+DATE=$(date +"%F %T %z")
+SCRIPT_BASEDIR=$(dirname "$0")
+
+
+which ruby &> /dev/null || { echo 'ERROR: ruby not found in PATH'; exit 1; }
+
+set -e
+cd "${SCRIPT_BASEDIR}/.."
+
+RUBY_VERSION=$(ruby -e "print RUBY_VERSION")
+TIMR_VERSION=$(ruby -I lib/timr -rversion -e "print %{#{TheFox::Timr::VERSION} (#{TheFox::Timr::DATE})}")
+
+printf "%s
+
+ruby: %s
+timr: %s
+
+--- build ---
+id: %s
+ref: %s@%s
+stage: %s
+server: %s %s
+" "${DATE}" "${RUBY_VERSION}" "${TIMR_VERSION}" "${CI_BUILD_ID}" "${CI_BUILD_REF}" "${CI_BUILD_REF_NAME}" "${CI_BUILD_STAGE}" "${CI_SERVER_NAME}" "${CI_SERVER_VERSION}"

data/bin/build_man.sh

@@ -0,0 +1,41 @@
+#!/usr/bin/env bash
+
+# Build manual pages.
+
+DATE=$(date +"%F")
+SCRIPT_BASEDIR=$(dirname "$0")
+
+
+set -e
+which cp &> /dev/null || { echo 'ERROR: cp not found in PATH'; exit 1; }
+which cat &> /dev/null || { echo 'ERROR: cat not found in PATH'; exit 1; }
+which ronn &> /dev/null || { echo 'ERROR: ronn not found in PATH'; exit 1; }
+
+cd "${SCRIPT_BASEDIR}/../man"
+
+for file in \
+	timr-continue.1.ronn \
+	timr-log.1.ronn \
+	timr-pause.1.ronn \
+	timr-pop.1.ronn \
+	timr-push.1.ronn \
+	timr-report.1.ronn \
+	timr-start.1.ronn \
+	timr-status.1.ronn \
+	timr-stop.1.ronn \
+	timr-task.1.ronn \
+	timr-track.1.ronn \
+	timr-ftime.7.ronn ; do
+	
+	echo "file: '$file'"
+	tmp_file="${file}.tmp"
+	cp "$file" "$tmp_file"
+	{
+		echo
+		cat _footer
+	} >> "$tmp_file"
+done
+
+ronn -w --date="$DATE" --manual='Timr Manual' --organization='FOX21.at' timr.1.ronn timr-*.ronn.tmp
+
+echo 'done'

data/bin/clean.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+# Clean up development files.
+
+SCRIPT_BASEDIR=$(dirname "$0")
+
+
+set -e
+which rm &> /dev/null || { echo 'ERROR: rm not found in PATH'; exit 1; }
+
+cd "${SCRIPT_BASEDIR}/.."
+
+rm -frd .bundle
+rm -f .setup Gemfile.lock

data/bin/dev_setup.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+# Development setup.
+
+SCRIPT_BASEDIR=$(dirname "$0")
+
+
+set -e
+which cp &> /dev/null || { echo 'ERROR: cp not found in PATH'; exit 1; }
+which bundler &> /dev/null || { echo 'ERROR: bundler not found in PATH'; exit 1; }
+
+cd "${SCRIPT_BASEDIR}/.."
+
+# Create .env file.
+if [[ ! -f .env ]]; then
+	cp .env.example .env
+fi
+
+bundler install

data/bin/install.sh

@@ -0,0 +1,49 @@
+#!/usr/bin/env bash
+
+# Install Gem local.
+
+SCRIPT_BASEDIR=$(dirname "$0")
+
+
+option=$1
+set -e
+which mkdir &> /dev/null || { echo 'ERROR: mkdir not found in PATH'; exit 1; }
+which mv &> /dev/null || { echo 'ERROR: mv not found in PATH'; exit 1; }
+which chmod &> /dev/null || { echo 'ERROR: chmod not found in PATH'; exit 1; }
+which gem &> /dev/null || { echo 'ERROR: gem not found in PATH'; exit 1; }
+which bundler &> /dev/null || { echo 'ERROR: bundler not found in PATH'; exit 1; }
+
+cd "${SCRIPT_BASEDIR}/.."
+
+# Load Environment Variables
+[[ -f .env ]] && source .env
+
+if [[ -z "${GEMSPEC_FILE}" ]] ; then
+	echo 'ERROR: one of the environment variables is missing'
+	
+	echo "GEMSPEC_FILE: '${GEMSPEC_FILE}'"
+	
+	exit 1
+fi
+
+gem_file=$(gem build "${GEMSPEC_FILE}" 2> /dev/null | grep 'File:' | tail -1 | awk '{ print $2 }')
+
+if [[ -z "$gem_file" ]] ; then
+	echo 'ERROR: gem_file variable not set'
+	exit 1
+fi
+
+echo "install gem file '$gem_file'"
+gem install "$gem_file"
+
+# Create tmp directory.
+if [[ ! -d tmp ]]; then
+	mkdir -p tmp
+	chmod u=rwx,go-rwx tmp
+fi
+
+if [[ "$option" = "-f" ]]; then
+	mv -v "$gem_file" tmp
+else
+	mv -v -i "$gem_file" tmp
+fi

data/bin/publish

@@ -0,0 +1,38 @@
+#!/usr/bin/env bash
+
+# Upload files to https://timr.fox21.at.
+
+SCRIPT_BASEDIR=$(dirname "$0")
+
+
+set -e
+cd "${SCRIPT_BASEDIR}/.."
+
+# Load Environment Variables
+[[ -f .env ]] && source .env
+
+if [[ -z "${CI_BUILD_REF_NAME}" ]] || [[ -z "${RSYNC_USER}" ]] || [[ -z "${RSYNC_HOST}" ]] || [[ -z "${RSYNC_REMOTE_PATH_MASTER}" ]] || [[ -z "${RSYNC_REMOTE_PATH_DEVELOP}" ]] || [[ -z "${RSYNC_OPTIONS}" ]] ; then
+	echo 'ERROR: one of the environment variables is missing'
+	
+	echo "CI_BUILD_REF_NAME: '${CI_BUILD_REF_NAME}'"
+	
+	echo "RSYNC_USER: '${RSYNC_USER}'"
+	echo "RSYNC_HOST: '${RSYNC_HOST}'"
+	echo "RSYNC_REMOTE_PATH_MASTER: '${RSYNC_REMOTE_PATH_MASTER}'"
+	echo "RSYNC_REMOTE_PATH_DEVELOP: '${RSYNC_REMOTE_PATH_DEVELOP}'"
+	echo "RSYNC_OPTIONS: '${RSYNC_OPTIONS}'"
+	
+	exit 1
+fi
+
+which rsync &> /dev/null || { echo 'ERROR: rsync not found in PATH'; exit 1; }
+
+remote_path=$RSYNC_REMOTE_PATH_DEVELOP
+if [[ "$CI_BUILD_REF_NAME" = "master" ]]; then
+	remote_path=$RSYNC_REMOTE_PATH_MASTER
+fi
+
+echo "rsync to '${RSYNC_USER}@${RSYNC_HOST}:${remote_path}'"
+rsync ${RSYNC_OPTIONS} build.txt coverage api "${RSYNC_USER}@${RSYNC_HOST}:${remote_path}"
+
+rsync ${RSYNC_OPTIONS} --include man --include='man/*.html' --exclude='*' man "${RSYNC_USER}@${RSYNC_HOST}:${remote_path}"

data/bin/release.sh

@@ -0,0 +1,35 @@
+#!/usr/bin/env bash
+
+# Release gem to https://rubygems.org.
+
+SCRIPT_BASEDIR=$(dirname "$0")
+
+
+set -e
+which mv &> /dev/null || { echo 'ERROR: mv not found in PATH'; exit 1; }
+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 "${GEMSPEC_FILE}" ]] ; then
+	echo 'ERROR: one of the environment variables is missing'
+	
+	echo "GEMSPEC_FILE: '${GEMSPEC_FILE}'"
+	
+	exit 1
+fi
+
+gem_file=$(gem build "${GEMSPEC_FILE}" 2> /dev/null | grep 'File:' | tail -1 | awk '{ print $2 }')
+
+echo "push gem file '$gem_file'"
+gem push "$gem_file"
+
+# Create tmp directory.
+if [[ ! -d tmp ]]; then
+	mkdir -p tmp
+	chmod u=rwx,go-rwx tmp
+fi
+mv -v -i "$gem_file" tmp

data/bin/test.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+# Run Unit Tests.
+
+SCRIPT_BASEDIR=$(dirname "$0")
+RUBYOPT=-w
+TZ=Europe/Vienna
+
+
+set -e
+which grep &> /dev/null || { echo 'ERROR: grep not found in PATH'; exit 1; }
+which bundler &> /dev/null || { echo 'ERROR: bundler not found in PATH'; exit 1; }
+
+cd "${SCRIPT_BASEDIR}/.."
+
+# What should 'taks' mean? Task?
+grep -r -i taks lib man test && { echo 'ERROR: Wrong word found'; exit 1; } || true
+
+bundler exec ./test/suite_all.rb

data/bin/timr

@@ -1,50 +1,30 @@
 #!/usr/bin/env ruby
 # coding: UTF-8
 
-require 'optparse'
 require 'timr'
 
+include TheFox::Timr::Command
+include TheFox::Timr::Error
 
-@options = {
-	:dir => nil,
-	:config_path => "#{Dir.home}/.timr/timr.conf",
-}
-opts = OptionParser.new do |o|
-	o.banner = 'Usage: timr [options]'
-	o.separator('')
-	
-	o.on('-d', '--dir <path>', 'Path to a timr directory.') do |path|
-		@options[:dir] = path
-	end
-	
-	o.on('-p', '--project <name>', 'Project Name: use ~/.timr/projects/NAME as path.') do |name|
-		@options[:dir] = File.expand_path(name, "#{Dir.home}/.timr/projects")
-	end
-	
-	o.on('-c', '--config <path>', 'Path to config file. Default: ~/.timr/timr.conf') do |path|
-		@options[:config_path] = File.expand_path(path)
-	end
-	
-	o.on_tail('-V', '--version', 'Show version.') do
-		puts "#{TheFox::Timr::NAME} #{TheFox::Timr::VERSION} (#{TheFox::Timr::DATE})"
-		puts "#{TheFox::Timr::HOMEPAGE}"
-		exit
-	end
-	
-	o.on_tail('-h', '--help', 'Show this message.') do
-		puts o
-		puts
-		exit 3
-	end
+if $DEBUG # @TODO deactivate this
+	START_TIME = Time.now.to_ms
+	puts "#{START_TIME} #{self.class} #{__method__} START"
+	# puts "__FILE__: #{__FILE__}"
+	# puts "$0: #{$0}"
+	puts '-------------------------------------------------------------------------'
 end
-ARGV << '-h' if ARGV.count == 0
-opts.parse(ARGV)
 
-timr = TheFox::Timr::Timr.new(@options[:dir], @options[:config_path])
 begin
-	timr.run
-rescue Exception => e
-	raise e
-ensure
-	timr.close
+	command = BasicCommand.create_command_from_argv(ARGV.clone)
+	command.run
+	command.shutdown
+rescue TimrError => e
+	puts "timr error: #{e}"
+end
+
+if $DEBUG # @TODO deactivate this
+	END_TIME = Time.now.to_ms
+	puts '-------------------------------------------------------------------------'
+	puts "#{END_TIME} #{self.class} #{__method__} END"
+	puts "TIMR RUNTIME: #{END_TIME - START_TIME} ms"
 end

data/bin/timr_bash_completion.sh

@@ -0,0 +1,337 @@
+
+# Source from this file running
+# 	source bin/timr_bash_completion.sh
+
+function _timr_command {
+	local curr_word=$1
+	local timr_commands=(
+		continue
+		help
+		log
+		pause
+		pop
+		push
+		report
+		start
+		status
+		stop
+		task
+		track
+	)
+	COMPREPLY=( $(compgen -W '${timr_commands[@]}' -- "${curr_word}") )
+}
+
+function _timr_continue_main {
+	local curr_word=$1
+	local timr_commands=(
+		--help
+		--date
+		--time
+	)
+	COMPREPLY=( $(compgen -W '${timr_commands[@]}' -- "${curr_word}") )
+}
+
+function _timr_log_main {
+	local curr_word=$1
+	local timr_commands=(
+		--help
+		
+		--from
+		--to
+		
+		--day
+		--month
+		--year
+		
+		--all
+		
+		--start-date --start-time
+		--end-date --end-time
+	)
+	COMPREPLY=( $(compgen -W '${timr_commands[@]}' -- "${curr_word}") )
+}
+
+function _timr_pause_main {
+	local curr_word=$1
+	local timr_commands=(
+		--help
+		--end-date --date
+		--end-time --time
+	)
+	COMPREPLY=( $(compgen -W '${timr_commands[@]}' -- "${curr_word}") )
+}
+
+function _timr_pop_main {
+	local curr_word=$1
+	local timr_commands=(
+		--help
+		
+		--start-date --start-time
+		--end-date --end-time
+		
+		--date
+		--time
+	)
+	COMPREPLY=( $(compgen -W '${timr_commands[@]}' -- "${curr_word}") )
+}
+
+function _timr_push_main {
+	local curr_word=$1
+	local timr_commands=(
+		--help
+		
+		--name
+		--description
+		--hourly-rate
+		--flat-rate
+		
+		--message
+		--edit
+		--date
+		--time
+	)
+	COMPREPLY=( $(compgen -W '${timr_commands[@]}' -- "${curr_word}") )
+}
+
+function _timr_report_main {
+	local curr_word=$1
+	local timr_commands=(
+		--help
+		--day
+		--month
+		--year
+		--all
+		--tasks
+		--tracks
+		--csv
+		--force
+	)
+	COMPREPLY=( $(compgen -W '${timr_commands[@]}' -- "${curr_word}") )
+}
+
+function _timr_start_main {
+	local curr_word=$1
+	local timr_commands=(
+		--help
+		
+		--id
+		--name
+		--description
+		--estimation
+		--hourly-rate
+		--flat-rate
+		
+		--message
+		--edit
+		--date
+		--time
+	)
+	COMPREPLY=( $(compgen -W '${timr_commands[@]}' -- "${curr_word}") )
+}
+
+function _timr_status_main {
+	local curr_word=$1
+	local timr_commands=(
+		--help
+		--verbose
+		--full
+		--reverse
+	)
+	COMPREPLY=( $(compgen -W '${timr_commands[@]}' -- "${curr_word}") )
+}
+
+function _timr_stop_main {
+	local curr_word=$1
+	local timr_commands=(
+		--help
+		
+		--start-date
+		--start-time
+		--end-date --date
+		--end-time --time
+		
+		--message
+		--edit
+	)
+	COMPREPLY=( $(compgen -W '${timr_commands[@]}' -- "${curr_word}") )
+}
+
+function _timr_task_main {
+	local curr_word=$1
+	local timr_commands=(
+		--help
+		
+		add
+		remove
+		set
+		show
+	)
+	COMPREPLY=( $(compgen -W '${timr_commands[@]}' -- "${curr_word}") )
+}
+
+function _timr_task_add {
+	local curr_word=$1
+	local timr_commands=(
+		--id
+		--name
+		--description
+		--estimation
+		--billed --unbilled
+		--hourly-rate --no-hourly-rate
+		--flat-rate --no-flat-rate
+	)
+	COMPREPLY=( $(compgen -W '${timr_commands[@]}' -- "${curr_word}") )
+}
+
+function _timr_task_remove {
+	local curr_word=$1
+	COMPREPLY=( $(compgen -A variable 'TIMR_' -- "${curr_word}") )
+}
+
+function _timr_task_set {
+	local curr_word=$1
+	local timr_commands=(
+		--id
+		--name
+		--description
+		--estimation
+		--billed --unbilled
+		--hourly-rate --no-hourly-rate
+		--flat-rate --no-flat-rate
+	)
+	COMPREPLY=( $(compgen -W '${timr_commands[@]}' -- "${curr_word}") )
+}
+
+function _timr_task_show {
+	local curr_word=$1
+	local timr_commands=(
+		--tracks
+	)
+	COMPREPLY=( $(compgen -W '${timr_commands[@]}' -- "${curr_word}") )
+}
+
+function _timr_track_main {
+	local curr_word=$1
+	local timr_commands=(
+		--help
+		
+		add
+		remove
+		set
+		show
+	)
+	COMPREPLY=( $(compgen -W '${timr_commands[@]}' -- "${curr_word}") )
+}
+
+function _timr_track_add {
+	local curr_word=$1
+	local timr_commands=(
+		--message
+		--start-date --start-time
+		--end-date --end-time
+		--billed --unbilled
+	)
+	COMPREPLY=( $(compgen -W '${timr_commands[@]}' -- "${curr_word}") )
+}
+
+function _timr_track_remove {
+	local curr_word=$1
+	COMPREPLY=( $(compgen -A variable 'TIMR_' -- "${curr_word}") )
+}
+
+function _timr_track_set {
+	local curr_word=$1
+	local timr_commands=(
+		--message
+		--start-date --start-time
+		--end-date --end-time
+		--billed --unbilled
+		--task
+	)
+	COMPREPLY=( $(compgen -W '${timr_commands[@]}' -- "${curr_word}") )
+}
+
+function _timr_track_show {
+	local curr_word=$1
+	COMPREPLY=( $(compgen -W '--task' -- "${curr_word}") )
+}
+
+function _timr_main {
+	local curr_word
+	# local prev_word
+	
+	curr_word="${COMP_WORDS[COMP_CWORD]}"
+	# prev_word="${COMP_WORDS[COMP_CWORD-1]}"
+	
+	unset -v 'COMP_WORDS[0]'
+	
+	COMPREPLY=()
+	
+	local timr_command timr_subcommand
+	
+	for word in "${COMP_WORDS[@]}"; do
+		case ${word} in
+			-*)
+				# Skip, next.
+				;;
+			*)
+				if [[ ! -z "$word" ]]; then
+					if [[ -z "$timr_command" ]]; then
+						timr_command=$word
+					else
+						timr_subcommand=$word
+						break
+					fi
+				fi
+				;;
+		esac
+	done
+	
+	if [[ -z "$timr_command" ]]; then
+		case ${curr_word} in
+			-*)
+				COMPREPLY=( $(compgen -W "-V --version -h --help -C" -- "${curr_word}") )
+				;;
+			*)
+				_timr_command "$curr_word"
+				;;
+		esac
+	else
+		if [[ "$curr_word" = "$timr_command" ]]; then
+			# To fit *) in the case below.
+			unset timr_command
+		fi
+		if [[ "$curr_word" = "$timr_subcommand" ]]; then
+			# To fit *) in the second level case below.
+			unset timr_subcommand
+		fi
+		
+		case "${timr_command}" in
+			continue|log|pause|pop|push|report|start|status|stop)
+				"_timr_${timr_command}_main" "$curr_word"
+				;;
+			task|track)
+				case "${timr_subcommand}" in
+					add|remove|set|show)
+						"_timr_${timr_command}_${timr_subcommand}" "$curr_word"
+						;;
+					*)
+						"_timr_${timr_command}_main" "$curr_word"
+						;;
+				esac
+				;;
+			help|*)
+				_timr_command "$curr_word"
+				;;
+		esac
+	fi
+	# echo
+}
+
+# Dev
+# complete -F _timr_main -o bashdefault timr_dev
+
+complete -F _timr_main -o bashdefault timr
+
+# To remove timr.
+# complete -r timr