SBT baseline project.

.gitignore

@@ -0,0 +1,44 @@
+# ##########################################################################
+#                                 SBT files
+# ##########################################################################
+target
+/project/project
+/*/project/project
+
+# ##########################################################################
+#                               Eclipse files
+# ##########################################################################
+.classpath
+.project
+.cache
+.settings
+.worksheet
+
+# ##########################################################################
+#                               IntelliJ files
+# ##########################################################################
+.idea*
+*.iml
+
+# ##########################################################################
+#                                 Vim files
+# ##########################################################################
+*.sw[a-z]
+
+# ##########################################################################
+#                                 Misc files
+# ##########################################################################
+
+# OS X directory data
+.DS_Store
+
+# Log files
+*.log
+
+# Java compiled
+*.jar
+*.class
+
+# Intentionally ignored code
+*.scala.old
+/*.script

LICENSE.md

@@ -0,0 +1,13 @@
+Copyright 2015 Sarah Gerweck
+
+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.

README.md

@@ -0,0 +1,17 @@
+# Sarah’s ScalaFX Utilities #
+
+This project contains helper functions, utilities and convenience
+functions for working with JavaFX and ScalaFx in Scala.
+
+ScalaFX does a tremendous job at making JavaFX more usable from Scala,
+but it doesn't go as far as it could in facilitating functional and
+reactive programming.
+
+This code is offered as is with now guarantees.
+
+
+## Installation ##
+
+To use ScalaFX, add the following to your SBT build:
+
+    libraryDependencies += "org.gerweck.scala" %% "scalafx-utils" % "0.1.0"

project/Build.scala

@@ -0,0 +1,320 @@
+import sbt._
+import Keys._
+
+import com.typesafe.sbt.SbtSite.site
+import sbtrelease.ReleasePlugin._
+
+import scala.util.Properties.envOrNone
+import com.typesafe.sbteclipse.plugin.EclipsePlugin._
+
+import Helpers._
+
+sealed trait Basics {
+  final val buildOrganization  = "org.gerweck.scala"
+
+  final val buildScalaVersion  = "2.11.6"
+  final val extraScalaVersions = Seq.empty
+  final val buildJavaVersion   = "1.8"
+  lazy  val defaultOptimize    = true
+
+  lazy  val parallelBuild      = false
+  lazy  val cachedResolution   = false
+
+  /* Metadata definitions */
+  lazy val buildMetadata = Vector(
+    licenses    := Seq("Apache License, Version 2.0" -> url("http://www.apache.org/licenses/LICENSE-2.0.txt")),
+    homepage    := Some(url("https://github.com/sarahgerweck/scala-utils")),
+    description := "ScalaFX Utilities",
+    startYear   := Some(2015),
+    scmInfo     := Some(ScmInfo(url("https://github.com/sarahgerweck/scala-utils"), "scm:git:git@github.com:sarahgerweck/scala-utils.git"))
+  )
+}
+
+object BuildSettings extends Basics {
+  /* Overridable flags */
+  lazy val optimize     = boolFlag("OPTIMIZE") orElse boolFlag("OPTIMISE") getOrElse defaultOptimize
+  lazy val deprecation  = boolFlag("NO_DEPRECATION") map (!_) getOrElse true
+  lazy val inlineWarn   = boolFlag("INLINE_WARNINGS") getOrElse false
+  lazy val debug        = boolFlag("DEBUGGER") getOrElse false
+  lazy val debugPort    = envOrNone("DEBUGGER_PORT") map { _.toInt } getOrElse 5050
+  lazy val debugSuspend = boolFlag("DEBUGGER_SUSPEND") getOrElse true
+  lazy val unusedWarn   = boolFlag("UNUSED_WARNINGS") getOrElse false
+  lazy val importWarn   = boolFlag("IMPORT_WARNINGS") getOrElse false
+
+  /* Scala build setup */
+  lazy val buildScalaVersions = buildScalaVersion +: extraScalaVersions
+  val buildScalacOptions = Seq (
+    "-unchecked",
+    "-feature",
+    "-target:jvm-" + buildJavaVersion
+  ) ++ (
+    if (deprecation) Seq("-deprecation") else Seq.empty
+  ) ++ (
+    if (optimize) Seq("-optimize") else Seq.empty
+  ) ++ (
+    if (inlineWarn) Seq("-Yinline-warnings") else Seq.empty
+  ) ++ (
+    if (unusedWarn) Seq("-Ywarn-unused") else Seq.empty
+  ) ++ (
+    if (importWarn) Seq("-Ywarn-unused-import") else Seq.empty
+  )
+
+  /* Java build setup */
+  val buildJavacOptions = Seq(
+    "-target", buildJavaVersion,
+    "-source", buildJavaVersion
+  ) ++ (
+    if (deprecation) Seq("-Xlint:deprecation") else Seq.empty
+  )
+
+  /* Site setup */
+  lazy val siteSettings = site.settings ++ site.includeScaladoc()
+
+  val buildSettings = buildMetadata ++
+                      siteSettings ++
+                      Seq (
+    organization       :=  buildOrganization,
+
+    scalaVersion       :=  buildScalaVersion,
+    crossScalaVersions :=  buildScalaVersions,
+
+    scalacOptions      ++= buildScalacOptions,
+    javacOptions       ++= buildJavacOptions,
+    autoAPIMappings    :=  true,
+
+    updateOptions      :=  updateOptions.value.withCachedResolution(cachedResolution),
+    parallelExecution  :=  parallelBuild,
+
+    evictionWarningOptions in update :=
+      EvictionWarningOptions.default.withWarnTransitiveEvictions(false).withWarnDirectEvictions(false).withWarnScalaVersionEviction(false)
+  )
+}
+
+object Helpers {
+  def getProp(name: String): Option[String] = sys.props.get(name) orElse sys.env.get(name)
+  def parseBool(str: String): Boolean = Set("yes", "y", "true", "t", "1") contains str.trim.toLowerCase
+  def boolFlag(name: String): Option[Boolean] = getProp(name) map { parseBool _ }
+  def boolFlag(name: String, default: Boolean): Boolean = boolFlag(name) getOrElse default
+  def opts(names: String*): Option[String] = names.view.map(getProp _).foldLeft(None: Option[String]) { _ orElse _ }
+
+  import scala.xml._
+  def excludePomDeps(exclude: (String, String) => Boolean): Node => Node = { node: Node =>
+    val rewriteRule = new transform.RewriteRule {
+      override def transform(n: Node): NodeSeq = {
+        if ((n.label == "dependency") && exclude((n \ "groupId").text, (n \ "artifactId").text))
+          NodeSeq.Empty
+        else
+          n
+      }
+    }
+    val transformer = new transform.RuleTransformer(rewriteRule)
+    transformer.transform(node)(0)
+  }
+}
+
+object Resolvers {
+  val sonatypeSnaps   = Resolver.sonatypeRepo("snapshots")
+  val sonatypeRelease = Resolver.sonatypeRepo("releases")
+  val sonatypeStaging = Resolver.sonatypeRepo("staging")
+}
+
+object PublishSettings {
+  import BuildSettings._
+  import Resolvers._
+  import Helpers._
+
+  val sonaCreds = (
+    for {
+      user <- getProp("SONATYPE_USER")
+      pass <- getProp("SONATYPE_PASS")
+    } yield {
+      credentials +=
+          Credentials("Sonatype Nexus Repository Manager",
+                      "oss.sonatype.org",
+                      user, pass)
+    }
+  ).toSeq
+
+  val publishSettings = sonaCreds ++ Seq (
+    publishMavenStyle       := true,
+    pomIncludeRepository    := { _ => false },
+    publishArtifact in Test := false,
+
+    publishTo               := {
+      if (version.value.trim endsWith "SNAPSHOT")
+        Some(sonatypeSnaps)
+      else
+        Some(sonatypeStaging)
+    },
+
+    pomExtra                := (
+      <developers>
+        <developer>
+          <id>sarah</id>
+          <name>Sarah Gerweck</name>
+          <email>sarah.a180@gmail.com</email>
+          <url>https://github.com/sarahgerweck</url>
+          <timezone>America/Los_Angeles</timezone>
+        </developer>
+      </developers>
+    )
+  )
+
+  /** Use this if you don't want to publish a certain module.
+    * (SBT's release plugin doesn't handle this well.)
+    */
+  val falsePublishSettings = publishSettings ++ Seq (
+    publishArtifact in Compile := false,
+    publishArtifact in Test := false,
+    publishTo := Some(Resolver.file("phony-repo", file("target/repo")))
+  )
+}
+
+object Release {
+  import sbtrelease._
+  import ReleaseStateTransformations._
+  import ReleasePlugin._
+  import ReleaseKeys._
+  import Utilities._
+  import com.typesafe.sbt.SbtPgp.PgpKeys._
+
+  val settings = releaseSettings ++ Seq (
+    ReleaseKeys.crossBuild := true,
+    ReleaseKeys.releaseProcess := Seq[ReleaseStep](
+      checkSnapshotDependencies,
+      inquireVersions,
+      runTest,
+      setReleaseVersion,
+      commitReleaseVersion,
+      tagRelease,
+      publishArtifacts.copy(action = publishSignedAction),
+      setNextVersion,
+      commitNextVersion,
+      pushChanges
+    )
+  )
+
+  lazy val publishSignedAction = { st: State =>
+    val extracted = st.extract
+    val ref = extracted.get(thisProjectRef)
+    extracted.runAggregated(publishSigned in Global in ref, st)
+  }
+}
+
+object Eclipse {
+  import com.typesafe.sbteclipse.plugin.EclipsePlugin._
+
+  val settings = Seq (
+    EclipseKeys.createSrc            := EclipseCreateSrc.Default + EclipseCreateSrc.Resource,
+    EclipseKeys.projectFlavor        := EclipseProjectFlavor.Scala,
+    EclipseKeys.executionEnvironment := Some(EclipseExecutionEnvironment.JavaSE17),
+    EclipseKeys.withSource           := true
+  )
+}
+
+object Dependencies {
+  /* ********************************************************************** */
+  /*                          Utility Dependencies                          */
+  /* ********************************************************************** */
+  final val slf4jVersion       = "1.7.12"
+  final val log4sVersion       = "1.1.4"
+  final val logbackVersion     = "1.1.3"
+  final val threeTenVersion    = "1.2"
+  final val commonsVfsVersion  = "2.0"
+  final val commonsIoVersion   = "2.4"
+  final val spireVersion       = "0.9.1"
+  final val groovyVersion      = "2.4.3"
+  final val scalaParserVersion = "1.0.3"
+  final val scalaXmlVersion    = "1.0.3"
+  final val gerweckUtilVersion = "1.3.11"
+
+  val log4s       = "org.log4s"           %% "log4s"            % log4sVersion
+  val slf4j       = "org.slf4j"           %  "slf4j-api"        % slf4jVersion
+  val jclBridge   = "org.slf4j"           %  "jcl-over-slf4j"   % slf4jVersion
+  val log4jBridge = "org.slf4j"           %  "log4j-over-slf4j" % slf4jVersion
+  val logback     = "ch.qos.logback"      %  "logback-classic"  % logbackVersion
+  val threeTen    = "org.threeten"        %  "threetenbp"       % threeTenVersion
+  val spire       = "org.spire-math"      %% "spire"            % spireVersion
+  val commonsIo   = "commons-io"          %  "commons-io"       % commonsIoVersion
+  val groovy      = "org.codehaus.groovy" %  "groovy-all"       % groovyVersion
+  val gerweckUtil = "org.gerweck.scala"   %% "gerweck-utils"    % gerweckUtilVersion
+
+  val commonsVfs = {
+    val base      = "org.apache.commons"  %  "commons-vfs2"     % commonsVfsVersion
+    base.exclude("commons-logging",      "commons-logging")
+        .exclude("org.apache.maven.scm", "maven-scm-provider-svnexe")
+        .exclude("org.apache.maven.scm", "maven-scm-api")
+    base
+  }
+
+  /* Use like this: libraryDependencies <++= (scalaBinaryVersion) (scalaParser) */
+  def scalaParser(optional: Boolean): String => Seq[ModuleID] = { scalaBinaryVersion: String =>
+    optionalize(optional) {
+      scalaBinaryVersion match {
+        case "2.11" => Seq("org.scala-lang.modules" %% "scala-parser-combinators" % scalaParserVersion % "optional")
+        case _      => Seq.empty
+      }
+    }
+  }
+
+  def scalaXml(optional: Boolean)(scalaBinaryVersion: String): String => Seq[ModuleID] = { scalaBinaryVersion: String =>
+    optionalize(optional) {
+      scalaBinaryVersion match {
+        case "2.11" => Seq("org.scala-lang.modules" %% "scala-xml" % scalaXmlVersion % "optional")
+        case _      => Seq.empty
+      }
+    }
+  }
+
+  /* ********************************************************************** */
+  /*                          Testing Dependencies                          */
+  /* ********************************************************************** */
+  final val scalaCheckVersion  = "1.12.2"
+  final val scalaTestVersion   = "2.2.4"
+
+  val scalaCheck = "org.scalacheck" %% "scalacheck" % scalaCheckVersion
+  val scalaTest  = "org.scalatest"  %% "scalatest"  % scalaTestVersion
+
+  private[this] def optionalize(optional: Boolean)(f: => Seq[ModuleID]): Seq[ModuleID] = {
+    if (optional) {
+      f map { _ % "optional" }
+    } else {
+      f
+    }
+  }
+
+  private[this] def noCL(m: ModuleID) = (
+    m exclude("commons-logging", "commons-logging")
+      exclude("commons-logging", "commons-logging-api")
+  )
+}
+
+object UtilsBuild extends Build {
+  build =>
+
+  import BuildSettings._
+  import Resolvers._
+  import Dependencies._
+  import PublishSettings._
+  import Helpers._
+
+  lazy val root = (project in file ("."))
+    .settings(buildSettings: _*)
+    .settings(Eclipse.settings: _*)
+    .settings(publishSettings: _*)
+    .settings(Release.settings: _*)
+    .settings(
+      name := "ScalaFX Utils",
+
+      libraryDependencies ++= Seq (
+        log4s,
+        slf4j,
+        jclBridge   % "runtime,optional",
+        log4jBridge % "runtime,optional",
+        logback     % "runtime,optional",
+        gerweckUtil
+      ),
+
+      resolvers += sonatypeRelease
+    )
+}

project/build.properties

@@ -0,0 +1,2 @@
+sbt.version=0.13.8
+scala.version=2.11.6

project/plugins.sbt

@@ -0,0 +1,10 @@
+addSbtPlugin("com.typesafe.sbteclipse" % "sbteclipse-plugin" % "3.0.0")
+
+addSbtPlugin("com.typesafe.sbt" % "sbt-site" % "0.8.1")
+
+addSbtPlugin("com.typesafe.sbt" % "sbt-pgp" % "0.8.3")
+
+addSbtPlugin("org.xerial.sbt" % "sbt-sonatype" % "0.2.2")
+
+addSbtPlugin("com.github.gseitz" % "sbt-release" % "0.8.5")
+

version.sbt

@@ -0,0 +1 @@
+version in ThisBuild := "0.1.0-SNAPSHOT"