ViewBindingPropertyDelegate

ViewBindingPropertyDelegate is a library designed to simplify working with Android View Binding. It provides three main benefits:

1. Lifecycle Management: It automatically manages the ViewBinding lifecycle and clears references to prevent memory leaks.
2. Non-nullable References: It eliminates the need to maintain nullable references to Views or ViewBindings in your Fragments or Activities.
3. Lazy Initialization: It creates the ViewBinding lazily.

The library offers two variants:

• vbpd: The recommended version that does not use reflection for better performance.
• vbpd-reflection: Includes additional factories that use reflection under the hood.

To enable code coverage reporting with Kover:

1. Add the dependency: Add gradleplugins-kover to gradle/libs.versions.toml and include implementation(libs.gradleplugins.kover) in the convention plugin's build.gradle.kts.
2. Apply the plugin: In vbpdconfig.gradle.kts, add plugins.apply(libs.plugins.kover.get().pluginId).

Commands:

• Generate HTML report: ./gradlew koverHtmlReport

To support testing Activity and Fragment lifecycles in the vbpd module, update vbpd/build.gradle.kts with the following dependencies:

plugins {
    id("vbpdconfig")
}

dependencies {
    compileOnly(libs.androidx.fragment)
    compileOnly(libs.androidx.activity)
    compileOnly(libs.androidx.recyclerview)
    api(projects.vbpdCore)

    testImplementation(libs.test.junit)
    testImplementation(libs.test.kotlin)
    testImplementation(libs.test.mockk)
    testImplementation(libs.test.robolectric)
    testImplementation(libs.test.androidx.core)
    testImplementation(libs.test.androidx.runner)
    testImplementation(libs.androidx.fragment)
    testImplementation(libs.androidx.activity)
    testImplementation(libs.androidx.recyclerview)
    testImplementation(libs.androidx.appcompat)
    // For Fragment testing
    testImplementation(libs.test.fragment)
}

To verify the entire project, run the following commands:

1. Run all tests: ./gradlew testDebugUnitTest
2. Generate HTML coverage report: ./gradlew koverHtmlReport
3. Run all quality checks (including detekt and ktlint): ./gradlew check

Coverage reports can be found in the following locations:

• vbpd-core/build/reports/kover/html/index.html
• vbpd/build/reports/kover/html/index.html
• vbpd-reflection/build/reports/kover/html/index.html

If you are upgrading from version 1.x, you can use both versions in the same project during transition. To complete the migration:

1. Update Package Names: Replace com.github.kirich1409.viewbindingpropertydelegate with dev.androidbroadcast.vbpd.
2. Update Lifecycle Handling: Replace the use of onViewDestroyed by moving that logic to the appropriate lifecycle callback, such as Fragment.onDestroyView() or Activity.onDestroy().

The vbpd-reflection module requires specific test dependencies and coverage for its cache and reflection logic.

Testing ViewBindingCache: Verify that ViewBindingCache.setEnabled(true/false) works without crashing and that ViewBindingCache.clear() behaves correctly even when the cache is empty or when the cache is disabled.

Testing Reflection (CreateMethod): Verify that the CreateMethod enum contains the expected values BIND and INFLATE and that these values are distinct.

Add the library to your Gradle dependencies. It is recommended to use the vbpd artifact for optimal performance. Ensure mavenCentral() is included in your repositories configuration.

allprojects {
  repositories {
    mavenCentral()
  }
}

dependencies {
    // recommended
    implementation("dev.androidbroadcast.vbpd:vbpd:2.0.4")
    
    // additional factories that use reflection under hood
    implementation("dev.androidbroadcast.vbpd:vbpd-reflection:2.0.4")
}

To run the unit tests specifically for the vbpd-core module, use the following Gradle command:

./gradlew :vbpd-core:testDebugUnitTest

To run a specific test class (e.g., LazyViewBindingPropertyTest), use:

./gradlew :vbpd-core:testDebugUnitTest --tests "dev.androidbroadcast.vbpd.LazyViewBindingPropertyTest"

To enforce code formatting using ktlint:

1. Add the dependency: Add gradleplugins-ktlint to gradle/libs.versions.toml and include implementation(libs.gradleplugins.ktlint) in the convention plugin's build.gradle.kts.
2. Apply the plugin: In vbpdconfig.gradle.kts, add plugins.apply(libs.plugins.ktlint.get().pluginId).

Commands:

• Check formatting: ./gradlew ktlintCheck
• Auto-fix formatting: ./gradlew ktlintFormat