Add Generator Factory #31

tux-rampage · 2017-12-07T10:42:16Z

This PR provides service factories for the AoT code generators, to minimize repetetive Tasks when using AoT.

The factory should will the config service to obtain information such as target namespace and output directory.

As Stated in #30, component consumers will then be able to retrieve the generator from the IoC container:

/** @var \Zend\ServiceManager\ServiceManager */
$generator = $serviceManager->get(\Zend\Di\GodeGenerator\InjectorGenerator::class);

Are you creating a new feature?
- Why is the new feature needed? What purpose does it serve?
- How will users use the new feature?
- Base your feature on the develop branch, and submit against that branch.
- Add only one feature per pull request; split multiple features over multiple pull requests
- Add tests for the new feature.
- Add documentation for the new feature.
- Add a CHANGELOG.md entry for the new feature.

michalbundyra · 2017-12-11T13:01:42Z

CHANGELOG.md

@@ -6,11 +6,14 @@ All notable changes to this project will be documented in this file, in reverse

 ### Added

- Nothing.
+- Service factory `Zend\Di\Container\GeneratorFactory`, to create a


PR number and link where this change has been made.

michalbundyra · 2017-12-11T13:04:23Z

CHANGELOG.md

- Nothing.
+- Added `getOutputDirectory` to `Zend\Di\CodeGenerator\GeneratorTrait`.
+
+- Added `getNamespace()` to `Zend\Di\CodeGenerator\InjectorGenerator`.


The same here, please see CHANGELOG in another repo, for example:
https://github.com/zendframework/zend-db/blob/master/CHANGELOG.md

Also for me these changes, are additions so should be in "Added" section.

michalbundyra · 2017-12-11T13:04:40Z

docs/book/codegen.md

@@ -14,7 +14,7 @@ based on these results.
 > $ composer require zendframework/zend-code
 > ```

-## Generating an optimized injector
+# Generating an optimized injector


I think it was right, we should have only one header 1st lvl in each doc.

michalbundyra · 2017-12-11T13:05:02Z

docs/book/codegen.md

@@ -46,3 +46,43 @@ You can also utilize `Zend\Code\Scanner` to scan your code for classes:
 $scanner = new DirectoryScanner(__DIR__);
 $generator->generate($scanner->getClassNames());
 ```
+
+# MVC and Expressive integration


It should be 2nd lvl header

michalbundyra · 2017-12-11T13:08:57Z

src/CodeGenerator/GeneratorTrait.php

@@ -80,4 +80,12 @@ public function setOutputDirectory(string $dir, ?int $mode = null) : self

        return $this;
    }
+
+    /**
+     * @return string


Doc-block comment is useless here, as function has defined return type.
What's more it is not consistent with return type (or maybe it is on purpose?)

It was auto generated by ZendStudio and i forgot to remove it ...

michalbundyra · 2017-12-11T13:16:53Z

test/Container/GeneratorFactoryTest.php

+<?php
+/**
+ * @see       https://github.com/zendframework/zend-di for the canonical source repository
+ * @copyright Copyright (c) 2017 Zend Technologies USA Inc. (http://www.zend.com)


https link for zend.com

michalbundyra · 2017-12-11T13:17:23Z

test/Container/GeneratorFactoryTest.php

+            'dependencies' => [
+                'auto' => [
+                    'aot' => [
+                        'directory' => $expected


trailing comma after last element please

michalbundyra · 2017-12-11T13:17:48Z

test/Container/GeneratorFactoryTest.php

+    {
+        $container = $this->getMockBuilder(ContainerInterface::class)->getMockForAbstractClass();
+        $container->method('has')->willReturnCallback(function ($type) {
+            return ($type == ConfigInterface::class);


parenthesis around the expression are useless

I find this more expressive and readable, but this is personal preference. I will remove it.

michalbundyra · 2017-12-11T13:18:45Z

test/Container/GeneratorFactoryTest.php

+
+    public function testFactoryUsesDiConfigContainer(): void
+    {
+        $container = $this->getMockBuilder(ContainerInterface::class)->getMockForAbstractClass();


It's ok, but probably you'll find easier to use prophecy (it is required by phpunit, and we are using it in other repos)

Thanks for the hint, I'll keep this in mind the next time

michalbundyra · 2017-12-11T13:19:34Z

test/Container/GeneratorFactoryTest.php

+        $factory->create($container);
+    }
+
+    public function testSetsOutputDirectoryFromConfig()


return type void for consistency, also in other test methods in that file

michalbundyra · 2017-12-11T13:30:19Z

test/Container/GeneratorFactoryTest.php

+            ->method('create')
+            ->with($container);
+
+        $mock($container);


Here we should assign the result and do some assertions on it.

michalbundyra · 2017-12-11T14:50:51Z

CHANGELOG.md


- Added `getNamespace()` to `Zend\Di\CodeGenerator\InjectorGenerator`.
+- #31 Added `getNamespace()` to `Zend\Di\CodeGenerator\InjectorGenerator`.


still missing links to the PR, and these changes should be moved to "Added" section, as these are additions

michalbundyra · 2017-12-11T14:52:58Z

test/Container/GeneratorFactoryTest.php

    {
        $container = $this->getMockBuilder(ContainerInterface::class)->getMockForAbstractClass();
        $container->method('has')->willReturnCallback(function ($type) {
-            return ($type == ConfigInterface::class);
+            return $type == ConfigInterface::class;


Didn't note it previously, I would use here === as we started using strict types

weierophinney

I've pushed a few commits that provide edits to the changelog and documentation; otherwise, looks great!

When you are ready to release, be sure to remove the 3.0.1 stub in the CHANGELOG, as well as to set the date for the 3.1.0 release in it. Also, after pushing the tag, edit the release on github, name it "zend-di 3.1.0", and copy-paste the 3.1.0 changelog entry. These actions will trigger a webhook that will tweet the release, as well as update the master ZF release feed.

Thanks, @tux-rampage !

tux-rampage · 2017-12-11T17:22:51Z

Great thank you very much

Add Generator Factory

Close #30 Close #31

tux-rampage added 3 commits December 6, 2017 06:39

Add test case for generator factory

900833e

Add generator factory

37c9cad

Fix use statement order

f31987d

tux-rampage self-assigned this Dec 7, 2017

tux-rampage added the enhancement label Dec 7, 2017

tux-rampage added this to the 3.1.0 milestone Dec 7, 2017

tux-rampage added 10 commits December 7, 2017 12:52

Refactor container usage test to test one aspect per test

8a7fc18

Add missing test cases

429002c

Implement generator factory

8153e4d

Add test for construct with custom namespace

7781e61

Add missing test for invoke

839dafb

Add typehints

3c27630

Update documentation

4a02b9f

Update documentation

d5a55c4

Add changelog entries

497963f

Update documentation

190d0ad

tux-rampage changed the title ~~Add Generator Factory (WIP)~~ Add Generator Factory Dec 11, 2017

michalbundyra reviewed Dec 11, 2017

View reviewed changes

tux-rampage added 4 commits December 11, 2017 15:26

Add PR reference to changelog

c0b58b6

Update docs

4e932e4

Style fixes

298b62d

Update dependencies

30d3ec9

michalbundyra reviewed Dec 11, 2017

View reviewed changes

Style fixes

74577a2

michalbundyra reviewed Dec 11, 2017

View reviewed changes

weierophinney added 2 commits December 11, 2017 09:49

Rephrases CHANGELOG entries for zendframework#31

dc73ab9

Documentation edits for consistency and readability.

2f34376

weierophinney approved these changes Dec 11, 2017

View reviewed changes

tux-rampage merged commit 2f34376 into zendframework:develop Dec 13, 2017

tux-rampage added a commit that referenced this pull request Dec 13, 2017

Merge pull request #31 from tux-rampage/generator-factory

e6e17c4

Add Generator Factory

tux-rampage added a commit that referenced this pull request Dec 13, 2017

Merge branch 'feature/31' into develop

dcd0081

Close #30 Close #31

tux-rampage deleted the generator-factory branch December 13, 2017 06:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Generator Factory #31

Add Generator Factory #31

tux-rampage commented Dec 7, 2017 •

edited

Loading

michalbundyra Dec 11, 2017

michalbundyra Dec 11, 2017

michalbundyra Dec 11, 2017

michalbundyra Dec 11, 2017

michalbundyra Dec 11, 2017

michalbundyra Dec 11, 2017

tux-rampage Dec 11, 2017

michalbundyra Dec 11, 2017

michalbundyra Dec 11, 2017

michalbundyra Dec 11, 2017

tux-rampage Dec 11, 2017

michalbundyra Dec 11, 2017

tux-rampage Dec 11, 2017

michalbundyra Dec 11, 2017

michalbundyra Dec 11, 2017

michalbundyra Dec 11, 2017

michalbundyra Dec 11, 2017

weierophinney left a comment

tux-rampage commented Dec 11, 2017


		- Added `getNamespace()` to `Zend\Di\CodeGenerator\InjectorGenerator`.
		- #31 Added `getNamespace()` to `Zend\Di\CodeGenerator\InjectorGenerator`.

Add Generator Factory #31

Add Generator Factory #31

Conversation

tux-rampage commented Dec 7, 2017 • edited Loading

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

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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

weierophinney left a comment

Choose a reason for hiding this comment

tux-rampage commented Dec 11, 2017

tux-rampage commented Dec 7, 2017 •

edited

Loading