Refactor RoborazziComposeConfigBuilder

[takahirom]

No description provided.

[takahirom]

• Refactor RoborazziComposeConfigBuilder #590 👈 (View in Graphite)
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[takahirom]

The release note will be like this.

---

Add support for heightDp, widthDp, showBackground, and backgroundColor of Compose Preview parameters

We have introduced Experimental Compose Preview Support in 1.22.0, but it does not yet support all parameters of the @Preview annotation. Thanks to @sergio-sastre 's pull request, the Experimental Compose Preview Support now includes support for heightDp, widthDp, showBackground, and backgroundColor.

Introduce RoborazziComposeOptions

To accommodate the changes in preview parameters, we’ve made the API more flexible.

We’ve added the RoborazziComposeOptions parameter to ComposablePreview.captureRoboImage() and the composable function version, captureRoboImage{}. Previously, the API was limited; for example, you couldn’t access the ActivityScenario or the composable function directly. Now, you have full control over these components. Thank you for your code review @sergio-sastre

Here’s an example of a custom option:

    captureRoboImage(
      roborazziComposeOptions = RoborazziComposeOptions {
        // We have several options to configure the test environment.
        fontScale(2f)
        // We can also configure the activity scenario and the composable content.
        addOption(
          object : RoborazziComposeComposableOption,
            RoborazziComposeActivityScenarioOption {
            override fun configureWithActivityScenario(scenario: ActivityScenario<out Activity>) {
              scenario.onActivity {
                it.window.decorView.setBackgroundColor(Color.BLUE)
              }
            }

            override fun configureWithComposable(content: @Composable () -> Unit): @Composable () -> Unit {
              return {
                Box(Modifier
                  .padding(10.dp)
                  .background(color = androidx.compose.ui.graphics.Color.Red)
                  .padding(10.dp)
                ) {
                  content()
                }
              }
            }
          }
        )
      },
    ) {
      Text("Hello Compose!")
    }

Breaking change: fun ComposablePreview.applyToRobolectricConfiguration()

As part of our changes to how composables are set up, the applyToRobolectricConfiguration() function is now deprecated and error. Instead, you can use the following:

• previewInfo.toRoborazziComposeOptions().apply(scenario, composeContent)
• ComposablePreview.captureRoboImage(roborazziComposeOptions)

We believe this migration can be done smoothly. However, if you encounter any issues, please don’t hesitate to reach out.

What's Changed

• Update dependency androidx.compose.runtime:runtime to v1.7.5 by @renovate in Update dependency androidx.compose.runtime:runtime to v1.7.5 #548
• Add .gitignore by @takahirom in Add .gitignore #578
• Refactor Add support for heightDp, widthDp, showBackground, backgroundColor by @takahirom in Refactor Add support for heightDp, widthDp, showBackground, backgroundColor #577
• Add support for heightDp, widthDp, showBackground, backgroundColor by @sergio-sastre in Add support for heightDp, widthDp, showBackground, backgroundColor #576
• Rename Applier to Config by @takahirom in Rename Applier to Config #579
• Refactor naming by @takahirom in Refactor naming #582
• Add Assertion for minus or zero fontScale by @takahirom in Add Assertion for minus or zero fontScale #584
• Add a deprecated method of ComposablePreview.applyToRobolectricConfiguration() as it was a ExperimentalApi by @takahirom in Add a deprecated method of ComposablePreview<AndroidPreviewInfo>.applyToRobolectricConfiguration() as it was a ExperimentalApi #585
• Adjustment for compose preview config by @takahirom in Adjustment for compose preview config #586

Full Changelog: 1.34.0...1.35.0

[takahirom]

@sergio-sastre
Thank you for reviewing PRs. I was almost ready to release this, but while writing the release notes, I realized it might be a bit strange to pass a builder to the APIs. Additionally, the names RoborazziComposeConfig and RoborazziComposeConfigBuilder felt odd because RoborazziComposeConfig is not actually created by RoborazziComposeConfigBuilder.

I also think we don’t have a strong preference for using Config over Options, especially since we’re already using RoborazziOptions. Therefore, I renamed it to RoborazziComposeOptions.

I made some adjustments. Could you take a look?

[takahirom]

@sergio-sastre This is going to block other tasks, so I'll merge this now. If you have any concerns, let me know. I think we can address them in a patch release.

[github-actions]

Snapshot diff report

File name	Image
manual_compose_with_ compose_options_comp are.png