oliverklee / ext-oelib

TYPO3 library extension "oelib"

"One Is Enough" library TYPO3 extension

This extension provides useful stuff for extension development: helper functions for unit testing, templating and automatic configuration checks.

Most of the documentation is in ReST format in the Documentation/ folder and is rendered as part of the TYPO3 documentation.

Running the tests locally

You will need to have a Git clone of the extension for this with the Composer dependencies installed.

Running the unit tests

On the command line

To run all unit tests on the command line:

composer ci:tests:unit

To run all unit tests in a directory or file (using the directory Tests/Unit/Model/ as an example):

.Build/vendor/bin/phpunit -c .Build/vendor/typo3/testing-framework/Resources/Core/Build/UnitTests.xml Tests/Unit/Model/

In PhpStorm

First, you need to configure the path to PHPUnit in the settings:

Languages & Frameworks > PHP > Test Frameworks

In this section, configure PhpStorm to use the Composer autoload and the script path .Build/vendor/autoload.php within your project.

In the Run/Debug configurations for PHPUnit, use an alternative configuration file:

.Build/vendor/typo3/testing-framework/Resources/Core/Build/UnitTests.xml

Running the functional tests

You will need a local MySQL user that has the permissions to create new databases.

In the examples, the following credentials are used:

• user name: typo3
• password: typo3pass
• DB name prefix: typo3_test (optional)
• DB host: localhost (omitted as this is the default)

You will need to provide those credentials as environment variables when running the functional tests:

• typo3DatabaseUsername
• typo3DatabasePassword
• typo3DatabaseName

On the command line

To run all functional tests on the command line:

typo3DatabaseUsername=typo3 typo3DatabasePassword=typo3pass typo3DatabaseName=typo3_test composer ci:tests:functional

To run all functional tests in a directory or file (using the directory Tests/Functional/Authentication/ as an example):

typo3DatabaseUsername=typo3 typo3DatabasePassword=typo3pass typo3DatabaseName=typo3_test .Build/vendor/bin/phpunit -c .Build/vendor/typo3/testing-framework/Resources/Core/Build/FunctionalTests.xml Tests/Functional/Authentication/

In PhpStorm

First, you need to configure the path to PHPUnit in the settings:

Languages & Frameworks > PHP > Test Frameworks

In this section, configure PhpStorm to use the Composer autoload and the script path .Build/vendor/autoload.php within your project.

In the Run/Debug configurations for PHPUnit, use an alternative configuration file:

.Build/vendor/typo3/testing-framework/Resources/Core/Build/FunctionalTests.xml

Also set the following environment variables in your runner configuration:

• typo3DatabaseUsername
• typo3DatabasePassword
• typo3DatabaseName

ext-oelib's Issues

Drop deprecated classes, methods, and arguments

… that are marked as @deprecatedand to be removed in oelib 4.0 (and keeps those that are marked to be removed in later version).

Also drop the corresponding tests and documentation.

Blocked by #411.

Use contexts for SIM_EXEC_TIME

In TYPO3 9LTS.

Add @extensionScannerIgnoreLine annotations to ignore false positives

Running https://github.com/Tuurlijk/typo3scan on the complete code base should not create any false positive when scanning with versions 6, 7, 8, 9 and 10. All places that are false positives need a https://github.com/Tuurlijk/typo3scan PHPDoc annotation.

(This is ticket is not about fixing the real issues.)

Drop the old @lazy annotation

from the ParentModel class. Only keep the new annotation.

Blocked by #406.

5) Tests/Unit/Domain/Fixtures/ParentModel.php:3

    ---------- begin diff ----------
@@ @@

 namespace OliverKlee\Oelib\Tests\Unit\Domain\Fixtures;

+use TYPO3\CMS\Extbase\Annotation as Extbase;
 use OliverKlee\Oelib\Domain\Model\Traits\CachedAssociationCount;
 use TYPO3\CMS\Extbase\Annotation\ORM\Lazy;
 use TYPO3\CMS\Extbase\DomainObject\AbstractEntity;
@@ @@
     /**
      * @var \TYPO3\CMS\Extbase\Persistence\ObjectStorage<\OliverKlee\Oelib\Tests\Unit\Domain\Fixtures\ParentModel>
      * @Lazy
-     * @lazy
+     * @Extbase\ORM\Lazy
      */
     protected $children = null;

Fix use of deprecated core API

As far as possible while maintaining compatibility with TYPO3 8.7 and 9.5.

PhpStorm's code inspection will find the usage of deprecated code.

Depends on #416.

Allow providing an API key for the Google geocoding

Require TYPO3 >= 9LTS

… and drop support for TYPO3 8.

Deprecate HeaderProxy and SystemEmailFromBuilder

@deprecated will be removed in oelib 4.0

Allow providing an API key for Google Maps

Replace insensitive, inconsiderate writing in the docs

… using the tool "alex" like Symfony has done:
https://alexjs.com/
https://github.com/symfony/symfony-docs/pull/14215/files

TypeError in Tx_Oelib_Template::getMarker()

I'm implementing a hook in seminars, and need to get marker values a from Tx_Oelib_Template. On integer values I get an exception:

(1/1) TypeError
Return value of Tx_Oelib_Template::getMarker() must be of the type string, integer returned
in /var/www/html/public/typo3conf/ext/oelib/Classes/Template.php line 226

     */
    public function getMarker(string $markerName): string
    {
        $unifiedMarkerName = $this->createMarkerName($markerName);
        return $this->markers[$unifiedMarkerName] ?? '';
    }

    /**
     * Sets a subpart's content.

at Tx_Oelib_Template->getMarker('number_of_registrations')
...

Cast to string in getMarker() or set type hint in setMarker() to ensure only strings are passed in (which will produce a multitude of errors at other places until casting to string everywhere).

Fix most instances of extension scanner warnings for TYPO3 9, 10

We might split this up into multiple PRs.

Rework the geocoding timing

https://developers.google.com/maps/documentation/geocoding/web-service-best-practices

We also must make sure to not exceed 300 seconds (which is the max execution time for running the tests on Travis):
https://travis-ci.org/oliverklee/ext-oelib/jobs/433380512

Fix most instances of extension scanner warnings for TYPO3 7, 8, 9

Fix the issues in code that will not be removed in oelib 4.0 anyway. We might need version-dependent code here (with version switches). For things that require a bigger refactoring, we need separate tickets, and we might need to move them to the 4.0 milestone.

We might split this up into multiple PRs.

Blocked by #387.

Fix use of deprecated core API

As far as possible while maintaining compatibility with TYPO3 9.5 and 10.4.

PhpStorm's code inspection will find the usage of deprecated code.

Depends on #406.

Stop accessing $controller->loginUser in TYPO3 9

Declare compatibility with TYPO3 10

… in composer.json and ext_emconf.php, but do not build/test with it yet.

Drop the migration files for namespaces

Now users of the extensions should only use the namespaced classes.

Add Migrations/ to the PHP linting in the CI

Update the configuration proxy to the new configuration format

https://docs.typo3.org/c/typo3/cms-core/master/en-us/Changelog/9.0/Deprecation-82254-DeprecateGLOBALSTYPO3_CONF_VARSEXTextConf.html

We need to support both, and if both are present, the new format needs to have a higher priority.

Mark the old way as @deprecated and to be removed in oelib 4.0.

Part of #419.

Static data of the geo coordinates of German ZIP codes

Move the testing framework dummy files to typo3temp

Currently, the oelib TestingFramework puts its dummy files in uploads/. Instead, it should put them in typo3temp/.

Also, stop using the constant PATH_site in all places.

Drop 8.7-only code

We can check for those by searching for class_exists and Typo3Version.

Blocked by #406.

Check/update/fix the language handling

Check the SalutationSwitcher class, whether detection of the current FE and BE language is still correct in TYPO3 8/9/10, check whether the language labels are still read correctly, and fix any issues and add tests as needed.

Blocked by #467 and #498.

Failed check for logged in users

FrontendLoginManager does not really check if fe_user is really logged. This ends i an exception in for example EXT:realty where tx_realty_Mapper_FrontendUser not exists, but is expected.

Hide test record from creation list

Stop using tmpl->getFileName

Either in general, or at least in TYPO3 V9.

Require PHP >= 7.2

… and drop support for PHP 7.0 and 7.1.

This affects composer.json, the ext_emconf.php and Resources/Private/Php/.

This is only about changing the requirements, not about changing the code.

Scrub the ext_tables.sql

Remove fields that now are autogenerated from the TCA: https://docs.typo3.org/c/typo3/cms-core/master/en-us/Changelog/9.3/Feature-85160-AutoCreateManagementDBFieldsFromTCACtrl.html

Blocked by #406.

Namespace all classes and rename some

All classes should be properly PSR-4-namespaced, including the test cases and fixture classes, also also including the deprecated classes.

The namespacing schema should follow the already namespaced classes and the existing tests. If the test case names and the tested class names differ, the new names should follow the names of the test cases.

We need proper migrations and a class alias map (with the old classes being marked as deprecated and to be removed in oelib 4.0.0).

We should have one PR per renamed/moved class or namespace (if the classes are really small).

Update the dev dependencies

To ^ with the highest bugfix-level versions that still run on PHP 7.0.

Stop calling initLLvars in TYPO3 9

Stop calling $page->getRootLine in TYPO3 V9

Use contexts for FE users

… in the login managers and the testing framework in TYPO3 9LTS.

Stop using the whitespace constants

Replace LF, CR, CRLF and TAB with "\n" etc.

Add badge for TYPO3 compatility

Like this:

![TYPO3 compatibility](https://img.shields.io/badge/TYPO3-8.7%20%7C%209.5-orange?maxAge=3600&style=flat-square&logo=typo3)

Throw version-dependent deprecation warnings

For all instances of GeneralUtility::logDeprecatedFunction, we need a version switch that triggers an error in TYPO3 >= 9 as recommended in https://docs.typo3.org/c/typo3/cms-core/master/en-us/Changelog/9.0/Deprecation-82438-DeprecationMethods.html.

Part of #419

Make the TemplateHelper namespaceable

Migrate to PHPUnit 7.5

Also add the corresponding fixer rules and use new assertions (as suggested by PhpStorm's code inspection).

Depends on #405

Upgrade Emogrifier to 5.0.0 or 5.0.1

… in the composer.json and in Resources/Private/Php/

Blocked by #405

Add tests for the Time constants

Add required PHP extensions to the composer.json

Add more type declarations

Parameter and return types. PhpStorm's code inspection will find them.

Add the new @lazy annotation

In the "parentModel" class.

We then temporarily will have two annotations - the old one and the new one.

https://docs.typo3.org/c/typo3/cms-core/master/en-us/Changelog/9.0/Deprecation-83078-ReplaceLazyWithTYPO3CMSExtbaseAnnotationORMLazy.html

Stop calling $template->init in TYPO3 V9

Use MailUtility in SystemEmailFromBuilder

Rework the configuration check

This needs to work in a way that is easier and less error-prone.

Stop accessing deprecated TypoScriptFrontendController properties in TYPO3 9

TestingFramework:

        $frontEnd->beUserLogin = false;
        $frontEnd->workspacePreview = '';

Either skip these in 9LTS or use/set the backend.user and workspace aspects.

        $frontEnd->initFEuser();
        …
        $frontEnd->initTemplate();

Only call both initTemplate in 8.7.

moveByRandomDistance may move too much

1. OliverKlee\Oelib\Tests\Unit\Geocoding\CalculatorTest::moveByRandomDistanceMovesAtMostByGivenDistanceWithPositiveDistance with data set "N" (90)
   Failed asserting that 100.0078663189693 is equal to 100.0 or is less than 100.0.

Add a visibility to all class constants

The visibility should be as narrow as possible: private, protected or public. We need to check whether seminars uses a constant.

Also drop the corresponding exception from phpcs.xml.dist.

Blocked by #405.