From b08fabdf0872f64e830016f9fbc9a34e6a9330d0 Mon Sep 17 00:00:00 2001 From: Ethan Date: Sun, 1 Nov 2026 07:07:10 +0200 Subject: [PATCH 1/6] docs: Update `BACKLOG.md` to add `Arrays` module planning --- meta/BACKLOG.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/meta/BACKLOG.md b/meta/BACKLOG.md index 7f94574..3e8e86a 100644 --- a/meta/BACKLOG.md +++ b/meta/BACKLOG.md @@ -1,5 +1,7 @@ # Feature Backlog +_Last Updated: 2026-11-01_ + - [ ] `TextFiles` Module - [ ] Log Parsing - [x] Log type counter @@ -8,3 +10,10 @@ - [ ] General File Handling - [x] `can_open()` subroutine - [x] `cant_open()` subroutine +- [ ] `Arrays` Module + - [ ] `Arrays::Sets` + - [ ] Move `union()` subroutine + - [ ] `intersection()` subroutine + - [ ] `is_subset()` subroutine + - [ ] `difference()` subroutine + - [ ] `symmetric_difference()` subroutine From 416dfb1691ce00d4f0074740aecdd381b3c57e94 Mon Sep 17 00:00:00 2001 From: Ethan Date: Sun, 1 Nov 2026 07:07:26 +0200 Subject: [PATCH 2/6] docs: Update version numbers --- README.md | 2 +- meta/project.yaml | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 62e2b39..8477155 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Utility modules written in Perl, for Perl. - Author: Ethan Kletschke -- Version: `0.0.6` +- Version: `0.0.7` - Developed on: Ubuntu (WSL) - License: MIT - Project metadata file: [`project.yaml`](./meta/project.yaml) diff --git a/meta/project.yaml b/meta/project.yaml index ff0694d..a9b4ee9 100644 --- a/meta/project.yaml +++ b/meta/project.yaml @@ -6,7 +6,7 @@ project-meta: - Perl status: Experimental license: MIT - version: 0.0.6 + version: 0.0.7 build: dev-environments: @@ -21,6 +21,7 @@ build: team: author: Ethan Kletschke + owner: Ethan Kletschke contributors: - name: Ethan Kletschke role: Author and Owner From 519be41079f3090fd4fab7b780def65cf3c51e62 Mon Sep 17 00:00:00 2001 From: Ethan Date: Sun, 1 Nov 2026 07:09:05 +0200 Subject: [PATCH 3/6] docs(src): Add `TODO` comment --- src/lib/Utils/Arrays/Simple.pm | 1 + 1 file changed, 1 insertion(+) diff --git a/src/lib/Utils/Arrays/Simple.pm b/src/lib/Utils/Arrays/Simple.pm index 1fa625a..2ad3fe8 100644 --- a/src/lib/Utils/Arrays/Simple.pm +++ b/src/lib/Utils/Arrays/Simple.pm @@ -8,6 +8,7 @@ our @EXPORT_OK = qw( union ); +# TODO -> Move to a new file for array sets sub union { # Parameters my ($arr1, $arr2) = @_; From d3e2a16555102c839a0911a13e234641a79f1ac8 Mon Sep 17 00:00:00 2001 From: Ethan Date: Sun, 1 Nov 2026 07:14:49 +0200 Subject: [PATCH 4/6] docs: Add comment to `.gitignore` --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 1944fd6..83d7c6e 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ +# Temporary Files *.tmp From 33496d784deee35574579e4a30f2a616aa40152e Mon Sep 17 00:00:00 2001 From: Ethan Date: Sun, 1 Nov 2026 07:19:31 +0200 Subject: [PATCH 5/6] docs: Add more plans to `BACKLOG.md` --- meta/BACKLOG.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/meta/BACKLOG.md b/meta/BACKLOG.md index 3e8e86a..ae03303 100644 --- a/meta/BACKLOG.md +++ b/meta/BACKLOG.md @@ -1,16 +1,27 @@ # Feature Backlog -_Last Updated: 2026-11-01_ +_Last Updated: 2026-11-01, 07:19am_ - [ ] `TextFiles` Module - - [ ] Log Parsing + - [ ] `TextFiles::LogFileParsing` - [x] Log type counter - [x] Log type filter (works like UNIX `grep` but more features(?)) - - [ ] CSV parsing - - [ ] General File Handling + - [ ] Log file validator + - Validates log lines against a provided RegEx format + - [ ] `TextFiles::ParseCSV` + - [ ] `validate_csv()` + - Validates that a file is a valid `.csv` file + - [ ] `TextFiles::Simple` - [x] `can_open()` subroutine - [x] `cant_open()` subroutine - [ ] `Arrays` Module + - [ ] `Arrays::Simple` + - [ ] `is_empty()` subroutine + - [ ] `isnt_empty()` subroutine + - [ ] `clear()` subroutine + - Empties out an array + - [ ] `populate()` subroutine + - Appends items to an array using a list of arbitrary arguments - [ ] `Arrays::Sets` - [ ] Move `union()` subroutine - [ ] `intersection()` subroutine From 5b093d541a28e28cf0921d6f3eed9048363b553d Mon Sep 17 00:00:00 2001 From: Ethan Date: Sun, 1 Nov 2026 07:26:41 +0200 Subject: [PATCH 6/6] docs(README): Add content to `README.md` --- README.md | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) diff --git a/README.md b/README.md index 8477155..0d9c12b 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,70 @@ Utility modules written in Perl, for Perl. - Developed on: Ubuntu (WSL) - License: MIT - Project metadata file: [`project.yaml`](./meta/project.yaml) + +--- + +- [PerlUtils](#perlutils) + - [About This Project](#about-this-project) + - [Features](#features) + - [Running the Module Tests](#running-the-module-tests) + - [Validating the POD Documentation](#validating-the-pod-documentation) + +--- + +## About This Project + +PerlUtils is a library of Perl modules (created mostly as a skills reference) +that currently provides utility subroutines for text-file handling and array handling, +and is planned to also provide OS subroutines (i.e., making directories, running specific +utility commands, etc.), text processing subroutines, and other + +### Features + +- Various utility subroutines aimed at simplifing Perl programs + - Array subroutines (planned), such as: + - `is_empty()` + - `clear()` + - `populate()` + - Mathematical set subroutines (i.e., `union()`, `intersection()`, etc.) + - Text processing subroutines +- Extensive POD documentation validated with CI/CD (using `podchecker`) +- Comprehensive `Test::More` testing suite run with `prove` +- Bash scripts that run the testing suite and validate POD documentation + +## Running the Module Tests + +To run the module tests, navigate to the `src/` directory and run the following command: + +```bash +prove -lv t/* +``` + +Or in the root directory of the project, run the provided Bash script: + +```bash +./RunUnitTests.sh +``` + +Both will run the provided module tests in the `src/t/` directory using `prove`. + + +## Validating the POD Documentation + +To validate the project's POD documentation, run this in the project's root directory: + +```bash +find src -type f -name '*.pm' -exec podchecker {} \; +``` + +This will: + +1. Find every Perl module file ending with `.pm` +2. Execute the `podchecker` command against each `.pm` file +3. Display the output of the validation for each file + +Alternatively, you can also run the provided Bash script: + +```bash +./ValidatePod.sh +```