Prepare for zend-mvc v3 #329

weierophinney · 2016-04-18T20:17:49Z

For the v3 release, we will be pulling in a smaller set of components out-of-the-box. These are primarily defined by zend-mvc, but also include:

~~zend-config (used by the zend-modulemanager ConfigListener by default)~~ (zend-modulemanager now defines the zend-config requirement)
zend-skeleton-installer for prompting for optional packages/capabilities.
zend-component-installer, to automate registration of components as modules.

Additionally, we plan to leverage Composer for all autoloading, which means:

we can register a PSR-4 entry for the Application module, and remove one directory level;
the Application module no longer needs to setup autoloading.

For a minimal application, we do not want or need internationalization. As such, this patch also removes all translations and calls to translate strings in templates. We can explore re-adding them later, or offering an alternative skeleton application with more default features (including i18n, forms, databases, etc.).

At the time of submission, this patch provides a working skeleton with the current zend-mvc develop branch.

Testing

If you wish to test:

Clone the repository locally
Enter the cloned repository
Switch to the develop branch: git checkout -b develop origin/develop
Apply the changes: wget https://patch-diff.githubusercontent.com/raw/zendframework/ZendSkeletonApplication/pull/329.patch && git am 329.patch (or, if you use the hub command: git merge https://github.com/zendframework/ZendSkeletonApplication/pull/329)
Execute composer install

If you want to use vagrant:

Start it: vagrant up
Run composer within it: vagrant ssh -c 'cd /var/www ; composer install'
Start testing

If you want to use docker:

Build and run it: docker-compose up -d --build
Run composer within it: docker-compose run zf composer install
Start testing.

Please report any issues you notice or provide constructive feedback via comments to this pull request, or issue a pull request against my branch.

TODO

Installer

In each case, this should register the module(s) with the application, so that the user does not need to be prompted twice.

Documentation

ModuleRouteListener is removed from the skeleton. This won't affect existing users, but will affect experienced users who originally relied on it being active in new skeleton projects.
The /[:controller][/:action]] route was removed from the skeleton. Again, it will not affect existing users, but will affect experienced users who originally relied on it being active in new skeleton projects.

These items have been added to the maintainers wiki.

Updates

2016-05-17: added TODO list tracking installer and documentation tasks remaining.

Close #293

- Removed configuration for non-default zend-mvc features, including translation, forms, etc. - Removed translation files. - Removed translation within templates. - Re-organized Application module as a PSR-4 directory, and added an autoloading rule for it.

- Adds a `VERSION` constant to the `Application\Module` class; this is now consumed by the home page template. - Updates dependencies to pick up zend-view 2.6.7 and zend-router 3.0.1. - Updates the base application config to include the router and validator components. - Simplifies the autoloader to *only* use composer.

weierophinney · 2016-04-18T20:34:25Z

This is a WIP; do not merge until zend-mvc is tagged and/or zendframework is tagged!

Ocramius · 2016-04-19T00:33:00Z

init_autoloader.php


-if (!class_exists('Zend\Loader\AutoloaderFactory')) {
-    throw new RuntimeException('Unable to load ZF2. Run `php composer.phar install` or define a ZF2_PATH environment variable.');
+if (! class_exists('Zend\Mvc\Application')) {


Why not move that code in index.php? Imo it will simplify things a little more.

Ocramius · 2016-04-19T01:06:30Z

A few notes here:

not sure about translations, although they did make the skeleton MUCH fatter for very little gain. Including a translation module would be sufficient. Keeping the ->translate() calls would also be sufficient, for now.
I can't find direct references to Zend\Config in this code. Is the zend-modulemanager using class_exists()? If so, we should probably make this particular dependency usage explicit.
zend-component-installer I'm trying that nao \o/

Ocramius · 2016-04-19T01:14:58Z

A few other notes:

Zend\Loader still seems to be required: what does it take to chop its head off?
Zend\Http also required, but I see no diactoros: does that mean that PSR-7 support won't be there OOTB?
aren't required components automatically injected in application.config.php by the zendframework/zend-component-installer`? I glanced over the code at https://github.com/zendframework/zend-component-installer/blob/07fa730b11041d48106f658b655230828dc76ff1/src/ComponentInstaller.php#L187 - seems like that's the case

Ocramius · 2016-04-19T01:18:29Z

Confirmed: adding them to application.config.php is probably not needed, and it would expose the users to the process of configuring modules (possibly good):

back-2-95 · 2016-04-19T03:56:56Z

Very nice, it looks very clear and I like the way other zend-components are registered as modules. Removing one directory level is also very nice. We developers are lazy and like every small thing which makes our lives easier.

For the skeleton, I would convert all array(...) to use short array syntax. Old arrays exists on config files and in the layout.phtml.

Thanks for good work guys!

samsonasik · 2016-04-19T09:34:10Z

module/Application/view/application/index/index.phtml

            </div>
            <div class="panel-body">
-                <p><?php echo sprintf($this->translate('If you need any help or support while developing with ZF2, you may reach us via IRC: %s#zftalk on Freenode%s. We\'d love to hear any questions or feedback you may have regarding the beta releases. Alternatively, you may subscribe and post questions to the %smailing lists%s.'), '<a href="irc://irc.freenode.net/zftalk">', '</a>', '<a href="http://framework.zend.com/wiki/display/ZFDEV/Mailing+Lists">', '</a>') ?></p>
-                <p><a class="btn btn-success pull-right" href="http://webchat.freenode.net?channels=zftalk" target="_blank"><?php echo $this->translate('Ping us on IRC') ?> &raquo;</a></p>
+                <p><?php echo sprintf('If you need any help or support while developing with ZF2, you may reach us via IRC: %s#zftalk on Freenode%s. We\'d love to hear any questions or feedback you may have regarding the beta releases. Alternatively, you may subscribe and post questions to the %smailing lists%s.', '<a href="irc://irc.freenode.net/zftalk">', '</a>', '<a href="http://framework.zend.com/wiki/display/ZFDEV/Mailing+Lists">', '</a>') ?></p>


s/beta release/this release

s/the beta releases/this release

samsonasik · 2016-04-19T10:09:12Z

init_autoloader.php

-        ));
-    }
-}
+include 'vendor/autoload.php';


as no file_exists check, I think @ prefix ( @include usage ) should be provided as the error needs to be shown to user is the RuntimeException error

PHP will barf all over the place at this point anyways, and you'll get both an E_WARNING and the following RuntimeException. Essentially, I don't want to suppress errors or do additional error checking for something that represents a fundamentally broken install anyways.

samsonasik · 2016-04-19T10:20:21Z

@weierophinney I created PR weierophinney#3 to your branch for some feedbacks above ( wording, ::class, short array syntax )

Ocramius · 2016-04-19T13:27:08Z

module/Application/src/Module.php

+
+class Module
+{
+    const VERSION = '3.0.0dev';


This is shameless advertising, but ocramius/package-versions deals with it, eventually :)

Oh, that's slick!

/me goes to add that in the next push...

DAMMIT, @Ocramius ... PHP 7 as the minimum requirement?!?!?! (now I understand the "eventually" comment, though...)

Hah, totally forgot about that, sorry :-)

Yeah, next time then :-P

weierophinney · 2016-04-19T13:33:51Z

@Ocramius — some responses:

not sure about translations, although they did make the skeleton MUCH fatter for very little gain. Including a translation module would be sufficient. Keeping the ->translate() calls would also be sufficient, for now.

The translate() helper is part of zend-i18n, and would thus require installing zend-mvc-i18n as a dependency (which also brings in zend-i18n). We can certainly do that, but my thought is to have:

a base, minimal skeleton, with only the bare minimum necessary to create an MVC application, and then potentially add skeletons with more features.
an installer, ala zend-expressive, that allows you to opt-in to features:
- "Do you want the console integration?"
- "Do you want i18n integration?"
- "Do you want to use zend-db?"
- "Do you need caching?"
- etc.

One consistent complaint I've heard is from developers who start with the skeleton, and then need to strip out a whole bunch of stuff they don't need. If we have a minimal base on which we can expand, we solve that problem.

I can't find direct references to Zend\Config in this code. Is the zend-modulemanager using class_exists()? If so, we should probably make this particular dependency usage explicit.

It's used by the ConfigListener of zend-modulemanager, which I discovered that when testing out the skeleton. At this point, I'm unsure if the dependency should go in:

zend-modulemanager (ConfigListener is technically optional, though)
zend-mvc (as it enables the ConfigListener by default)
the skeleton application

Thoughts?

zend-component-installer I'm trying that nao \o/

Interestingly, the Zend\Router and Zend\Validator entries in the application configuration were added by the component installer when I first did a composer install. 😄 (I'm very excited by this!)

weierophinney · 2016-04-19T13:43:37Z

@Ocramius — more responses:

Zend\Loader still seems to be required: what does it take to chop its head off?

It's currently required by zend-modulemanager, for autoloading modules that do not have autoloading setup. (See Zend\ModuleManager\Listener\ModuleLoaderListener.)

Since one goal is to have a clear and clean upgrade path, we currently need to keep that. What we could do, however, is deprecate the usage; the question is if we should do that in a 2.x series of zend-modulemanager, or in the v3 release.

If we do it in the 2.x series, we could emit a deprecation notice from Zend\ModuleManager\Listener\AutoloaderListener whenever it receives autoloader configuration, prompting the user to add autoloading configuration to their composer.json; we could even link to a documentation page detailing the various approaches.

Thoughts?

Zend\Http also required, but I see no diactoros: does that mean that PSR-7 support won't be there OOTB?

Out of the box, no, not for the minimal skeleton. zend-psr7bridge is listed as a suggested requirement for zend-mvc already, however, and the suggestion text indicates it should be installed if you plan to use PSR-7 middleware within your application.

aren't required components automatically injected in application.config.php by the zendframework/zend-component-installer`? I glanced over the code at https://github.com/zendframework/zend-component-installer/blob/07fa730b11041d48106f658b655230828dc76ff1/src/ComponentInstaller.php#L187 - seems like that's the case

Yes and no. zend-component-installer prompts you to add the component, but gives you the option of saying "no" (as well as saying, "remember my selection for all remaining components on this installation run). It also checks to see if the component is already listed, and, if so, will not prompt. My feeling is that components required by the base skeleton should be listed in the configuration as well, so that you only get prompted the first time you add a new component.

weierophinney · 2016-04-19T13:44:23Z

For the skeleton, I would convert all array(...) to use short array syntax. Old arrays exists on config files and in the layout.phtml.

Noted; can't believe I missed that on the first pass through!

ZendSkeletonApplication#329 feedbacks

Ocramius · 2016-04-19T13:56:07Z

The translate() helper is part of zend-i18n, and would thus require installing zend-mvc-i18n as a dependency (which also brings in zend-i18n). We can certainly do that, but my thought is to have:

a base, minimal skeleton, with only the bare minimum necessary to create an MVC application, and then potentially add skeletons with more features.

an installer, ala zend-expressive, that allows you to opt-in to features:

"Do you want the console integration?"

"Do you want i18n integration?"

"Do you want to use zend-db?"

"Do you need caching?"

etc.

Agreed, let's keep i18n out then.

I can't find direct references to Zend\Config in this code. Is the zend-modulemanager using class_exists()? If so, we should probably make this particular dependency usage explicit.

It's used by the ConfigListener of zend-modulemanager, which I discovered that when testing out the skeleton. At this point, I'm unsure if the dependency should go in:

It should probably live in the module-manager. The 95% use-case of the module manager is merging config.

Out of the box, no, not for the minimal skeleton. zend-psr7bridge is listed as a suggested requirement for zend-mvc already, however, and the suggestion text indicates it should be installed if you plan to use PSR-7 middleware within your application.

Fair enough. I feel like we should push further on this in future, but maybe not now.

Yes and no. zend-component-installer prompts you to add the component, but gives you the option of saying "no" (as well as saying, "remember my selection for all remaining components on this installation run). It also checks to see if the component is already listed, and, if so, will not prompt. My feeling is that components required by the base skeleton should be listed in the configuration as well, so that you only get prompted the first time you add a new component.

My thought here is that while the user may answer "no", he may actually learn that he will be prompted. Not having that is also fine, IMO, but we're committing post-install artifacts. Still: good for usability, let's keep it as-is, I'd say.

Thinkscape · 2016-04-20T06:37:01Z

Out of the box, no, not for the minimal skeleton. zend-psr7bridge is listed as a suggested requirement for zend-mvc already, however, and the suggestion text indicates it should be installed if you plan to use PSR-7 middleware within your application.
Fair enough. I feel like we should push further on this in future, but maybe not now.

Would it be that crazy if the "installer" and skeleton was merged with zend-expressive-skeleton ?

If it was, there are possible cons:

People would still need to decide whether to go PSR7 or "legacy mvc", requires understanding what it is.
Increases package complexity slightly.

Pros:

Advertising: 3.0.0 equals the future version - expressive becomes integral part of new version.
Only one skeleton to maintain instead of two.
People actually start using PSR7 when they "default to ZF" or just want to try "the new ZF".
Because there's still a choice between PSR7 and "legacy mvc" in the installer, people can choose the latter and have somewhat easier migration path from ZF2.
Less legacy stuff. No need to wait for ZF4 or ZF3.1 or whatever else that cuts the cord.

Current blog posts and available docs do not clearly explain the PSR7 transition IMO. This would effectively solve the problem as ZF3 skeleton would give one clear choice. Through the "power of defaults" (default = expressive), the installer would be educating and promoting PSR7.

samsonasik · 2016-04-20T17:55:06Z

I think for 'controllers' -> 'invokables' config, we can use factories and use Zend\ServiceManager\Factory\InvokableFactory ? and change Application\Controller\Index to Application\Controller\IndexController for the key.

Maks3w · 2016-05-26T04:19:51Z

Dockerfile

@@ -0,0 +1,16 @@
+FROM php:7.0-apache
+
+RUN apt-get update \


Is this Dockerfile intended for use in production?

Most likely you would end up modifying it for production to include your application specific needs. The primary intent is to allow developers to start with a consistent development environment.

I wonder if we could split the command for make it more simple and add more things to docker cache even if it add more layers

This is doing exactly three things:

Ensuring we have the extensions necessary to run composer.

Ensuring the web server is configured correctly (enables mod_rewrite and changes the document root).

Installing composer.

I'm not sure we really need to simplify it further…

- Port 80 is already exposed by the parent container - docker-composer defines the volume

@Maks3w

- Per @Maks3w, added a `cd /var/www` command into the vagrant user's profile; simplifies running commands.

- Details various ways to install dependencies.

Maks3w · 2016-05-26T13:57:24Z

This is ok for me 👍

- zend-mvc is now at 3.0.0 - zend-test is now at 3.0.0 - zend-mvc-console is now at 1.1.10 - zend-mvc-i18n is now at 1.0.0 - zend-mvc-plugin-* are now at 1.0.0

- Instead of individual packages for each plugin.

weierophinney · 2016-05-31T22:05:46Z

Status update

First, I've updated to stable versions of:

zend-mvc (3.0)
zend-test (3.0)
zend-mvc-console (1.1.10, which marks zend-mvc v2 as a conflict)
zend-mvc-i18n (1.0)
zend-mvc-plugins (1.0; see below)

This puts the pull request in a good position to be tagged once merged. However…

I've created a zend-mvc-plugins metapackage, to aggregate all official plugins, reducing the number of prompts by three. However, on experimentation, it appears that packages installed via a metapackage do not trigger plugins; instead, only the metapackage triggers the plugin.

The solution will be to allow the module and component keys to be arrays, which will allow zend-mvc-plugins to define the list of components for zend-component-installer to install. Until that is done, this PR cannot be merged.

- skeleton installer: Prefer ^1.0 or ^0.1.2 - component installer: Prefer ^1.0 or ^0.2 - organize optional packages by package name

- first package to define component installer metadata

weierophinney · 2016-06-02T18:48:59Z

Status update

I've released zend-component-installer 0.2.0, which adds support for arrays of components, modules, and config-providers when defining packages.
I've released zend-skeleton-installer 0.1.1, which fixes a bug in the Uninstaller whereby the `composer.lock was not updated to reflect the removal of the skeleton installer package.
I've released zend-mvc-plugins 1.0.1, which updates the package to define an array of components for the component installer to inject into configuration.

At this time, this patch is finally ready to merge!

Close #329

weierophinney · 2016-06-02T18:55:50Z

Pushed to develop for release with 3.0.0.

weierophinney added 2 commits April 18, 2016 11:44

Streamline Application module

38167aa

- Removed configuration for non-default zend-mvc features, including translation, forms, etc. - Removed translation files. - Removed translation within templates. - Re-organized Application module as a PSR-4 directory, and added an autoloading rule for it.

weierophinney added this to the 3.0.0 milestone Apr 18, 2016

Ocramius reviewed Apr 19, 2016
View reviewed changes

samsonasik reviewed Apr 19, 2016
View reviewed changes

samsonasik added 2 commits April 19, 2016 16:41

remove "beta releases" wording in the home page

ed62746

::class

8794332

samsonasik reviewed Apr 19, 2016
View reviewed changes

short array syntax

9e62ae8

samsonasik mentioned this pull request Apr 19, 2016

ZendSkeletonApplication#329 feedbacks weierophinney/ZendSkeletonApplication#3

Merged

Ocramius reviewed Apr 19, 2016
View reviewed changes

Merge pull request #3 from samsonasik/feature/zend-mvc-v3-minimal

73e7263

ZendSkeletonApplication#329 feedbacks

samsonasik mentioned this pull request Apr 20, 2016

try zend-mvc dev-develop got error: "Could not find a valid ServiceManager for RoutePluginManager" zendframework/zend-mvc#133

Closed

InvokableFactory usage and short array syntax in layout

bd6d236

samsonasik mentioned this pull request Apr 20, 2016

InvokableFactory usage and missed short array syntax in layout weierophinney/ZendSkeletonApplication#4

Merged

Maks3w reviewed May 26, 2016
View reviewed changes

weierophinney added 5 commits May 26, 2016 08:07

Remove unnecessary Dockerfile directives

a0049bb

- Port 80 is already exposed by the parent container - docker-composer defines the volume

Remove unused variable declaration

fb5cf5c

Modify vagrantfile profile to change to /var/www

1ee68d6

- Per @Maks3w, added a `cd /var/www` command into the vagrant user's profile; simplifies running commands.

More useful error message if autoloading fails.

5616e68

- Details various ways to install dependencies.

Condense docker build and up operations to a one-liner

372459a

weierophinney added 5 commits May 26, 2016 09:40

Added link to docker-compose overview page

bada00a

Rename docker env to "zf"

05e2b24

Updated to stable dependencies

b26d228

- zend-mvc is now at 3.0.0 - zend-test is now at 3.0.0 - zend-mvc-console is now at 1.1.10 - zend-mvc-i18n is now at 1.0.0 - zend-mvc-plugin-* are now at 1.0.0

Use zend-mvc-plugins metapackage

cd36e05

- Instead of individual packages for each plugin.

Replace accidentally removed zend-skeleton-installer

1d67a42

weierophinney added 2 commits June 2, 2016 13:36

Preferred versions of skeleton installer, component installer

128c96a

- skeleton installer: Prefer ^1.0 or ^0.1.2 - component installer: Prefer ^1.0 or ^0.2 - organize optional packages by package name

Pin zend-mvc-plugins to ^1.0.1

bdd7909

- first package to define component installer metadata

weierophinney added a commit that referenced this pull request Jun 2, 2016

Merge branch 'feature/zend-mvc-v3-minimal' into develop

ec189b8

Close #329

weierophinney closed this Jun 2, 2016

This was referenced Jun 9, 2016

Kill non-composer installation methods? #313

Closed

Docker support #293

Closed

remove ZF2_PATH env usage as requirement is zf ~2.5 #306

Closed

Drop supports for Zend\Loader #316

Closed

that real minimum dependencies #323

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Prepare for zend-mvc v3 #329

Prepare for zend-mvc v3 #329

weierophinney commented Apr 18, 2016 •

edited

Loading

weierophinney commented Apr 18, 2016

Ocramius Apr 19, 2016

ghost Apr 19, 2016

Ocramius commented Apr 19, 2016

Ocramius commented Apr 19, 2016

Ocramius commented Apr 19, 2016

back-2-95 commented Apr 19, 2016

samsonasik Apr 19, 2016

samsonasik Apr 19, 2016 •

edited

Loading

samsonasik Apr 19, 2016

weierophinney Apr 19, 2016

samsonasik commented Apr 19, 2016

Ocramius Apr 19, 2016

weierophinney Apr 19, 2016

weierophinney Apr 19, 2016

Ocramius Apr 19, 2016

weierophinney commented Apr 19, 2016

weierophinney commented Apr 19, 2016 •

edited

Loading

weierophinney commented Apr 19, 2016

Ocramius commented Apr 19, 2016

Thinkscape commented Apr 20, 2016

samsonasik commented Apr 20, 2016

Maks3w May 26, 2016

weierophinney May 26, 2016

Maks3w May 26, 2016

weierophinney May 26, 2016

Maks3w commented May 26, 2016

weierophinney commented May 31, 2016

weierophinney commented Jun 2, 2016

weierophinney commented Jun 2, 2016

Prepare for zend-mvc v3 #329

Prepare for zend-mvc v3 #329

Conversation

weierophinney commented Apr 18, 2016 • edited Loading

Testing

TODO

Installer

Documentation

Updates

weierophinney commented Apr 18, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Ocramius commented Apr 19, 2016

Ocramius commented Apr 19, 2016

Ocramius commented Apr 19, 2016

back-2-95 commented Apr 19, 2016

Choose a reason for hiding this comment

samsonasik Apr 19, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

samsonasik commented Apr 19, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

weierophinney commented Apr 19, 2016

weierophinney commented Apr 19, 2016 • edited Loading

weierophinney commented Apr 19, 2016

Ocramius commented Apr 19, 2016

Thinkscape commented Apr 20, 2016

If it was, there are possible cons:

Pros:

samsonasik commented Apr 20, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Maks3w commented May 26, 2016

weierophinney commented May 31, 2016

Status update

weierophinney commented Jun 2, 2016

Status update

weierophinney commented Jun 2, 2016

weierophinney commented Apr 18, 2016 •

edited

Loading

samsonasik Apr 19, 2016 •

edited

Loading

weierophinney commented Apr 19, 2016 •

edited

Loading