Move excel support to dataframe-spreadsheets module

koperagen · koperagen · commit 3f103979acfb · 2022-06-01T17:08:25.000+03:00
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -40,8 +40,6 @@ dependencies {
     api(libs.commonsCsv)
     implementation(libs.klaxon)
     implementation(libs.fuel)
-    implementation(libs.poi)
-    implementation(libs.poi.ooxml)
 
     implementation(libs.kotlin.datetimeJvm)
     implementation("com.squareup:kotlinpoet:1.11.0")
diff --git a/dataframe-spreadsheets/build.gradle.kts b/dataframe-spreadsheets/build.gradle.kts
@@ -0,0 +1,36 @@
+plugins {
+    kotlin("jvm")
+    kotlin("libs.publisher")
+}
+
+group = "org.jetbrains.kotlinx"
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    api(project(":"))
+    implementation(libs.poi)
+    implementation(libs.poi.ooxml)
+
+    implementation(libs.kotlin.datetimeJvm)
+
+    testImplementation(libs.junit)
+    testImplementation(libs.kotestAssertions) {
+        exclude("org.jetbrains.kotlin", "kotlin-stdlib-jdk8")
+    }
+}
+
+kotlinPublications {
+    publication {
+        publicationName.set("dataframeSpreadsheets")
+        artifactId.set(project.name)
+        description.set("Spreadsheets support for Kotlin Dataframe")
+        packageName.set(artifactId)
+    }
+}
+
+kotlin {
+    explicitApi()
+}
diff --git a/dataframe-spreadsheets/src/main/kotlin/org/jetbrains/kotlinx/dataframe/io/xlsx.kt b/dataframe-spreadsheets/src/main/kotlin/org/jetbrains/kotlinx/dataframe/io/xlsx.kt
@@ -23,8 +23,8 @@ import org.jetbrains.kotlinx.dataframe.DataFrame
 import org.jetbrains.kotlinx.dataframe.api.dataFrameOf
 import org.jetbrains.kotlinx.dataframe.api.forEach
 import org.jetbrains.kotlinx.dataframe.api.select
+import org.jetbrains.kotlinx.dataframe.codeGen.AbstractDefaultReadMethod
 import org.jetbrains.kotlinx.dataframe.codeGen.DefaultReadDfMethod
-import org.jetbrains.kotlinx.dataframe.codeGen.DefaultReadExcelMethod
 import java.io.File
 import java.io.InputStream
 import java.io.OutputStream
@@ -48,6 +48,10 @@ public class Excel : SupportedFormat {
     }
 }
 
+internal class DefaultReadExcelMethod(path: String?) : AbstractDefaultReadMethod(path, MethodArguments.EMPTY, readExcel)
+
+private const val readExcel = "readExcel"
+
 public fun DataFrame.Companion.readExcel(
     url: URL,
     sheetName: String? = null,
diff --git a/dataframe-spreadsheets/src/main/resources/META-INF/services/org.jetbrains.kotlinx.dataframe.io.SupportedFormat b/dataframe-spreadsheets/src/main/resources/META-INF/services/org.jetbrains.kotlinx.dataframe.io.SupportedFormat
@@ -0,0 +1 @@
+org.jetbrains.kotlinx.dataframe.io.Excel
diff --git a/dataframe-spreadsheets/src/test/kotlin/org/jetbrains/kotlinx/dataframe/io/XlsxTest.kt b/dataframe-spreadsheets/src/test/kotlin/org/jetbrains/kotlinx/dataframe/io/XlsxTest.kt
@@ -7,13 +7,15 @@ import org.jetbrains.kotlinx.dataframe.DataFrame
 import org.jetbrains.kotlinx.dataframe.api.concat
 import org.jetbrains.kotlinx.dataframe.api.dataFrameOf
 import org.jetbrains.kotlinx.dataframe.api.toColumn
-import org.jetbrains.kotlinx.dataframe.testResource
 import org.junit.Test
+import java.net.URL
 import java.nio.file.Files
 import kotlin.reflect.typeOf
 
 class XlsxTest {
 
+    fun testResource(resourcePath: String): URL = this::class.java.classLoader.getResource(resourcePath)!!
+
     @Test
     fun `numerical columns`() {
         DataFrame.readExcel(testResource("sample.xls"), "Sheet1") shouldBe dataFrameOf("col1", "col2")(1.0, 2.0)
diff --git a/dataframe-spreadsheets/src/test/resources/datetime.xlsx b/dataframe-spreadsheets/src/test/resources/datetime.xlsx
diff --git a/dataframe-spreadsheets/src/test/resources/empty_cell.xls b/dataframe-spreadsheets/src/test/resources/empty_cell.xls
diff --git a/dataframe-spreadsheets/src/test/resources/sample.xls b/dataframe-spreadsheets/src/test/resources/sample.xls
diff --git a/dataframe-spreadsheets/src/test/resources/sample2.xlsx b/dataframe-spreadsheets/src/test/resources/sample2.xlsx
diff --git a/dataframe-spreadsheets/src/test/resources/sample3.xlsx b/dataframe-spreadsheets/src/test/resources/sample3.xlsx
diff --git a/dataframe-spreadsheets/src/test/resources/sample4.xls b/dataframe-spreadsheets/src/test/resources/sample4.xls
diff --git a/plugins/dataframe-gradle-plugin/build.gradle.kts b/plugins/dataframe-gradle-plugin/build.gradle.kts
@@ -16,6 +16,7 @@ group = "org.jetbrains.kotlin"
 dependencies {
     implementation(project(":"))
     implementation(project(":dataframe-arrow"))
+    implementation(project(":dataframe-spreadsheets"))
     implementation(kotlin("gradle-plugin-api"))
     implementation(kotlin("gradle-plugin"))
     implementation("com.beust:klaxon:5.5")
@@ -105,8 +106,10 @@ val integrationTestConfiguration by configurations.creating {
 val integrationTestTask = task<Test>("integrationTest") {
     dependsOn(":plugins:symbol-processor:publishToMavenLocal")
     dependsOn(":dataframe-arrow:publishToMavenLocal")
+    dependsOn(":dataframe-spreadsheets:publishToMavenLocal")
     dependsOn(":publishApiPublicationToMavenLocal")
     dependsOn(":dataframe-arrow:publishDataframeArrowPublicationToMavenLocal")
+    dependsOn(":dataframe-spreadsheets:publishDataframeSpreadsheetsPublicationToMavenLocal")
     description = "Runs integration tests."
     group = "verification"
 
diff --git a/plugins/symbol-processor/build.gradle b/plugins/symbol-processor/build.gradle
@@ -14,6 +14,7 @@ group = "org.jetbrains.kotlinx.dataframe"
 dependencies {
     implementation(project(":"))
     implementation(project(":dataframe-arrow"))
+    implementation(project(":dataframe-spreadsheets"))
     implementation(libs.ksp.api)
     testImplementation("org.jetbrains.kotlin:kotlin-test")
     testImplementation("com.github.tschuchortdev:kotlin-compile-testing:1.4.4")
diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -29,4 +29,4 @@ pluginManagement {
         gradlePluginPortal()
     }
 }
-
+include("dataframe-spreadsheets")
diff --git a/src/main/kotlin/org/jetbrains/kotlinx/dataframe/codeGen/DefaultReadDfMethods.kt b/src/main/kotlin/org/jetbrains/kotlinx/dataframe/codeGen/DefaultReadDfMethods.kt
@@ -23,7 +23,6 @@ private const val cast = "cast"
 private const val verify = "verify" // cast(true) is obscure, i think it's better to use named argument here
 private const val readCSV = "readCSV"
 private const val readTSV = "readTSV"
-private const val readExcel = "readExcel"
 private const val readJson = "readJson"
 
 public abstract class AbstractDefaultReadMethod(
@@ -98,5 +97,3 @@ internal class DefaultReadCsvMethod(
 ) : AbstractDefaultReadMethod(path, arguments, readCSV)
 
 internal class DefaultReadTsvMethod(path: String?) : AbstractDefaultReadMethod(path, MethodArguments.EMPTY, readTSV)
-
-internal class DefaultReadExcelMethod(path: String?) : AbstractDefaultReadMethod(path, MethodArguments.EMPTY, readExcel)
diff --git a/src/main/kotlin/org/jetbrains/kotlinx/dataframe/io/csv.kt b/src/main/kotlin/org/jetbrains/kotlinx/dataframe/io/csv.kt
@@ -189,7 +189,7 @@ private fun asStream(fileOrUrl: String) = (
     }
     ).toURL().openStream()
 
-internal fun asURL(fileOrUrl: String): URL = (
+public fun asURL(fileOrUrl: String): URL = (
     if (isURL(fileOrUrl)) {
         URL(fileOrUrl).toURI()
     } else {
diff --git a/src/main/resources/META-INF/services/org.jetbrains.kotlinx.dataframe.io.SupportedFormat b/src/main/resources/META-INF/services/org.jetbrains.kotlinx.dataframe.io.SupportedFormat
@@ -1,4 +1,3 @@
 org.jetbrains.kotlinx.dataframe.io.CSV
-org.jetbrains.kotlinx.dataframe.io.Excel
 org.jetbrains.kotlinx.dataframe.io.JSON
 org.jetbrains.kotlinx.dataframe.io.TSV
diff --git a/tests/build.gradle.kts b/tests/build.gradle.kts
@@ -15,6 +15,7 @@ repositories {
 
 dependencies {
     implementation(project(":"))
+    implementation(project(":dataframe-spreadsheets"))
     testImplementation(libs.junit)
     testImplementation(libs.kotestAssertions) {
         exclude("org.jetbrains.kotlin", "kotlin-stdlib-jdk8")

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+org.jetbrains.kotlinx.dataframe.io.Excel`