com.uchuhimo.konf.source.env.EnvProvider.kt Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2017-2019 the original author or authors.
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.uchuhimo.konf.source.env

import com.uchuhimo.konf.Feature
import com.uchuhimo.konf.annotation.JavaApi
import com.uchuhimo.konf.source.Source
import com.uchuhimo.konf.source.base.FlatSource

/**
 * Provider for system environment source.
 */
object EnvProvider {
    private val validEnv = Regex("(\\w+)(.\\w+)*")

    /**
     * Returns a new source from system environment.
     *
     * @param nested whether to treat "AA_BB_CC" as nested format "AA.BB.CC" or not. True by default.
     * @return a new source from system environment
     */
    @JvmOverloads
    fun env(nested: Boolean = true): Source {
        return FlatSource(
            System.getenv().mapKeys { (key, _) ->
                val lowerCasedKey = key.toLowerCase()
                if (nested) lowerCasedKey.replace('_', '.') else lowerCasedKey
                }.filter { (key, _) ->
                key.matches(validEnv)
            }.toSortedMap(),
            type = "system-environment",
            allowConflict = true
        ).enabled(Feature.LOAD_KEYS_CASE_INSENSITIVELY)
            .disabled(Feature.SUBSTITUTE_SOURCE_BEFORE_LOADED)
    }

    /**
     * Returns a new source from system environment.
     *
     * @return a new source from system environment
     */
    @Deprecated("use `env` instead", replaceWith = ReplaceWith("env"))
    fun fromEnv(): Source = env()

    @JavaApi
    @JvmStatic
    fun get() = this
}