Skip to content

Commit 4643638

Browse files
committed
refactor(scanner)!: Rename fromConfig in ScannerCriteria to create
Use a generic name for the factory function as the previous name will not match anymore after an upcoming change. Signed-off-by: Martin Nonnenmacher <[email protected]>
1 parent 9794da6 commit 4643638

File tree

7 files changed

+11
-11
lines changed

7 files changed

+11
-11
lines changed

plugins/scanners/askalono/src/main/kotlin/Askalono.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ class Askalono internal constructor(
5656

5757
override val configuration = ""
5858

59-
override val criteria by lazy { ScannerCriteria.fromConfig(details, scannerConfig) }
59+
override val criteria by lazy { ScannerCriteria.create(details, scannerConfig) }
6060

6161
override fun command(workingDir: File?) =
6262
listOfNotNull(workingDir, if (Os.isWindows) "askalono.exe" else "askalono").joinToString(File.separator)

plugins/scanners/boyterlc/src/main/kotlin/BoyterLc.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ class BoyterLc internal constructor(
6060

6161
override val configuration = CONFIGURATION_OPTIONS.joinToString(" ")
6262

63-
override val criteria by lazy { ScannerCriteria.fromConfig(details, scannerConfig) }
63+
override val criteria by lazy { ScannerCriteria.create(details, scannerConfig) }
6464

6565
override fun command(workingDir: File?) =
6666
listOfNotNull(workingDir, if (Os.isWindows) "lc.exe" else "lc").joinToString(File.separator)

plugins/scanners/licensee/src/main/kotlin/Licensee.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ class Licensee internal constructor(
5959

6060
override val configuration = CONFIGURATION_OPTIONS.joinToString(" ")
6161

62-
override val criteria by lazy { ScannerCriteria.fromConfig(details, scannerConfig) }
62+
override val criteria by lazy { ScannerCriteria.create(details, scannerConfig) }
6363

6464
override fun command(workingDir: File?) =
6565
listOfNotNull(workingDir, if (Os.isWindows) "licensee.bat" else "licensee").joinToString(File.separator)

plugins/scanners/scancode/src/main/kotlin/ScanCode.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ class ScanCode internal constructor(
9797
override fun create(scannerConfig: ScannerConfiguration) = ScanCode(type, scannerConfig)
9898
}
9999

100-
override val criteria by lazy { ScannerCriteria.fromConfig(details, scannerConfig) }
100+
override val criteria by lazy { ScannerCriteria.create(details, scannerConfig) }
101101

102102
override val configuration by lazy {
103103
buildList {

plugins/scanners/scanoss/src/main/kotlin/ScanOss.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ class ScanOss internal constructor(
7474

7575
override val configuration = ""
7676

77-
override val criteria by lazy { ScannerCriteria.fromConfig(details, scannerConfig) }
77+
override val criteria by lazy { ScannerCriteria.create(details, scannerConfig) }
7878

7979
/**
8080
* The name of the file corresponding to the fingerprints can be sent to SCANOSS for more precise matches.

scanner/src/main/kotlin/ScannerCriteria.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ data class ScannerCriteria(
135135
* instance, to specify that a specific minimum version of ScanCode is allowed, set this property:
136136
* `options.ScanCode.minVersion=3.0.2`.
137137
*/
138-
fun fromConfig(details: ScannerDetails, config: ScannerConfiguration): ScannerCriteria {
138+
fun create(details: ScannerDetails, config: ScannerConfiguration): ScannerCriteria {
139139
val options = config.options?.get(details.name).orEmpty()
140140
val scannerVersion = Semver(normalizeVersion(details.version))
141141
val minVersion = parseVersion(options[PROP_CRITERIA_MIN_VERSION]) ?: scannerVersion

scanner/src/test/kotlin/ScannerCriteriaTest.kt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,11 @@ class ScannerCriteriaTest : WordSpec({
6868
}
6969
}
7070

71-
"ScannerCriteria.fromConfig()" should {
71+
"ScannerCriteria.create()" should {
7272
"obtain default values from the scanner details" {
7373
val config = createScannerConfig(emptyMap())
7474

75-
val criteria = ScannerCriteria.fromConfig(testDetails, config)
75+
val criteria = ScannerCriteria.create(testDetails, config)
7676

7777
criteria.regScannerName shouldBe SCANNER_NAME
7878
criteria.minVersion.version shouldBe SCANNER_VERSION
@@ -88,7 +88,7 @@ class ScannerCriteriaTest : WordSpec({
8888
)
8989
)
9090

91-
val criteria = ScannerCriteria.fromConfig(testDetails, config)
91+
val criteria = ScannerCriteria.create(testDetails, config)
9292

9393
criteria.regScannerName shouldBe "foo"
9494
criteria.minVersion.version shouldBe "1.2.3"
@@ -103,7 +103,7 @@ class ScannerCriteriaTest : WordSpec({
103103
)
104104
)
105105

106-
val criteria = ScannerCriteria.fromConfig(testDetails, config)
106+
val criteria = ScannerCriteria.create(testDetails, config)
107107

108108
criteria.minVersion.version shouldBe "1.0.0"
109109
criteria.maxVersion.version shouldBe "3.7.0"
@@ -112,7 +112,7 @@ class ScannerCriteriaTest : WordSpec({
112112
"use an exact configuration matcher" {
113113
val config = createScannerConfig(emptyMap())
114114

115-
val criteria = ScannerCriteria.fromConfig(testDetails, config)
115+
val criteria = ScannerCriteria.create(testDetails, config)
116116

117117
criteria.configMatcher(testDetails.configuration) shouldBe true
118118
criteria.configMatcher(testDetails.configuration + "_other") shouldBe false

0 commit comments

Comments
 (0)