Compare commits
33 commits
Author | SHA1 | Date | |
---|---|---|---|
985478ff91 | |||
![]() |
04ea85aa5d | ||
![]() |
4e065e8cf7 | ||
![]() |
eb8d63fea0 | ||
![]() |
1244aa0a24 | ||
![]() |
2eb49f4cff | ||
ca1bafdad1 | |||
d6e1292f45 | |||
![]() |
5e849d079f | ||
![]() |
fdb752cfe0 | ||
![]() |
0e2704aecc | ||
![]() |
2181b495a9 | ||
![]() |
43ddda23ef | ||
![]() |
d4f7b08714 | ||
![]() |
e333821450 | ||
![]() |
2477d81af3 | ||
![]() |
e86bc52cb7 | ||
![]() |
7a43c6623a | ||
![]() |
b9e942635a | ||
![]() |
23790bd189 | ||
![]() |
6e7f9089d2 | ||
![]() |
0a8e47cc71 | ||
![]() |
7c929cefa4 | ||
![]() |
81ab2fdf77 | ||
![]() |
7d1c11c051 | ||
![]() |
c3092eb688 | ||
![]() |
c98939d33f | ||
![]() |
6cd05ab051 | ||
![]() |
b41b8465f1 | ||
![]() |
f1e2df0dcc | ||
![]() |
9d6008368b | ||
![]() |
d7f2543183 | ||
![]() |
6cd044a0ad |
14 changed files with 525 additions and 68 deletions
308
.github/workflows/ncc_workflow.yml
vendored
Normal file
308
.github/workflows/ncc_workflow.yml
vendored
Normal file
|
@ -0,0 +1,308 @@
|
|||
name: CI
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- '**'
|
||||
release:
|
||||
types: [created]
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
release:
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: php:8.3
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
apt update -yqq
|
||||
apt install git libpq-dev libzip-dev zip make wget gnupg -yqq
|
||||
|
||||
- name: Install phive
|
||||
run: |
|
||||
wget -O phive.phar https://phar.io/releases/phive.phar
|
||||
wget -O phive.phar.asc https://phar.io/releases/phive.phar.asc
|
||||
gpg --keyserver hkps://keys.openpgp.org --recv-keys 0x9D8A98B29B2D5D79
|
||||
gpg --verify phive.phar.asc phive.phar
|
||||
chmod +x phive.phar
|
||||
mv phive.phar /usr/local/bin/phive
|
||||
|
||||
- name: Install phab
|
||||
run: |
|
||||
phive install phpab --global --trust-gpg-keys 0x2A8299CE842DD38C
|
||||
|
||||
- name: Install latest version of NCC
|
||||
run: |
|
||||
git clone https://git.n64.cc/nosial/ncc.git
|
||||
cd ncc
|
||||
make redist
|
||||
NCC_DIR=$(find build/ -type d -name "ncc_*" | head -n 1)
|
||||
if [ -z "$NCC_DIR" ]; then
|
||||
echo "NCC build directory not found"
|
||||
exit 1
|
||||
fi
|
||||
php "$NCC_DIR/INSTALL" --auto
|
||||
cd .. && rm -rf ncc
|
||||
|
||||
- name: Build project
|
||||
run: |
|
||||
ncc build --config release --build-source --log-level debug
|
||||
|
||||
- name: Upload build artifact
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: release
|
||||
path: build/release/net.nosial.optslib.ncc
|
||||
release-executable:
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: php:8.3
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
apt update -yqq
|
||||
apt install git libpq-dev libzip-dev zip make wget gnupg -yqq
|
||||
|
||||
- name: Install phive
|
||||
run: |
|
||||
wget -O phive.phar https://phar.io/releases/phive.phar
|
||||
wget -O phive.phar.asc https://phar.io/releases/phive.phar.asc
|
||||
gpg --keyserver hkps://keys.openpgp.org --recv-keys 0x9D8A98B29B2D5D79
|
||||
gpg --verify phive.phar.asc phive.phar
|
||||
chmod +x phive.phar
|
||||
mv phive.phar /usr/local/bin/phive
|
||||
|
||||
- name: Install phab
|
||||
run: |
|
||||
phive install phpab --global --trust-gpg-keys 0x2A8299CE842DD38C
|
||||
|
||||
- name: Install latest version of NCC
|
||||
run: |
|
||||
git clone https://git.n64.cc/nosial/ncc.git
|
||||
cd ncc
|
||||
make redist
|
||||
NCC_DIR=$(find build/ -type d -name "ncc_*" | head -n 1)
|
||||
if [ -z "$NCC_DIR" ]; then
|
||||
echo "NCC build directory not found"
|
||||
exit 1
|
||||
fi
|
||||
php "$NCC_DIR/INSTALL" --auto
|
||||
cd .. && rm -rf ncc
|
||||
|
||||
- name: Build project
|
||||
run: |
|
||||
ncc build --config release-executable --build-source --log-level debug
|
||||
|
||||
- name: Upload build artifact
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: release-executable
|
||||
path: build/release/release_executable_gz
|
||||
|
||||
|
||||
# Checking for phpunit.xml
|
||||
check-phpunit:
|
||||
runs-on: ubuntu-latest
|
||||
outputs:
|
||||
phpunit-exists: ${{ steps.check.outputs.phpunit-exists }}
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
- name: Check for phpunit.xml
|
||||
id: check
|
||||
run: |
|
||||
if [ -f phpunit.xml ]; then
|
||||
echo "phpunit-exists=true" >> $GITHUB_OUTPUT
|
||||
else
|
||||
echo "phpunit-exists=false" >> $GITHUB_OUTPUT
|
||||
fi
|
||||
# Checking for phpdoc.dist.xml
|
||||
check-phpdoc:
|
||||
runs-on: ubuntu-latest
|
||||
outputs:
|
||||
phpdoc-exists: ${{ steps.check.outputs.phpdoc-exists }}
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
- name: Check for phpdoc.dist.xml
|
||||
id: check
|
||||
run: |
|
||||
if [ -f phpdoc.dist.xml ]; then
|
||||
echo "phpdoc-exists=true" >> $GITHUB_OUTPUT
|
||||
else
|
||||
echo "phpdoc-exists=false" >> $GITHUB_OUTPUT
|
||||
fi
|
||||
generate-phpdoc:
|
||||
needs: [release, check-phpdoc]
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: php:8.3
|
||||
if: needs.check-phpdoc.outputs.phpdoc-exists == 'true'
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
apt update -yqq
|
||||
apt install git libpq-dev libzip-dev zip make wget gnupg -yqq
|
||||
|
||||
- name: Download PHPDocumentor
|
||||
run: |
|
||||
wget https://phpdoc.org/phpDocumentor.phar
|
||||
chmod +x phpDocumentor.phar
|
||||
|
||||
- name: Generate PHPDoc
|
||||
run: |
|
||||
php phpDocumentor.phar -d src -t docs
|
||||
|
||||
- name: Archive PHPDoc
|
||||
run: |
|
||||
zip -r docs.zip docs
|
||||
|
||||
- name: Upload PHPDoc
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: documentation
|
||||
path: docs.zip
|
||||
|
||||
test:
|
||||
needs: [release, release-executable, check-phpunit]
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: php:8.3
|
||||
if: needs.check-phpunit.outputs.phpunit-exists == 'true'
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Download build artifacts
|
||||
uses: actions/download-artifact@v4
|
||||
with:
|
||||
name: release
|
||||
path: release
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
apt update -yqq
|
||||
apt install git libpq-dev libzip-dev zip make wget gnupg -yqq
|
||||
curl -sSLf -o /usr/local/bin/install-php-extensions https://github.com/mlocati/docker-php-extension-installer/releases/latest/download/install-php-extensions
|
||||
chmod +x /usr/local/bin/install-php-extensions
|
||||
install-php-extensions zip
|
||||
|
||||
- name: Install phive
|
||||
run: |
|
||||
wget -O phive.phar https://phar.io/releases/phive.phar
|
||||
wget -O phive.phar.asc https://phar.io/releases/phive.phar.asc
|
||||
gpg --keyserver hkps://keys.openpgp.org --recv-keys 0x9D8A98B29B2D5D79
|
||||
gpg --verify phive.phar.asc phive.phar
|
||||
chmod +x phive.phar
|
||||
mv phive.phar /usr/local/bin/phive
|
||||
|
||||
- name: Install phab
|
||||
run: |
|
||||
phive install phpab --global --trust-gpg-keys 0x2A8299CE842DD38C
|
||||
|
||||
- name: Install latest version of NCC
|
||||
run: |
|
||||
git clone https://git.n64.cc/nosial/ncc.git
|
||||
cd ncc
|
||||
make redist
|
||||
NCC_DIR=$(find build/ -type d -name "ncc_*" | head -n 1)
|
||||
if [ -z "$NCC_DIR" ]; then
|
||||
echo "NCC build directory not found"
|
||||
exit 1
|
||||
fi
|
||||
php "$NCC_DIR/INSTALL" --auto
|
||||
cd .. && rm -rf ncc
|
||||
|
||||
- name: Install NCC packages
|
||||
run: |
|
||||
ncc package install --package="release/net.nosial.optslib.ncc" --build-source --reinstall -y --log-level debug
|
||||
|
||||
- name: Run PHPUnit tests
|
||||
run: |
|
||||
wget https://phar.phpunit.de/phpunit-11.3.phar
|
||||
php phpunit-11.3.phar --configuration phpunit.xml --log-junit reports/junit.xml --log-teamcity reports/teamcity --testdox-html reports/testdox.html --testdox-text reports/testdox.txt
|
||||
|
||||
- name: Upload test reports
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: reports
|
||||
path: reports
|
||||
|
||||
|
||||
release-documentation:
|
||||
needs: generate-phpdoc
|
||||
permissions: write-all
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: php:8.3
|
||||
if: github.event_name == 'release'
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Download documentation artifact
|
||||
uses: actions/download-artifact@v4
|
||||
with:
|
||||
name: documentation
|
||||
path: documentation
|
||||
|
||||
- name: Upload documentation artifact
|
||||
uses: softprops/action-gh-release@v1
|
||||
with:
|
||||
files: |
|
||||
documentation/*
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
|
||||
release-artifacts:
|
||||
needs: [release, release-executable]
|
||||
permissions: write-all
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: php:8.3
|
||||
if: github.event_name == 'release'
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Download release artifact
|
||||
uses: actions/download-artifact@v4
|
||||
with:
|
||||
name: release
|
||||
path: release
|
||||
- name: Upload release artifact to release
|
||||
uses: softprops/action-gh-release@v1
|
||||
with:
|
||||
files: |
|
||||
release/*
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
- name: Download release-executable artifact
|
||||
uses: actions/download-artifact@v4
|
||||
with:
|
||||
name: release-executable
|
||||
path: release-executable
|
||||
- name: Upload release-executable artifact to release
|
||||
uses: softprops/action-gh-release@v1
|
||||
with:
|
||||
files: |
|
||||
release-executable/*
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
6
.gitignore
vendored
6
.gitignore
vendored
|
@ -1 +1,5 @@
|
|||
build/
|
||||
build/
|
||||
/.idea/gbrowser_project.xml
|
||||
|
||||
/.phpunit.result.cache
|
||||
/.idea/php-test-framework.xml
|
||||
|
|
7
.idea/php.xml
generated
7
.idea/php.xml
generated
|
@ -14,12 +14,17 @@
|
|||
<path value="/usr/share/php" />
|
||||
</include_path>
|
||||
</component>
|
||||
<component name="PhpProjectSharedConfiguration" php_language_level="7.1">
|
||||
<component name="PhpProjectSharedConfiguration" php_language_level="8.3">
|
||||
<option name="suggestChangeDefaultLanguageLevel" value="false" />
|
||||
</component>
|
||||
<component name="PhpStanOptionsConfiguration">
|
||||
<option name="transferred" value="true" />
|
||||
</component>
|
||||
<component name="PhpUnit">
|
||||
<phpunit_settings>
|
||||
<PhpUnitSettings load_method="PHPUNIT_PHAR" custom_loader_path="" phpunit_phar_path="$USER_HOME$/phpunit.phar" />
|
||||
</phpunit_settings>
|
||||
</component>
|
||||
<component name="PsalmOptionsConfiguration">
|
||||
<option name="transferred" value="true" />
|
||||
</component>
|
||||
|
|
25
CHANGELOG.md
25
CHANGELOG.md
|
@ -5,6 +5,30 @@ All notable changes to this project will be documented in this file.
|
|||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
## [1.1.3] - 2024-10-29
|
||||
|
||||
This update introduces a critical bug fix
|
||||
|
||||
### Fixed
|
||||
- Fixed issue where if global $argv is not available, a check to see if `$_SERVER['argv']` is set
|
||||
before accessing it due to a potential 'undefined' error.
|
||||
|
||||
|
||||
## [1.1.2] - 2024-10-13
|
||||
|
||||
Updated Build System
|
||||
|
||||
|
||||
## [1.1.1] - 2024-09-24
|
||||
|
||||
Updated OptsLib to work with php 8.3+ & ncc 2.1.0+
|
||||
|
||||
### Changed
|
||||
- Introduced typed properties to OptsLib
|
||||
|
||||
### Fixed
|
||||
- Fixed code-smell from OptsLib
|
||||
|
||||
|
||||
|
||||
## [1.1.0] - 2023-10-10
|
||||
|
@ -12,7 +36,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
Updated optslib to work with ncc 2.+.
|
||||
|
||||
### Fixed
|
||||
|
||||
- Fixed code-smell from optslib.
|
||||
|
||||
|
||||
|
|
34
Makefile
34
Makefile
|
@ -1,27 +1,25 @@
|
|||
# Variables
|
||||
NCC = ncc
|
||||
PACKAGE_NAME = net.nosial.optslib.ncc
|
||||
BUILD_CONFIG = release
|
||||
DEFAULT_CONFIGURATION ?= release
|
||||
LOG_LEVEL = debug
|
||||
|
||||
# Directories
|
||||
SRC_DIR = src
|
||||
BUILD_DIR = build/$(BUILD_CONFIG)
|
||||
# Default Target
|
||||
all: release release-executable
|
||||
|
||||
.PHONY: all release install uninstall clean
|
||||
# Build Steps
|
||||
release:
|
||||
ncc build --config=release --log-level $(LOG_LEVEL)
|
||||
release-executable:
|
||||
ncc build --config=release-executable --log-level $(LOG_LEVEL)
|
||||
|
||||
all: release install
|
||||
|
||||
release: prepare_build
|
||||
$(NCC) build --config=$(BUILD_CONFIG)
|
||||
install: release
|
||||
ncc package install --package=build/release/net.nosial.optslib.ncc --skip-dependencies --build-source --reinstall -y --log-level $(LOG_LEVEL)
|
||||
|
||||
install: prepare_build
|
||||
$(NCC) package install --package="$(BUILD_DIR)/$(PACKAGE_NAME)" --skip-dependencies -y
|
||||
|
||||
uninstall:
|
||||
$(NCC) package uninstall -y --package="$(PACKAGE_NAME)"
|
||||
test: release
|
||||
[ -f phpunit.xml ] || { echo "phpunit.xml not found"; exit 1; }
|
||||
phpunit
|
||||
|
||||
clean:
|
||||
rm -rf $(BUILD_DIR)
|
||||
rm -rf build
|
||||
|
||||
prepare_build:
|
||||
mkdir -p $(BUILD_DIR)
|
||||
.PHONY: all install test clean release release-executable
|
33
README.md
33
README.md
|
@ -2,13 +2,29 @@
|
|||
|
||||
A basic Options parser and command-line arguments handling a library for PHP.
|
||||
|
||||
## Community
|
||||
|
||||
This project and many others from Nosial are available on multiple publicly available and free git repositories at
|
||||
|
||||
- [n64](https://git.n64.cc/nosial/optslib)
|
||||
- [GitHub](https://github.com/nosial/optslib)
|
||||
- [Codeberg](https://codeberg.org/nosial/optslib)
|
||||
|
||||
Issues & Pull Requests are frequently checked and to be referenced accordingly in commits and changes, Nosial remains
|
||||
dedicated to keep these repositories up to date when possible.
|
||||
|
||||
For questions & discussions see the public Telegram community at [@NosialDiscussions](https://t.me/NosialDiscussions).
|
||||
We do encourage community support and discussions, please be respectful and follow the rules of the community.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
<!-- TOC -->
|
||||
* [OptsLib](#optslib)
|
||||
* [Community](#community)
|
||||
* [Table of Contents](#table-of-contents)
|
||||
* [Installation](#installation)
|
||||
* [Compiling from source](#compiling-from-source)
|
||||
* [Testing](#testing)
|
||||
* [Usage](#usage)
|
||||
* [parseArgument()](#parseargument)
|
||||
* [getArguments()](#getarguments)
|
||||
|
@ -26,7 +42,11 @@ A basic Options parser and command-line arguments handling a library for PHP.
|
|||
The library can be installed using ncc:
|
||||
|
||||
```bash
|
||||
ncc install -p "nosial/libs.opts=latest@n64"
|
||||
# n64
|
||||
ncc package install -p "nosial/libs.opts=latest@n64"
|
||||
|
||||
# github
|
||||
ncc package install -p "nosial/libs.opts=latest@github"
|
||||
```
|
||||
|
||||
or by adding the following to your project.json file under
|
||||
|
@ -36,6 +56,7 @@ the `build.dependencies` section:
|
|||
{
|
||||
"name": "net.nosial.optslib",
|
||||
"version": "latest",
|
||||
"source_type": "remote",
|
||||
"source": "nosial/libs.opts=latest@n64"
|
||||
}
|
||||
```
|
||||
|
@ -61,6 +82,16 @@ or by running the following command:
|
|||
make release
|
||||
```
|
||||
|
||||
## Testing
|
||||
|
||||
The library can be tested using PhpUnit with the `phpunit.xml` file that is already included in the repository.
|
||||
This requires that you have PhpUnit installed & the library has been compiled and installed on the local system.
|
||||
|
||||
```bash
|
||||
phpunit
|
||||
```
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
The usage of this library is very simple, there are
|
||||
|
|
3
bootstrap.php
Normal file
3
bootstrap.php
Normal file
|
@ -0,0 +1,3 @@
|
|||
<?php
|
||||
require 'ncc';
|
||||
import('net.nosial.optslib');
|
15
phpdoc.dist.xml
Normal file
15
phpdoc.dist.xml
Normal file
|
@ -0,0 +1,15 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<phpdocumentor configVersion="3" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://www.phpdoc.org" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/phpDocumentor/phpDocumentor/master/data/xsd/phpdoc.xsd">
|
||||
<paths>
|
||||
<output>build/docs</output>
|
||||
<cache>build/cache</cache>
|
||||
</paths>
|
||||
<version number="latest">
|
||||
<api>
|
||||
<source dsn=".">
|
||||
<path>src/OptsLib</path>
|
||||
</source>
|
||||
<default-package-name>OptsLib</default-package-name>
|
||||
</api>
|
||||
</version>
|
||||
</phpdocumentor>
|
11
phpunit.xml
Normal file
11
phpunit.xml
Normal file
|
@ -0,0 +1,11 @@
|
|||
<phpunit bootstrap="bootstrap.php">
|
||||
<testsuites>
|
||||
<testsuite name="OptsLib Test Suite">
|
||||
<directory>tests</directory>
|
||||
</testsuite>
|
||||
</testsuites>
|
||||
<php>
|
||||
<ini name="error_reporting" value="-1"/>
|
||||
<server name="KERNEL_DIR" value="app/"/>
|
||||
</php>
|
||||
</phpunit>
|
16
project.json
16
project.json
|
@ -2,8 +2,8 @@
|
|||
"project": {
|
||||
"compiler": {
|
||||
"extension": "php",
|
||||
"minimum_version": "8.0",
|
||||
"maximum_version": "8.2"
|
||||
"minimum_version": "8.2",
|
||||
"maximum_version": "8.0"
|
||||
},
|
||||
"update_source": {
|
||||
"source": "nosial/libs.opts@n64",
|
||||
|
@ -18,9 +18,9 @@
|
|||
"assembly": {
|
||||
"name": "OptsLib",
|
||||
"package": "net.nosial.optslib",
|
||||
"copyright": "Copyright (c) 2022-2023 Nosial",
|
||||
"description": "A simple options parser library for PHP",
|
||||
"version": "1.1.0",
|
||||
"copyright": "Copyright (c) 2022-2023 Nosial",
|
||||
"version": "1.1.3",
|
||||
"uuid": "20aefdfa-7b91-11ed-919f-cb63712c8e36"
|
||||
},
|
||||
"build": {
|
||||
|
@ -31,6 +31,14 @@
|
|||
"name": "release",
|
||||
"build_type": "ncc",
|
||||
"output": "build/release/%ASSEMBLY.PACKAGE%.ncc"
|
||||
},
|
||||
{
|
||||
"name": "release-executable",
|
||||
"build_type": "executable",
|
||||
"output": "build/release/release_executable_gz",
|
||||
"options": {
|
||||
"ncc_configuration": "release"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
|
@ -26,77 +26,79 @@
|
|||
*
|
||||
* @var string
|
||||
*/
|
||||
private static $regex = "/(?(?=-)-(?(?=-)-(?'bigflag'[^\\s=]+)|(?'smallflag'\\S))(?:\\s*=\\s*|\\s+)(?(?!-)(?(?=[\\\"\\'])((?<![\\\\])['\"])(?'string'(?:.(?!(?<![\\\\])\\3))*.?)\\3|(?'value'\\S+)))(?:\\s+)?|(?'unmatched'\\S+))/";
|
||||
private static string $regex = "/(?(?=-)-(?(?=-)-(?'bigflag'[^\\s=]+)|(?'smallflag'\\S))(?:\\s*=\\s*|\\s+)(?(?!-)(?(?=[\\\"\\'])((?<![\\\\])['\"])(?'string'(?:.(?!(?<![\\\\])\\3))*.?)\\3|(?'value'\\S+)))(?:\\s+)?|(?'unmatched'\\S+))/";
|
||||
|
||||
/**
|
||||
* Cache of the parsed arguments. This is used to prevent the arguments from being parsed more than once.
|
||||
*
|
||||
* @var array
|
||||
* @var array|null
|
||||
*/
|
||||
private static $args_cache;
|
||||
private static ?array $args_cache = null;
|
||||
|
||||
/**
|
||||
* Parses the input arguments into an array of flags and values
|
||||
*
|
||||
* @param string|array $input array The input arguments
|
||||
* @param array|string|null $input array The input arguments
|
||||
* @param int $max_arguments The maximum number of arguments to parse
|
||||
* @return array The parsed arguments
|
||||
*/
|
||||
public static function parseArgument($input, int $max_arguments=1000): array
|
||||
public static function parseArgument(array|string|null $input, int $max_arguments = 1000): array
|
||||
{
|
||||
$flags = '';
|
||||
|
||||
if (is_string($input))
|
||||
{
|
||||
$flags = $input;
|
||||
}
|
||||
elseif(is_array($input))
|
||||
elseif (is_array($input))
|
||||
{
|
||||
$flags = implode(' ', $input);
|
||||
}
|
||||
else
|
||||
{
|
||||
global $argv;
|
||||
if(isset($argv) && count($argv) > 1)
|
||||
if (isset($argv) && count($argv) > 1)
|
||||
{
|
||||
array_shift($argv);
|
||||
$flags = implode(' ', $argv);
|
||||
}
|
||||
$flags = implode(' ', $argv);
|
||||
}
|
||||
|
||||
$configs = array();
|
||||
$configs = [];
|
||||
|
||||
// Assuming self::$regex is always defined and valid
|
||||
preg_match_all(self::$regex, $flags, $matches, PREG_SET_ORDER);
|
||||
|
||||
foreach ($matches as $index => $match)
|
||||
{
|
||||
if(isset($match['value']) && $match['value'] !== '')
|
||||
$value = true;
|
||||
|
||||
if (!empty($match['value']))
|
||||
{
|
||||
$value = $match['value'];
|
||||
}
|
||||
elseif(isset($match['string']) && $match['string'] !== '')
|
||||
elseif (!empty($match['string']))
|
||||
{
|
||||
// fix escaped quotes
|
||||
$value = str_replace(["\\\"", "\\'"], ["\"", "'"], $match['string']);
|
||||
}
|
||||
else
|
||||
{
|
||||
$value = true;
|
||||
}
|
||||
|
||||
if(isset($match['bigflag']) && $match['bigflag'] !== '')
|
||||
if (!empty($match['bigflag']))
|
||||
{
|
||||
$configs[$match['bigflag']] = $value;
|
||||
}
|
||||
|
||||
if(isset($match['smallflag']) && $match['smallflag'] !== '')
|
||||
if (!empty($match['smallflag']))
|
||||
{
|
||||
$configs[$match['smallflag']] = $value;
|
||||
}
|
||||
|
||||
if(isset($match['unmatched']) && $match['unmatched'] !== '')
|
||||
if (!empty($match['unmatched']))
|
||||
{
|
||||
$configs[$match['unmatched']] = true;
|
||||
}
|
||||
|
||||
if($index >= $max_arguments)
|
||||
if ($index >= $max_arguments)
|
||||
{
|
||||
break;
|
||||
}
|
||||
|
@ -115,21 +117,18 @@
|
|||
{
|
||||
global $argv;
|
||||
|
||||
if($argv === null)
|
||||
if($argv === null && isset($_SERVER['argv']))
|
||||
{
|
||||
$argv = $_SERVER['argv'];
|
||||
}
|
||||
|
||||
if(self::$args_cache === null)
|
||||
{
|
||||
self::$args_cache = [];
|
||||
if(isset($argv))
|
||||
{
|
||||
self::$args_cache = self::parseArgument($argv);
|
||||
}
|
||||
else
|
||||
{
|
||||
self::$args_cache = [];
|
||||
}
|
||||
}
|
||||
|
||||
if($after === null)
|
||||
|
@ -138,7 +137,6 @@
|
|||
}
|
||||
|
||||
$after_index = array_search($after, array_keys(self::$args_cache), true);
|
||||
|
||||
if($after_index === false)
|
||||
{
|
||||
return [];
|
||||
|
|
70
tests/OptsLib/ParseTest.php
Normal file
70
tests/OptsLib/ParseTest.php
Normal file
|
@ -0,0 +1,70 @@
|
|||
<?php
|
||||
|
||||
namespace OptsLib;
|
||||
|
||||
use PHPUnit\Framework\TestCase;
|
||||
|
||||
class ParseTest extends TestCase
|
||||
{
|
||||
/**
|
||||
* Testing parseArgument method when input is a string type, also testing different flag pattern
|
||||
*/
|
||||
public function testParseArgumentWithStringInput()
|
||||
{
|
||||
$input = '--flag1=value1 -f value2 unmatched_string';
|
||||
$expected_result = [
|
||||
'flag1' => 'value1',
|
||||
'f' => 'value2',
|
||||
'unmatched_string' => true,
|
||||
];
|
||||
|
||||
$this->assertEquals($expected_result, Parse::parseArgument($input));
|
||||
}
|
||||
|
||||
/**
|
||||
* Testing parseArgument method when input is an array type
|
||||
*/
|
||||
public function testParseArgumentWithArrayInput()
|
||||
{
|
||||
// Array argument will be transformed into '--flag1 value1 "-"f" value2" unmatched_string'
|
||||
$input = ['--flag1', 'value1', '-', 'f', 'value2', 'unmatched_string'];
|
||||
$expected_result = [
|
||||
'flag1' => 'value1',
|
||||
'unmatched_string' => true,
|
||||
'f' => true,
|
||||
'value2' => true
|
||||
];
|
||||
|
||||
$this->assertEquals($expected_result, Parse::parseArgument($input));
|
||||
}
|
||||
|
||||
/**
|
||||
* Testing parseArgument method when input contains escaped quotes in a string argument
|
||||
*/
|
||||
public function testParseArgumentWithEscapedQuotes()
|
||||
{
|
||||
$input = "--flag1=\"value1 with some \\\"escaped quotes\\\"\" -f 'value2 with some \\'escaped quotes\\'' unmatched_string";
|
||||
$expected_result = [
|
||||
'flag1' => 'value1 with some "escaped quotes"',
|
||||
'f' => 'value2 with some \'escaped quotes\'',
|
||||
'unmatched_string' => true,
|
||||
];
|
||||
|
||||
$this->assertEquals($expected_result, Parse::parseArgument($input));
|
||||
}
|
||||
|
||||
/**
|
||||
* Testing parseArgument method only takes maximum number of arguments specified
|
||||
*/
|
||||
public function testParseArgumentWithMaxArguments()
|
||||
{
|
||||
$input = '--flag1=value1 -f value2 unmatched_string1 unmatched_string2';
|
||||
$expected_result = [
|
||||
'flag1' => 'value1',
|
||||
'f' => 'value2',
|
||||
'unmatched_string1' => true
|
||||
]; // It should only parse maximum 3 arguments
|
||||
|
||||
$this->assertEquals($expected_result, Parse::parseArgument($input, 2));
|
||||
}
|
||||
}
|
|
@ -1,10 +0,0 @@
|
|||
<?php
|
||||
|
||||
require 'ncc';
|
||||
import('net.nosial.optslib', 'latest');
|
||||
|
||||
$parse = \OptsLib\Parse::getArguments();
|
||||
var_dump($parse);
|
||||
|
||||
$parse = \OptsLib\Parse::getArguments('exec');
|
||||
var_dump($parse);
|
|
@ -1,7 +0,0 @@
|
|||
<?php
|
||||
|
||||
require 'ncc';
|
||||
import('net.nosial.optslib', 'latest');
|
||||
|
||||
$parse = \OptsLib\Parse::parseArgument('test --foo=bar --baz=qux --quux --corge --grault=garply --waldo --fred --plugh --xyzzy --thud');
|
||||
var_dump($parse);
|
Loading…
Add table
Reference in a new issue