Prepare skeleton to use ZF v3 releases by default #130

weierophinney · 2016-08-09T22:50:02Z

For the next minor release (1.4), we'll be using ZF v3 components by default. This patch does the followign:

Sets the minimum supported PHP version to 5.6.
Removes the zendframework/zendframework dependency entirely; zf-apigility and others bring in zend-mvc already, which gives us the MVC foundation necessary.
Adds zendframework/zend-component-installer as a requirement.
Adds zfcampus/zf-asset-manager as a development requirement.
Removes zendframework/zftool as a development requirement.
Updates all Apigility requirements, both production and development, to their latest stable versions.
Adds Composer scripts for:
- enabling development mode (composer development-enable)
- disabling development mode (composer development-disable)
- reporting development mode status (composer development-status)

This has been tested quite a bit along with the zf-apigility-admin 1.5.0 release, but likely needs more testers. In particular, I'm curious what the "install" experience is like, and whether or not people are getting endless requests to update their module configuration, or if it "just installs".

- Use latest, known-stable versions that are forwards compatible with v3 releases. - Do not require all of zendframework.

- Proxy to zf-development-mode script installed via composer.

- Removes usage of `translate()` helper in shipped view scripts. - Use `<?=` instead of `<?php echo` in shipped view scripts. - Remove abstract factory entries for components not shipped by default. - Add module entries for components that define them. - Remove zf-tool dependency and module entry. - Remove AssetManager dependency and module entry. - Add zf-asset-manager as a dev dependency. - Add zend-component-installer as a dependency. - Adds .gitignore placeholder file in `public`.

- Picks up changes to zf-content-validation and zf-apigility-documentation.

- Updated to stable zf-apigility-admin, and removed zf-apigility-admin-ui (as it's a dependency of zf-apigility-admin).

lrochas · 2016-08-10T12:13:40Z

Not sure what kind of "install experience" feed back you're looking for but I can confirm that the basic installation worked like a charm:

Download the develop branch via zipball.
Unzip.
Install dependencies with Composer composer.phar install.
Put the skeleton in development mode php public/index.php development enable.
Start the built-in web server php -S 0.0.0.0:8080 -ddisplay_errors=0 -t public public/index.php.
Create new API and new Service then modify and delete.

Everything went smooth.

michalbundyra · 2016-08-10T13:04:10Z

module/Application/view/layout/layout.phtml

@@ -15,14 +15,14 @@
    </head>
    <body>
        <div class="container">
-            <?php echo $this->content; ?>
+            <?= $this->content; ?>


usually we don't have ending ; in this type of expression

benjaminkoetting · 2016-08-10T13:05:59Z

same here

use the code as zip
composer install
composer development-enable
composer serve

it's working!

michalbundyra · 2016-08-10T13:09:22Z

module/Application/view/error/index.phtml

 <hr/>
-<h2><?php echo $this->translate('Additional information') ?>:</h2>
-<h3><?php echo get_class($this->exception); ?></h3>
+<h2>Additional information:</h2>


Why this part is not with 2 indents? It is body of if statement, so I think we should have:

<?php if (something) : ?> <some html="tag">...</some> <?php endif ?>

Of course the same for loops.

Some of this indenting is inherited. Most changes I made were based on phpcs warning me about issues as I edited. I'll review again, however.

Actually, this is different.

The markup should not be indented here, only the PHP statements. Otherwise, when viewing the source of the page, you'll have markup indented that shouldn't be.

In this particular case, we're conditionally displaying some markup, but that markup is not semantically inside any other blocks.

@weierophinney ok, it just looks odd in phtml files, but it make sense, thanks!

@webimpress Agreed, but it makes view source so much nicer when retrieving the final pages via HTTP. 😄

weierophinney · 2016-08-10T13:14:56Z

For those interested in testing composer create-project, you can do the following:

Create a file named packages.json with the following contents:

{
   "packages": {
       "zfcampus/zf-apigility-skeleton": {
           "1.4.0": {
               "name": "zfcampus/zf-apigility-skeleton",
               "version": "1.4.0",
               "source": {
                   "url": "https://github.com/weierophinney/zf-apigility-skeleton.git",
                   "type": "git",
                   "reference": "9c166078bd5b51186e9e10b4d4c819639611190f"
               }
           }
       }
   }
}

Run create-project, referencing the above as a repository:
```
$ composer create-project --repository=packages.json zfcampus/zf-apigility-skeleton apigility 1.4.0
```
This will create a new project in the directory apigility/.
Descend into the project:
```
$ cd apigility
```
Put it into development mode:
```
$ composer development-enable
```
Test it:
```
$ composer serve
```
and visit http://localhost:8080/

I've done this locally, and found installation "just worked". Assets were correctly copied into the application, the installer did not prompt me to add modules, and the UI worked correctly.

Please let me know if you have any issues!

UPDATE

I've updated the sha1 reference to reflect recent commits pushed.

michalbundyra · 2016-08-10T13:15:12Z

composer.json

-        "zfcampus/zf-apigility-doctrine": "zfcampus/zf-apigility-doctrine ~1.0 to create Doctrine-Connected REST services",
-        "zfcampus/zf-http-cache": "zfcampus/zf-http-cache ~1.0 to add HTTP caching to your API",
-        "zfr/zfr-cors": "zfr/zfr-cors ~1.2 to add CORS support to your API"
+        "zfcampus/zf-apigility-doctrine": "zfcampus/zf-apigility-doctrine ^1.0 to create Doctrine-Connected REST services",


zfcampus/zf-apigility-doctrine is alredy in version 2, hopefully soon will be 2.1

weierophinney · 2016-08-10T13:32:56Z

@lrochas —

Put the skeleton in development mode php public/index.php development enable.

That worked? It shouldn't! With zf-development-mode v3, it should be one of:

composer development-enable
./vendor/bin/zf-development-mode enable

I'm thinking you may have tested the develop branch, and not my branch specifically. Try the example I noted above, or:

$ git clone https://github.com/weierophinney/zf-apigility-skeleton.git
$ cd zf-apigility-skeleton
$ git checkout -b feature/zf-v3-readiness origin/feature/zf-v3-readiness
$ composer install
$ composer development-enable

- Per @webimpress

- No tailing `;` if a closing `?>` is present. - Ensure indentation is correct based on conditional/loop level.

- per @webimpress

- Usually, this will not be an issue, but this ensures no problems can occur. Per @webimpress.

- Suggested v2.1 instead.

weierophinney · 2016-08-10T13:50:48Z

@webimpress — thanks for the detailed feedback; I've just pushed changes that should address each item you raised.

weierophinney · 2016-08-10T13:53:43Z

For those of you testing via create-project, please note that I've updated the comment now to reflect the most recent sha1 pushed; update your packages.json to test against it! 😄

michalbundyra · 2016-08-10T13:54:02Z

config/application.config.php

        // Using __DIR__ to ensure cross-platform compatibility. Some platforms --
        // e.g., IBM i -- have problems with globs that are not qualified.
-        'config_glob_paths' => array(realpath(__DIR__) . '/autoload/{,*.}{global,local}.php'),
+        'config_glob_paths' => [realpath(__DIR__) . '/autoload/{,*.}{global,local}.php'],


I think __DIR__ should be enough here, we don't need realpath here, am I wrong?

WRONG! 😄

IBM i Series users have reported to us in the past that globbing, even when using zend-stdlib, fails unless the real path is used. As such, we provide it both in here and the ZF skeleton application.

Oh, I didn't it, thanks ! :)

Yeah, I didn't either until I got the issues in the tracker, and one of our pro services folks did the research. It seems an edge case, but we have a significant number of IBM i users.

- Use ubuntu/xenial64 as the base. - Inline the additions to the default vhost, instead of requiring another file. - Document vagrant + virtualbox requirements on linux to use the image. - Ensure UI module is up-to-date.

- Inline the default vhost - Add `ubuntu-xenial` to the `/etc/hosts` file to fix a bug - Use the `-q` switch with grep to prevent the need for redirecting output in conditionals - Conditionally install composer; if it's already present, do a self-update

weierophinney · 2016-08-11T20:48:39Z

Besides the instructions noted above for using create-project, you can also, once the project is created, use either docker-compose or vagrant:

# docker-compose:
$ docker-compose build # only needed the first time
$ docker-compose up
# vagrant:
$ vagrant up

Please note that the vagrant image is ubuntu/xenial64; if you are using VirtualBox, you will need vagrant 1.8.5 or higher, and VirtualBox 5.0.26 or higher.

Simplifies documentation, and you can enable/disable development mode easily via the container.

- Uses PHP_EOL now. - Also updates the docker-compose directions

Adds a delegator factory for the `ZF\Configuration\ConfigWriter` service that configures it to use short array notation and `::class` constants. The delegator is only enabled in development mode.

michalbundyra · 2016-08-12T19:43:49Z

module/Application/test/Controller/ZZIndexControllerDevModeTest.php

+                'config_cache_enabled' => false,
+                'config_glob_paths' => [
+                    __DIR__ . '/../../../../config/autoload/{,*.}{global,local}.php',
+                    __DIR__ . '/../../../../config/autoload/{,*.}{global,local}-development.php',


globbing, IBM etc... ? realpath(__DIR__) ?

Not necessary in the unit tests.

- zf-apigility-admin-ui 1.3.6 - zf-apigility-admin 1.5.4 - zf-asset-manager 1.1.1 - zf-composer-autoloading 1.0

- eliminates the need for the delegator factory!

- zfcampus/zf-apigility-admin 1.5.6 - zfcampus/zf-apigility-admin-ui 1.3.7

- No longer necessary to include it as of 1.2.0.

michalbundyra · 2016-08-14T21:07:27Z

config/autoload/global-development.php

 */

-return array(
-    'view_manager' => array(
+use Apigility\ConfigWriterDelegatorFactory;


it can be removed now

viyirenov · 2016-08-15T05:13:33Z

I tried your instructions and it ran nicely, two things though:

1 - composer serve script has to be with public and not public/ to work on Windows otherwise it will throw an error saying that the directory doesn't exist.

"scripts": {
    // ...
    "serve": "php -S 0.0.0.0:8080 -t public public/index.php",
    // ...
}

2 - Error when trying to require doctrine orm module:

Your requirements could not be resolved to an installable set of packages.

  Problem 1
    - Can only install one of: zendframework/zend-hydrator[2.2.1, 1.1.0].
    - Can only install one of: zendframework/zend-hydrator[1.1.0, 2.2.1].
    - Can only install one of: zendframework/zend-hydrator[1.1.0, 2.2.1].
    - doctrine/doctrine-orm-module 1.0.0 requires zendframework/zend-hydrator ^1.1 -> satisfiable by zendframework/zend-hydrator[1.1.0].
    - Installation request for doctrine/doctrine-orm-module ^1.0 -> satisfiable by doctrine/doctrine-orm-module[1.0.0].
    - Installation request for zendframework/zend-hydrator (locked at 2.2.1) -> satisfiable by zendframework/zend-hydrator[2.2.1].

Installation failed, reverting ./composer.json to its original content.

- Remove tooling-specific entries (those should be in global configuration, or can be added after starting a project) - Moved `config/autoload/` rules to that directory - Removed unused rules

- It's only required in development anyways.

Close #130

weierophinney added 6 commits August 3, 2016 14:24

Updated dependencies

1ac3fd5

- Use latest, known-stable versions that are forwards compatible with v3 releases. - Do not require all of zendframework.

Added development-enable and development-disable scripts

285ca1a

- Proxy to zf-development-mode script installed via composer.

Added serve and development-status scripts

1b3f0c9

Updated dependencies

aa179c1

- Picks up changes to zf-content-validation and zf-apigility-documentation.

Updated to stable dependencies

35d47b3

- Updated to stable zf-apigility-admin, and removed zf-apigility-admin-ui (as it's a dependency of zf-apigility-admin).

AGmakonts mentioned this pull request Aug 9, 2016

ZF 3.0.0 Compatibility - progress monitoring zfcampus/zf-apigility#167

Closed

25 tasks

weierophinney added the enhancement label Aug 9, 2016

weierophinney added this to the 1.4.0 milestone Aug 9, 2016

michalbundyra mentioned this pull request Aug 10, 2016

Error when composer update #131

Closed

michalbundyra reviewed Aug 10, 2016
View reviewed changes

weierophinney added 5 commits August 10, 2016 08:35

Remove trailing semicolon within template

215fd83

- Per @webimpress

Fixed indentation, syntax on all view scripts

e99c76a

- No tailing `;` if a closing `?>` is present. - Ensure indentation is correct based on conditional/loop level.

Updated copyright in configuration file

5526b44

- per @webimpress

Escape exception messages

3169db8

- Usually, this will not be an issue, but this ensures no problems can occur. Per @webimpress.

Updated zf-apigility-doctrine suggestion

62b5ba1

- Suggested v2.1 instead.

michalbundyra reviewed Aug 10, 2016
View reviewed changes

weierophinney added 6 commits August 11, 2016 13:14

subsitute spaces with tabs in apache configuration

f8c76f2

Updated Vagrant configuration again, per @webimpress

3bbcc56

- Use ubuntu/xenial64 as the base. - Inline the additions to the default vhost, instead of requiring another file. - Document vagrant + virtualbox requirements on linux to use the image. - Ensure UI module is up-to-date.

Updated Vagrant configuration

dcd9ede

- Inline the default vhost - Add `ubuntu-xenial` to the `/etc/hosts` file to fix a bug - Use the `-q` switch with grep to prevent the need for redirecting output in conditionals - Conditionally install composer; if it's already present, do a self-update

Updated vagrant + virtualbox requirements

0eeb50c

Make license docblocks consistent

d2ae804

Added image name to Vagrantfile

e27b8b9

weierophinney added 7 commits August 11, 2016 15:52

Renamed default docker container to "apigility"

609c4ad

One dockerfile only

9cb5533

Simplifies documentation, and you can enable/disable development mode easily via the container.

Ensure autoloading exception displays properly regardless of OS

3d4218a

- Uses PHP_EOL now. - Also updates the docker-compose directions

Use short array syntax and ::class in generated config files

541d1f0

Adds a delegator factory for the `ZF\Configuration\ConfigWriter` service that configures it to use short array notation and `::class` constants. The delegator is only enabled in development mode.

Generate PSR-4 modules by default

1d1e857

Updated to zf-apigility-admin 1.5.3

ac497ab

Use constant for value

e224abc

michalbundyra reviewed Aug 12, 2016
View reviewed changes

weierophinney added 7 commits August 12, 2016 16:05

Updated dependencies

42722c9

- zf-apigility-admin-ui 1.3.6 - zf-apigility-admin 1.5.4 - zf-asset-manager 1.1.1 - zf-composer-autoloading 1.0

Updated zf-apigility-admin to 1.5.5

260f695

Enable short array notation in generated config by default

45868d3

Use zf-configuration's class_name_scalars setting

8de683e

- eliminates the need for the delegator factory!

Updated to zfcampus/zf-apigility-admin-ui 1.3.7

15c1554

Last dependency updates (hopefully)

9c16607

- zfcampus/zf-apigility-admin 1.5.6 - zfcampus/zf-apigility-admin-ui 1.3.7

Remove ZF\Apigility\Provider from module list

67e5402

- No longer necessary to include it as of 1.2.0.

michalbundyra reviewed Aug 14, 2016
View reviewed changes

weierophinney added 3 commits August 15, 2016 07:31

Remove unused import statements

be72a66

Simplify gitignore rules

b437c4a

- Remove tooling-specific entries (those should be in global configuration, or can be added after starting a project) - Moved `config/autoload/` rules to that directory - Removed unused rules

Moved constants autoloading to development

721ea7b

- It's only required in development anyways.

weierophinney merged commit 721ea7b into zfcampus:develop Aug 15, 2016

weierophinney added a commit that referenced this pull request Aug 15, 2016

Merge branch 'feature/zf-v3-readiness' into develop

5065109

Close #130

weierophinney deleted the feature/zf-v3-readiness branch August 15, 2016 12:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Prepare skeleton to use ZF v3 releases by default #130

Prepare skeleton to use ZF v3 releases by default #130

weierophinney commented Aug 9, 2016

lrochas commented Aug 10, 2016 •

edited

michalbundyra Aug 10, 2016

benjaminkoetting commented Aug 10, 2016

michalbundyra Aug 10, 2016

weierophinney Aug 10, 2016

weierophinney Aug 10, 2016

michalbundyra Aug 10, 2016

weierophinney Aug 10, 2016

weierophinney commented Aug 10, 2016 •

edited

michalbundyra Aug 10, 2016

weierophinney commented Aug 10, 2016

weierophinney commented Aug 10, 2016

weierophinney commented Aug 10, 2016

michalbundyra Aug 10, 2016

weierophinney Aug 10, 2016

michalbundyra Aug 10, 2016

weierophinney Aug 10, 2016

weierophinney commented Aug 11, 2016

michalbundyra Aug 12, 2016

weierophinney Aug 12, 2016

michalbundyra Aug 14, 2016

viyirenov commented Aug 15, 2016 •

edited

Prepare skeleton to use ZF v3 releases by default #130

Prepare skeleton to use ZF v3 releases by default #130

Conversation

weierophinney commented Aug 9, 2016

lrochas commented Aug 10, 2016 • edited

Choose a reason for hiding this comment

benjaminkoetting commented Aug 10, 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

Choose a reason for hiding this comment

weierophinney commented Aug 10, 2016 • edited

UPDATE

Choose a reason for hiding this comment

weierophinney commented Aug 10, 2016

weierophinney commented Aug 10, 2016

weierophinney commented Aug 10, 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 Aug 11, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

viyirenov commented Aug 15, 2016 • edited

lrochas commented Aug 10, 2016 •

edited

weierophinney commented Aug 10, 2016 •

edited

viyirenov commented Aug 15, 2016 •

edited