Merge pull request #2356 from keymanapp/auto/A19S17-merge-master-into-staging

auto: A19S17 merge master into staging

Author: keyman-status

.github/workflows/ci.yml

@@ -18,7 +18,7 @@ jobs:
       shell: bash
       run: |
         echo "TIER_TEST" > tier.txt
-        ./build.sh configure build start
+        ./build.sh configure build start --debug
       env:
         fail-fast: true
 
@@ -37,13 +37,21 @@ jobs:
 
     - name: Check broken links
       shell: bash
+      continue-on-error: false
       run: |
-        set +e;
-        set +o pipefail;
-        npx broken-link-checker http://localhost:8055 --ordered --recursive --requests 50 --host-requests 50 -e --filter-level 3 | \
+        set +e
+        set +o pipefail
+        npx broken-link-checker http://localhost:8055 --ordered --recursive --host-requests 50 -e --filter-level 3 | tee blc.log
+        echo "BLC_RESULT=${PIPESTATUS[0]}" >> "$GITHUB_ENV"
+
+    - name: Report on broken links
+      run: |
+        set +e
+        set +o pipefail
+        cat blc.log | \
           grep -E "BROKEN|Getting links from" | \
-          grep -B 1 "BROKEN"
-        exit ${PIPESTATUS[0]}
+          grep -B 1 "BROKEN";
+        exit "${BLC_RESULT}"
 
     - name: Check PHP errors
       shell: bash

.gitignore

@@ -2,6 +2,13 @@
 **/.DS_Store
 .idea/
 cdn/deploy
+
+tier.txt
+
+# unit test artifacts
+blc.log
+.phpunit.result.cache
+
 vendor*
 .vscode/
 node_modules/

Dockerfile

@@ -1,4 +1,6 @@
 # syntax=docker/dockerfile:1
+
+ARG BUILDER_CONFIGURATION="release"
 FROM php:7.4-apache@sha256:c9d7e608f73832673479770d66aacc8100011ec751d1905ff63fae3fe2e0ca6d AS composer-builder
 
 # Install Zip to use composer
@@ -15,7 +17,14 @@ RUN composer self-update
 USER www-data
 WORKDIR /composer
 COPY composer.* /composer/
-RUN composer install
+# Consume the build argment
+ARG BUILDER_CONFIGURATION
+RUN if [ "$BUILDER_CONFIGURATION" = "debug" ]; then \
+      # composer install --dev deprecated
+      COMPOSER_NO_DEV=0 composer install ; \
+    else \
+      COMPOSER_NO_DEV=1 composer install ; \
+    fi
 
 # Site
 FROM php:7.4-apache@sha256:c9d7e608f73832673479770d66aacc8100011ec751d1905ff63fae3fe2e0ca6d

README.md

@@ -72,6 +72,12 @@ shell, and from this folder, run:
 ./build.sh build
 ```
 
+If you'll be running tests locally, the Docker image will need to be built with dev dependencies:
+
+```sh
+./build.sh build --debug
+```
+
 #### Start the Docker container
 
 To start up the website, in bash, run:
@@ -101,7 +107,11 @@ In bash, run:
 
 #### Running tests
 
-To check for broken links and .php file conformance, when the site is running,
+When the site is running, the test action will do the following:
+* PHP unit tests
+* Check .php file conformance
+* Check for internal broken links
+
 in bash, run:
 
 ```sh

build.sh

@@ -2,7 +2,7 @@
 ## START STANDARD SITE BUILD SCRIPT INCLUDE
 readonly THIS_SCRIPT="$(readlink -f "${BASH_SOURCE[0]}")"
 readonly BOOTSTRAP="$(dirname "$THIS_SCRIPT")/resources/bootstrap.inc.sh"
-readonly BOOTSTRAP_VERSION=v1.0.7
+readonly BOOTSTRAP_VERSION=v1.08
 [ -f "$BOOTSTRAP" ] && source "$BOOTSTRAP" || source <(curl -H "Cache-Control: no-cache" -fs https://raw.githubusercontent.com/keymanapp/shared-sites/$BOOTSTRAP_VERSION/bootstrap.inc.sh)
 ## END STANDARD SITE BUILD SCRIPT INCLUDE
 
@@ -31,21 +31,38 @@ builder_parse "$@"
 function test_docker_container() {
   # Note: ci.yml replicates these
 
-  # Run unit tests
+  echo "TIER_TEST" > tier.txt
+  set +e;
+  set +o pipefail;
+
+  builder_echo blue "---- PHP unit tests"
   docker exec $HELP_CONTAINER_DESC sh -c "vendor/bin/phpunit --testdox"
 
   # Lint .php files for obvious errors
+  builder_echo blue "---- Lint PHP files"
   docker exec $HELP_CONTAINER_DESC sh -c "find . -name '*.php' | grep -v '/vendor/' | xargs -n 1 -d '\\n' php -l"
 
   # Check all internal links
   # NOTE: link checker runs on host rather than in docker image
-  npx broken-link-checker http://localhost:8055 --ordered --recursive --host-requests 10 -e --filter-level 3
+  builder_echo blue "---- Testing links"
+  npx broken-link-checker http://localhost:8055 --recursive --ordered ---host-requests 50 -e --filter-level 3 | tee blc.log
+  local BLC_RESULT=${PIPESTATUS[0]}
+  echo ----------------------------------------------------------------------
+  echo Link check summary
+  echo ----------------------------------------------------------------------
+  cat blc.log | \
+    grep -E "BROKEN|Getting links from" | \
+    grep -B 1 "BROKEN";
+
+  builder_echo blue "Done checking links"
+  rm tier.txt
+  return "${BLC_RESULT}"
 }
 
 builder_run_action configure  bootstrap_configure
 builder_run_action clean      clean_docker_container $HELP_IMAGE_NAME $HELP_CONTAINER_NAME
 builder_run_action stop       stop_docker_container  $HELP_IMAGE_NAME $HELP_CONTAINER_NAME
-builder_run_action build      build_docker_container $HELP_IMAGE_NAME $HELP_CONTAINER_NAME
+builder_run_action build      build_docker_container $HELP_IMAGE_NAME $HELP_CONTAINER_NAME $BUILDER_CONFIGURATION
 builder_run_action start      start_docker_container $HELP_IMAGE_NAME $HELP_CONTAINER_NAME $HELP_CONTAINER_DESC $HOST_HELP_KEYMAN_COM $PORT_HELP_KEYMAN_COM $BUILDER_CONFIGURATION
 
 builder_run_action test       test_docker_container

developer/engine/android/19.0/KMAPro/index.md

@@ -0,0 +1,23 @@
+---
+title: Keyman for Android APIs
+---
+
+## Summary
+
+The **`Keyman for Android`** app has the following APIs for integration:
+
+
+## Description
+
+The Keyman for Android app installs as an Input Method Extension. When selected as the active system keyboard, it provides the following APIs:
+
+
+## Intents
+
+When the Keyman system keyboard changes the associated font name, the following Intent is broadcast so the integrating application can match the font:
+
+```java
+intent = new Intent("com.tavultesoft.kmapro.keyboard_changed");
+intent.putExtra("fontName", fontName);
+sendBroadcast(intent);
+```

developer/engine/android/19.0/KMManager/applyKeyboardHeight.md

@@ -23,7 +23,7 @@ KMManager.applyKeyboardHeight(Context context, int height, int orientation)
 : The context
 
 `height`
-: The height of the keyboard frame in *density-independent pixels (dp)*. Pass `KMManager.KeyboardHeight_Reset` to reset the keyboard height (for current orientation) to device-specific defaults.
+: The height of the keyboard frame in *density-independent pixels (dp)*. Pass `KMManager.KeyboardHeight_Reset` to reset the keyboard height (for the current orientation) to device-specific defaults.
 
 `orientation` _(Optional)_
 : Accepts a [screen orientation](https://developer.android.com/training/multiscreen/screensizes#TaskUseOriQuali) value. This is most useful if you want to change the size of the keyboard in the other (non-current) orientation. If `orientation` is not defined, keyboard height is set for the current device orientation.
@@ -78,3 +78,5 @@ The following script illustrates the use of `applyKeyboardHeight()` to reset key
 
 ## See also
 * [getKeyboardHeight()](getKeyboardHeight)
+* [getKeyboardHeightMax()](getKeyboardHeightMax)
+* [getKeyboardHeightMin()](getKeyboardHeightMin)

developer/engine/android/19.0/KMManager/getKeyboardHeight.md

@@ -55,3 +55,5 @@ or
 ## See also
 
 -   [applyKeyboardHeight()](applyKeyboardHeight)
+-   [getKeyboardHeightMax](getKeyboardHeightMax)
+-   [getKeyboardHeightMin](getKeyboardHeightMin)

developer/engine/android/19.0/KMManager/getKeyboardHeightMax.md

@@ -0,0 +1,57 @@
+---
+title: KMManager.getKeyboardHeightMax()
+---
+
+## Summary
+
+The **`getKeyboardHeightMax()`** method returns the maximum allowed height of the keyboard frame for this context.
+
+## Syntax
+
+``` javascript
+KMManager.getKeyboardHeightMax(Context context)
+```
+or
+``` javascript
+KMManager.getKeyboardHeightMax(Context context, int orientation)
+```
+
+### Parameters
+
+`context`
+:   The context.
+
+`orientation` _(Optional)_
+: Accepts a [screen orientation](https://developer.android.com/training/multiscreen/screensizes#TaskUseOriQuali) value. This is most useful if you want to get the size of the keyboard in the other (non-current) orientation. If `orientation` is not defined, maximum keyboard height is returned for the current device orientation.
+
+### Returns
+
+Returns the maximum allowed height of the keyboard frame in *density-independent pixels
+(dp)*.
+
+## Description
+
+Use this method to get the maximum allowed height of the keyboard frame.
+
+## Examples
+
+### Example: Using `getKeyboardHeightMax()`
+
+The following script illustrate the use of `getKeyboardHeightMax()`:
+
+``` javascript
+    int maxKeyboardHeight = KMManager.getKeyboardHeightMax(this);
+```
+or
+```java
+    import android.content.res.Configuration;
+    ...
+    // Get the maximum allowed Keyman keyboard height for landscape mode.
+    int maxKeyboardHeightLandscape = KMManager.getKeyboardHeightMax(this, Configuration.ORIENTATION_LANDSCAPE);
+```
+
+## See also
+
+-   [applyKeyboardHeight()](applyKeyboardHeight)
+-   [getKeyboardHeight()](getKeyboardHeight)
+-   [getKeyboardHeightMin()](getKeyboardHeightMin)

developer/engine/android/19.0/KMManager/getKeyboardHeightMin.md

@@ -0,0 +1,57 @@
+---
+title: KMManager.getKeyboardHeightMin()
+---
+
+## Summary
+
+The **`getKeyboardHeightMin()`** method returns the minimum allowed height of the keyboard frame for this context.
+
+## Syntax
+
+``` javascript
+KMManager.getKeyboardHeightMin(Context context)
+```
+or
+``` javascript
+KMManager.getKeyboardHeightMin(Context context, int orientation)
+```
+
+### Parameters
+
+`context`
+:   The context.
+
+`orientation` _(Optional)_
+: Accepts a [screen orientation](https://developer.android.com/training/multiscreen/screensizes#TaskUseOriQuali) value. This is most useful if you want to get the size of the keyboard in the other (non-current) orientation. If `orientation` is not defined, minimum keyboard height is returned for the current device orientation.
+
+### Returns
+
+Returns the minimum allowed height of the keyboard frame in *density-independent pixels
+(dp)*.
+
+## Description
+
+Use this method to get the minimum allowed height of the keyboard frame.
+
+## Examples
+
+### Example: Using `getKeyboardHeightMin()`
+
+The following script illustrate the use of `getKeyboardHeightMin()`:
+
+``` javascript
+    int minKeyboardHeight = KMManager.getKeyboardHeightMin(this);
+```
+or
+```java
+    import android.content.res.Configuration;
+    ...
+    // Get the minimum allowed Keyman keyboard height for landscape mode.
+    int minKeyboardHeightLandscape = KMManager.getKeyboardHeightMin(this, Configuration.ORIENTATION_LANDSCAPE);
+```
+
+## See also
+
+-   [applyKeyboardHeight()](applyKeyboardHeight)
+-   [getKeyboardHeight()](getKeyboardHeight)
+-   [getKeyboardHeightMax()](getKeyboardHeightMax)