AktiveForm

Better form processing for Ktor inspired by Ruby on Rails/Rack's form handling. Bind forms to kotlin data classes. Just follow the Ruby on Rails naming convention for form fields. You will still have access to File data parts via request attributes.

Installation

1. Add the dependency

//build.gradle
repositories {
    maven { url 'https://jitpack.io' }
}

dependencies {
    implementation 'com.github.dajulia3:aktive-form:v0.1'
}

2. Setup Ktor ContentNegotiation

fun Application.module() {
    install(ContentNegotiation) {
        lateinit var mapper: ObjectMapper
        jackson {
            disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES)
            registerModule(JavaTimeModule())
            mapper = this
        }

        //register your own jackson mapper since we customized it above
        //that way the form binding respects our customizations.
        val formConverter = ActiveFormUrlEncodedToContentTypeConverter(mapper)
        register(ContentType.Application.FormUrlEncoded, formConverter)
        register(ContentType.MultiPart.FormData, formConverter)
    }
}

Handling form submissions

data class Fizzer(
    var fizziness: String,
    var temperature: Int
)
data class WizzBanger(var id: String, var name: String, var fizzer: Fizzer)
    
fun Application.module() {
    routing {
        post("/wizz-banger") {
            val wizzBanger: WizzBanger = call.receive()
            call.respond(HttpStatusCode.Created, wizzBanger)
        }

    }
}

The html form for this endpoint should look like this:

<form action="/wizz-banger" method="post">
    <input type="text" name="wizzbanger[id]"/>
    <input type="text" name="wizzbanger[name]"/>
    <input type="text" name="wizzbanger[fizzer][fizziness]"/>
    <input type="text" name="wizzbanger[fizzer][temperature]"/>
    <input type="submit">
 </form>

Ommitting classnames for top level fields

For convenience sake, you can omit the class name for top-level fields. This is convenient when you don't have any nested objects.

<form action="/wizz-banger" method="post">
    <input type="text" name="id"/>
    <input type="text" name="name"/>
    
    <!-- still need the class name for attributes of child objects --> 
    <input type="text" name="wizzbanger[fizzer][fizziness]"/>
    <input type="text" name="wizzbanger[fizzer][temperature]"/>
    <input type="submit">
 </form>

Handling forms with file uploads

data class Form(val name: String, val tag: String)
data class FormWithFileResp(val name: String, val tag: String, val fileContents: String)
    
fun Application.module() {
    routing {
        post("/form-with-fileContents") {
            val attrs = call.attributes
            val form: Form = call.receive() //just use plain call.receive()
            
            //still have access to Files via the filesKey attribute 
            val files: List<PartData.FileItem> = call.attributes[RequestAttributes.filesKey]

            files.first().streamProvider().use {
                val fileContents = it.readBytes().toString(Charset.defaultCharset())
                val formWithFile =
                    FormWithFileResp(name = form.name, tag = form.tag, fileContents = fileContents)
                call.respond(HttpStatusCode.Created, formWithFile)
            }
        }
    }
}

Coming Soon: Form Helpers

The next feature to implement is form helpers. We'd like to be able to generate forms for data classes as below. The example uses Thymeleaf for templating but the implementation is completely agnostic of Thymeleaf. Here is what I'm currently thinking:

fun Application.module() {
 routing {
        get("/new-wizz-banger-form") {
            val formHelper = wizzBangerFormHelper {
                withOverrides{
                    forFields {
                        wizzBanger{
                            name{
                                label { 
                                text = "Enter the name:"
                            }
                        }
                    }
                }
            }
                            
            call.respond(
                ThymeleafContent( 
                    "/new-wizz-banger-form-template",
                    listOf("wizzBangerFormHelper" to formHelper).toMap()
                )
            )
        }
    }
}

And the accompanying thymeleaf template. The helper will generate the html with the correct field names. A design goal is to maintain type safety, hence the builder pattern. The final api design is still under consideration. We would love suggestions on this.

<form action="/new-wizz-banger-form" method="post">
    <th:block th:utext='${wizzBangerFormHelper.html()}'/>
</form>

dajulia3/aktive-form