Unpublishes ISL and removes unused schemadiscovery/partiqlisl packages (

#1123)

* Unpublishes ISL
* Removes unused schemadiscovery package
* Removes unused partiqlisl package
* Update CHANGELOG.md

Co-authored-by: R. C. Howell <RCHowell@users.noreply.github.com>

CHANGELOG.md

@@ -102,6 +102,12 @@ Thank you to all who have contributed!
 - **Breaking**: Removes deprecated `org.partiql.lang.syntax.SourceSpan`
 - **Breaking**: Removes deprecated `org.partiql.lang.syntax.Token`
 - **Breaking**: Removes deprecated `org.partiql.lang.syntax.TokenType`
+- **Breaking**: Stops publishing PartiQL ISL to Maven Central. The last published version is https://central.sonatype.com/artifact/org.partiql/partiql-isl-kotlin/0.11.0
+- **Breaking**: Removes unused package `org.partiql.lang.schemadiscovery` which included unused classes of:
+  `SchemaInferencerFromExample`, `SchemaInferencerFromExampleImpl`, `TypeConstraint`, `NormalizeNullableVisitorTransform`,
+  `NormalizeDecimalPrecisionsToUpToRange`, and `IonExampleParser`.
+- **Breaking**: Removes unused package `org.partiql.lang.partiqlisl` which includes unused classes/methods: `ResourceAuthority`,
+  `getResourceAuthority()`, and `loadPartiqlIsl()`.
 - **Breaking**: Plan nodes cannot be directly instantiated. To instantiate, use the `Plan` (DEFAULT) factory.
 - **Breaking**: PlanRewriter has been moved from `org.partiql.plan.visitor.PlanRewriter` to `org.partiql.plan.util.PlanRewriter`
 

lib/isl/README.md

@@ -1,4 +1,7 @@
-## PartiQL ISL Kotlin
+## PartiQL ISL Kotlin (Testing Utility)
+
+**NOTE**: PartiQL ISL is no longer published to Maven. The generated classes should only be used for
+internal testing.
 
 PartiQL ISL Kotlin provides an in-memory [Ion Schema Language](https://amzn.github.io/ion-schema/docs/spec.html) (ISL) object
 model. The open-source Kotlin implementation of ISL, [ion-schema-kotlin](https://github.com/amzn/ion-schema-kotlin) allows

lib/isl/build.gradle.kts

@@ -12,13 +12,12 @@
  * express or implied. See the License for the specific language governing
  * permissions and limitations under the License.
  */
-//
+
 plugins {
     id(Plugins.conventions)
     id(Plugins.dokka)
     id(Plugins.library)
     id(Plugins.pig)
-    id(Plugins.publish)
 }
 
 dependencies {
@@ -33,13 +32,6 @@ kotlin {
     explicitApi = null
 }
 
-publish {
-    artifactId = "partiql-isl-kotlin"
-    name = "PartiQL ISL Kotlin"
-    description = "An object model that allows for programmatic manipulation of Ion Schema Language schemas."
-    url = "https://github.com/partiql/partiql-lang-kotlin/tree/main/lib/isl"
-}
-
 pig {
     namespace = "org.partiql.ionschema.model"
 }

partiql-lang/src/main/kotlin/org/partiql/lang/schemadiscovery/ConstraintDiscoverer.kt → lib/isl/src/main/kotlin/org/partiql/ionschema/discovery/ConstraintDiscoverer.kt

@@ -1,4 +1,4 @@
-package org.partiql.lang.schemadiscovery
+package org.partiql.ionschema.discovery
 
 import com.amazon.ion.IonBlob
 import com.amazon.ion.IonBool

partiql-lang/src/main/kotlin/org/partiql/lang/schemadiscovery/ConstraintInferer.kt → lib/isl/src/main/kotlin/org/partiql/ionschema/discovery/ConstraintInferer.kt

@@ -1,4 +1,4 @@
-package org.partiql.lang.schemadiscovery
+package org.partiql.ionschema.discovery
 
 import com.amazon.ion.IonBlob
 import com.amazon.ion.IonBool

partiql-lang/src/main/kotlin/org/partiql/lang/schemadiscovery/ConstraintUnifier.kt → lib/isl/src/main/kotlin/org/partiql/ionschema/discovery/ConstraintUnifier.kt

@@ -1,4 +1,4 @@
-package org.partiql.lang.schemadiscovery
+package org.partiql.ionschema.discovery
 
 import com.amazon.ionelement.api.ionBool
 import org.partiql.ionschema.model.IonSchemaModel

partiql-lang/src/main/kotlin/org/partiql/lang/schemadiscovery/ConstraintUtils.kt → lib/isl/src/main/kotlin/org/partiql/ionschema/discovery/ConstraintUtils.kt

@@ -1,4 +1,4 @@
-package org.partiql.lang.schemadiscovery
+package org.partiql.ionschema.discovery
 
 import com.amazon.ionelement.api.ionBool
 import com.amazon.ionelement.api.ionInt

partiql-lang/src/main/kotlin/org/partiql/lang/schemadiscovery/DiscoveredConstraintUnifier.kt → lib/isl/src/main/kotlin/org/partiql/ionschema/discovery/DiscoveredConstraintUnifier.kt

@@ -1,4 +1,4 @@
-package org.partiql.lang.schemadiscovery
+package org.partiql.ionschema.discovery
 
 import org.partiql.ionschema.model.IonSchemaModel
 

partiql-lang/src/main/kotlin/org/partiql/lang/schemadiscovery/IonExampleParser.kt → lib/isl/src/main/kotlin/org/partiql/ionschema/discovery/IonExampleParser.kt

@@ -1,4 +1,4 @@
-package org.partiql.lang.schemadiscovery
+package org.partiql.ionschema.discovery
 
 import com.amazon.ion.IonReader
 import com.amazon.ion.IonSystem

partiql-lang/src/main/kotlin/org/partiql/lang/schemadiscovery/NormalizeDecimalPrecisionsToUpToRange.kt → lib/isl/src/main/kotlin/org/partiql/ionschema/discovery/NormalizeDecimalPrecisionsToUpToRange.kt

@@ -1,4 +1,4 @@
-package org.partiql.lang.schemadiscovery
+package org.partiql.ionschema.discovery
 
 import com.amazon.ionelement.api.ionInt
 import org.partiql.ionschema.model.IonSchemaModel

partiql-lang/src/main/kotlin/org/partiql/lang/schemadiscovery/NormalizeNullableVisitorTransform.kt → lib/isl/src/main/kotlin/org/partiql/ionschema/discovery/NormalizeNullableVisitorTransform.kt

@@ -1,4 +1,4 @@
-package org.partiql.lang.schemadiscovery
+package org.partiql.ionschema.discovery
 
 import com.amazon.ionelement.api.ionBool
 import org.partiql.ionschema.model.IonSchemaModel

partiql-lang/src/main/kotlin/org/partiql/lang/partiqlisl/ResourceAuthority.kt → lib/isl/src/main/kotlin/org/partiql/ionschema/discovery/ResourceAuthority.kt

@@ -1,4 +1,4 @@
-package org.partiql.lang.partiqlisl
+package org.partiql.ionschema.discovery
 
 import com.amazon.ion.IonSystem
 import com.amazon.ion.IonValue
@@ -37,7 +37,3 @@ class ResourceAuthority(
         }
     }
 }
-
-fun getResourceAuthority(ion: IonSystem) = ResourceAuthority("org/partiql/schemas", ResourceAuthority::class.java.getClassLoader(), ion)
-
-fun loadPartiqlIsl(iss: IonSchemaSystem) = iss.loadSchema("partiql.isl")

partiql-lang/src/main/kotlin/org/partiql/lang/schemadiscovery/SchemaInferencerFromExample.kt → lib/isl/src/main/kotlin/org/partiql/ionschema/discovery/SchemaInferencerFromExample.kt

@@ -1,4 +1,4 @@
-package org.partiql.lang.schemadiscovery
+package org.partiql.ionschema.discovery
 
 import com.amazon.ion.IonReader
 import org.partiql.ionschema.model.IonSchemaModel

partiql-lang/src/main/kotlin/org/partiql/lang/schemadiscovery/SchemaInferencerFromExampleImpl.kt → lib/isl/src/main/kotlin/org/partiql/ionschema/discovery/SchemaInferencerFromExampleImpl.kt

@@ -1,21 +1,23 @@
-package org.partiql.lang.schemadiscovery
+package org.partiql.ionschema.discovery
 
 import com.amazon.ion.IonReader
 import com.amazon.ion.IonSequence
 import com.amazon.ion.IonStruct
+import com.amazon.ion.IonText
+import com.amazon.ion.IonValue
 import com.amazon.ion.system.IonSystemBuilder
 import com.amazon.ionschema.IonSchemaSystem
 import com.amazon.ionschema.Type
 import org.partiql.ionschema.model.IonSchemaModel
-import org.partiql.lang.util.stringValueOrNull
 
 /**
  * Implementation for [SchemaInferencerFromExample]. Requires a [typeName] for the generated schema's top level type
  * name. Also requires an [IonSchemaSystem] and [schemaIds] to load additional schema types that will be used in the
  * generated schema. The passed [schemaIds] will also be used for the generated
  * [IonSchemaModel.SchemaStatement.HeaderStatement]'s [IonSchemaModel.ImportList].
  */
-class SchemaInferencerFromExampleImpl(val typeName: String, iss: IonSchemaSystem, val schemaIds: List<String>) : SchemaInferencerFromExample {
+class SchemaInferencerFromExampleImpl(val typeName: String, iss: IonSchemaSystem, val schemaIds: List<String>) :
+    SchemaInferencerFromExample {
     private val importedTypes = schemaIds.loadImportedTypes(iss)
     private val sequenceTypes = importedTypes.loadSequenceTypes()
     private val islAnyConstraints = IonSchemaModel.build { constraintList() }
@@ -113,4 +115,9 @@ class SchemaInferencerFromExampleImpl(val typeName: String, iss: IonSchemaSystem
             acc
         }
     }
+
+    private fun IonValue.stringValueOrNull(): String? = when (this) {
+        is IonText -> stringValue()
+        else -> null
+    }
 }

partiql-lang/src/main/kotlin/org/partiql/lang/schemadiscovery/TypeConstraint.kt → lib/isl/src/main/kotlin/org/partiql/ionschema/discovery/TypeConstraint.kt

@@ -1,4 +1,4 @@
-package org.partiql.lang.schemadiscovery
+package org.partiql.ionschema.discovery
 
 import org.partiql.ionschema.model.IonSchemaModel
 

lib/isl/src/main/resources/org/partiql/ionschemas/partiql.isl

@@ -0,0 +1,35 @@
+$ion_schema_1_0
+
+type::{
+    name: missing,
+    type: $null,
+    annotations: [required::$missing],
+    valid_values: [null]
+}
+
+type::{
+    name: bag,
+    type: list,
+    annotations: [required::$bag]
+}
+
+type::{
+    name: date,
+    type: {
+        timestamp_precision: day
+    },
+    annotations: [required::$date]
+}
+
+type::{
+    name: time,
+    type: struct,
+    fields: {
+        hour:         {type: int, occurs: required, valid_values: range::[0,23]},
+        min:          {type: int, occurs: required, valid_values: range::[0,59]},
+        sec:          {type: int, occurs: required, valid_values: range::[0,59]},
+        sec_fraction: {type: int, occurs: optional, valid_values: range::[0,999999]}
+    },
+    content: closed,
+    annotations: [required::$time]
+}

partiql-lang/src/test/kotlin/org/partiql/lang/schemadiscovery/SchemaInferencerFromExampleTests.kt → lib/isl/src/test/kotlin/org/partiql/ionschema/discovery/SchemaInferencerFromExampleTests.kt

@@ -1,4 +1,4 @@
-package org.partiql.lang.schemadiscovery
+package org.partiql.ionschema.discovery
 
 import com.amazon.ion.system.IonReaderBuilder
 import com.amazon.ion.system.IonSystemBuilder
@@ -8,13 +8,7 @@ import org.junit.jupiter.params.ParameterizedTest
 import org.junit.jupiter.params.provider.ArgumentsSource
 import org.partiql.ionschema.model.toIsl
 import org.partiql.ionschema.parser.parseSchema
-import org.partiql.lang.TestBase
-import org.partiql.lang.eval.BAG_ANNOTATION
-import org.partiql.lang.eval.DATE_ANNOTATION
-import org.partiql.lang.eval.MISSING_ANNOTATION
-import org.partiql.lang.eval.TIME_ANNOTATION
-import org.partiql.lang.partiqlisl.ResourceAuthority
-import org.partiql.lang.util.ArgumentsProviderBase
+import org.partiql.ionschema.util.ArgumentsProviderBase
 import java.math.BigInteger
 
 private const val typeName = "SchemaInferencerFromExample"
@@ -31,8 +25,13 @@ private val islFooter = """
     schema_footer::{ }
 """.trimIndent()
 
+const val MISSING_ANNOTATION = "\$missing"
+const val BAG_ANNOTATION = "\$bag"
+const val DATE_ANNOTATION = "\$date"
+const val TIME_ANNOTATION = "\$time"
+
 private val ion = IonSystemBuilder.standard().build()
-private val resourceAuthority = ResourceAuthority("org/partiql/schemas", ClassLoader.getSystemClassLoader(), ion)
+private val resourceAuthority = ResourceAuthority("org/partiql/ionschemas", ClassLoader.getSystemClassLoader(), ion)
 private val iss = IonSchemaSystemBuilder.standard().addAuthority(resourceAuthority).build()
 
 private val inferencer: SchemaInferencerFromExample = SchemaInferencerFromExampleImpl(typeName, iss, listOf(schemaId))
@@ -97,7 +96,7 @@ private fun assertCorrectISL(
     }
 }
 
-class SchemaInferencerFromExampleTests : TestBase() {
+class SchemaInferencerFromExampleTests {
 
     class SchemaDiscoveryTests : ArgumentsProviderBase() {
         private val structOneTwoIon = """{ one: 1, two: 2 }"""

partiql-lang/build.gradle.kts

@@ -32,12 +32,12 @@ kotlin {
 }
 
 dependencies {
-    api(project(":lib:isl"))
     api(project(":partiql-ast"))
     api(project(":partiql-spi"))
     api(project(":partiql-types"))
     api(Deps.ionElement)
     api(Deps.ionJava)
+    api(Deps.ionSchema)
     // libs are included in partiql-lang-kotlin JAR, but are not published independently yet.
     libs(project(":partiql-parser"))
     libs(project(":partiql-plan"))
@@ -46,6 +46,7 @@ dependencies {
     implementation(Deps.kotlinReflect)
 
     testImplementation(project(":plugins:partiql-mockdb"))
+    testImplementation(project(":lib:isl"))
     testImplementation(Deps.assertj)
     testImplementation(Deps.junit4)
     testImplementation(Deps.junit4Params)

partiql-lang/src/main/kotlin/org/partiql/lang/graph/ExternalGraphReader.kt

@@ -12,7 +12,7 @@ import com.amazon.ion.system.IonSystemBuilder
 import com.amazon.ionschema.IonSchemaSystemBuilder
 import com.amazon.ionschema.Schema
 import org.partiql.lang.eval.ExprValue
-import org.partiql.lang.partiqlisl.getResourceAuthority
+import org.partiql.lang.util.impl.ResourceAuthority
 import java.io.File
 
 abstract class ExternalGraphException(override val message: String) : RuntimeException(message)
@@ -32,7 +32,7 @@ object ExternalGraphReader {
 
     private val ion: IonSystem = IonSystemBuilder.standard().build()
     private val iss = IonSchemaSystemBuilder.standard()
-        .addAuthority(getResourceAuthority(ion))
+        .addAuthority(ResourceAuthority.getResourceAuthority(ion))
         .withIonSystem(ion)
         .build()
     private val graphSchema: Schema = iss.loadSchema(islSchemaFile)

partiql-lang/src/main/kotlin/org/partiql/lang/util/impl/ResourceAuthority.kt

@@ -0,0 +1,44 @@
+package org.partiql.lang.util.impl
+
+import com.amazon.ion.IonSystem
+import com.amazon.ion.IonValue
+import com.amazon.ionschema.Authority
+import com.amazon.ionschema.IonSchemaSystem
+import com.amazon.ionschema.util.CloseableIterator
+import java.io.InputStream
+
+internal class ResourceAuthority(
+    private val rootPackage: String,
+    private val classLoader: ClassLoader,
+    val ion: IonSystem
+) : Authority {
+
+    companion object {
+        internal fun getResourceAuthority(ion: IonSystem) =
+            ResourceAuthority("org/partiql/schemas", ResourceAuthority::class.java.classLoader, ion)
+    }
+
+    override fun iteratorFor(iss: IonSchemaSystem, id: String): CloseableIterator<IonValue> {
+        val resourceName = "$rootPackage/$id"
+        val str: InputStream = classLoader.getResourceAsStream(resourceName)
+            ?: error("Failed to load schema with resource name '$resourceName'")
+
+        return object : CloseableIterator<IonValue> {
+
+            private var stream = str
+            private var reader = ion.newReader(stream).also { it.next() }
+            private var iter = ion.iterate(reader)
+
+            override fun hasNext() = iter.hasNext()
+            override fun next() = iter.next()
+            override fun close() {
+                try {
+                    reader?.close()
+                    stream.close()
+                } finally {
+                    reader = null
+                }
+            }
+        }
+    }
+}

partiql-lang/src/test/kotlin/org/partiql/lang/mockdb/MockDb.kt

@@ -2,12 +2,12 @@ package org.partiql.lang.mockdb
 
 import com.amazon.ion.IonValue
 import com.amazon.ionschema.IonSchemaSystem
+import org.partiql.ionschema.discovery.NormalizeDecimalPrecisionsToUpToRange
+import org.partiql.ionschema.discovery.SchemaInferencerFromExampleImpl
 import org.partiql.lang.ION
 import org.partiql.lang.eval.Bindings
 import org.partiql.lang.eval.EvaluationSession
 import org.partiql.lang.eval.ExprValue
-import org.partiql.lang.schemadiscovery.NormalizeDecimalPrecisionsToUpToRange
-import org.partiql.lang.schemadiscovery.SchemaInferencerFromExampleImpl
 import org.partiql.types.StaticType
 
 /**

partiql-lang/src/test/kotlin/org/partiql/lang/util/SchemaHelpers.kt

@@ -2,9 +2,9 @@ package org.partiql.lang.util
 
 import com.amazon.ion.IonSystem
 import com.amazon.ionschema.IonSchemaSystemBuilder
-import org.partiql.lang.partiqlisl.getResourceAuthority
+import org.partiql.lang.util.impl.ResourceAuthority
 
 fun createPartiqlIonSchemaSystem(ion: IonSystem) = IonSchemaSystemBuilder.standard()
-    .addAuthority(getResourceAuthority(ion))
+    .addAuthority(ResourceAuthority.getResourceAuthority(ion))
     .withIonSystem(ion)
     .build()

partiql-lang/src/test/kotlin/org/partiql/lang/partiqlisl/PartiQLISLSchemaTests.kt → partiql-lang/src/test/kotlin/org/partiql/lang/util/impl/ResourceAuthorityTests.kt

@@ -1,4 +1,4 @@
-package org.partiql.lang.partiqlisl
+package org.partiql.lang.util.impl
 
 import com.amazon.ion.system.IonSystemBuilder
 import com.amazon.ionschema.IonSchemaSystemBuilder
@@ -9,11 +9,11 @@ import org.partiql.lang.eval.DATE_ANNOTATION
 import org.partiql.lang.eval.MISSING_ANNOTATION
 import org.partiql.lang.eval.TIME_ANNOTATION
 
-class PartiQLISLSchemaTests {
+class ResourceAuthorityTests {
 
     private val ION = IonSystemBuilder.standard().build()
-    private val ISS = IonSchemaSystemBuilder.standard().addAuthority(getResourceAuthority(ION)).build()
-    private val schema = loadPartiqlIsl(ISS)
+    private val ISS = IonSchemaSystemBuilder.standard().addAuthority(ResourceAuthority.getResourceAuthority(ION)).build()
+    private val schema = ISS.loadSchema("partiql.isl")
 
     @Test
     fun missingTypeTest() {