feat[indexes]: Add support for inverted indexes (#20)

* fix: use 'sprintf' instead of string interpolation

* drop tests for arango 3.11 and add tests with PHP 8.4

* Update php.yml

* Update dependencies

* composer update + composer bump

* Small refactor on AQL namespace

* update .gitignore

* fix code sniffs

* Http namespace refactor

* update dev dependencies

* refactor: ODM tests

* refactor: PSR12 code fix for tests

* refactor: PSR12 code fix for src/

* chore: remove obsolete collection properties (#14)

* Improved validation for collection key options (#15)

* improve Collection 'keyOptions' attribute validation

* refactor 'KeyType' class

* fix exception attribute type

* drop support for PHP 8.2

* remove uses of 'print_r' (#16)

* Drop noop method 'load' for Collections (#17)

* small refactors for Cursor namespace

* drop no-op collection method 'load'

* refactor AQLFunction exception handling

* small refactors for AQL namespace

* remove unused exception'

* remove unused variables

* small refactor on Graph namespace

* refactors on Transaction namespace

* one more round of small fixes

* refactor array list

* add make file with test, lint and static analyzer helpers

* chore[PHP-8.4]: Handle php 8.4 deprecations (#18)

* chore[php-8.4]: handle php 8.4 deprecations

* chore[php-8.4]: revert enforcing strict type on 'Admin\Task\Task::'

* feat[index]: Add support for inverted indexes (#19)

* feat[inverted-index]: strict typing for base index class

* chore[indexes]: deprecate 'hash' and 'skiplist' index types

* feat[indexes]: base implementation for 'inverted' index

* tests[indexes]: remove ununsed imports

* tests[indexes]: add tests for inverted index

* feat[indexes]: add inverted index implementation

* chore[documentation]: update existing docs

Author: lucassouzavieira

.github/workflows/php.yml

@@ -24,8 +24,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php-versions: ["8.2", "8.3", "8.4"]
-
+        php-versions: ["8.3", "8.4"]
     steps:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2

.gitignore

@@ -11,9 +11,6 @@ coverage.xml
 *.phar
 .phpactor.json
 
-# Ignore documentation generation script
-documentation.php
-
 # Removed from dist package
 /docs               export-ignore
 /tests              export-ignore
@@ -22,3 +19,6 @@ documentation.php
 /.gitignore         export-ignore
 /.travis.yml        export-ignore
 /phpunit.xml        export-ignore
+/phpdoc.dist.xml    export-ignore
+/phpcs.xml          export-ignore
+/Makefile           export-ignore

Makefile

@@ -0,0 +1,18 @@
+ARANGODB_VERSION="3.12.5.2"
+env-up:
+	cp .env.testing .env
+	echo -e "\nARANGODB_VERSION=$(ARANGODB_VERSION)" >> .env
+	docker compose -f tests/compose.yaml up -d
+
+env-down:
+	docker compose -f tests/compose.yaml down -v
+	rm .env
+
+unittests:
+	vendor/bin/phpunit -c phpunit.xml
+
+format:
+	vendor/bin/php-cs-fixer fix src/ --rules=@PSR1,@PSR2,@PSR12 && vendor/bin/php-cs-fixer fix tests/ --rules=@PSR1,@PSR2,@PSR12
+
+analyze:
+	vendor/bin/phpstan --memory-limit=256M analyze src/

composer.json

@@ -19,7 +19,7 @@
     }
   ],
   "require": {
-    "php": ">=8.2",
+    "php": ">=8.3",
     "ext-json": "*",
     "guzzlehttp/guzzle": "^7.10",
     "symfony/service-contracts": "^3.6",
@@ -32,7 +32,8 @@
     "vlucas/phpdotenv": "^5.6.2",
     "phpunit/php-code-coverage": "^9.2.32",
     "friendsofphp/php-cs-fixer": "^3.88.2",
-    "squizlabs/php_codesniffer": "^3.13.4"
+    "squizlabs/php_codesniffer": "^3.13.4",
+    "phpstan/phpstan": "^2.1.31"
   },
   "autoload": {
     "psr-4": {

composer.lock

@@ -41,7 +41,7 @@
     --color-hue-brown:     16;
 
     /* Colors */
-    --primary-color-hue: var(--color-hue-red, --color-hue-phpdocumentor-green);
+    --primary-color-hue: var(--color-hue-phpdocumentor-green, --color-hue-phpdocumentor-green);
     --primary-color-saturation: 57%;
     --primary-color: hsl(var(--primary-color-hue), var(--primary-color-saturation), 60%);
     --primary-color-darken: hsl(var(--primary-color-hue), var(--primary-color-saturation), 40%);
@@ -99,6 +99,7 @@
 /* Base Styles
 -------------------------------------------------- */
 body {
+    background-color: #fff;
     color: var(--text-color);
     font-family: var(--font-primary);
     font-size: var(--text-md);
@@ -494,7 +495,7 @@ div.phpdocumentor-list > ul,
 ol.phpdocumentor-list,
 ul.phpdocumentor-list {
     margin-top: 0;
-    padding-left: var(--spacing-md);
+    padding-left: var(--spacing-lg);
     margin-bottom: var(--spacing-sm);
 }
 
@@ -1215,6 +1216,10 @@ is too big a fix and needs to be done in a new design iteration.
         word-break: break-all;
         line-height: normal;
     }
+
+    .phpdocumentor-on-this-page__content li.-deprecated {
+        text-decoration: line-through;
+    }
 }
 
 /* Used for screen readers and such */

docs/css/base.css

@@ -100,6 +100,7 @@
     display: block;
     font-size: var(--text-sm);
     border: 1px solid #f0f0f0;
+    margin-bottom: calc(var(--spacing-sm));
 }
 
 .phpdocumentor .phpdocumentor-signature.-deprecated .phpdocumentor-signature__name {
@@ -126,6 +127,10 @@
     flex: 0 1 auto;
 }
 
+.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry > a.-deprecated {
+    text-decoration: line-through;
+}
+
 .phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry > span {
     flex: 1;
     white-space: nowrap;
@@ -152,7 +157,7 @@
     width: 1.25rem;
     height: 1.25rem;
     line-height: 1.25rem;
-    background: transparent url('data:image/svg+xml;utf8,<svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><circle cx="10" cy="10" r="10" fill="hsl(    4, 57%, 60%)"/></svg>') no-repeat center center;
+    background: transparent url('data:image/svg+xml;utf8,<svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><circle cx="10" cy="10" r="10" fill="hsl(    96, 57%, 60%)"/></svg>') no-repeat center center;
     content: '';
     position: absolute;
     left: 0;
@@ -167,13 +172,13 @@
 .phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-method:before {
     content: 'M';
     color: '';
-    background-image: url('data:image/svg+xml;utf8,<svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><circle cx="10" cy="10" r="10" fill="hsl(    4, 57%, 60%)"/></svg>');
+    background-image: url('data:image/svg+xml;utf8,<svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><circle cx="10" cy="10" r="10" fill="hsl(    96, 57%, 60%)"/></svg>');
 }
 
 .phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-function:before {
     content: 'M';
-    color: '    4';
-    background-image: url('data:image/svg+xml;utf8,<svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><circle cx="10" cy="10" r="10" fill="hsl(    4, 57%, 60%)"/></svg>');
+    color: '    96';
+    background-image: url('data:image/svg+xml;utf8,<svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><circle cx="10" cy="10" r="10" fill="hsl(    96, 57%, 60%)"/></svg>');
 }
 
 .phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-property:before {
@@ -183,7 +188,7 @@
 .phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-constant:before {
     content: 'C';
     background-color: transparent;
-    background-image: url('data:image/svg+xml;utf8,<svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><rect x="-3.05176e-05" y="9.99998" width="14.1422" height="14.1422" transform="rotate(-45 -3.05176e-05 9.99998)" fill="hsl(    4, 57%, 60%)"/></svg>');
+    background-image: url('data:image/svg+xml;utf8,<svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><rect x="-3.05176e-05" y="9.99998" width="14.1422" height="14.1422" transform="rotate(-45 -3.05176e-05 9.99998)" fill="hsl(    96, 57%, 60%)"/></svg>');
 }
 
 .phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-class:before {
@@ -269,3 +274,6 @@
 .phpdocumentor-tag-link {
     margin-right: var(--spacing-sm);
 }
+.phpdocumentor-uml-diagram svg {
+    cursor: zoom-in;
+}