alexandereggers / archknife Goto Github PK

Add new annotation to allow the injection of views and misc objects into the dependency graph. Like services and broadcast receiver, this injection will be quite manual for the dev. The only challenge for the lib implementation is to provide a way to get the ArchKnifeComponent and use the included inject(....) method.

Scopes provide the user with a wider ability to structure the dependency graph. Currently ArchKnife provides no support for that - everything is scoped as Singleton (or no scope of course).

In order to provide this features, there are different steps required as well as several core library changes (to ArchKnife).

• Extend each Provide(...) annotation to include a scope annotation class as member. By default it should use Singleton::class.
• Add new annotation ProvideScope. This class has the member dependency. If null, it will use the AppComponent (Singleton scope) as dependency. This annotation can only be used on other annotations. Therefore the dev needs to create a scope annotation class which then will be used by the ArchKnife processor.
• Add new processor that will create app component classes that will use the dependent member based on the dependency value. Each scope will be mapped against a certain component class.
• The component processor needs to create the builder modules (activity, fragment, viewmodel, ...) based on the scope.
• Renamed ArchKnifeComponent to AppComponent
• Add new processor that is creating a static object that is holding the references for the components and provides options to retrieve the component instance and to clear a given one (simplify set it to null). The getter ensures to always return non-null objects.

Currently Proguard is not well supported using this library. The dev needs to write a custom rule to get it working.

In order to fix that each relevant class should use the Keep annotation provided by Google. That is necessary for at least the component interface and the component builder interface.

TODO

• Tweaking of processor implementation to include Keep annotation.

• Improve javadoc implementation.
• Tweaking public documentation in the Readme file.

Greetings @Mordag ,
I would like to ask for your permission to propose logo/icon designs. Im a graphics designer and i would like to help your project regarding this issue. Hoping for your response and good luck to your project.
Thank You!

Best Regards,
-jbeguna04