Feature/v0.1.3 (#9)

### Added: - 🧑🏻‍💻 Implement `ErrorKind::FromRowError`. - 🧑🏻‍💻 Implement DB migrations with sqlx for the creation of the MySQL test database. - 🧑🏻‍💻 Implement ***SqlxPagination*** to generalize the implementation of pagination methods using *sqlx*. - 🧑🏻‍💻 Implement **SqlxPagination** for `QueryBuilder<MySQL>` to paginate results from a SQL query into a `Page`. Only available on ***mysql-sqlx*** feature is enabled. - 🧑🏻‍💻 Implement **SqlxPagination** for `QueryBuilder<Postgres>` to paginate results from a SQL query into a `Page`. Only available on ***pg-sqlx*** feature is enabled. - 🧑🏻‍💻 Implement integration test for pagination with ***mysql-sqlx***. ### Changed: - 🔨 Refactor of the pagination.rs module to create the records_pagination.rs and sqlx_pagination.rs modules. Renaming the test module test_sqlx_postgres_pagination.rs to test_sqlx_pagination.rs. ### Removed: - ❌ Remove **From** **sqlx::Error** for `PaginationError`. ### Docs: - 📝 Update project documentation.
JMTamayo · May 25, 2024 · 01179eb · 01179eb
2 parents 2255ac4 + 55e86da
commit 01179eb
Show file tree

Hide file tree

Showing 26 changed files with 1,211 additions and 453 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -12,14 +12,23 @@ jobs:
 
     services:
       postgres:
-        image: postgres:15
+        image: postgres:latest
         env:
-          POSTGRES_USER: ${{ secrets.PG_DB_USER }}
-          POSTGRES_PASSWORD: ${{ secrets.PG_DB_PASSWORD }}
-          POSTGRES_DB: ${{ secrets.PG_DB_NAME }}
+          POSTGRES_USER: ${{ secrets.DB_USER }}
+          POSTGRES_PASSWORD: ${{ secrets.DB_PASSWORD }}
+          POSTGRES_DB: ${{ secrets.DB_NAME }}
         ports:
-            - 5432:5432
+          - 5432:5432
 
+      mysql:
+        image: mysql:latest
+        env:
+          MYSQL_USER: ${{ secrets.DB_USER }}
+          MYSQL_PASSWORD: ${{ secrets.DB_PASSWORD }}
+          MYSQL_ROOT_PASSWORD: ${{ secrets.DB_PASSWORD }}
+          MYSQL_DATABASE: ${{ secrets.DB_NAME }}
+        ports:
+          - 3306:3306
     steps:
     - uses: actions/checkout@v2
 
@@ -34,12 +43,17 @@ jobs:
         tool: cargo-llvm-cov
 
     - name: Install SQLx CLI
-      run: cargo install sqlx-cli --no-default-features --features postgres
+      run: cargo install sqlx-cli --no-default-features --features postgres,mysql,sqlite
 
     - name: Run migrations for Postgres
       env:
-        DATABASE_URL: postgres://${{ secrets.PG_DB_USER }}:${{ secrets.PG_DB_PASSWORD }}@${{ secrets.PG_DB_HOST }}:${{ secrets.PG_DB_PORT }}/${{ secrets.PG_DB_NAME }}
-      run: sqlx migrate run --source page-hunter/tests/migrations/postgres 
+        DATABASE_URL: postgres://${{ secrets.DB_USER }}:${{ secrets.DB_PASSWORD }}@${{ secrets.DB_HOST }}:${{ secrets.PG_DB_PORT }}/${{ secrets.DB_NAME }}
+      run: sqlx migrate run --source page-hunter/tests/migrations/postgres
+
+    - name: Run migrations for MySQL
+      env:
+        DATABASE_URL: mysql://${{ secrets.DB_USER }}:${{ secrets.DB_PASSWORD }}@${{ secrets.DB_HOST }}:${{ secrets.MYSQL_DB_PORT }}/${{ secrets.DB_NAME }}
+      run: sqlx migrate run --source page-hunter/tests/migrations/mysql
 
     - name: Check project
       uses: actions-rs/cargo@v1
@@ -48,15 +62,16 @@ jobs:
         args: --all-features
 
     - name: Check formatting
-      run: cargo fmt --all -- --check
+      run: cargo fmt --all --check
 
     - name: Run tests with coverage for all features
       env:
-        PG_DB_USER: ${{ secrets.PG_DB_USER }}
-        PG_DB_PASSWORD: ${{ secrets.PG_DB_PASSWORD }}
-        PG_DB_NAME: ${{ secrets.PG_DB_NAME }}
-        PG_DB_HOST: ${{ secrets.PG_DB_HOST }}
+        DB_USER: ${{ secrets.DB_USER }}
+        DB_PASSWORD: ${{ secrets.DB_PASSWORD }}
+        DB_NAME: ${{ secrets.DB_NAME }}
+        DB_HOST: ${{ secrets.DB_HOST }}
         PG_DB_PORT: ${{ secrets.PG_DB_PORT }}
+        MYSQL_DB_PORT: ${{ secrets.MYSQL_DB_PORT }}
       run: cargo llvm-cov --workspace --all-features --codecov --output-path codecov.json
 
     - name: Upload coverage to Codecov

diff --git a/.gitignore b/.gitignore
@@ -27,4 +27,7 @@ venv/
 .venv/
 
 # macOS
-.DS_Store
+.DS_Store
+
+# Env files
+*.env
diff --git a/Makefile b/Makefile
@@ -1,3 +1,33 @@
+pg-db-docker:
+	docker run --name postgres-db -e POSTGRES_PASSWORD=docker -e POSTGRES_DB=test -e POSTGRES_USER=test -p 5432:5432 -d postgres
+
+mysql-db-docker:
+	docker run --name mysql-db -e MYSQL_ROOT_PASSWORD=docker -e MYSQL_DATABASE=test -e MYSQL_USER=test -e MYSQL_PASSWORD=docker -p 3306:3306 -d mysql
+
+install-sqlx-cli:
+	cargo install sqlx-cli --no-default-features --features postgres,mysql,sqlite
+
+install-tarpaulin:
+	cargo install cargo-tarpaulin
+
+install-llvm-cov:
+	cargo install cargo-llvm-cov
+
+run-postgres-migrations:
+	sqlx migrate run --source page-hunter/tests/migrations/postgres --database-url postgres://test:docker@localhost:5432/test
+
+revert-postgres-migrations:
+	sqlx migrate revert --source page-hunter/tests/migrations/postgres --database-url postgres://test:docker@localhost:5432/test
+
+run-mysql-migrations:
+	sqlx migrate run --source page-hunter/tests/migrations/mysql --database-url mysql://test:docker@localhost:3306/test
+
+revert-mysql-migrations:
+	sqlx migrate revert --source page-hunter/tests/migrations/mysql --database-url mysql://test:docker@localhost:3306/test
+
+fmt-check:
+	cargo fmt --all --check
+
 fmt:
 	cargo fmt --all
 

diff --git a/README.md b/README.md
@@ -18,19 +18,20 @@ To use **page-hunter** from GitHub repository with specific version, set the dep
 
 ```ini
 [dependencies]
-page-hunter = {git = "https://github.com/JMTamayo/page-hunter.git", version = "0.1.2", features = ["serde"] }
+page-hunter = {git = "https://github.com/JMTamayo/page-hunter.git", version = "0.1.3", features = ["serde"] }
 ```
 
 You can depend on it via cargo by adding the following dependency to your `Cargo.toml` file:
 
 ```ini
 [dependencies]
-page-hunter = { version = "0.1.2", features = ["serde", "pg-sqlx"] }
+page-hunter = { version = "0.1.3", features = ["serde", "pg-sqlx"] }
 ```
 
 ## CRATE FEATURES
-- `serde`: Add [Serialize](https://docs.rs/serde/1.0.197/serde/trait.Serialize.html) and [Deserialize](https://docs.rs/serde/1.0.197/serde/trait.Deserialize.html) support for `Page` and `Book` based on crate [serde](https://crates.io/crates/serde/1.0.197). This feature is useful for implementing pagination models as a request or response body in REST APIs, among other implementations.
-- `pg-sqlx`: Add support for pagination with [SQLx](https://crates.io/crates/sqlx) crate for PostgreSQL database. This feature is useful for paginating records from a PostgreSQL database.
+- `serde`: Add [Serialize](https://docs.rs/serde/1.0.197/serde/trait.Serialize.html) and [Deserialize](https://docs.rs/serde/1.0.197/serde/trait.Deserialize.html) support for `Page` and `Book` based on [serde](https://crates.io/crates/serde/1.0.197). This feature is useful for implementing pagination models as a request or response body in REST APIs, among other implementations.
+- `pg-sqlx`: Add support for pagination with [SQLx](https://crates.io/crates/sqlx) for PostgreSQL database.
+- `mysql-sqlx`: Add support for pagination with [SQLx](https://crates.io/crates/sqlx) for MySQL database.
 
 ## BASIC OPERATION
 The **page-hunter** library provides two main models to manage pagination:
@@ -151,7 +152,7 @@ On feature `serde` enabled, you can serialize and deserialize a `Book` as follow
 ```
 
 #### Paginate records from a PostgreSQL database with SQLx:
-If you need to paginate records from a PostgreSQL database using the [SQLx](https://crates.io/crates/sqlx) crate:
+To paginate records from a PostgreSQL database:
 ```rust,no_run
     use page_hunter::*;
     use sqlx::postgres::{PgPool, Postgres};
@@ -180,7 +181,39 @@ If you need to paginate records from a PostgreSQL database using the [SQLx](http
             query.paginate(&pool, 0, 10).await.unwrap_or_else(|error| {
                 panic!("Error paginating records: {:?}", error);
             });
-   }
+    }
+```
+
+To paginate records from a MySQL database:
+```rust,no_run
+    use page_hunter::*;
+    use sqlx::mysql::{MySqlPool, MySql};
+    use sqlx::{FromRow, QueryBuilder};
+    use uuid::Uuid;
+
+    #[tokio::main]
+    async fn main() {
+        #[derive(Clone, Debug, FromRow)]
+        pub struct Country {
+            id: Uuid,
+            name: String,
+        }
+
+        let pool: MySqlPool = MySqlPool::connect(
+            "mysql://username:password@localhost/db"
+        ).await.unwrap_or_else(|error| {
+            panic!("Error connecting to database: {:?}", error);
+        });
+
+        let query: QueryBuilder<MySql> = QueryBuilder::new(
+            "SELECT * FROM countries"
+        );
+
+        let page: Page<Country> =
+            query.paginate(&pool, 0, 10).await.unwrap_or_else(|error| {
+               panic!("Error paginating records: {:?}", error);
+            });
+    }
 ```
 
 ## DEVELOPMENT
@@ -189,36 +222,53 @@ To test `page-hunter`, follow these recommendations:
 #### Set env variables:
 Create `local.env` file at workspace folder to store the required environment variables
 ```text
-    PG_DB_HOST=localhost
+    DB_HOST=localhost
+    DB_USER=test
+    DB_PASSWORD=docker
+    DB_NAME=test
     PG_DB_PORT=5432
-    PG_DB_USER=test
-    PG_DB_PASSWORD=docker
-    PG_DB_NAME=test
+    MYSQL_DB_PORT=3306
 ```
 
 #### Setup databases:
 Run databases as Docker containers using the following commands:
 
 ##### Postgres SQL:
 ```bash
-    docker run --name postgres-db -e POSTGRES_PASSWORD=docker -e POSTGRES_DB=test -e POSTGRES_USER=test -p 5432:5432 postgres 
+    make pg-db-docker 
+```
+
+##### MySQL:
+```bash
+    make mysql-db-docker
 ```
 
 #### Run database migrations:
+- Install sqlx-cli:
+```bash
+    make install-sqlx-cli
+```
+
 ##### Postgres SQL
-- Install sqlx-cli for postgres:
+- Run migrations:
 ```bash
-    cargo install sqlx-cli --no-default-features --features postgres
+    make run-postgres-migrations
 ```
 
-- Export DATABASE_URL:
+- Revert migrations:
 ```bash
-    export DATABASE_URL=postgres://test:docker@localhost:5432/test 
+    make revert-postgres-migrations
 ```
 
+##### MySQL
 - Run migrations:
 ```bash
-    sqlx migrate run --source page-hunter/tests/migrations/postgres 
+    make run-mysql-migrations
+```
+
+- Revert migrations:
+```bash
+    make revert-mysql-migrations
 ```
 
 #### To test:
@@ -229,7 +279,7 @@ Run databases as Docker containers using the following commands:
 #### To test using tarpaulin:
 - Install cargo-tarpaulin:
 ```bash
-    cargo install cargo-tarpaulin  
+    make install-tarpaulin
 ```
 
 - Run tests:
@@ -240,7 +290,7 @@ Run databases as Docker containers using the following commands:
 #### To test using llvm-cov:
 - Install llvm-cov:
 ```bash
-    cargo install cargo-llvm-cov 
+    make install-llvm-cov
 ```
 
 - Run tests:

diff --git a/page-hunter/CHANGELOG.md b/page-hunter/CHANGELOG.md
@@ -5,61 +5,85 @@ 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.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 🚀 v0.1.3 [2024-05-24]
+
+### Added:
+
+- 🧑🏻‍💻 Implement `ErrorKind::FromRowError`.
+- 🧑🏻‍💻 Implement DB migrations with sqlx for the creation of the MySQL test database.
+- 🧑🏻‍💻 Implement ***SqlxPagination*** to generalize the implementation of pagination methods using *sqlx*.
+- 🧑🏻‍💻 Implement **SqlxPagination** for `QueryBuilder<MySQL>` to paginate results from a SQL query into a `Page`. Only available on ***mysql-sqlx*** feature is enabled.
+- 🧑🏻‍💻 Implement **SqlxPagination** for `QueryBuilder<Postgres>` to paginate results from a SQL query into a `Page`. Only available on ***pg-sqlx*** feature is enabled.
+- 🧑🏻‍💻 Implement integration test for pagination with ***mysql-sqlx***.
+
+
+### Changed:
+
+- 🔨 Refactor of the pagination.rs module to create the records_pagination.rs and sqlx_pagination.rs modules. Renaming the test module test_sqlx_postgres_pagination.rs to test_sqlx_pagination.rs.
+
+### Removed:
+
+- ❌ Remove **From** **sqlx::Error** for `PaginationError`.
+
+### Docs:
+
+- 📝 Update project documentation.
+
 ## 🚀 v0.1.2 [2024-05-22]
 
 ### Added:
 
-- 🧑🏻‍💻 Implementation of `ErrorKind::DatabaseError`.
-- 🧑🏻‍💻 Implementation of **From** **sqlx::Error** for `PaginationError`.
+- 🧑🏻‍💻 Implement `ErrorKind::DatabaseError`.
+- 🧑🏻‍💻 Implement **From** **sqlx::Error** for `PaginationError`.
 - 🧑🏻‍💻 Paginate results from a SQL query into a `Page` from a PostgreSQL database using *sqlx*. Implementation of the **PgSqlxPagination** for `QueryBuilder`. Only available on ***pg-sqlx*** feature is enabled.
-- 🧑🏻‍💻 Including unitary test for the **Debug** implementation for `Book`.
-- 🧑🏻‍💻 Including checking project format in ci.yml.
-- 🧑🏻‍💻 Implementation of DB migrations with sqlx for the creation of the postgres test database.
-- 🧑🏻‍💻 Implementation of integration test for pagination with pg-sqlx in CI.
+- 🧑🏻‍💻 Include unitary test for the **Debug** implementation for `Book`.
+- 🧑🏻‍💻 Include checking project format in ci.yml.
+- 🧑🏻‍💻 Implement DB migrations with *sqlx* for the creation of the postgres test database.
+- 🧑🏻‍💻 Implement integration tests for pagination with ***pg-sqlx***.
 
 ### Changed:
 
-- 🔨 Changing the implementation of **Clone** and **Debug** using derive to implement directly in `ErrorKind` and `PaginationError`.
-- 🔨 Changing the implementation of **Clone** and **Debug** using derive to implement directly in `Page` and `Book`.
-- 🔨 Updating unit tests to get 100% coverage on the errors module.
+- 🔨 Change the implementation of **Clone** and **Debug** using derive to implement directly in `ErrorKind` and `PaginationError`.
+- 🔨 Change the implementation of **Clone** and **Debug** using derive to implement directly in `Page` and `Book`.
+- 🔨 Update unit tests to get 100% coverage on the errors module.
 
 ### Docs:
 
-- 📝 Updating project documentation to include new implementations, utilities and development section.
+- 📝 Update project documentation to include new implementations, utilities and development section.
 
 ## 🚀 v0.1.1 [2024-05-18]
 
 ### Added:
 
-- 🧑🏻‍💻 Implementation of `Book` model for binding uses.
-- 🧑🏻‍💻 Implementation of **Default**, **Clone**, **Debug**, **Display** and **IntoIterator** in `Book` model for default feature.
-- 🧑🏻‍💻 Implementation of **Serialize** and **Deserialize** in `Book` model for feature ***serde***.
-- 🧑🏻‍💻 Implementation of `bind_records()` function for binding uses.
-- 🧑🏻‍💻 Implementation of unitary tests for `bind_records()` and `Book` model.
+- 🧑🏻‍💻 Implement `Book` model for binding uses.
+- 🧑🏻‍💻 Implement **Default**, **Clone**, **Debug**, **Display** and **IntoIterator** in `Book` model for default feature.
+- 🧑🏻‍💻 Implement **Serialize** and **Deserialize** in `Book` model for feature ***serde***.
+- 🧑🏻‍💻 Implement `bind_records()` function for binding uses.
+- 🧑🏻‍💻 Implement unitary tests for `bind_records()` and `Book` model.
 - 🧑🏻‍💻 Codecov implementation to verify 90% of coverage in unit tests.
 
 ### Changed:
 
-- 🔨 Changing the implementation of **Serialize** trait using derive to implement directly in `Page` and `Book` models.
+- 🔨 Change the implementation of **Serialize** trait using derive to implement directly in `Page` and `Book` models.
 
 ### Docs:
 
-- 📝 Including badges in README.md
-- 📝 Fixing minor typos from documentation in traits implementation.
+- 📝 Include badges in README.md
+- 📝 Fix minor typos from documentation in traits implementation.
 
 
 ## 🚀 v0.1.0 [2024-05-15]
 
 ### Added:
 
-- 🧑🏻‍💻 Implementation of `Page` model for pagination uses.
-- 🧑🏻‍💻 Implementation of **Default**, **Clone**, **Debug**, **Display** and **IntoIterator** in `Page` model for default feature.
-- 🧑🏻‍💻 Implementation of **Serialize** and **Deserialize** in `Page` model for feature ***serde***.
-- 🧑🏻‍💻 Implementation of `paginate_records()` function for record pagination.
-- 🧑🏻‍💻 Implementation of unitary tests for `paginate_records()` and `Page` model.
-- 🧑🏻‍💻 Implementation of CI workflow with GitHub actions to verify unit testing.
+- 🧑🏻‍💻 Implement `Page` model for pagination uses.
+- 🧑🏻‍💻 Implementat **Default**, **Clone**, **Debug**, **Display** and **IntoIterator** in `Page` model for default feature.
+- 🧑🏻‍💻 Implement **Serialize** and **Deserialize** in `Page` model for feature ***serde***.
+- 🧑🏻‍💻 Implement `paginate_records()` function for record pagination.
+- 🧑🏻‍💻 Implement unitary tests for `paginate_records()` and `Page` model.
+- 🧑🏻‍💻 Implement CI workflow with GitHub actions to verify unit testing.
 
 ### Docs:
 
-- 📝 Implementation of project documentation in README.md file, functions, methods, implementations, models and library.
-- 📝 Implementation of CHANGELOG.md file.
+- 📝 Implement project documentation in README.md file, functions, methods, implementations, models and library.
+- 📝 Implement CHANGELOG.md file.