Method Annotations

[briandowns]

Well detailed description of the change :

Initial pass at method annotation implementation. Method annotations have the same expectations as class annotations where they're not brought up from an inherited class.

This is a breaking change as the previous class field of annotations is now classAnnotations with an additional field methodAnnotations

Underlying class structure to carry the annotations:

// class annotations
{
    "ResourceController": "/api/v1"
}

// method annotations
{
    "methodName": {
        "Get": "/assets", 
        "BasicAuth": nil
    }
}

Resolves: #

#464

Type of change:

• Bug fix

• New feature

• Breaking change (fix or feature that would cause existing functionality to not work as expected)

Housekeeping

• Tests have been updated to reflect the changes done within this PR (if applicable).

• Documentation has been updated to reflect the changes done within this PR (if applicable).

Preview (Screenshots) :

[briandowns]

Might need some assistance @Jason2605 . All tests and examples are passing locally but not in CI and not sure wht the failure is there. Output seems to be cut off.

[Jason2605]

Sorry @briandowns been away for the new year! Thanks for working on this, I haven't forgotten, I'll try to get around to seeing why the tests aren't passing

[Jason2605]

Yeah for me running in the debug build im getting a segfault when running the annotation tests, will investigate further

[Jason2605]

Whats the rationale for not on initialisers for my curiosity?

[briandowns]

Most the thought of class initialization consistency. I'm happy to update it to allow for init to have annotations as well.

[Jason2605]

Yeah I think allowing it on constructors could be useful, initial thoughts being it may be useful in the future (potentially?) if we were to create some sort of service container and enable some sort of clever dependency injection or something like that

[Jason2605]

Yeah I think allowing it on constructors could be useful, initial thoughts being it may be useful in the future (potentially?) if we were to create some sort of service container and enable some sort of clever dependency injection or something like that

[briandowns]

Sounds good. I'll work on this tonight. Thanks for all of the feedback!

[Jason2605]

No worries, sorry it took a bit longer! Thanks for the effort on this too

[briandowns]

Thanks for the review. I think we're all set now.

[Jason2605]

Something I've noticed from a "correctness" standpoint is this is technically legal:

class Test {
    @Test
    @Test1
    @Test2
    @Test3
}

print(Test.methodAnnotations); // {"__annotatedMethodName": {"Test3": nil, "Test1": nil, "Test": nil, "Test2": nil}}

It is an edge case scenario but it would be good if this resulted in a compile time error since there's no method, what do you think?

[briandowns]

I "think" we're all set.

[Jason2605]

Legend, thank you very much for this!

[briandowns]

Thanks! Was a fun challenge. And thanks for the guidance and feedback through the process.