From 47b6bb26896eab4faea628fa9c0d453800fc82b7 Mon Sep 17 00:00:00 2001 From: Priyadi Iman Nurcahyo <1102197+priyadi@users.noreply.github.com> Date: Mon, 22 Jul 2024 20:21:06 +0700 Subject: [PATCH] fix --- packages/collections-common/composer.json | 16 +++++++++++-- packages/collections-contracts/README.md | 15 ++---------- packages/collections-contracts/composer.json | 16 +++++++++++-- packages/collections-domain/README.md | 25 ++++++++++++++++---- packages/collections-domain/composer.json | 16 +++++++++++-- packages/collections-orm/README.md | 8 +++---- packages/collections-orm/composer.json | 16 +++++++++++-- 7 files changed, 83 insertions(+), 29 deletions(-) diff --git a/packages/collections-common/composer.json b/packages/collections-common/composer.json index c8ebc8d..d184595 100644 --- a/packages/collections-common/composer.json +++ b/packages/collections-common/composer.json @@ -1,13 +1,25 @@ { "name": "rekalogika/collections-common", - "description": "", + "description": "Common library required by other components of the rekalogika/collections library", "license": "MIT", "type": "library", "keywords": [ "domain", "collections", "doctrine", - "pagination" + "pagination", + "orm", + "recollection", + "minimalrecollection", + "count", + "precounting", + "extra-lazy", + "rekapager", + "keyset-pagination", + "cursor-pagination", + "batch", + "batch-processing", + "repository" ], "authors": [ { diff --git a/packages/collections-contracts/README.md b/packages/collections-contracts/README.md index e5aca51..53d21fb 100644 --- a/packages/collections-contracts/README.md +++ b/packages/collections-contracts/README.md @@ -1,17 +1,6 @@ -# rekalogika/collections-domain +# rekalogika/collections-contracts -Transforms a Doctrine `Collection` object into our `Recollection` object, which -extends `Collection` itself but also extends `PageableInterface` from our -`rekalogika/rekapager` library. - -The features include: - -* Safeguards against potential out-of-memory situations. -* Pluggable counting strategies. -* Keyset pagination for batch processing and user interfaces. - -The classes also available in the minimal flavor, which only exposes the safe -methods, those which won't trigger full load of an extra-lazy collection. +Interfaces and nominal classes for the `rekalogika/collections` library. ## Documentation diff --git a/packages/collections-contracts/composer.json b/packages/collections-contracts/composer.json index e237597..8af3e04 100644 --- a/packages/collections-contracts/composer.json +++ b/packages/collections-contracts/composer.json @@ -1,13 +1,25 @@ { "name": "rekalogika/collections-contracts", - "description": "", + "description": "Interfaces and nominal classes for the rekalogika/collections library.", "license": "MIT", "type": "library", "keywords": [ "domain", "collections", "doctrine", - "pagination" + "pagination", + "orm", + "recollection", + "minimalrecollection", + "count", + "precounting", + "extra-lazy", + "rekapager", + "keyset-pagination", + "cursor-pagination", + "batch", + "batch-processing", + "repository" ], "authors": [ { diff --git a/packages/collections-domain/README.md b/packages/collections-domain/README.md index 8d014a7..e5aca51 100644 --- a/packages/collections-domain/README.md +++ b/packages/collections-domain/README.md @@ -1,11 +1,28 @@ -# Rekalogika Collections Domain +# rekalogika/collections-domain -TBD +Transforms a Doctrine `Collection` object into our `Recollection` object, which +extends `Collection` itself but also extends `PageableInterface` from our +`rekalogika/rekapager` library. + +The features include: + +* Safeguards against potential out-of-memory situations. +* Pluggable counting strategies. +* Keyset pagination for batch processing and user interfaces. + +The classes also available in the minimal flavor, which only exposes the safe +methods, those which won't trigger full load of an extra-lazy collection. ## Documentation -TBD +[rekalogika.dev/collections](https://rekalogika.dev/collections) ## License -MIT \ No newline at end of file +MIT + +## Contributing + +This library consists of multiple repositories split from a monorepo. Be sure to +submit issues and pull requests to the +[rekalogika/collections](https://github.com/rekalogika/collections) monorepo. \ No newline at end of file diff --git a/packages/collections-domain/composer.json b/packages/collections-domain/composer.json index d935d11..ee6b83e 100644 --- a/packages/collections-domain/composer.json +++ b/packages/collections-domain/composer.json @@ -1,13 +1,25 @@ { "name": "rekalogika/collections-domain", - "description": "Improves Doctrine Collections usage in your domain entities.", + "description": "Transforms a Doctrine Collection object into our Recollection object, which extends Collection itself but also extends PageableInterface from our rekalogika/rekapager library.", "license": "MIT", "type": "library", "keywords": [ "domain", "collections", "doctrine", - "pagination" + "pagination", + "orm", + "recollection", + "minimalrecollection", + "count", + "precounting", + "extra-lazy", + "rekapager", + "keyset-pagination", + "cursor-pagination", + "batch", + "batch-processing", + "repository" ], "authors": [ { diff --git a/packages/collections-orm/README.md b/packages/collections-orm/README.md index 07462b9..18c66cc 100644 --- a/packages/collections-orm/README.md +++ b/packages/collections-orm/README.md @@ -1,9 +1,9 @@ # rekalogika/collections-orm -A collection class using Doctrine ORM `QueryBuilder` as the data source. Unlike -doing the query in the traditional way, this class allows lazy loading. You can -safely pass the object around, and it will only execute the query when you start -getting items from it. +Lazy-loading collection class using Doctrine ORM `QueryBuilder` as the data +source. Unlike doing the query in the traditional way, this class allows lazy +loading. You can safely pass the object around, and it will only execute the +query when you start getting items from it. The class also implements the `PageableInterface` from the [`rekalogika/rekapager`](https://rekalogika.dev/rekapager) library. This allows diff --git a/packages/collections-orm/composer.json b/packages/collections-orm/composer.json index 44b8a07..b60a5f7 100644 --- a/packages/collections-orm/composer.json +++ b/packages/collections-orm/composer.json @@ -1,13 +1,25 @@ { "name": "rekalogika/collections-orm", - "description": "Supercharged query-backed Doctrine Collection.", + "description": "Lazy-loading collection class using Doctrine ORM QueryBuilder as the data source", "license": "MIT", "type": "library", "keywords": [ "domain", "collections", "doctrine", - "pagination" + "pagination", + "orm", + "recollection", + "minimalrecollection", + "count", + "precounting", + "extra-lazy", + "rekapager", + "keyset-pagination", + "cursor-pagination", + "batch", + "batch-processing", + "repository" ], "authors": [ {