com.microsoft.thrifty.schema.render.ThriftSpec.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of thrifty-schema Show documentation
A simple Thrift IDL parser and validator
There is a newer version: 3.1.0
/*
 * Thrifty
 *
 * Copyright (c) Microsoft Corporation
 *
 * All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the License);
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * THIS CODE IS PROVIDED ON AN  *AS IS* BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING
 * WITHOUT LIMITATION ANY IMPLIED WARRANTIES OR CONDITIONS OF TITLE,
 * FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABLITY OR NON-INFRINGEMENT.
 *
 * See the Apache Version 2.0 License for specific language governing permissions and limitations under the License.
 */
package com.microsoft.thrifty.schema.render

import com.microsoft.thrifty.schema.NamespaceScope
import com.microsoft.thrifty.schema.Schema
import java.io.File

/**
 * A representation of an individual thrift spec file.
 *
 * @property filePath the relative path of this file.
 * @property namespaces the namespaces of this file.
 * @property includes any includes this file declares.
 * @property schema the [Schema] of elements contained within this file.
 */
data class ThriftSpec internal constructor(
    val filePath: String,
    val namespaces: Map,
    val includes: List,
    val schema: Schema
) {

    /**
     * The simple name of this file.
     */
    val name = File(filePath).nameWithoutExtension

    /**
     * @return a render of this file. This returns valid thrift that could be parsed back and yield
     * an equivalent [Schema] to this spec's [schema].
     */
    fun render(fileComment: String? = null) = renderTo(StringBuilder(), fileComment).toString()

    /**
     * Renders this file to a given [buffer]. This returns valid thrift that could be parsed back and
     * yield an equivalent [Schema] to this spec's [schema].
     *
     * @return the [buffer] for convenience chaining.
     */
    fun  renderTo(buffer: A, fileComment: String? = null) = buffer.apply {
        fileComment?.let {
            append("// ", it)
            appendln()
            appendln()
        }
        if (namespaces.isNotEmpty()) {
            namespaces.entries.joinEachTo(
                buffer = buffer,
                separator = NEWLINE,
                postfix = DOUBLE_NEWLINE
            ) { _, (key, value) ->
                buffer.append("namespace ", key.thriftName, " ", value)
            }
        }
        if (includes.isNotEmpty()) {
            includes
                .sortedBy(Include::path)
                .joinEachTo(buffer,
                    NEWLINE, postfix = DOUBLE_NEWLINE
                ) { _, include ->
                    buffer.append("include \"", include.path, "\"")
                }
        }
        schema.renderTo(this)
    }
}