Draft: 3.x

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: '[BUG]: '
+labels: ["bug"]
+assignees:
+  - dimitriBouteille
+
+---
+
+### Describe the bug
+
+A clear and concise description of what the bug is.
+
+### Steps to reproduce the issue
+
+A clear and concise description to reproduce the bug.
+
+### Expected behavior
+
+A clear and concise description of what you expected to happen.
+
+### Your setup
+
+- Wordpress Version: [e.g. 6.4.2]
+- Module version: [e.g. 3.0.0]
+- Are you using framework ?: [e.g. Bedrock, Wordplate, ... - If yes, Please specify the framework and version]
+
+### Additional context
+
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: true

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,28 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: '[FEATURE]: '
+labels: ["enhancement"]
+assignees:
+  - dimitriBouteille
+
+---
+
+### Introduction
+
+Making your own contribution is easy, encouraged and greatly appreciated! We will put effort into reviewing and merging your PR quickly. For more info, please refer to the [contribution guidelines](https://github.com/dbout/wp-orm/blob/develop/CONTRIBUTING.md).
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+### Describe the solution you'd like
+
+A clear and concise description of what you want to happen.
+
+### Describe alternatives you've considered
+
+A clear and concise description of any alternative solutions or features you've considered.
+
+### Additional context
+
+Add any other context or screenshots about the feature request here.

.github/workflows/styles.yml

@@ -0,0 +1,31 @@
+name: Coding Styles
+
+on:
+  pull_request:
+
+jobs:
+  codingStyle:
+    name: Coding Style
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v3
+
+      - name: Configure PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.1
+          tools: composer:v2
+
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-progress
+
+      - name: PHPCsFixer
+        run: composer csFixer
+
+      #- name: Rector
+      #  run: composer rector
+
+      - name: PHPStan Analyse
+        run: composer phpstan

.github/workflows/tests.yml

@@ -0,0 +1,25 @@
+name: Tests
+
+on:
+  pull_request:
+
+jobs:
+  test:
+    name: Tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v3
+
+      - name: Configure PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.1
+          tools: composer:v2
+
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-progress
+
+      - name: Running unit test
+        run: composer phpunit

.gitignore

@@ -1,4 +1,5 @@
-
 vendor/
+var/
 .idea/
-
+composer.lock
+.php-cs-fixer.cache

.php-cs-fixer.php

@@ -0,0 +1,48 @@
+<?php
+/**
+ * Copyright (c) 2023 Dimitri BOUTEILLE
+ * See LICENSE.txt for license details.
+ *
+ * Author: Dimitri BOUTEILLE <bonjour@dimitri-bouteille.fr>
+ */
+
+$finder = \PhpCsFixer\Finder::create()
+    ->name('*.php')
+    ->in([
+        'src',
+    ])
+;
+
+$header = <<<EOF
+    Copyright (c) 2024 Dimitri BOUTEILLE (https://github.com/dimitriBouteille)
+    See LICENSE.txt for license details.
+
+    Author: Dimitri BOUTEILLE <bonjour@dimitri-bouteille.fr>
+    EOF;
+
+$config = new \PhpCsFixer\Config();
+return $config
+    ->setFinder($finder)
+    ->setCacheFile(__DIR__ . '/var/.php-cs-fixer.cache')
+    ->setRiskyAllowed(true)
+    ->setRules([
+        '@PSR12' => true,
+        '@PHP81Migration' => true,
+        'strict_param' => true,
+        'array_syntax' => ['syntax' => 'short'],
+        'octal_notation' => false,
+        'trim_array_spaces' => true,
+        'phpdoc_order' => true,
+        'ordered_imports' => true,
+        'new_with_braces' => true,
+        'method_chaining_indentation' => true,
+        'no_unused_imports' => true,
+        'align_multiline_comment' => true,
+        'array_indentation' => true,
+        'header_comment' => [
+            'header' => $header,
+            'comment_type' => 'PHPDoc',
+            'location' => 'after_open',
+            'separate' => 'bottom',
+        ],
+    ]);

CONTRIBUTING.md

@@ -0,0 +1,19 @@
+# Contribution guidelines
+
+## How to contribute step-by-step
+
+1. Fork the `dbout/wp-orm` repository.
+2. Create a new branch from `main` in your fork. This makes it easier for you to keep track of your changes.
+3. Make the desired changes to the code.
+    * If you are adding new functionality or fixing a bug, we recommend you add unit tests that cover it.
+4. Push the changes to your fork.
+5. Create a pull request to the `dbout/wp-orm` repository.
+6. In your pull request, please describe in detail:
+    * What problem you’re solving
+    * Your approach to fixing the problem
+    * Any tests you wrote
+7. Check Allow edits from maintainers.
+8. Create the pull request.
+9. Ensure that all checks have passed.
+
+After you create your pull request, one of the code owners will review your code.

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Dimitri BOUTEILLE
+Copyright (c) 2024 Dimitri BOUTEILLE
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,72 +1,70 @@
-# Wordpress ORM with Eloquent
+# WordPress ORM with Eloquent
+
+![GitHub Release](https://img.shields.io/github/v/release/dimitriBouteille/wp-orm) [![tests](https://img.shields.io/github/actions/workflow/status/dimitriBouteille/wp-orm/tests.yml?label=tests)](https://github.com/dimitriBouteille/wp-orm/actions/workflows/tests.yml) [![Packagist Downloads](https://img.shields.io/packagist/dt/dbout/wp-orm?color=yellow)](https://packagist.org/packages/dbout/wp-orm) ![Eloquent version](https://img.shields.io/packagist/dependency-v/dbout/wp-orm/illuminate%2Fdatabase?color=orange)
 
 WordPress ORM wih Eloquent is a small library that adds a basic ORM into WordPress, which is easily extendable and includes models for core WordPress models such as posts, post metas, users, comments and more.
-The ORM is based on [Eloquent ORM](https://laravel.com/docs/8.x/eloquent) and uses the Wordpress connection (`wpdb` class).
+The ORM is based on [Eloquent ORM](https://laravel.com/docs/eloquent) and uses the WordPress connection (`wpdb` class).
 
 The ORM also offers a system to simply manage database migrations based on [Phinx](https://phinx.org/).
 
-Requirements
---------
-
-The server requirements are basically the same as for [WordPress](https://wordpress.org/about/requirements/) with the addition of a few ones :
+> 💡 To simplify the integration of this library, we recommend using WordPress with one of the following tools: [Bedrock](https://roots.io/bedrock/), [Themosis](https://framework.themosis.com/) or [Wordplate](https://github.com/wordplate/wordplate#readme).
 
-- PHP >= 7.4
-- [Composer](https://getcomposer.org/) ❤️
+### Features
 
-> To simplify the integration of this library, we recommend using Wordpress with one of the following tools: [Bedrock](https://roots.io/bedrock/), [Themosis](https://framework.themosis.com/) or [Wordplate](https://github.com/wordplate/wordplate#readme).
+- ✅ Support core WordPress models: `Comment`, `Option`, `Post`, `TermTaxonomy`, `Term`, `User`, `PostMeta` and `UserMeta`
+- ✅ Support core WordPress post type: `Article`, `Attachment` and `Page`
+- ✅ Based on core WordPress database connection (`wpdb` class), no configuration required !
+- ✅ Migration with `Phinx`
+- ✅ Custom functions to filter models with meta
+- ❤️ Easy integration of a custom post type
+- ❤️ Easy model creation for projects with custom tables
+- ❤️ All the features available in Eloquent, are usable with this library !
 
-Installation
---------
+**Not yet developed but planned in a future version:**
 
+- 🗓️ Create custom comment type
+- 🗓️ Meta casting (e.g. [Attribute Casting](https://laravel.com/docs/10.x/eloquent-mutators#attribute-casting)) 
 
-Install with composer, in the root of the Wordpress project run:
-
-```bash
-composer require dbout/wp-orm
-```
+### Documentation
 
-Basic usage with core Wordpress models 
---------
+This documentation only covers the specific points of this library, if you want to know more about Eloquent, the easiest is to look at [the documentation of Eloquent](https://laravel.com/docs/10.x/eloquent) :)
 
-### Page model
+- [Installation](#installation)
+- [Use WordPress core models](doc/wordpress-core-models.md)
+- [Filter data](/doc/filter-data.md)
+    - [With findOneBy*](/doc/filter-data.md#with-findoneby)
+    - [With taps](/doc/filter-data.md#with-taps)
+    - [With query builder](/doc/filter-data.md#with-query-builder)
+- [Create custom model](doc/create-model.md)
+    - [Generic Model](doc/create-model.md#generic-model)
+    - [Custom Post Type Model](doc/create-model.md#custom-post-type-model)
+- [Migration with Phinx](doc/migration.md)
 
-#### Queries
+## Installation
 
-```php
-# Get all pages
-$pages = \Dbout\WpOrm\Models\Page::all();
+**Requirements**
 
-# Get one page by ID
-$page = \Dbout\WpOrm\Models\Page::find(15);
-
-# Get all pages by author
-$pages = \Dbout\WpOrm\Models\Page::query()
-    ->whereAuthor(1)
-    ->get();
-
-# Get all publish pages
-$pages = \Dbout\WpOrm\Models\Page::query()
-    ->whereStatus('publish')
-    ->get();
-```
+The server requirements are basically the same as for [WordPress](https://wordpress.org/about/requirements/) with the addition of a few ones :
 
+- PHP >= 8.1
+- [Composer](https://getcomposer.org/)
 
-### Migration
+**Installation**
 
-To use phinx, you must create a configuration file named `config-phinx.php` at the root of your project. To create this file, please see one of the following documentation:
+You can use [Composer](https://getcomposer.org/). Follow the [installation instructions](https://getcomposer.org/doc/00-intro.md) if you do not already have composer installed.
 
-- [Create config-phinx.php file for Bedrock Framework](doc/migration-with-bedrock.md)
+~~~bash
+composer require dbout/wp-orm
+~~~
 
-If you would like to learn more about the configuration file, please visit  [Phinx - Configuration](https://phinx.readthedocs.io/en/latest/configuration.html).
+In your PHP script, make sure you include the autoloader:
 
-#### Create new migration : 
+~~~php
+require __DIR__ . '/vendor/autoload.php';
+~~~
 
-```bash
-php vendor/bin/phinx create -c config-phinx.php
-```
+🎉 You have nothing more to do, you can use the library now! Not even need to configure database accesses because it's the `wpdb` connection that is used.
 
-#### Run migration :
+## Contributing
 
-```bash
-php vendor/bin/phinx migrate -c config-phinx.php
-```
+We encourage you to contribute to this repository, so everyone can benefit from new features, bug fixes, and any other improvements. Have a look at our [contributing guidelines](CONTRIBUTING.md) to find out how to raise a pull request.

composer.json

@@ -1,8 +1,8 @@
 {
   "name": "dbout/wp-orm",
-  "description": "Wordpress ORM with Eloquent and Phinx",
+  "description": "WordPress ORM with Eloquent and Phinx.",
   "type": "package",
-  "license": "GPL-2.0-or-later",
+  "license": "MIT",
   "authors": [
     {
       "name": "Dimitri BOUTEILLE",
@@ -12,16 +12,17 @@
     }
   ],
   "keywords": ["wordpress", "wp", "orm", "database", "eloquent", "db", "sql", "migration", "phinx"],
-  "homepage": "https://github.com/dimitriBouteille/wp-orm/",
+  "homepage": "https://github.com/dimitriBouteille/wp-orm",
   "support": {
-    "issues": "https://github.com/dimitriBouteille/wp-orm/issues"
+    "issues": "https://github.com/dimitriBouteille/wp-orm/issues",
+    "source": "https://github.com/dimitriBouteille/wp-orm/"
   },
   "minimum-stability": "dev",
   "prefer-stable": true,
   "require": {
-    "php": "^7.4|^8.0",
-    "illuminate/database": "^8.0",
-    "robmorgan/phinx": "^0.12.5"
+    "php": ">=8.1",
+    "robmorgan/phinx": "^0.12.5",
+    "illuminate/database": "^10.0"
   },
   "suggest": {
     "illuminate/events": "Add events to your models"
@@ -33,5 +34,32 @@
     "psr-4": {
       "Dbout\\WpOrm\\": "src/"
     }
+  },
+  "require-dev": {
+    "friendsofphp/php-cs-fixer": "^3.28",
+    "phpstan/phpstan": "^1.10",
+    "rector/rector": "^0.18.4",
+    "phpunit/phpunit": "^10.5",
+    "phpstan/phpstan-phpunit": "^1.3",
+    "phpstan/extension-installer": "^1.3"
+  },
+  "config": {
+    "allow-plugins": {
+      "phpstan/extension-installer": true
+    }
+  },
+  "extra": {
+    "phpstan": {
+      "includes": [
+        "extension.neon"
+      ]
+    }
+  },
+  "scripts": {
+    "rector": "vendor/bin/rector process src --dry-run",
+    "phpstan": "vendor/bin/phpstan analyse -c phpstan.neon",
+    "phpunit": "vendor/bin/phpunit",
+    "csFixer": "vendor/bin/php-cs-fixer fix --verbose --diff --dry-run",
+    "fix:csFixer": "vendor/bin/php-cs-fixer fix"
   }
 }