RFC: 2.0.0 Roadmap

[davidyell]

I wanted to quickly make some notes about things which I think could be worked on for the next major release of the plugin. This is a quick list and by no means exhaustive. Any suggestions are welcome

• CakePHP 3.5 support. Is it worth continuing work in the existing 3.4-test branch? Bump up to CakePHP 3.6
• Where appropriate refactor mixed mode methods, such as Endpoint::endpoint() and Endpoint::alias() to getters and setters
• Tidy up the api to remove confusing method names. Eg, Endpoint::endpoint and Endpoint::endpoint()
• Upgrade to usage of setConfig() and getConfig()
• Bump code sniffer version and fix any warnings
• Implement the new setAlias() and getAlias() methods which are now part of the core RepositoryInterface into the Endpoints
• Replace the useless {@inheritDoc} doc blocks with actual doc blocks
• Move the AbstractDriver class into the Driver folder and update it's namespace
• Typehint where appropriate such as Endpoint::webservice()
• Add phpstan, with a script for basic support such as level 2
• Bump phpunit to 7.x and update the test suite
• Fix the FixtureListener in the phpunit.xml file as PHPUnit 7.x doesn't have the BaseListener class
• If no results are found, the returned total should be zero Query::count() should always return integer. #44
• Refactor Schema::options()
• Refactor Schema::columnType()
• Deprecate ControllerEndpointFilter since dispatch filters are deprecated in Cake 3.6 and add corresponding middleware instead. Deprecate the DispatchFilter #64
• Deprecate the EndpointRegistry, as TableRegistry has been deprecated Deprecate the EndpointRegistry #69
• Fix the Test boostraps use of deprecated DispatcherFactory Remove the use of deprecated dispatcher factory #67
• Using Query::repository() as getter is deprecated. Use getRepository() instead. Seems mostly to be in the tests
• Update the deprecated TypeMap() calls
• Adding pagination support, ref How to get pagination data? #42 Preserve the pagination data in the result set #43 Moved to post 2.0.0 release.
• Re-name some variables to better differentiate between strings and instances
• Update the Readme to show the new api

[ADmad]

CakePHP 3.5 support. Is it worth continuing work in the existing 3.4-test branch?

I am fine with bumping CakePHP version to 3.5. Let's start by doing that and updating the deprecated methods/properties. Please try and make small PRs addressing one point at a time.

Add phpstan, with a script for basic support such as level 2

Current master already passes phpstan checks at level 2.
https://github.com/UseMuffin/Webservice/blob/master/.travis.yml#L39

Bump phpunit to 7.x and update the test suite

Unless CakePHP core is updated to support phpunit 7 this can't be done.

[ADmad]

Move the AbstractDriver class into the Driver folder and update it's namespace

What benefit does that achieve? I dislike changes just for the sake of it.

If no results are found, the returned total should be zero

Doesn't #44 already take care of this?

[davidyell]

Any thoughts @Marlinc ? Would you see #23 as something for the 2.x release?

[davidyell]

@ADmad Are you happy for me to target master or would you prefer a new release branch?

[ADmad]

Just target master, I can change target later if needed.

[davidyell]

@ceeram Would you like to contribute a few tests in #49 so we can include your changes in the release?