- lets try a package.yaml instead

- added get_generator API to testing utilities (a nice way to setup default options)
- updated python scwrypts API to use latest pattern established in the nodejs library
2024-04-15 08:48:19 -06:00 · 2024-04-15 08:46:47 -06:00 · 2024-04-15 08:45:55 -06:00
10 changed files with 143 additions and 182 deletions
--- a/.circleci/config.yml
+++ b/.circleci/config.yml
@@ -102,7 +102,6 @@ jobs:
            && echo "source=(scwrypts.tar.gz)" >> PKGBUILD
            && echo "sha256sums=(SKIP)" >> PKGBUILD
            && makepkg --noconfirm -si
-            && echo validating scwrypts version
            && scwrypts --version | grep "^scwrypts v$PKGVER$"
            ;

--- a/py/lib/scwrypts/http/conftest.py
+++ b/py/lib/scwrypts/http/conftest.py
@@ -2,22 +2,23 @@ from types import SimpleNamespace

 from pytest import fixture

-from scwrypts.test import get_generator
+from scwrypts.test import generate
 from scwrypts.test.character_set import uri

-generate = get_generator({
+options = {
        'str_length_minimum':   8,
        'str_length_maximum': 128,
        'uuid_output_type':   str,
-        })
+        }

 def get_request_client_sample_data():
    return {
-            'base_url' : generate(str, {'character_set': uri}),
-            'endpoint' : generate(str, {'character_set': uri}),
-            'method'   : generate(str),
-            'response' : generate('requests_Response', {'depth': 4}),
+            'base_url' : generate(str, options | {'character_set': uri}),
+            'endpoint' : generate(str, options | {'character_set': uri}),
+            'method'   : generate(str, options),
+            'response' : generate('requests_Response', options | {'depth': 4}),
            'payload'  : generate(dict, {
+                **options,
                'depth': 1,
                'data_types': { str, 'uuid' },
                }),
@@ -29,11 +30,13 @@ def fixture_sample():
            **get_request_client_sample_data(),

            headers = generate(dict, {
+                **options,
                'depth': 1,
                'data_types': { str, 'uuid' },
                }),

            payload_headers = generate(dict, {
+                **options,
                'depth': 1,
                'data_types': { str, 'uuid' },
                }),
--- a/py/lib/scwrypts/http/directus/conftest.py
+++ b/py/lib/scwrypts/http/directus/conftest.py
@@ -2,14 +2,15 @@ from types import SimpleNamespace

 from pytest import fixture

+from scwrypts.test import generate
 from scwrypts.test.character_set import uri
-from ..conftest import generate, get_request_client_sample_data
+from ..conftest import options, get_request_client_sample_data


@fixture(name='sample')
 def fixture_sample():
    return SimpleNamespace(
            **get_request_client_sample_data(),
-            api_token = generate(str, {'character_set': uri}),
-            query     = generate(str),
+            api_token = generate(str, options | {'character_set': uri}),
+            query     = generate(str, options),
            )
--- a/py/lib/scwrypts/http/discord/conftest.py
+++ b/py/lib/scwrypts/http/discord/conftest.py
@@ -3,8 +3,9 @@ from types import SimpleNamespace

 from pytest import fixture

+from scwrypts.test import generate
 from scwrypts.test.character_set import uri
-from ..conftest import generate, get_request_client_sample_data
+from ..conftest import options, get_request_client_sample_data

@fixture(name='sample')
 def fixture_sample():
@@ -13,12 +14,12 @@ def fixture_sample():
                **get_request_client_sample_data(),
                'base_url': 'https://discord.com/api',
                },
-            bot_token  = generate(str, {'character_set': uri}),
-            username   = generate(str, {'character_set': ascii_letters + digits}),
-            avatar_url = generate(str, {'character_set': uri}),
-            webhook    = generate(str, {'character_set': uri}),
-            channel_id = generate(str, {'character_set': uri}),
-            content_header = generate(str),
-            content_footer = generate(str),
-            content = generate(str),
+            bot_token  = generate(str, options | {'character_set': uri}),
+            username   = generate(str, options | {'character_set': ascii_letters + digits}),
+            avatar_url = generate(str, options | {'character_set': uri}),
+            webhook    = generate(str, options | {'character_set': uri}),
+            channel_id = generate(str, options | {'character_set': uri}),
+            content_header = generate(str, options),
+            content_footer = generate(str, options),
+            content = generate(str, options),
        )
--- a/py/lib/scwrypts/http/linear/conftest.py
+++ b/py/lib/scwrypts/http/linear/conftest.py
@@ -3,8 +3,9 @@ from types import SimpleNamespace

 from pytest import fixture

+from scwrypts.test import generate
 from scwrypts.test.character_set import uri
-from ..conftest import generate, get_request_client_sample_data
+from ..conftest import options, get_request_client_sample_data

@fixture(name='sample')
 def fixture_sample():
@@ -13,6 +14,6 @@ def fixture_sample():
                **get_request_client_sample_data(),
                'base_url': 'https://api.linear.app',
                },
-            api_token = generate(str, {'character_set': uri}),
-            query     = generate(str),
+            api_token = generate(str, options | {'character_set': uri}),
+            query     = generate(str, options),
        )
--- a/34
+++ b/34
@@ -6,6 +6,11 @@ source "$(dirname $(readlink -f "$0"))/zsh/lib/import.driver.zsh" || exit 42
 	cd "$SCWRYPTS_ROOT__scwrypts"
 	GIT_SCWRYPTS() { git -C "$SCWRYPTS_ROOT__scwrypts" $@; }

+	local INSTALLATION_TYPE
+	[ ! -d "$SCWRYPTS_ROOT__scwrypts/.git" ] && [ ! -f "$SCWRYPTS_ROOT__scwrypts/.git" ] \
+		&& INSTALLATION_TYPE=$(cat "$SCWRYPTS_ROOT__scwrypts/MANAGED_BY" 2>/dev/null) \
+		|| INSTALLATION_TYPE=manual \
+		;

 	local ERRORS=0
 	local USAGE='
@@ -33,7 +38,6 @@ source "$(dirname $(readlink -f "$0"))/zsh/lib/import.driver.zsh" || exit 42
 		    -h, --help        display this message and exit
 		    -l, --list        print out command list and exit
 		        --list-envs   print out environment list and exit
-		        --root        print out SCWRYPTS_ROOT__scwrypts and exit
 		        --update      update scwrypts library to latest version
 		        --version     print out scwrypts version and exit

@@ -82,20 +86,15 @@ source "$(dirname $(readlink -f "$0"))/zsh/lib/import.driver.zsh" || exit 42
 				;;

 			--version )
-				case $SCWRYPTS_INSTALLATION_TYPE in
+				case $INSTALLATION_TYPE in
 					manual ) echo "scwrypts $(GIT_SCWRYPTS describe --tags) (via GIT)" ;;
-					     * ) echo "scwrypts $(cat "$SCWRYPTS_ROOT__scwrypts/VERSION")" ;;
+					     * ) echo scwrypts $(cat "$SCWRYPTS_ROOT__scwrypts/VERSION")   ;;
 				esac
 				return 0
 				;;

-			--root )
-				echo "$SCWRYPTS_ROOT__scwrypts"
-				return 0
-				;;
-
 			--update )
-				case $SCWRYPTS_INSTALLATION_TYPE in
+				case $INSTALLATION_TYPE in
 					aur )
 						SCWRYPTS_LOG_LEVEL=3 REMINDER " 
 							This installation is built from the AUR. Update through 'makepkg' or use
@@ -103,10 +102,6 @@ source "$(dirname $(readlink -f "$0"))/zsh/lib/import.driver.zsh" || exit 42
 							 "
 						;;

-					homebrew )
-						SCWRYPTS_LOG_LEVEL=3 REMINDER "This installation is managed by homebrew. Update me with 'brew update scwrypts'"
-						;;
-
 					manual )
 						GIT_SCWRYPTS fetch --quiet origin main
 						GIT_SCWRYPTS fetch --quiet origin main --tags
@@ -299,17 +294,9 @@ source "$(dirname $(readlink -f "$0"))/zsh/lib/import.driver.zsh" || exit 42

 	[[ $ENV_REQUIRED =~ true ]] && {
 		[ ! $ENV_NAME ] && ENV_NAME=$(SCWRYPTS__SELECT_ENV)
-		[ ! $ENV_NAME ] && ABORT
-
-		export ENV_NAME
-		export SCWRYPTS_ENV=$ENV_NAME

 		for GROUP in ${SCWRYPTS_GROUPS[@]}
 		do
-			local REQUIRED_REGEX=$(eval echo '$SCWRYPTS_REQUIRED_ENVIRONMENT_REGEX__'$GROUP)
-			[ $REQUIRED_REGEX ] && {
-				[[ $ENV_NAME =~ $REQUIRED_REGEX ]] || continue
-			}
 			local ENV_FILE=$(SCWRYPTS__GET_ENV_FILE "$ENV_NAME" "$GROUP")
 			source "$ENV_FILE" || FAIL 5 "missing or invalid environment '$GROUP/$ENV_NAME'"

@@ -318,6 +305,8 @@ source "$(dirname $(readlink -f "$0"))/zsh/lib/import.driver.zsh" || exit 42
 				source "$f" || FAIL 5 "invalid static config '$f'"
 			done
 		done
+
+		export ENV_NAME
 	}

 	[ $REQUIRED_ENVIRONMENT_REGEX ] && {
@@ -325,12 +314,11 @@ source "$(dirname $(readlink -f "$0"))/zsh/lib/import.driver.zsh" || exit 42
 			|| FAIL 5 "group '$SCWRYPT_GROUP' requires current environment name to match '$REQUIRED_ENVIRONMENT_REGEX' (currently $ENV_NAME)"
 	}

-
 	##########################################

 	[ ! $SUBSCWRYPT ] && export SUBSCWRYPT=0

-	[[ $SCWRYPTS_INSTALLATION_TYPE =~ ^manual$ ]] && {
+	[[ $INSTALLATION_TYPE =~ ^manual$ ]] && {
 		[[ $SUBSCWRYPT -eq 0 ]] && [[ $ENV_NAME =~ prod ]] && [[ $SCWRYPTS_LOG_LEVEL -gt 0 ]] && {
 			STATUS "on '$ENV_NAME'; checking diff against origin/main"

--- a/scwrypts.plugin.zsh
+++ b/scwrypts.plugin.zsh
@@ -1,13 +1,11 @@
 #####################################################################

-: \
-	&& command -v scwrypts &>/dev/null \
-	&& source "$(scwrypts --root)/zsh/lib/import.driver.zsh" \
-	&& unset __SCWRYPT \
-	|| {
-		echo 'scwrypts must be in PATH and properly configured; skipping zsh plugin setup' >&2
-		return 0
-	}
+command -v scwrypts &>/dev/null || {
+	echo 'scwrypts is required in your PATH in order to use the zsh plugins; skipping' >&2
+	return 0
+}
+
+NO_EXPORT_CONFIG=1 source "${0:a:h}/zsh/lib/import.driver.zsh" || return 42

 #####################################################################

--- a/zsh/lib/config.zsh
+++ b/zsh/lib/config.zsh
@@ -1,28 +1,14 @@
 [[ $__SCWRYPT -eq 1 ]] && return 0
 #####################################################################

-# Apparently MacOS puts ALL of the homebrew stuff inside of a top level git repository
-# with bizarre git ignores; so:
-#  - USE the git root if it's a manual install...
-#  - UNLESS that git root is just the $(brew --prefix)
-SCWRYPTS_ROOT="$(cd -- ${0:a:h}; git rev-parse --show-toplevel 2>/dev/null | grep -v "^$(brew --prefix 2>/dev/null)$")"
+[ ! $SCWRYPTS_ROOT ] \
+	&& SCWRYPTS_ROOT="$(cd $(dirname "${0:a:h}"); git rev-parse --show-toplevel 2>/dev/null)"

-[ $SCWRYPTS_ROOT ] && [ -d "$SCWRYPTS_ROOT" ] \
-	|| SCWRYPTS_ROOT="$(echo "${0:a:h}" | sed -n 's|\(share/scwrypts\).*$|\1|p')"
-
-[ $SCWRYPTS_ROOT ] && [ -d "$SCWRYPTS_ROOT" ] || {
-	echo "cannot determine scwrypts root path for current installation; aborting"
-	exit 1
-}
+[ ! $SCWRYPTS_ROOT ] && [ -d /usr/share/scwrypts ] \
+	&& SCWRYPTS_ROOT=/usr/share/scwrypts

 export SCWRYPTS_ROOT__scwrypts="$SCWRYPTS_ROOT"

-[ -f "$SCWRYPTS_ROOT__scwrypts/MANAGED_BY" ] \
-	&& export SCWRYPTS_INSTALLATION_TYPE=$(cat "$SCWRYPTS_ROOT__scwrypts/MANAGED_BY") \
-	|| export SCWRYPTS_INSTALLATION_TYPE=manual \
-	;
-
-
 #####################################################################

 DEFAULT_CONFIG="$SCWRYPTS_ROOT/zsh/lib/config.user.zsh"
@@ -35,13 +21,11 @@ USER_CONFIG_OVERRIDES="$SCWRYPTS_CONFIG_PATH/config.zsh"
 }
 source "$USER_CONFIG_OVERRIDES"

-mkdir -p \
-	"$SCWRYPTS_CONFIG_PATH" \
-	"$SCWRYPTS_DATA_PATH" \
-	"$SCWRYPTS_ENV_PATH" \
-	"$SCWRYPTS_LOG_PATH" \
-	"$SCWRYPTS_OUTPUT_PATH" \
-	;
+[ ! -d $SCWRYPTS_CONFIG_PATH ] && mkdir -p $SCWRYPTS_CONFIG_PATH
+[ ! -d $SCWRYPTS_DATA_PATH   ] && mkdir -p $SCWRYPTS_DATA_PATH
+[ ! -d $SCWRYPTS_ENV_PATH    ] && mkdir -p $SCWRYPTS_ENV_PATH
+[ ! -d $SCWRYPTS_LOG_PATH    ] && mkdir -p $SCWRYPTS_LOG_PATH
+[ ! -d $SCWRYPTS_OUTPUT_PATH ] && mkdir -p $SCWRYPTS_OUTPUT_PATH

 export \
 	SCWRYPTS_GROUPS \
@@ -78,8 +62,7 @@ done
 	&& [ ! "$SCWRYPTS_AUTODETECT_GROUP_BASEDIR" ] \
 	&& [ $GITHUB_WORKSPACE ] \
 	&& [ ! $SCWRYPTS_GITHUB_NO_AUTOLOAD ] \
-	&& SCWRYPTS_AUTODETECT_GROUP_BASEDIR="$GITHUB_WORKSPACE" \
-	;
+	&& SCWRYPTS_AUTODETECT_GROUP_BASEDIR="$GITHUB_WORKSPACE"

 [ "$SCWRYPTS_AUTODETECT_GROUP_BASEDIR" ] && [ -d "$SCWRYPTS_AUTODETECT_GROUP_BASEDIR" ] && {
 	for GROUP_LOADER in $(find "$SCWRYPTS_AUTODETECT_GROUP_BASEDIR" -type f -name \*scwrypts.zsh)
@@ -89,4 +72,5 @@ done
 }

 #####################################################################
-__SCWRYPT=1 # arbitrary; indicates currently inside a scwrypt
+[ $NO_EXPORT_CONFIG ] || __SCWRYPT=1 # arbitrary; indicates currently inside a scwrypt
+true
--- a/zx/lib/package.json
+++ b/zx/lib/package.json
@@ -1,100 +0,0 @@
-{
-	"name": "scwrypts",
-	"main": "dist/index.js",
-	"type": "module",
-	"files": [
-		"dist"
-	],
-	"description": "scwrypts integration for typescript",
-	"scripts": {
-		"build": "rm -rf ./dist && tsc",
-		"test": "jest",
-		"lint": "eslint . && prettier --check src/",
-		"format": "prettier --write src/"
-	},
-	"author": "Wryn (yage) Wagner",
-	"license": "GPL-3.0",
-	"devDependencies": {
-		"@jest/globals": "^29.7.0",
-		"@types/jest": "^29.5.12",
-		"@types/node": "^20.11.19",
-		"@types/uuid": "^9.0.8",
-		"@typescript-eslint/eslint-plugin": "^7.0.2",
-		"@typescript-eslint/parser": "^7.0.2",
-		"eslint": "^8.56.0",
-		"jest": "^29.7.0",
-		"prettier": "^3.2.5",
-		"ts-jest": "^29.1.2",
-		"ts-node": "^10.9.2",
-		"typescript": "^5.3.3",
-		"uuid": "^9.0.1"
-	},
-	"eslintConfig": {
-		"ignorePatterns": [
-			"dist",
-			"node_modules"
-		],
-		"env": {
-			"node": true,
-			"es2021": true
-		},
-		"extends": [
-			"eslint:recommended",
-			"plugin:@typescript-eslint/recommended"
-		],
-		"overrides": [
-			{
-				"env": {
-					"node": true
-				},
-				"files": [
-					".eslintrc.{js,cjs}"
-				],
-				"parserOptions": {
-					"sourceType": "script"
-				}
-			}
-		],
-		"parser": "@typescript-eslint/parser",
-		"parserOptions": {
-			"ecmaVersion": "latest",
-			"sourceType": "module"
-		},
-		"plugins": [
-			"@typescript-eslint"
-		],
-		"rules": {
-			"linebreak-style": [
-				"error",
-				"unix"
-			],
-			"quotes": [
-				"error",
-				"single"
-			],
-			"semi": [
-				"error",
-				"always"
-			],
-			"comma-dangle": [
-				"error",
-				"always-multiline"
-			]
-		}
-	},
-	"prettier": {
-		"printWidth": 120,
-		"singleQuote": true,
-		"trailingComma": "all"
-	},
-	"jest": {
-		"preset": "ts-jest",
-		"clearMocks": true,
-		"moduleNameMapper": {
-			"^(\\.{1,2}/.*)\\.js$": "$1"
-		}
-	},
-	"dependencies": {
-		"execa": "^8.0.1"
-	}
-}
--- a/zx/lib/package.yaml
+++ b/zx/lib/package.yaml
@@ -0,0 +1,86 @@
+---
+name: scwrypts
+author: Wryn (yage) Wagner
+description: scwrypts integration for typescript
+license: GPL-3.0
+type: module
+main: dist/index.js
+
+files:
+  - dist
+
+scripts:
+  build: rm -rf ./dist && tsc
+  test: jest
+  lint: eslint . && prettier --check src/
+  format: prettier --write src/
+
+#####################################################################
+
+dependencies:
+  execa: ^8.0.1
+
+devDependencies:
+  '@jest/globals': ^29.7.0
+  '@types/jest': ^29.5.12
+  '@types/node': ^20.11.19
+  '@types/uuid': ^9.0.8
+  '@typescript-eslint/eslint-plugin': ^7.0.2
+  '@typescript-eslint/parser': ^7.0.2
+  eslint: ^8.56.0
+  jest: ^29.7.0
+  prettier: ^3.2.5
+  ts-jest: ^29.1.2
+  ts-node: ^10.9.2
+  typescript: ^5.3.3
+  uuid: ^9.0.1
+
+#####################################################################
+
+eslintConfig:
+  ignorePatterns:
+    - dist
+    - node_modules
+  env:
+    node: true
+    es2021: true
+  extends:
+    - eslint:recommended
+    - plugin:@typescript-eslint/recommended
+  overrides:
+    - env:
+        node: true
+      files:
+        - .eslintrc.{js,cjs}
+      parserOptions:
+        sourceType: script
+  parser: '@typescript-eslint/parser'
+  parserOptions:
+    ecmaVersion: latest
+    sourceType: module
+  plugins:
+    - '@typescript-eslint'
+  rules:
+    linebreak-style:
+      - error
+      - unix
+    quotes:
+      - error
+      - single
+    semi:
+      - error
+      - always
+    comma-dangle:
+      - error
+      - always-multiline
+
+prettier:
+  printWidth: 120
+  singleQuote: true
+  trailingComma: all
+
+jest:
+  preset: ts-jest
+  clearMocks: true
+  moduleNameMapper:
+    ^(\.{1,2}/.*)\.js$: $1
Author	SHA1	Message	Date
yage	41da641ab9	- lets try a package.yaml instead	2024-04-15 08:48:19 -06:00
yage	6ba628f80e	- added get_generator API to testing utilities (a nice way to setup default options)	2024-04-15 08:46:47 -06:00
yage	1f10268aa0	- updated python scwrypts API to use latest pattern established in the nodejs library	2024-04-15 08:45:55 -06:00