Updates on files

Author: Alexander Rogalskiy

.crowdin.bak

@@ -0,0 +1 @@
+{"token":"","organization":"Nullables.io","projectId":"java-patterns","baseDir":"docs","path":"."}

.github/workflows/performance-comparison-label.yml

@@ -0,0 +1,44 @@
+name: Run Performance Comparison
+
+on:
+  pull_request:
+    types: [ labeled ]
+
+permissions:
+  pull-requests: write
+  issues: write
+
+concurrency:
+  group: build-${{ github.event.pull_request.number || github.ref }}-${{github.workflow}}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    if: ${{ github.event.label.name == 'help:run-comparisonstats' }}
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Remove run-performance-comparison label
+      uses: actions-ecosystem/action-remove-labels@v1
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        labels: help:run-comparisonstats
+
+    - name: Check out code into the Go module directory
+      uses: actions/checkout@v3
+
+    - name: Parse comment template into gh output
+      id: parse-comment-template-into-gh-output
+      working-directory: ./scripts/template
+      run: |
+        body=$(cat comment.txt)
+        body="${body//'%'/'%25'}"
+        body="${body//$'\n'/'%0A'}"
+        body="${body//$'\r'/'%0D'}"
+        echo ::set-output name=body::$body
+
+    - name: Create comment
+      uses: peter-evans/create-or-update-comment@c9fcb64660bc90ec1cc535646af190c992007c32
+      with:
+        issue-number: ${{ github.event.pull_request.number }}
+        body: "${{ steps.parse-comment-template-into-gh-output.outputs.body }}"

.gitignore

@@ -65,3 +65,6 @@ venv
 
 # Env files
 .env
+
+# Crowdin files
+.crowdin

README.md

@@ -44,34 +44,36 @@
 ## 🎹 *Table of contents*
 
 <!--ts-->
-   * [Java Design Patterns](#java-design-patterns)
-      * [<em>Table of contents</em>](#-table-of-contents)
-      * [<em>Summary</em>](#-summary)
-      * [<em>Documentation</em>](#-documentation)
-      * [<em>Kubernetes</em>](#-kubernetes)
-      * [<em>Statistics</em>](#-statistics)
-      * [<em>Versioning</em>](#-versioning)
-      * [<em>Authors</em>](#-authors)
-      * [<em>Contributing</em>](#-contributing)
-      * [<em>Visitor stats</em>](#-visitor-stats)
-      * [<em>Licensing</em>](#-licensing)
-      * [<em>Development Support</em>](#-development-support)
-      * [<em>Acknowledgement</em>](#-acknowledgement)
-      * [<em>OpenGraph Card</em>](#-opengraph-card)
-      * [<em>Feeds and Podcasts</em>](#-feeds-and-podcasts)
-         * [<em>Reddit posts</em>](#reddit-posts)
-         * [<em>InfoWorld posts</em>](#infoworld-posts)
-         * [<em>Let's talk posts</em>](#lets-talk-posts)
-         * [<em>Random thoughts posts</em>](#random-thoughts-posts)
-         * [<em>Better code posts</em>](#better-code-posts)
-         * [<em>Inside Java posts</em>](#inside-java-posts)
-         * [<em>Java programmer posts</em>](#java-programmer-posts)
-         * [<em>Dreamix posts</em>](#dreamix-posts)
-         * [<em>Plumbr posts</em>](#plumbr-posts)
-         * [<em>Thorben Janssen posts</em>](#thorben-janssen-posts)
-         * [<em>Redhat posts</em>](#redhat-posts)
-         * [<em>JavaCodeGeeks posts</em>](#javacodegeeks-posts)
-         * [<em>DevCases posts</em>](#devcases-posts)
+
+- [Java Design Patterns](#java-design-patterns)
+  - [<em>Table of contents</em>](#-table-of-contents)
+  - [<em>Summary</em>](#-summary)
+  - [<em>Documentation</em>](#-documentation)
+  - [<em>Kubernetes</em>](#-kubernetes)
+  - [<em>Statistics</em>](#-statistics)
+  - [<em>Versioning</em>](#-versioning)
+  - [<em>Authors</em>](#-authors)
+  - [<em>Contributing</em>](#-contributing)
+  - [<em>Visitor stats</em>](#-visitor-stats)
+  - [<em>Licensing</em>](#-licensing)
+  - [<em>Development Support</em>](#-development-support)
+  - [<em>Acknowledgement</em>](#-acknowledgement)
+  - [<em>OpenGraph Card</em>](#-opengraph-card)
+  - [<em>Feeds and Podcasts</em>](#-feeds-and-podcasts)
+    - [<em>Reddit posts</em>](#reddit-posts)
+    - [<em>InfoWorld posts</em>](#infoworld-posts)
+    - [<em>Let's talk posts</em>](#lets-talk-posts)
+    - [<em>Random thoughts posts</em>](#random-thoughts-posts)
+    - [<em>Better code posts</em>](#better-code-posts)
+    - [<em>Inside Java posts</em>](#inside-java-posts)
+    - [<em>Java programmer posts</em>](#java-programmer-posts)
+    - [<em>Dreamix posts</em>](#dreamix-posts)
+    - [<em>Plumbr posts</em>](#plumbr-posts)
+    - [<em>Thorben Janssen posts</em>](#thorben-janssen-posts)
+    - [<em>Redhat posts</em>](#redhat-posts)
+    - [<em>JavaCodeGeeks posts</em>](#javacodegeeks-posts)
+    - [<em>DevCases posts</em>](#devcases-posts)
+
 <!--te-->
 
 <div style="text-align: right"><a href="https://github.com/AlexRogalskiy/java-patterns#java-design-patterns"><i>(back to top)</i></a></div>

makefiles/common.mk

@@ -37,16 +37,18 @@ GIT_REPO_PREFIX 					:= $(shell git config --get remote.origin.url | tr ':.' '/'
 # GIT_REPO_NAME stores git repository name
 GIT_REPO_NAME 						:= $(shell git config --get remote.origin.url | tr ':.' '/'  | rev | cut -d '/' -f 2 | rev)
 
-# SYS_HOST stores the host name
+# SYS_HOST stores system hostname
 SYS_HOST 									:= $(shell hostname | tr '[:upper:]' '[:lower:]')
-# SYS_OS stores the value of uname -s.
+# SYS_OS stores system operating system
 SYS_OS 					  				:= $(shell uname -s | tr '[:upper:]' '[:lower:]')
-# SYS_ARCH stores the value of uname -m.
+# SYS_ARCH stores system architecture
 SYS_ARCH 									:= $(shell uname -m | sed -e 's/x86_64/amd64/' | sed -e 's/aarch64\(_be\)\?/arm64/' | sed -e 's/\(arm\)\(64\)\?.*/\1\2/')
-# SYS_USER_GROUP stores user name/group
+# SYS_USER_GROUP stores system user name/group
 SYS_USER_GROUP 						:= $(shell echo "$(UID):$(GID)")
-# SYS_CPU stores cpu count
+# SYS_CPU stores system cpu count
 SYS_CPU 									:= $(shell bash $(GIT_ROOT_DIR)/scripts/read_cpus_available.sh)
+# SYS_LANGUAGE stores system locale
+SYS_LANGUAGE 							:= $(shell locale | egrep "^LANG=" | cut -d= -f2 | cut -d_ -f1 | tr -d '"' | egrep "^[a-z]{2}$")
 
 # QUIET stores silent mode
 QUIET 										:= $(if $(findstring s,$(filter-out --%,$(MAKEFLAGS))),-q)

package.json

@@ -17,6 +17,7 @@
   ],
   "description": "Java Design Patterns Documentation",
   "devDependencies": {
+    "@cadolabs/crowdin-cli": "^3.0.19",
     "@types/node": "^17.0.21",
     "adr-tools": "^2.0.4",
     "alex": "^9.1.0",
@@ -136,8 +137,9 @@
     "contribs": "all-contributors",
     "contribs:add": "all-contributors add",
     "contribs:generate": "all-contributors generate && cp .all-contributorsrc ./docs/contributors.json",
-    "crowdin-download": "yarn crowdin --config crowdin.yml download -b $(git rev-parse --abbrev-ref HEAD)",
-    "crowdin-upload": "yarn crowdin --config crowdin.yml upload sources --auto-update -b $(git rev-parse --abbrev-ref HEAD)",
+    "crowdin:download": "crowdin --config crowdin.yml download -b $(git rev-parse --abbrev-ref HEAD)",
+    "crowdin:pull": "crowdin pull --skip-untranslated-strings",
+    "crowdin:upload": "crowdin --config crowdin.yml upload sources --auto-update -b $(git rev-parse --abbrev-ref HEAD)",
     "deploy": "deploy-to-gh-pages --local --update site",
     "docker:build": "docker build -f ./distribution/docker-images/dev.Dockerfile -t $npm_package_config_image .",
     "docker:run": "docker run -ti --rm -v ${PWD}:/usr/src/app -e CI=1 $npm_package_config_image build --strict",

scripts/check_grammar.sh

@@ -0,0 +1,70 @@
+#!/usr/bin/env bash
+# Copyright (C) 2022 SensibleMetrics, Inc. (http://sensiblemetrics.io/)
+#
+# 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.
+
+# Usage example: /bin/sh ./scripts/check_license.sh
+
+set -o errexit
+set -o nounset
+set -o pipefail
+
+set -e
+
+if ! command -v aspell > /dev/null; then
+    echo "Missing aspell utility"
+elif ! aspell dump dicts | grep -qw "en$" > /dev/null ; then
+    echo "Missing aspell English dictionary (aspell-en)"
+fi
+
+DATAFILE=$(mktemp /tmp/aspell-strings.XXXXXXXXXX)
+DATAFILE_SORTED=$(mktemp /tmp/aspell-strings-sorted.XXXXXXXXXX)
+
+echo "Temporary file: ${DATAFILE}"
+#strings ./docs > "${DATAFILE}"
+find ./docs -type f -exec strings {} \; | tr ' ' '\n' >> "${DATAFILE}"
+
+
+# tr    delete quotes (disabled) #    tr -d "'" | \
+# tr    split key/value pairs
+# tr    split words or paths
+# grep  get all words 4 characters or more
+# sed   strip out unwanted characters
+# grep  ignore uppercase words (2 or more capitals)
+# grep  ignore words with underscores (most likely variables)
+# grep  ignore words with dots
+# awk   count number of capitals by doing a replacement and showing word + count
+# awk   only show items that have one capital max
+# grep  another run to get rid of very short words
+# tr    turn all words into lowercase before sorting
+# sort  sort and only store unique words
+{
+    tr '=' ' ' | \
+    tr '/' ' ' | \
+    grep -E "^[a-zA-Z]{4,}" | \
+    sed -e 's/[|?#,:"\{\}\$=\(\)\;\/]//g' | \
+    tr ' ' '\n' | \
+    grep -E -v "^[A-Z]{2,}" | \
+    grep -v "_" | \
+    grep -v "\." | \
+    awk '{print $1,gsub("[A-Z]","")}' | \
+    awk '{if ($2 <= 1) { print $1 }}' | \
+    grep -E "^[a-zA-Z]{4,}" | \
+    tr '[:upper:]' '[:lower:]' | \
+    sort --unique > "${DATAFILE_SORTED}"
+} < "${DATAFILE}"
+
+aspell --lang=en --ignore-case --personal=./scripts/template/words-to-ignore.en.pws check "${DATAFILE_SORTED}"
+
+if [ -f "${DATAFILE}" ]; then rm "${DATAFILE}"; fi
+if [ -f "${DATAFILE_SORTED}" ]; then rm "${DATAFILE_SORTED}"; fi

scripts/shellcheck.sh

@@ -26,7 +26,7 @@ test_shell()
     while IFS="" read -r file
     do
       # collect all warnings
-      shellcheck --format=checkstyle "$file" > ".shellcheck/$(basename "${file}")".log || true
+      shellcheck --format=checkstyle --check-sourced --shell=sh "$file" > ".shellcheck/$(basename "${file}")".log || true
       # fail on >=error
       shellcheck --severity error "$file"
     done
@@ -45,7 +45,7 @@ test_shell_error()
     done
 }
 
-if [ "$1" = "--shell" ]; then
+if [ "${1:-'--shell'}" = "--shell" ]; then
   test_shell
   exit 0
 else

scripts/template/comment-text.txt

@@ -0,0 +1,10 @@
+**Copy paste the msg below into a new comment and 'Comment' to trigger a run-comparisonstats job:**
+/run-comparisonstats
+exampleAppName: helm-deployment # helm-deployment, microservices, etc.
+exampleSrcFile: main.go # main.go, leeroy-app/app.go, etc.
+commentText: //per-dev-iteration-comment # go/js: //comment, python: #comment, etc.
+devIterations: 2 # number of dev iterations to run per binary
+\#mainBranchSkaffoldFlags: "--build-concurrency=0" # NOTE: only supports one flag
+\#thisPRSkaffoldFlags: "--build-concurrency=1" # NOTE: only supports one flag
+
+\#run-comparisonstats job adds a rocket emoji to your comment within ~30 seconds if kicked off successfully (refreshing might be required to see this)

scripts/template/words-to-ignore.en.pws

@@ -0,0 +1,132 @@
+personal_ws-1.1 en 42
+atftpd
+backends
+bootloader
+anacrontab
+boelen
+addrwatch
+apachectl
+bashrc
+arpon
+auditctl
+bochs
+bindir
+auter
+autoremove
+anacron
+auditd
+bourne
+avira
+afick
+basename
+bootnodevnoexecnosuid
+grep
+autolog
+args
+auditstat
+addr
+bootctl
+backend
+authori
+bootinfo
+autoindex
+atftp
+ansible
+archiver
+blkid
+bsdrc
+automounter
+arpwatch
+auth
+apparmor
+automount
+bitdefender
+builtin
+busybox
+capitan
+cfagent
+cfengine
+chainname
+chakra
+changelog
+chargen
+chargen-dgram
+chargen-stream
+checksums
+checkupdates
+check-value
+chef-client
+chkconfig
+chkgrp
+chkprintcap
+chkrootkit
+chmod
+chown
+chrony
+chronyd
+ckpt
+clamconf
+clamd
+clamscan
+cmdagent
+cmdline
+conf
+config
+config-data
+config-uname
+consts
+control-url-append
+control-url-prepend
+control-url-protocol
+counttests
+cracklib
+cramfs
+cronjob
+cronjobs
+crontab
+crypttab
+csum
+cups
+cupsd
+entstat
+journalctl
+journalling
+kauditd
+kerberos
+ldap
+lgwr
+malware
+metalog
+passwordless
+prepend
+qemu
+qmail
+qmgr
+readlink
+readlinkbinary
+readonly
+reco
+reinstalling
+relatime
+symlink
+systemd
+tftp
+timedate
+todo
+tune2fs
+ulimit
+umask
+usbguard
+utils
+wget
+whitelist
+xargs
+xinet
+xntpd
+ypbind
+ypldap
+ypserv
+zcat
+zgrep
+zoneadm
+zypper