Skip to content

Commit 035e067

Browse files
greg-at-moderneTeamModerne
authored andcommitted
Extract documentation examples from tests
Use this link to re-run the recipe: https://app.moderne.io/recipes/org.openrewrite.java.recipes.ExamplesExtractor?organizationId=QUxML01vZGVybmU%3D Co-authored-by: Moderne <team@moderne.io>
1 parent 0a86c8b commit 035e067

File tree

4 files changed

+75
-55
lines changed
  • rewrite-docker/src/main/resources/META-INF/rewrite
  • rewrite-gradle/src/main/resources/META-INF/rewrite
  • rewrite-kotlin/src/main/resources/META-INF/rewrite
  • rewrite-properties/src/main/resources/META-INF/rewrite

4 files changed

+75
-55
lines changed

rewrite-docker/src/main/resources/META-INF/rewrite/examples.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -135,13 +135,13 @@ examples:
135135
- description: '`DockerBestPracticesTest#appliesBestPractices`'
136136
sources:
137137
- before: |
138-
FROM ubuntu:22.04
138+
FROM ubuntu:20.04
139139
ADD app.jar /app/
140140
RUN apt-get update
141141
RUN apt-get install -y curl
142142
ENTRYPOINT /app/start.sh
143143
after: |
144-
~~(EOL: ubuntu:22.04 (ended 2024-09-30, suggest noble (24.04)))~~>~~(Missing HEALTHCHECK instruction)~~>FROM ubuntu:22.04
144+
~~(EOL: ubuntu:20.04 (ended 2025-05-31, suggest noble (24.04)))~~>~~(Missing HEALTHCHECK instruction)~~>FROM ubuntu:20.04
145145
COPY app.jar /app/
146146
RUN apt-get update && apt-get install -y curl && rm -rf /var/lib/apt/lists/*
147147
ENTRYPOINT ["/app/start.sh"]
@@ -219,7 +219,7 @@ examples:
219219
FROM debian:buster
220220
RUN apt-get update
221221
after: |
222-
~~(EOL: debian:buster (ended 2024-06-30, suggest trixie (13) or bookworm (12)))~~>FROM debian:buster
222+
~~(EOL: debian:buster (ended 2022-09-10, suggest trixie (13)))~~>FROM debian:buster
223223
RUN apt-get update
224224
language: docker
225225
---

rewrite-gradle/src/main/resources/META-INF/rewrite/examples.yml

Lines changed: 52 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -292,6 +292,24 @@ examples:
292292
language: groovy
293293
---
294294
type: specs.openrewrite.org/v1beta/example
295+
recipeName: org.openrewrite.gradle.ChangeTaskToTasksRegister
296+
examples:
297+
- description: '`ChangeTaskToTasksRegisterTest#groovyTaskWithClosure`'
298+
sources:
299+
- before: |
300+
task taskName(type: Copy) {
301+
from 'src/main/resources'
302+
into 'build/generated-resources'
303+
}
304+
after: |
305+
tasks.register("taskName", Copy) {
306+
from 'src/main/resources'
307+
into 'build/generated-resources'
308+
}
309+
path: build.gradle
310+
language: groovy
311+
---
312+
type: specs.openrewrite.org/v1beta/example
295313
recipeName: org.openrewrite.gradle.DependencyConstraintToRule
296314
examples:
297315
- description: '`DependencyConstraintToRuleTest#newResolutionStrategyBlock`'
@@ -519,6 +537,40 @@ examples:
519537
language: toml
520538
---
521539
type: specs.openrewrite.org/v1beta/example
540+
recipeName: org.openrewrite.gradle.MigrateToGradle9
541+
examples:
542+
- description: '`MigrateToGradle9Test#multipleSubRecipesApplyTogether`'
543+
sources:
544+
- before: |
545+
plugins {
546+
id 'java'
547+
id 'jacoco'
548+
}
549+
550+
repositories {
551+
mavenCentral()
552+
}
553+
554+
dependencies {
555+
implementation group: 'com.google.guava', name: 'guava', version: '31.1-jre'
556+
}
557+
after: |
558+
plugins {
559+
id 'java'
560+
id 'jacoco'
561+
}
562+
563+
repositories {
564+
mavenCentral()
565+
}
566+
567+
dependencies {
568+
implementation "com.google.guava:guava:31.1-jre"
569+
}
570+
path: build.gradle
571+
language: groovy
572+
---
573+
type: specs.openrewrite.org/v1beta/example
522574
recipeName: org.openrewrite.gradle.RemoveDependency
523575
examples:
524576
- description: '`RemoveDependencyTest#removeGradleDependencyUsingStringNotation`'
@@ -873,38 +925,6 @@ examples:
873925
language: groovy
874926
---
875927
type: specs.openrewrite.org/v1beta/example
876-
recipeName: org.openrewrite.gradle.ChangeTaskToTasksRegister
877-
examples:
878-
- description: ''
879-
sources:
880-
- before: |
881-
task exampleName(type: Copy) {
882-
from 'src/main/resources'
883-
into 'build/generated-resources'
884-
}
885-
after: |
886-
tasks.register("exampleName", Copy) {
887-
from 'src/main/resources'
888-
into 'build/generated-resources'
889-
}
890-
path: build.gradle
891-
language: groovy
892-
- description: ''
893-
sources:
894-
- before: |
895-
task<Copy>("exampleName") {
896-
from("src")
897-
into("dest")
898-
}
899-
after: |
900-
tasks.register<Copy>("exampleName") {
901-
from("src")
902-
into("dest")
903-
}
904-
path: build.gradle.kts
905-
language: kotlin
906-
---
907-
type: specs.openrewrite.org/v1beta/example
908928
recipeName: org.openrewrite.gradle.gradle8.JacocoReportDeprecations
909929
examples:
910930
- description: '`JacocoReportDeprecationsTest#deprecationsInNormalSyntax`'

rewrite-kotlin/src/main/resources/META-INF/rewrite/examples.yml

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -368,23 +368,3 @@ examples:
368368
class Test {
369369
}
370370
language: kotlin
371-
---
372-
type: specs.openrewrite.org/v1beta/example
373-
recipeName: org.openrewrite.kotlin.replace.ReplaceKotlinMethod
374-
examples:
375-
- description: '`ReplaceKotlinMethodTest#replaceCharToIntWithCode`'
376-
parameters:
377-
- kotlin.Char toInt()
378-
- code
379-
- 'null'
380-
- 'null'
381-
sources:
382-
- before: |
383-
fun test(c: Char): Int {
384-
return c.toInt()
385-
}
386-
after: |
387-
fun test(c: Char): Int {
388-
return c.code
389-
}
390-
language: kotlin

rewrite-properties/src/main/resources/META-INF/rewrite/examples.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,26 @@ examples:
7878
language: properties
7979
---
8080
type: specs.openrewrite.org/v1beta/example
81+
recipeName: org.openrewrite.properties.CopyValue
82+
examples:
83+
- description: '`CopyValueTest#copyValueSameFile`'
84+
parameters:
85+
- source.key
86+
- 'null'
87+
- destination.key
88+
- 'null'
89+
- 'null'
90+
- 'null'
91+
sources:
92+
- before: |
93+
source.key=myValue
94+
destination.key=original
95+
after: |
96+
source.key=myValue
97+
destination.key=myValue
98+
language: properties
99+
---
100+
type: specs.openrewrite.org/v1beta/example
81101
recipeName: org.openrewrite.properties.CreatePropertiesFile
82102
examples:
83103
- description: '`CreatePropertiesFileTest#hasCreatedPropertiesFile`'

0 commit comments

Comments
 (0)