allow non-English manual downloads (#16)

Co-authored-by: tyler36 <7234392+tyler36@users.noreply.github.com>

Author: tyler36

commands/host/get-php-manual

@@ -0,0 +1,44 @@
+#!/bin/bash
+
+## #ddev-generated
+## Description: This script is part of "tyler36/ddev-tinker". It's purpose is to download
+##              Psysh's PHP core documentation. After starting a "ddev tinker" session,
+##              type "doc date", where 'date' is any core PHP function. It will display a
+##              man-like page detailing the function.
+##              @see https://github.com/bobthecow/psysh/wiki/PHP-manual
+##              This addon does a "simple" (and naive) language check to see if the developer
+##              may prefer a different locale. See "Example" below to "fake" a non-English setup.
+## Usage: get-php-manual
+## Example: "ddev get-php-manual"
+## Example: "LANG=ja_JP.UTF8 ddev get-php-manual"
+
+mkdir -p "$DDEV_APPROOT/.ddev/homeadditions/.local/share/psysh"
+
+FILENAME=php_manual.sqlite
+BASE_URL="http://psysh.org/manual"
+
+## Parse the LANG and see if the developer has a non-English language
+case "${LANG}" in
+    de* )
+        ## Assume German from "LANG=de_DE.UTF-8"
+        MANUAL="de/$FILENAME"
+        ;;
+    fr* )
+        ## Assume French from "LANG=fr_FR.UTF-8"
+        MANUAL="fr/$FILENAME"
+        ;;
+    ja* )
+        ## Assume Japanese from "LANG=ja_JP.UTF8"
+        MANUAL="ja/$FILENAME"
+        ;;
+    ru* )
+        ## Assume Russian from "LANG=ru_RU.UTF-8"
+        MANUAL="ru/$FILENAME"
+        ;;
+    * )
+        ## Default to English
+        MANUAL="en/$FILENAME"
+        ;;
+esac
+
+curl -sSL "$BASE_URL/$MANUAL" -o "$DDEV_APPROOT/.ddev/homeadditions/.local/share/psysh/$FILENAME"

install.yaml

@@ -4,14 +4,14 @@ name: ddev-tinker
 # DDEV environment variables can be interpolated into these filenames
 project_files:
 - commands/web/tinker
+- commands/host/get-php-manual
 
 # DDEV environment variables can be interpolated into these actions
 post_install_actions:
 - |
   #ddev-nodisplay
-  #ddev-description:Downloading English manual ...
-  mkdir -p ./homeadditions/.local/share/psysh
-  curl -sSL http://psysh.org/manual/en/php_manual.sqlite -o ./homeadditions/.local/share/psysh/php_manual.sqlite
+  #ddev-description:Downloading PHP core manual
+  ddev get-php-manual
 
 # Shell actions that can be done during removal of the add-on
 removal_actions:

tests/test.bats

@@ -16,6 +16,11 @@ health_checks() {
 validate_tinker() {
   # Output should contain outcome
   ddev tinker 'print "tinker working " . 99+1' | grep 'working 100'
+  # Manual should exist
+  validate_php_manual
+}
+
+validate_php_manual() {
   # Manual should exist
   test -f ${TESTDIR}/.ddev/homeadditions/.local/share/psysh/php_manual.sqlite || (printf "Failed to find manual in ${TESTDIR}\n" && exit 1)
 }
@@ -38,6 +43,30 @@ teardown() {
   health_checks
 }
 
+@test "Non-English manuals can be installed" {
+  set -eu -o pipefail
+  cd ${TESTDIR}
+  echo "# ddev get ${DIR} with project ${PROJNAME} in ${TESTDIR} ($(pwd))" >&3
+  ddev config --project-name=${PROJNAME}
+  ddev get ${DIR}
+  ddev restart
+  validate_php_manual
+
+  # Grab the size of the file so we can compare it to another the second time.
+  EN_SIZE=$(ddev . stat -c%s '~/.local/share/psysh/php_manual.sqlite')
+
+  # Delete the file so we can change the language.
+  rm "${TESTDIR}/.ddev/homeadditions/.local/share/psysh/php_manual.sqlite"
+
+  # Change the language and get it again. NOTE: This requires a restart.
+  LANG="ja_JP.UTF-8" ddev get-php-manual
+  ddev restart
+  validate_php_manual
+
+  JA_SIZE=$(ddev . stat -c%s '~/.local/share/psysh/php_manual.sqlite')
+  [ $EN_SIZE != $JA_SIZE ]
+}
+
 @test "install from release" {
   set -eu -o pipefail
   cd ${TESTDIR} || ( printf "unable to cd to ${TESTDIR}\n" && exit 1 )