V5 (whikloj#69)

* Add workflow for version 4 development (whikloj#59)

* Remove support of PHP < 8.0 (whikloj#58)

* Remove support of PHP < 8.0

* More changes

* Add version 5 action

* More PHP 8 and phpstan fixes (whikloj#62)

* Add Tag Files functions (whikloj#65)

* Add addTagFile()

* Add removeTagFile and tests

* Build pushed feature branches

* Update action versions

* Fix messages

* Cover the new private function shared by addTagFile and removeTagFile

* Change bag to extended when adding a fetch file (whikloj#66)

* Add BagProfile (whikloj#67)

* Initial BagItProfile work

* More testing

* More tests

* Track serializations

* Load and validate profiles

* Return file path in archive type exception

* Windows test

* Clean up extension handling

* Add more profile tests

* Fixes and more profile tests

* Always check for Allow-Fetch before Require-Fetch, so the reverse test is unnecessary

* Fix callable in array_filter

* Move json into tests

* More tests

* Add methods to add profile to bag and some tests

* Allow other bag-info tag options

* Test bag is valid before creating a package

* Read BagIt Profile identifiers from bag-info.txt and validate

Additional tests

Handle long lines without a space to break at

* Add a change log

* Some tidying

* Correct PIPEWAIT and add test for trait

* Build on push and allow manual runs

* Clean up for PHPStan level 7 (whikloj#68)

* Clean up for PHPStan level 7

* Clean up some testing

* Prep for v5 merge

* Revert "Prep for v5 merge"

This reverts commit bd2b380.

Author: whikloj

.github/workflows/v5.yml

@@ -0,0 +1,80 @@
+name: Build version 5 development
+
+on:
+  pull_request:
+    branches:
+      - "v5"
+  push:
+    branches:
+      - "v5"
+      - "feature/v5/*"
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ${{ matrix.host-os }}
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        php-versions: ["8.0", "8.1", "8.2", "8.3"]
+        host-os: ["ubuntu-latest", "windows-latest"]
+        experimental: [false]
+
+    name: PHP ${{ matrix.php-versions }} - OS ${{ matrix.host-os }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-versions }}
+          coverage: none
+          extensions: sockets, intl, bz2, zip
+
+      - name: Get composer cache directory (Ubuntu)
+        id: composercache-ubuntu
+        run: |
+          echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+        if: ${{ startsWith( matrix.host-os , 'ubuntu') }}
+
+      - name: Cache dependencies (Ubuntu)
+        uses: actions/cache@v4
+        with:
+          path: ${{ steps.composercache-ubuntu.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-composer-
+        if: ${{ startsWith( matrix.host-os , 'ubuntu') }}
+
+      - name: Get composer cache directory (Windows)
+        id: composercache-windows
+        run: |
+          echo "dir=$(composer config cache-files-dir)" >> $env:GITHUB_OUTPUT
+        if: ${{ startsWith( matrix.host-os , 'windows') }}
+
+      - name: Cache dependencies (Windows)
+        uses: actions/cache@v4
+        with:
+          path: ${{ steps.composercache-windows.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-composer-
+        if: ${{ startsWith( matrix.host-os , 'windows') }}
+
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-progress
+
+      - name: Check codestyle
+        run: composer check
+
+      - name: Run test suite
+        run: composer phpunit
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          file: ./clover.xml
+          fail_ci_if_error: true
+          token: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -2,3 +2,4 @@
 vendor/
 clover.xml
 mytracedir/
+.phpunit.result.cache

CHANGELOG.md

@@ -0,0 +1,44 @@
+# Change Log
+
+The purpose of this document is to provide a list of changes included in a release under the covers that
+may have an impact on the user. This is not a comprehensive list of all changes, but hopefully catches most and 
+provides a reasoning for the changes.
+
+## v5.0.0
+
+### Added
+
+#### BagIt Profile support. 
+     
+You can now add BagIt Profile(s) to a newly created bag and/or they will be downloaded and parsed when validating an
+existing bag, assuming the profile is available at the URL specified in the bag-info.txt file.
+  
+Profiles are validated against the [BagIt Profile Specification (v1.4.0)](https://bagit-profiles.github.io/bagit-profiles-specification/)
+and profile rules are enforced when validating a bag (`$bag->isValid()`) and any errors are displayed in the `$bag->getErrors()` array.
+
+To add a profile to a bag you can use either:
+- `$bag->addProfileByJson($jsonString)` - To add a profile from a JSON string.
+- `$bag->addProfileByURL($url)` - To add a profile from a URL.
+
+Profiles are stored internally using their `BagIt-Profile-Identifier` as a key. You can only add a profile once
+per identifier. If you try to add a profile with the same identifier it will be ignored.
+
+To remove a profile you can use `$bag->removeBagProfile($profileIdentifier)` to remove a profile.
+
+You can also use `$bag->clearAllProfiles()` to remove all profiles from a bag.
+
+#### Package command validates the bag
+
+Previous versions allowed you to package without validating the bag. Now the package command will validate the bag
+before packaging. If the bag is not valid the package command will fail with a `BagItException::class` being thrown.
+
+This is due to the addition of BagIt Profile support, if you add a profile to a bag we want to ensure you do not package
+an invalid bag.
+
+TODO: Validate the serialization being attempted during package validation.
+
+### Removed
+
+#### PHP 7 Support
+
+This library now requires PHP 8.0 or higher, while PHP 8.0 is already end of life we will support it for the time being.

README.md

@@ -1,7 +1,7 @@
 # BagItTools
 
-[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%207.4-8892BF.svg?style=flat-square)](https://php.net/)
-[![Github Actions](https://github.com/whikloj/BagItTools/workflows/Build/badge.svg?branch=main)](https://github.com/whikloj/BagItTools/actions?query=workflow%3A%22Build%22+branch%3Amain)
+[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%208.0-8892BF.svg?style=flat-square)](https://php.net/)
+[![Github Actions](https://github.com/whikloj/BagItTools/actions/workflows/main.yml/badge.svg)](https://github.com/whikloj/BagItTools/actions/workflows/main.yml)
 [![LICENSE](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](./LICENSE)
 [![codecov](https://codecov.io/gh/whikloj/BagItTools/branch/main/graph/badge.svg)](https://codecov.io/gh/whikloj/BagItTools)
 
@@ -26,6 +26,8 @@ Features:
 * Create an archive (zip, tar, tar.gz, tgz, tar.bz2)
 * In-place upgrade of bag from v0.97 to v1.0
 
+## [Change Log](./CHANGELOG.md)
+
 ## Installation
 
 **Composer**
@@ -169,12 +171,33 @@ if ($bag->hasBagInfoTag('contact-name')) {
     $bag->removeBagInfoTag('contact-name');
 }
 
-// Write bagit support files (manifests, bag-info, etc)
-$bag->update();
-
 // Write the bag to the specified path and filename using the expected archiving method.
 $bag->package('./archive.tar.bz2');
+```
+
+#### Using a BagIt Profile
+```php
+require_once './vendor/autoload.php';
+
+use \whikloj\BagItTools\Bag;
+
+$dir = "./newbag";
+
+// Create new bag as directory $dir
+$bag = Bag::create($dir);
+// Add a profile by URL
+$bag->addBagProfileByURL("https://some.example.com/bagit-profile.json");
+// or add a profile by JSON
+$bag->addBagProfileByJson(file_get_contents("path/to/bagit-profile.json"));
+
+// Add a file
+$bag->addFile('../README.md', 'data/documentation/myreadme.md');
+
+// Add another algorithm
+$bag->addAlgorithm('sha1');
 
+// Write the bag to the specified path and filename using the expected archiving method.
+$bag->package('./archive.tar.bz2');
 ```
 
 ## Maintainer
@@ -184,9 +207,3 @@ $bag->package('./archive.tar.bz2');
 ## License
 
 [MIT](./LICENSE)
-
-## Development
-
-To-Do:
-
-* CLI interface to handle simple bag CRUD (CReate/Update/Delete) functions.

composer.json

@@ -14,16 +14,15 @@
   ],
   "require": {
     "pear/archive_tar": "^1.4.14",
-    "php": ">=7.4",
+    "php": ">=8.0",
     "ext-curl": "*",
     "ext-zip": "*",
     "ext-mbstring": "*",
     "ext-intl": "*",
     "symfony/console": "^5.4"
   },
   "require-dev": {
-    "phpunit/phpunit": "^9.0",
-    "sebastian/phpcpd": "^6.0",
+    "phpunit/phpunit": "^9.6",
     "squizlabs/php_codesniffer": "^3.5",
     "donatj/mock-webserver": "^2.6",
     "phpstan/phpstan": "^1.4"
@@ -40,21 +39,21 @@
   },
   "scripts": {
     "phpstan": [
-      "php -d memory_limit=-1 ./vendor/bin/phpstan analyze -l 3 src tests"
+      "php -d memory_limit=-1 ./vendor/bin/phpstan analyze -l 7 src tests"
     ],
     "profile": [
       "php -d xdebug.mode=profile -d xdebug.output_dir=mytracedir/ -d xdebug.start_with_request=yes -d xdebug.use_compression=true ./vendor/bin/phpunit"
     ],
     "check": [
-      "./vendor/bin/phpcs --standard=PSR12 src tests",
-      "./vendor/bin/phpcpd --suffix='.php' src"
+      "./vendor/bin/phpcs --standard=PSR12 src tests"
     ],
     "phpunit": [
-      "phpdbg -qrr ./vendor/bin/phpunit -d memory_limit=-1 --testsuite BagIt"
+      "phpdbg -qrr ./vendor/bin/phpunit -d memory_limit=-1 --verbose --testsuite BagIt"
     ],
     "test": [
       "@check",
-      "@phpunit"
+      "@phpunit",
+      "@phpstan"
     ]
   },
   "config": {