Convert ui.inc.sh to an external library with pseudo namespace:

coloredUI.inc.sh
With unit tests.
closes #13

conf/phpunit-dist.xml

@@ -13,8 +13,8 @@
     strict="true"
     verbose="true"
     stopOnFailure="false"
-    timeoutForSmallTests="8"
-    timeoutForMediumTests="10"
+    timeoutForSmallTests="20"
+    timeoutForMediumTests="40"
     timeoutForLargeTests="60"
 >
     <testsuites>

inc/coloredUI.inc.sh

@@ -0,0 +1,136 @@
+#!/bin/bash
+
+##
+# Provide an easy way to display colored and decorated messages in Bash: title, question, error, warning, success...
+# Just include this script, define colors, bold colors and headers, then call CUI_displayMsg() method.
+#
+# Generic example:
+#     CUI_displayMsg type 'Message with <b>bold section</b>.'
+#      `==> '<type.header><type>message with <type.bold>bold section<type>.\033[0m'
+#
+# Concrete example:
+#	  . coloredUI.inc.sh
+#     CUI_COLORS=(
+#	      [error]='\033[1;31m'
+#	      [help]='\033[0;36m'
+#	      [help.bold]='\033[1;36m'
+#	      [help.header]='\033[1;36m(i) '
+#     )
+#     CUI_displayMsg error 'Invalid number!'
+#	   `==> '\033[1;31mInvalid number!\033[0m'
+#     CUI_displayMsg help 'This is a <b>valuable</b> information.'
+#	   `==> '\033[1;36m(i) \033[0;36mThis is a \033[1;36mvaluable\033[0;36m information.\033[0m'
+#
+# Requirements:
+#   - Bash v4 (2009) and above
+#
+# Color codes :
+#   - http://www.tux-planet.fr/les-codes-de-couleurs-en-bash/
+#   - http://confignewton.com/wp-content/uploads/2011/07/bash_color_codes.png
+#
+#
+#
+# Copyright (c) 2012 Geoffroy Aubry <gaubry@hi-media.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software distributed under the License is distributed
+# on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License
+# for the specific language governing permissions and limitations under the License.
+#
+# @copyright 2012 Geoffroy Aubry <gaubry@hi-media.com>
+# @license http://www.apache.org/licenses/LICENSE-2.0
+#
+
+
+
+##
+# Default colors
+# @var associative array
+#
+declare -A CUI_COLORS
+CUI_COLORS=(
+    [error]='\033[1;31m'
+    [error.bold]='\033[1;33m'
+    [error.header]='\033[1m\033[4;33m/!\\\033[0;37m '
+    [feature_subject]='\033[1;34m'
+    [help]='\033[0;36m'
+    [help.bold]='\033[1;36m'
+    [help.header]='\033[1;36m(i) '
+    [help_detail]='\033[0;37m'
+    [help_detail.bold]='\033[1;37m'
+    [help_detail.header]='    '
+    [info]='\033[1;37m'
+    [normal]='\033[0;37m'
+    [ok]='\033[0;32m'
+    [processing]='\033[1;30m'
+    [question]='\033[1;33m'
+    [question.bold]='\033[1;37m'
+    [warning]='\033[0;33m'
+    [warning.bold]='\033[1;33m'
+    [warning.header]='\033[1m\033[4;33m/!\\\033[0;37m '
+)
+
+##
+# Check if the specified key exists in $CUI_COLORS associative array.
+#
+# @param string $1 key to check
+# @return int 0 if key exists, else 1
+# @testedby TwgitCUITest
+#
+function CUI_isSet () {
+    local key="$1"
+    return $(echo " ${!CUI_COLORS[*]} " | tr '\n' ' ' | grep " $key " -q)
+}
+
+##
+# Display a message of the specified type, using ${CUI_COLORS[$type]}.
+# If ${CUI_COLORS[$type.color]} exists, then this will be used as prefix.
+# If ${CUI_COLORS[$type.bold]} exists, then this will be used to display text in '<b>...</b>' tags.
+# In any case <b> tags will be stripped.
+#
+# @param string $1 type of the message (error, title, ...)
+# @param string $2..$n message
+# @see $CUI_COLORS
+# @testedby TwgitCUITest
+#
+function CUI_displayMsg () {
+    local type=$1; shift
+    local msg="$*"
+    local bold_pattern_start bold_pattern_end header
+
+    # Color:
+    if ! CUI_isSet "$type"; then
+        echo "Unknown display type '$type'!" >&2
+        echo -n 'Available types: ' >&2
+        local types=$(echo "${!CUI_COLORS[*]}" | grep -vE "\.bold$" | grep -vE "\.header$" | sort)
+        local trimmed_types=$(echo $types)
+        echo "${trimmed_types// /, }." >&2
+        exit 1
+    fi
+
+    # Header:
+    if ! CUI_isSet "$type.header"; then
+        header=''
+    else
+        header="${CUI_COLORS[$type'.header']}"
+    fi
+
+    # Bold pattern:
+    if ! CUI_isSet "$type.bold"; then
+        bold_pattern_start=''
+        bold_pattern_end=''
+    else
+        bold_pattern_start="${CUI_COLORS[$type'.bold']}"
+        bold_pattern_end="${CUI_COLORS[$type]}"
+    fi
+
+    # Display:
+    echo -en "$header${CUI_COLORS[$type]}"
+    echo -en "$msg" | sed "s/<b>/$(echo -e $bold_pattern_start | sed -e 's/[\/&]/\\&/g')/g" \
+                    | sed "s/<\/b>/$(echo -e $bold_pattern_end | sed -e 's/[\/&]/\\&/g')/g"
+    echo -e '\033[0m'
+}