Support for PHP 8.0 class attributes generation

[jakublabno]

Q	A
BC Break	no
New Feature	yes

Description

Feature that allows attribute generation for classes (methods/properties is the next step)
Either non-arguments attributes and named arguments are supported.
Nested attributes are not supported yet.
You can use it in a few ways:

1. From plain array

ClassGenerator::fromArray([
            'name' => 'AnyClassName',
            'attribute' => [
                ['FirstAttribute', ['firstArgument' => 'abc', 'secondArgument' => 12]],
                ['FirstAttribute', ['firstArgument' => 'abc', 'secondArgument' => 13]],
                ['SecondAttribute'],
            ],
        ])

2. From array with builder instance

/**
@ var AttributeGeneratorBuilder $builder
*/
ClassGenerator::fromArray([
            'name' => 'AnyClassName',
            'attribute' => $builder,
            ],
        ])

3. From class reflection

$classGenerator = new ClassGenerator();
$attributeGenerator = AttributeGenerator::fromReflection($reflectionClass);

$classGenerator->setAttributes($attributeGenerator);

4. From builder

$classGenerator = new ClassGenerator();
$builder = new AttributeGenerator\AttributeBuilder();
      $builder
          ->add('LaminasTest\Code\Generator\Fixture\AttributeGenerator\AttributeWithArguments', [
              'stringArgument' => 'any string',
              'intArgument' => 1,
              'boolArgument' => true,
          ])
          ->add('LaminasTest\Code\Generator\Fixture\AttributeGenerator\SimpleAttribute');

      $builder = AttributeGenerator::fromBuilder($builder);
      $generator->setAttribute($builder);

[Ocramius]

Did a first skim: endorse simplifying and removing flexibility in a first step.

The factory and the builder are not necessary, if the attribute generator can act as an immutable builder (most common use-case anyway)

[Ocramius]

We should probably make this final, since it's a new symbol, and inheritance abuse is strong :-)

[jakublabno]

Yes, I don't know why I extended it, maybe in the beginning when I didn't know the code, I'll stay on with interface GeneratorInterface :)

[Ocramius]

Let's not make this Stringable: Stringable is a terrible API.

See also ShittySoft/symfony-live-berlin-2018-doctrine-tutorial#3 (comment) for more clarity

[Ocramius]

This code can all be inlined into the AttributeGenerator: no need to make a separate class out of it.

[Ocramius]

This type is to be refined

[Ocramius]

Let's mark all internally used symbols as @internal, to allow refactoring/rewrite as soon as we are allowed to.

[jakublabno]

@Ocramius

[Ocramius]

Sorry, didn't get to work on this at all, due to other priorities.

[Ocramius]

I decided to drop all ::fromArray() methods as per #153

This API will be dropped once I have the green light on #153

[Ocramius]

After digging further into this, I decided to skip it for 4.8.0.

Specifically, I would simplify the AttributeGenerator to use a ValueGenerator or similar internally, instead of the current AttributeAssembler logic.

I understand that you wanted to split generator and data structure, but practically, it doesn't really help with the use-case of this library, IMO.

What I'd end up with in the end is probably a single class with a thin public API, and a lot of private and @internal API to start with:

• AttributeGenerator::fromReflection(Reflector): list<AttributeGenerator> (unsure about it - the API seems a bit messy)
• AttributeGenerator::fromValue(object $attribute): self
• AttributeGenerator#generate()

Everything else would be private or @internal in a first iteration.

Therefore needing to put this patch aside: it needs a good weekend of thinking it through, which I didn't manage to find, sorry.

[derrabus]

Hello. 👋🏻

Is there anything I can do to help moving this PR forward? I'm working on a small code generator tool at the moment and I need the ability to emit class and property attributes.

[jakublabno]

Hello. 👋🏻

Is there anything I can do to help moving this PR forward? I'm working on a small code generator tool at the moment and I need the ability to emit class and property attributes.

Sorry, I have no time to work it out, I'll try to close this next month.

[kitsunet]

If there is no objections I would pick this up, make the requested changes and see to add method support along the way.

[jakublabno]

• AttributeGenerator::fromValue(object $attribute): self

I don't understand this object type parameter, there is AttributePrototype for it
I haven't used ValueGenerator 'cause this class is too complex and terrible to maintain

@kitsunet I've pushed some changes

[kitsunet]

Cool, thanks! I guess I'll wait for ocramius verdict then and start in parallel to create changes for class members and methods on top of this.

[jakublabno]

I've already started working on methods 😱

[tyteen4a03]

Hi, any updates on this?

[jakublabno]

Hi, any updates on this?

I'm waiting for @Ocramius review

[birb2345345]

@Ocramius ??

[brzuchal]

This PR is already 17mo old almost 1 and a half years, still waiting for @Ocramius re-review for 7mo now.
Can there be anyone else doing the CR?
Attributes have existed in PHP since 8.0 which is so old that not even supported anymore.
I understand someone may not have enough time, but at least please help to find another person to do the code review.

[jakublabno]

@Ocramius

[lisachenko]

Colleagues, what the current status of this PR, as I can see, this feature is awaited by many developers.

[jakublabno]

I'm still waiting for @Ocramius review

[jakublabno]

Is there anyone else that could review this?

[Ocramius]

Haven't touched this component in a while, and OSS efforts currently compete with the time I'm dedicating to sleep.

[tr33m4n]

Any updates here? Trying to generate code with #[\SensitiveParameter] for logging security in Magento, which relies heavily on this library for its code generation

[axoudev]

Hello @Ocramius,

I hope you're doing well. I saw that this PR has been on hold for quite some time. Do you have any updates regarding its progress or any thoughts on how it could move forward?

Thanks in advance for your time!

[jakublabno]

Hi, just poking for update ;)

[homersimpsons]

Hello (sorry for ping),

I believe this merge request is too old for it to be productive. What I suggest is that we help @Ocramius on this.

The changes I see:

1. Rebase and target branch 4.18.x (instead of current 4.8.x)
2. Use enum where appropriate (4.18.x already targets PHP8.2+)
3. Drop AttributeGenerator::fromArray as requested (newer version does not have it)
4. Remove changes in GitHub workflow
5. Clean-up code, for instance there is a use Laminas\Code\Generator\AttributeGenerator\AttributeBuilder; but this class does not seem to exist (nor in the diff, nor in the source)
6. Close threads to start on a fresh basis

@jakublabno do you think you have the time to do this?

I believe that once this is done @Ocramius will be able to re-review, he is still active on the project.

[jakublabno]

Hello (sorry for ping),

I believe this merge request is too old for it to be productive. What I suggest is that we help @Ocramius on this.

The changes I see:

1. Rebase and target branch `4.18.x` (instead of current `4.8.x`)

2. Use enum where appropriate (`4.18.x` already targets PHP8.2+)

3. Drop `AttributeGenerator::fromArray` as requested (newer version does not have it)

4. Remove changes in GitHub workflow

5. Clean-up code, for instance there is a `use Laminas\Code\Generator\AttributeGenerator\AttributeBuilder;` but this class does not seem to exist (nor in the diff, nor in the source)

6. Close threads to start on a fresh basis

@jakublabno do you think you have the time to do this?

I believe that once this is done @Ocramius will be able to re-review, he is still active on the project.

Sure, I could do this, but I’m not sure it makes sense — @Ocramius hasn’t been here for months.
I’m worried that next year I’ll have to make similar changes to the ones you requested today. :)