skinny.SkinnyEnv.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of skinny-common_2.10 Show documentation

skinny-common

The newest version!

package skinny

/**
 * Skinny Env value (key: "skinny.env")
 */
object SkinnyEnv {

  /**
   * Key for Skinny framework env value.
   */
  val Key = "skinny.env"

  val Development = "development"
  val Dev = "dev"

  val Test = "test"

  val Staging = "stating"
  val QA = "qa"

  val Production = "production"
  val Prod = "prod"

  /**
   * Env value from system property (you can pass by JVM options or on runtime) or environment value.
   *
   * @return env string such as "production"
   */
  def get(): Option[String] = Option(System.getProperty(Key)).orElse(Option(System.getenv(Key)))

  /**
   * Predicates current env is "development" or "dev".
   *
   * @return true/false
   */
  def isDevelopment(env: Option[String] = get()): Boolean = env.isEmpty || env.exists(e => e == Development || e == Dev)

  /**
   * Predicates current env is "test".
   *
   * @return true/false
   */
  def isTest(env: Option[String] = get()): Boolean = env.exists(e => e == Test)

  /**
   * Predicates current env is "staging" or "qa".
   *
   * @return true/false
   */
  def isStaging(env: Option[String] = get()): Boolean = env.exists(e => e == Staging || e == QA)

  /**
   * Predicates current env is "production" or "prod".
   *
   * @return true/false
   */
  def isProduction(env: Option[String] = get()): Boolean = env.exists(env => env == Production || env == Prod)

}