Skip to main content

Replace a method invocation with a reference to an annotated field

io.moderne.java.dropwizard.boot.test.ReplaceMethodInvocationWithAnnotatedField

For each class containing an invocation matching the configured method pattern, introduces an annotated field of the requested type and rewrites every matching invocation in that class to reference the new field. If a field with the same annotation and type already exists, its name is reused.

Recipe source​

This recipe is only available to users of Moderne.

This recipe is available under the Moderne Proprietary License.

Options​

TypeNameDescriptionExample
StringmethodPatternA method pattern matched against the invocation to replace. A method pattern is used to find matching method invocations. For example, to find all method invocations in the Guava library, use the pattern: com.google.common..*#*(..).

The pattern format is <PACKAGE>#<METHOD_NAME>(<ARGS>).

..* includes all subpackages of com.google.common.
*(..) matches any method name with any number of arguments.

For more specific queries, like Guava's ImmutableMap, use com.google.common.collect.ImmutableMap#*(..) to narrow down the results.		io.dropwizard.testing.junit5.DropwizardAppExtension getLocalPort()
StringfieldTypeEither a primitive keyword (e.g. int) or a fully qualified class name for the field's type.int
StringannotationFqnFully qualified annotation type to place on the new field.org.springframework.boot.test.web.server.LocalServerPort
StringpreferredFieldNameName to give the new field. If a same-named field already exists in the class, an incrementing suffix is appended to avoid collision.localPort
ListclasspathResourcesResource patterns passed to the JavaParser used by the field-injection template.spring-boot-test-3.*

Used by​

This recipe is used as part of the following composite recipes:

Example​

Parameters​
ParameterValue
methodPatternGET_LOCAL_PORT_PATTERN
fieldTypeint
annotationFqnorg.springframework.boot.test.web.server.LocalServerPort
preferredFieldNamelocalPort
classpathResourcesList.of("spring-boot-test-3")
Unchanged​
import io.dropwizard.core.Application;
import io.dropwizard.core.Configuration;
import io.dropwizard.core.setup.Environment;
public class TestApp extends Application<Configuration> {
    @Override public void run(Configuration c, Environment e) {}
}
Before​
import io.dropwizard.core.Configuration;
import io.dropwizard.testing.junit5.DropwizardAppExtension;

abstract class AbstractComponentTest {
    static final DropwizardAppExtension<Configuration> DROPWIZARD =
        new DropwizardAppExtension<>(TestApp.class, "server.yml");

    void someTest() {
        int port = DROPWIZARD.getLocalPort();
    }
}
After​
import io.dropwizard.core.Configuration;
import io.dropwizard.testing.junit5.DropwizardAppExtension;
import org.springframework.boot.test.web.server.LocalServerPort;

abstract class AbstractComponentTest {
    @LocalServerPort
    int localPort;
    static final DropwizardAppExtension<Configuration> DROPWIZARD =
        new DropwizardAppExtension<>(TestApp.class, "server.yml");

    void someTest() {
        int port = localPort;
    }
}

Usage​

This recipe has required configuration parameters and can only be run by users of Moderne. To run this recipe, you will need to provide the Moderne CLI run command with the required options. Or, if you'd like to create a declarative recipe, please see the below example of a rewrite.yml file:

rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.ReplaceMethodInvocationWithAnnotatedFieldExample
displayName: Replace a method invocation with a reference to an annotated field example
recipeList:
  - io.moderne.java.dropwizard.boot.test.ReplaceMethodInvocationWithAnnotatedField:
      methodPattern: io.dropwizard.testing.junit5.DropwizardAppExtension getLocalPort()
      fieldType: int
      annotationFqn: org.springframework.boot.test.web.server.LocalServerPort
      preferredFieldName: localPort
      classpathResources:
        - spring-boot-test-3.*

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell
mod run . --recipe ReplaceMethodInvocationWithAnnotatedField --recipe-option "methodPattern=io.dropwizard.testing.junit5.DropwizardAppExtension getLocalPort()" --recipe-option "fieldType=int" --recipe-option "annotationFqn=org.springframework.boot.test.web.server.LocalServerPort" --recipe-option "preferredFieldName=localPort" --recipe-option "classpathResources=spring-boot-test-3.*"

If the recipe is not available locally, then you can install it using:

mod config recipes jar install io.moderne.recipe:rewrite-dropwizard:0.3.1

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Data Tables​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.