Merge branch 'develop'

Author: constup

README.adoc

@@ -25,7 +25,7 @@ Supports multiple programming languages and frameworks.
 
 == Key features
 
-* Written in POSIX compliant Bash. Available on Linux, Windows and MacOS
+* Written in Bash. Available on Linux, Windows and MacOS
 * Create a new project, whether it's a full application or a library
 * Set up a project using locally installed tools (languages, package managers,...) or containers (Docker)
 * Containerized projects with zero dependencies on your locally installed tech stack
@@ -73,7 +73,7 @@ Configure ProjectInit.sh by running:
 
 [source,shell]
 ----
-sh configure.sh
+bash configure.sh
 ----
 
 == How to use
@@ -83,7 +83,7 @@ Go to ProjectInit's `bin` directory and simply run it:
 [source,shell]
 ----
 cd bin
-sh projectinit.sh
+bash projectinit.sh
 ----
 
 == Supported project types (applications and libraries)

bin/projectinit.sh

@@ -1,12 +1,14 @@
 #!/bin/bash
 
-set -e
+set -Eeuo pipefail
+trap 'echo "Error in $0 at line $LINENO: command \"$BASH_COMMAND\" exited with status $?"' ERR
+
 source ../src/git/git.sh
 source ../src/filesystem/directory_management.sh
-source ../src/info_print.sh
+source ../src/projectinit_subsystem/info_print/info_print.sh
 source ../src/language/flow.sh
 source ../src/language/ask_flow.sh
-source ../src/tools/documentation/documentation.sh
+source ../src/projectinit_subsystem/documentation/documentation.sh
 source ../src/projectinit_subsystem/projectinit_cli/projectinit_cli.sh
 
 cat << "EOF"

doc/dev/globals.adoc

@@ -4,7 +4,6 @@
 
 == ProjectInit
 
-
 |===
 |variable |type |description
 
@@ -24,17 +23,31 @@
 |string value
 |Project name. Used throughout the project configuration for various purposes (example: Docker Compose service names)
 
-|`projectinit_tools_count`
-|integer
-|The number of additional tools configured for the project (example: memcached, redis,...)
-
 |`projectinit_generate_id_card_text`
 |0/1 flag
 |Flag to determine whether to generate the text version of the Project ID card (`projectinit_id_card.txt`) in project's
 root directory.
 
 |===
 
+=== ProjectInit Integrations subsystem
+
+|===
+|variable |type |description
+
+|`projectinit_tools_list`
+|array (strings)
+|List of tools to be integrated into the project. Example: `memcached`
+
+|`projectinit_main_app_dependencies_list`
+|array (strings)
+|List of main application dependencies (service names). Example: `sample_project_memcached`
+
+|`projectinit_libraries_list`
+|array (strings)
+|List of libraries to be integrated into the project. Example: `phpunit`
+|===
+
 == Git
 
 |===
@@ -72,10 +85,6 @@ root directory.
 |===
 |variable |type |description
 
-|`projectinit_docker_service_dependencies`
-|integer
-|The number of dependency services for your app service. If it's 0, dependencies block is removed from `compose.yaml`
-
 |`projectinit_language_version`
 |string
 |Version of the base language or technology (PHP, Node,...)
@@ -153,7 +162,7 @@ contains your application
 
 |`projectinit_composer_library_name`
 |string value
-|Composer library name. Format: `<your_brand>/<your_livrary_name>`
+|Composer library name. Format: `<your_brand>/<your_livrary_name>`. Used when creating a new Composer library project.
 
 |===
 ==== Symfony
@@ -246,14 +255,6 @@ contains your application
 |===
 |variable |type |description
 
-|`projectinit_use_memcached`
-|0/1 flag
-|Whether Memcached is used in the project or not.
-
-|`projectinit_memcached_service_name`
-|string value
-|Autogenerated from `projectinit_project_name` by adding `_memcached` suffix. Memcached service name in Docker compose
-
 |`projectinit_memcached_version`
 |string value
 |Memcached Docker image version

src/container/docker/dev.sh

@@ -3,7 +3,7 @@
 build_dev() {
   echo ""
   echo "Performing configuration cleanup..."
-  cleanup_before_build
+  cleanup_dev_docker_compose
   echo "Configuration ready..."
   if [ "${projectinit_build_containers}" -eq 1 ]; then
     echo ""
@@ -14,7 +14,7 @@ build_dev() {
   fi
 }
 
-cleanup_before_build() {
+cleanup_dev_docker_compose() {
   if [ "${projectinit_compose_has_root_volumes}" = 1 ]; then
     perl -pi -e "s/~~~root volumes~~~/volumes:/g" "${project_root_dir}/compose.yaml"
   else

src/container/docker/docker.sh

@@ -15,12 +15,26 @@ ask_base_service_properties() {
   read -r -e projectinit_app_host_port
 }
 
-calculate_app_service_dependencies() {
-  projectinit_docker_service_dependencies=0
-  if [ ! "${projectinit_database_type}" = "no database" ]; then
-    projectinit_docker_service_dependencies=$((projectinit_docker_service_dependencies + 1))
+cleanup_docker_compose() {
+  local target_file="$1"
+
+  if [ "${projectinit_compose_has_secrets}" -eq 1 ]; then
+    perl -pi -e "s/~~~secrets~~~/secrets:/g" "${target_file}"
+  else
+    perl -i -ne 'print unless /~~~secrets~~~/;' "${target_file}"
   fi
-  if [ "${projectinit_use_memcached}" -eq 1 ]; then
-    projectinit_docker_service_dependencies=$((projectinit_docker_service_dependencies + 1))
+
+  if [[ ! -v projectinit_main_app_dependencies_list ]]; then
+    perl -i -ne 'print unless /~~~main application dependencies~~~/;' "${target_file}"
+  else
+    perl -pi -e "s/~~~main application dependencies~~~/depends_on:/g"  "${target_file}"
   fi
+
+  if [ "${projectinit_compose_has_root_volumes}" = 1 ]; then
+    perl -pi -e "s/~~~root volumes~~~/volumes:/g" "${target_file}"
+  else
+    perl -i -ne 'print unless /~~~root volumes~~~/;' "${target_file}"
+  fi
+
+  perl -i -ne 'print unless /~~~container services~~~/;' "${target_file}"
 }

src/database/ask_database.sh

@@ -3,7 +3,7 @@
 ask_database_engine() {
   echo ""
   echo "Database engine:"
-  local options=("no database" "PostgreSQL" "MySQL" "Percona" "MariaDB")
+  local options=("no database" "PostgreSQL" "MySQL" "Percona" "MariaDB" "MongoDB")
   local option
   select option in "${options[@]}"; do
     case $option in
@@ -12,28 +12,39 @@ ask_database_engine() {
         break;;
       "PostgreSQL" )
         projectinit_database_type="pgsql"
+        projectinit_main_app_dependencies_list+=( "${projectinit_project_name}_database" )
         # shellcheck source=./pgsql/ask_pgsql.sh
         source "${tool_dir}/src/database/pgsql/ask_pgsql.sh"
         ask_pgsql_config
         break;;
       "MySQL" )
         projectinit_database_type="mysql"
+        projectinit_main_app_dependencies_list+=( "${projectinit_project_name}_database" )
         # shellcheck source=./mysql/ask_mysql.sh
         source "${tool_dir}/src/database/mysql/ask_mysql.sh"
         ask_mysql_config
         break;;
       "Percona" )
         projectinit_database_type="percona"
+        projectinit_main_app_dependencies_list+=( "${projectinit_project_name}_database" )
         # shellcheck source=./percona/ask_percona.sh
         source "${tool_dir}/src/database/percona/ask_percona.sh"
         ask_percona_config
         break;;
       "MariaDB" )
         projectinit_database_type="mariadb"
+        projectinit_main_app_dependencies_list+=( "${projectinit_project_name}_database" )
         # shellcheck source=./mariadb/ask_mariadb.sh
         source "${tool_dir}/src/database/mariadb/ask_mariadb.sh"
         ask_mariadb_config
         break;;
+      "MongoDB" )
+        projectinit_database_type="mongodb"
+        projectinit_main_app_dependencies_list+=( "${projectinit_project_name}_database" )
+        # shellcheck source=./mongodb/ask_mongodb.sh
+        source "${tool_dir}/src/database/mongodb/ask_mongodb.sh"
+        ask_mongodb_config
+        break;;
     esac
   done
 }

src/database/database_flow.sh

@@ -8,15 +8,16 @@ setup_database_docker_compose_dev() {
       ;;
     "pgsql" )
       projectinit_compose_has_root_volumes=1
-      # shellcheck source=pgsql/container/docker/v1/pqsql.sh
+      projectinit_compose_has_secrets=1
+      # shellcheck source=./pgsql/container/docker/v1/pqsql.sh
       source "${tool_dir}/src/database/pgsql/container/docker/v1/pqsql.sh"
       setup_pgsql_docker_compose_dev
       setup_pgsql_dev_dockerfile
       ;;
     "mysql" )
       projectinit_compose_has_root_volumes=1
       projectinit_compose_has_secrets=1
-      # shellcheck source=mysql/container/docker/v1/mysql.sh
+      # shellcheck source=./mysql/container/docker/v1/mysql.sh
       source "${tool_dir}/src/database/mysql/container/docker/v1/mysql.sh"
       setup_mysql_docker_compose_dev
       setup_mysql_my_cnf_dev
@@ -26,7 +27,7 @@ setup_database_docker_compose_dev() {
     "percona" )
       projectinit_compose_has_root_volumes=1
       projectinit_compose_has_secrets=1
-      # shellcheck source=percona/container/docker/v1/percona.sh
+      # shellcheck source=./percona/container/docker/v1/percona.sh
       source "${tool_dir}/src/database/percona/container/docker/v1/percona.sh"
       setup_percona_docker_compose_dev
       setup_percona_my_cnf_dev
@@ -36,13 +37,22 @@ setup_database_docker_compose_dev() {
     "mariadb" )
       projectinit_compose_has_root_volumes=1
       projectinit_compose_has_secrets=1
-      # shellcheck source=mariadb/container/docker/v1/mariadb.sh
+      # shellcheck source=./mariadb/container/docker/v1/mariadb.sh
       source "${tool_dir}/src/database/mariadb/container/docker/v1/mariadb.sh"
       setup_mariadb_docker_compose_dev
       setup_mariadb_my_cnf_dev
       setup_mariadb_dev_entrypoint
       setup_mariadb_dev_dockerfile
       ;;
+    "mongodb" )
+      projectinit_compose_has_root_volumes=1
+      projectinit_compose_has_secrets=1
+      # shellcheck source=./mongodb/container/docker/v1/mongodb.sh
+      source "${tool_dir}/src/database/mongodb/container/docker/v1/mongodb.sh"
+      setup_mongodb_docker_compose_dev
+      setup_mongodb_config_dev
+      setup_mongodb_dev_entrypoint
+      setup_mongodb_dev_dockerfile
   esac
 
   if [ ! "${projectinit_database_type}" = "no database" ]; then
@@ -57,42 +67,60 @@ setup_database_docker_compose_prod() {
       perl -i -ne 'print unless /~~~database creation and migration~~~/;' "${project_root_dir}/projectinit_docker/prod/start.sh"
       ;;
     "pgsql" )
-      # shellcheck source=pgsql/container/docker/v1/pqsql.sh
+      # shellcheck source=./pgsql/container/docker/v1/pqsql.sh
       source "${tool_dir}/src/database/pgsql/container/docker/v1/pqsql.sh"
       setup_pgsql_docker_compose_prod
       setup_pgsql_prod_dockerfile
       ;;
     "mysql" )
-      # shellcheck source=mysql/container/docker/v1/mysql.sh
+      # shellcheck source=./mysql/container/docker/v1/mysql.sh
       source "${tool_dir}/src/database/mysql/container/docker/v1/mysql.sh"
       setup_mysql_docker_compose_prod
       setup_mysql_my_cnf_prod
       setup_mysql_prod_entrypoint
       setup_mysql_prod_dockerfile
       ;;
     "percona" )
-      # shellcheck source=percona/container/docker/v1/percona.sh
+      # shellcheck source=./percona/container/docker/v1/percona.sh
       source "${tool_dir}/src/database/percona/container/docker/v1/percona.sh"
       setup_percona_docker_compose_prod
       setup_percona_my_cnf_prod
       setup_percona_prod_entrypoint
       setup_percona_prod_dockerfile
       ;;
     "mariadb" )
-      # shellcheck source=mariadb/container/docker/v1/mariadb.sh
+      # shellcheck source=./mariadb/container/docker/v1/mariadb.sh
       source "${tool_dir}/src/database/mariadb/container/docker/v1/mariadb.sh"
       setup_mariadb_docker_compose_prod
       setup_mariadb_my_cnf_prod
       setup_mariadb_prod_entrypoint
       setup_mariadb_prod_dockerfile
       ;;
+    "mongodb" )
+      # shellcheck source=./mongodb/container/docker/v1/mongodb.sh
+      source "${tool_dir}/src/database/mongodb/container/docker/v1/mongodb.sh"
+      setup_mongodb_docker_compose_prod
+      setup_mongodb_config_prod
+      setup_mongodb_prod_entrypoint
+      setup_mongodb_prod_dockerfile
   esac
 
   if [ ! "${projectinit_database_type}" = "no database" ]; then
     perl -pi -e "s/(.*~~~main application dependencies~~~.*)/\1\n      ${projectinit_database_service_name}:\n        condition: service_healthy/" "${project_root_dir}/projectinit_docker/prod/compose.yaml"
   fi
 }
 
+setup_database_dockerfile_installer() {
+  local target_file
+  target_file="${project_root_dir}/Dockerfile"
+
+  case "${projectinit_database_type}" in
+    "mongodb" )
+      perl -pi -e "s/(.*~~~php extension~~~.*)/\1\n        mongodb \\\\/g" "${target_file}"
+      ;;
+  esac
+}
+
 setup_database_dockerfile_dev() {
   local target_file
   target_file="${project_root_dir}/Dockerfile"
@@ -110,6 +138,9 @@ setup_database_dockerfile_dev() {
     "mariadb" )
       perl -pi -e "s/(.*~~~php extension~~~.*)/\1\n        pdo_mysql \\\\/g" "${target_file}"
       ;;
+    "mongodb" )
+      perl -pi -e "s/(.*~~~php extension~~~.*)/\1\n        mongodb \\\\/g" "${target_file}"
+      ;;
   esac
 }
 
@@ -130,5 +161,8 @@ setup_database_dockerfile_prod() {
     "mariadb" )
       perl -pi -e "s/(.*~~~php extension~~~.*)/\1\n        pdo_mysql \\\\/g" "${target_file}"
       ;;
+    "mongodb" )
+      perl -pi -e "s/(.*~~~php extension~~~.*)/\1\n        mongodb \\\\/g" "${target_file}"
+      ;;
   esac
 }

src/database/mariadb/container/docker/v1/mariadb.sh

@@ -25,14 +25,14 @@ setup_mariadb_docker_compose_dev() {
     mkdir -p "${project_root_dir}/projectinit_docker/dev/mariadb/docker-entrypoint-initdb.d"
   fi
 
-  perl -pi -e "s/~~~compose secrets~~~/$(<"${tool_dir}/src/database/mariadb/container/docker/v1/template/secrets" perl -pe 's/([\/\& \t])/\\$1/g')/g" "${target_file}"
+  perl -pi -e "s/~~~secrets~~~/$(<"${tool_dir}/src/database/mariadb/container/docker/v1/template/secrets" perl -pe 's/([\/\& \t])/\\$1/g')/g" "${target_file}"
 }
 
 setup_mariadb_docker_compose_prod() {
   local target_file
   target_file="${project_root_dir}/projectinit_docker/prod/compose.yaml"
   if [ ! -d "${project_root_dir}/projectinit_docker/prod" ]; then
-    mkdir "${project_root_dir}/projectinit_docker/prod"
+    mkdir -p "${project_root_dir}/projectinit_docker/prod"
   fi
 
   perl -pi -e "s/~~~database service~~~/$(<"${tool_dir}/src/database/mariadb/container/docker/v1/template/prod" perl -pe 's/([\/\& \t])/\\$1/g')/g" "${target_file}"
@@ -46,7 +46,7 @@ setup_mariadb_docker_compose_prod() {
     mkdir -p "${project_root_dir}/projectinit_docker/prod/mariadb/docker-entrypoint-initdb.d"
   fi
 
-  perl -pi -e "s/~~~compose secrets~~~/$(<"${tool_dir}/src/database/mariadb/container/docker/v1/template/secrets" perl -pe 's/([\/\& \t])/\\$1/g')/g" "${target_file}"
+  perl -pi -e "s/~~~secrets~~~/$(<"${tool_dir}/src/database/mariadb/container/docker/v1/template/secrets" perl -pe 's/([\/\& \t])/\\$1/g')/g" "${target_file}"
 }
 
 setup_mariadb_dev_dockerfile() {

src/database/mariadb/container/docker/v1/template/dockerfile/dev

@@ -3,7 +3,7 @@ FROM mariadb:~~~database server version~~~
 ENV MARIADB_MYSQL_LOCALHOST_USER=1
 
 COPY --chown=mysql:mysql --chmod=644 ./projectinit_docker/dev/mariadb/etc/mysql/conf.d/*.cnf /etc/mysql/conf.d/
-COPY --chown=mysql:mysql ./projectinit_docker/dev/mariadb/entrypoint.sh /entrypoint.sh
+COPY --chown=mysql:mysql --chmod=544 ./projectinit_docker/dev/mariadb/entrypoint.sh /entrypoint.sh
 
 HEALTHCHECK --timeout=10s --start-period=1m \
     CMD healthcheck.sh --connect --innodb_initialized