Readme

README.md

@@ -2,19 +2,17 @@
 
 Propel3 is an open-source Object-Relational Mapping (ORM) for modern PHP 7.1+.
 
-
-[![Build Status](https://circleci.com/gh/propelorm/Propel2/tree/master.png?style=shield)](https://circleci.com/gh/propelorm/Propel2/tree/master)
-[![Code Climate](https://codeclimate.com/github/propelorm/Propel2/badges/gpa.svg)](https://codeclimate.com/github/propelorm/Propel2)
-<a href="https://codeclimate.com/github/propelorm/Propel2"><img src="https://codeclimate.com/github/propelorm/Propel2/badges/coverage.svg" /></a>
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/97c839fc8e745f9f8f60/test_coverage)](https://codeclimate.com/github/propelorm/Propel3/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/97c839fc8e745f9f8f60/maintainability)](https://codeclimate.com/github/propelorm/Propel3/maintainability)
 [![PPM Compatible](https://raw.githubusercontent.com/php-pm/ppm-badge/master/ppm-badge.png)](https:/php-pm/php-pm)
 [![Gitter](https://badges.gitter.im/propelorm/Propel.svg)](https://gitter.im/propelorm/Propel)
 
-Version 3 of Propel ORM replaces [Propel2](https:/propelorm/Propel2), which is not maintained anymore.
 Propel3 introduces a data-mapper implementation which separates your entities from the actual persisting logic.
 
 ## Status
 
-This is in current development and is not yet ready to use.
+This is in current development and is not yet ready to use (please see the [TODO](TODO.md) list).
 
 ## Features
 

TODO.md

@@ -0,0 +1,31 @@
+Propel 3 ToDo list
+
+- PHP 7.4+ (move to php 8 when annotations will be ready)
+- Use twig instead of mustache, to move some render logic into the templates. 
+- Refactor model criteria
+- Refactor entity map
+- Refactor platform: split classes into smaller pieces. It can be done via twig templates.
+- EnityDiff: use FieldDiff objects instead of arrays whenever it's possible (renamed fields)
+- Refactor the XmlDumper and create others for the other supported formats (yaml, json, php)
+- Use phootwork/lang library to manipulate arrays and strings (still introduced).
+- Use phootwork/lang library for `toArray` method.
+- Use phootwork/collection to refactor Collections
+- Use phootwork/file for file and directory manipulation (it's stream compatible!!)
+- Move `Domain::getPhpDefaultValue` and `Field::getPhpDefaultValue` in `FieldDefaultValue` class or create a new class to 
+represent default values 
+- Inspect code to remove old style array
+- Remove deprecated methods
+- Implement `Propel\Generator\Builder\Om\Component\ActiveRecordTrait\GenericMutatorMethods` if needed
+- Port `VersionableBehavior` from Propel2 to Propel3
+- Fix Mysql tests
+- Fix Postgres tests
+- Fix sqlite tests
+- When test suite'll be green, remove commented code
+- Introduce `vimeo/psalm` static analisys tool
+- Remove `Propel\Generator\Builder\Sql` namespace ?
+- Remove `Propel\Generator\Builder\Util\DataRow`
+- Move from Travis to Github Actions and test everything against windows and MacOsx, too
+- Refactor Propel and test suite for massively usage of *vfsStream* instead of filesystem
+- Try to remove Quickbuilder and use vfsStream Files instead
+Basically we should remove unsupported functions (i.e. chdir, getcwd, pathinfo etc.)
+- Write the documentation and choose the tool. Maybe [MkDocs](https://www.mkdocs.org/)?

composer.json

@@ -16,33 +16,30 @@
  }
  ],
  "require": {
- "php": ">=7.2",
+ "php": ">=7.4",
  "ext-pdo": "*",
  "ext-sqlite3": "*",
- "symfony/yaml": "^3.0|^4.0",
- "symfony/console": "^3.0|^4.0",
- "symfony/finder": "^3.0|^4.0",
- "symfony/filesystem": "^3.0|^4.0",
- "symfony/event-dispatcher": "^3.0|^4.0",
- "symfony/config": "^3.0|^4.0",
+ "symfony/yaml": "^5.0",
+ "symfony/console": "^5.0",
+ "symfony/finder": "^5.0",
+ "symfony/filesystem": "^5.0",
+ "symfony/event-dispatcher": "^5.0",
+ "symfony/config": "^5.0",
  "psr/log": "^1.0",
- "gossi/php-code-generator": "0.5",
- "mustache/mustache": "^2.6",
- "marcj/topsort": "1.1.0",
- "bramus/monolog-colored-line-formatter": "^2.0",
- "phootwork/lang": "^0.9.0",
- "phootwork/file": "^0.2.0",
- "phootwork/collection": "^1.6",
- "phootwork/json": "^1.2"
+ "marcj/topsort": "^1.1",
+ "phootwork/lang": "^2.0",
+ "phootwork/collection": "^2.0",
+ "phootwork/json": "^2.0",
+ "phootwork/file": "^2.0",
+ "susina/psr2-code-generator": "^3.0",
+ "monolog/monolog": "^2.0",
+ "bramus/monolog-colored-line-formatter": "^3.0"
  },
  "require-dev" : {
- "monolog/monolog" : "~1.3",
- "phpunit/phpunit" : "^6.0|^7.0",
- "behat/behat" : "^3.3",
- "mikey179/vfsstream": "^1.6"
- },
- "suggest" : {
- "monolog/monolog" : "The recommended logging library to use with Propel."
+ "mikey179/vfsstream": "^1.6",
+ "behat/behat": "^3.6",
+ "phpunit/phpunit": "^9.1",
+ "susina/coding-standard": "^1.2"
  },
  "autoload" : {
  "psr-4" : {
@@ -69,5 +66,13 @@
  "branch-alias" : {
  "dev-master" : "3.0-dev"
  }
+ },
+ "scripts": {
+ "cs": "php-cs-fixer fix -v --diff --dry-run",
+ "cs-fix": "php-cs-fixer fix -v --diff"
+ },
+ "scripts-descriptions": {
+ "cs": "Run code style analysis, without fixing errors",
+ "cs-fix": "Run code style analysis and fix errors"
  }
 }

php_cs.dist

@@ -0,0 +1,22 @@
+<?php declare(strict_types=1);
+/**
+ * This file is part of the Propel package.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @license MIT License
+ */
+
+$config = new Susina\CodingStandard\Config();
+$config->getFinder()
+ ->exclude(['tests/Fixtures', 'tests/Resources'])
+ ->in(__DIR__ . '/src')
+ ->in(__DIR__ . '/tests')
+;
+
+// You can remove the following line if you don't run php-cs-fixer on Travis-ci
+$cacheDir = getenv('TRAVIS') ? getenv('HOME') . '/.php-cs-fixer' : __DIR__;
+
+$config->setCacheFile($cacheDir . '/.php_cs.cache');
+
+return $config;