Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add section on dependency resolution and exposure to README #266

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add section on dependency resolution and exposure to README #266

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
515d4ab
Update README.md
matt-ramotar Jun 26, 2024
4ee182a
Update README.md
matt-ramotar Jun 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,37 @@ MainScope mainScope = new MainScopeImpl();
ChildScope childScope = mainScope.child();
```

## Dependency Resolution and Exposure

Motif requires explicit dependency declarations to properly resolve and inject dependencies across scopes. When a parent scope needs to provide a dependency to a child scope, the dependency must be explicitly exposed using the `@Expose` annotation.
Copy link
Contributor

@davissuber davissuber Jun 26, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't line ~140 of README roughly mentions it?

I agree we perhaps need to make the use of @Expose a more pronounced section given how important it is, but perhaps we can remove / restructure the existing paragraph so readers don't think they know everything there is to know about Expose after reading that first section?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Totally fine with restructuring the existing paragraph

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated, thoughts? I think the explicit dependency declaration requirement is what is not completely clear

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is valuable documentation, but can we add the other way to pass dependency to children as well?

interface ParentScope {
   fun childScope(api: Api): ChildScope // Api is exposed to children through a scope factory method parameter.

   @motif.Objects
    abstract class Objects {
        fun provideImpl(): Impl {
            return Impl()
        }

        fun provideApi(impl: Impl): Api {
            return impl
        }
    }
}


For example:

```kotlin
@motif.Scope
interface ParentScope {
@motif.Objects
class Objects {
fun provideImpl(): Impl {
return Impl()
}

@Expose
fun provideApi(impl: Impl): Api {
return impl
}
}
}

@motif.Scope
interface ChildScope {
@motif.Objects
abstract class Objects {
abstract fun api(): Api
}
}
```

## Root Scopes

By extending `Creatable<D>` you can specify exactly the dependencies you expect from the parent `Scope`. This allows
Expand Down
Loading