Merge pull request #115 from gourlaysama/merge-1.0.x-master

Merge 1.0.x to master (i.e. 1.1.x)

Author: gourlaysama

.travis.yml

@@ -8,6 +8,9 @@ addons:
   hosts:
     - myshorthost
   hostname: myshorthost
+  apt:
+    packages:
+      - graphviz
 
 env:
   global:
@@ -28,3 +31,12 @@ notifications:
   email:
     - [email protected]
     - [email protected]
+
+before_cache:
+  - find $HOME/.sbt -name "*.lock" | xargs rm
+  - find $HOME/.ivy2/cache -name "ivydata-*.properties" | xargs rm
+cache:
+  directories:
+  - $HOME/.ivy2/cache
+  - $HOME/.sbt/boot
+  - $HOME/.sbt/launchers

README.md

@@ -9,20 +9,60 @@ As of Scala 2.11, this library is a separate jar that can be omitted from Scala
 
 ## Documentation
 
- * [Latest version](http://www.scala-lang.org/files/archive/api/2.11.x/scala-parser-combinators/)
- * [Previous versions](http://scala-lang.org/documentation/api.html) (included in the API docs for the Scala library until Scala 2.11)
+ * [Current API](https://javadoc.io/page/org.scala-lang.modules/scala-parser-combinators_2.12/latest/scala/util/parsing/combinator/index.html)
+ * The [Getting Started](docs/Getting_Started.md) guide
+ * A more complicated example, [Building a lexer and parser with Scala's Parser Combinators](https://enear.github.io/2016/03/31/parser-combinators/)
+ * "Combinator Parsing", chapter 33 of [_Programming in Scala, Third Edition_](http://www.artima.com/shop/programming_in_scala), shows how to use this library to parse arithmetic expressions and JSON. The second half of the chapter examines how the library is implemented.
 
 ## Adding an SBT dependency
 To depend on scala-parser-combinators in SBT, add something like this to your build.sbt:
 
 ```
-libraryDependencies += "org.scala-lang.modules" %% "scala-parser-combinators" % "1.0.4"
+libraryDependencies += "org.scala-lang.modules" %% "scala-parser-combinators" % "1.0.6"
 ```
 
 (Assuming you're using a `scalaVersion` for which a scala-parser-combinators is published. The first 2.11 milestone for which this is true is 2.11.0-M4.)
 
 To support multiple Scala versions, see the example in https://github.com/scala/scala-module-dependency-sample.
 
+## Example
+
+```scala
+import scala.util.parsing.combinator._
+
+case class WordFreq(word: String, count: Int) {
+    override def toString = "Word <" + word + "> " +
+                            "occurs with frequency " + count
+}
+
+class SimpleParser extends RegexParsers {
+    def word: Parser[String]   = """[a-z]+""".r       ^^ { _.toString }
+    def number: Parser[Int]    = """(0|[1-9]\d*)""".r ^^ { _.toInt }
+    def freq: Parser[WordFreq] = word ~ number        ^^ { case wd ~ fr => WordFreq(wd,fr) }
+}
+
+object TestSimpleParser extends SimpleParser {
+    def main(args: Array[String]) = {
+        parse(freq, "johnny 121") match {
+            case Success(matched,_) => println(matched)
+            case Failure(msg,_) => println("FAILURE: " + msg)
+            case Error(msg,_) => println("ERROR: " + msg)
+        }
+    }
+}
+```
+
+For a detailed unpacking of this example see
+[Getting Started](docs/Getting_Started.md).
+
+## ScalaJS support
+
+Scala-parser-combinators directly supports scala-js 0.6+, starting with v1.0.5:
+
+```
+libraryDependencies += "org.scala-lang.modules" %%% "scala-parser-combinators" % "1.0.6"
+```
+
 ## Contributing
 
  * See the [Scala Developer Guidelines](https://github.com/scala/scala/blob/2.12.x/CONTRIBUTING.md) for general contributing guidelines

admin/README.md

@@ -1,7 +1,5 @@
 ## Tag Driven Releasing
 
-Copied from https://github.com/scala/scala-java8-compat/commit/4a6cfc97cd95227b86650410e1b632e5ff79335b.
-
 ### Background Reading
 
   - http://docs.travis-ci.com/user/environment-variables/
@@ -14,47 +12,61 @@ To configure tag driven releases from Travis CI.
 
   1. Generate a key pair for this repository with `./admin/genKeyPair.sh`.
      Edit `.travis.yml` and `admin/build.sh` as prompted.
-  2. Publish the public key to https://pgp.mit.edu
-  3. Store other secrets as encrypted environment variables with `admin/encryptEnvVars.sh`.
+  1. Publish the public key to https://pgp.mit.edu
+  1. Store other secrets as encrypted environment variables with `admin/encryptEnvVars.sh`.
      Edit `.travis.yml` as prompted.
-  4. Edit `.travis.yml` to use `./admin/build.sh` as the build script,
+  1. Edit `.travis.yml` to use `./admin/build.sh` as the build script,
      and edit that script to use the tasks required for this project.
-  5. Edit `build.sbt` to select which JDK will be used for publishing.
+  1. Edit `build.sbt`'s `scalaVersionsByJvm in ThisBuild` to select Scala and JVM version
+     combinations that will be used for publishing.
 
-It is important to add comments in .travis.yml to identify the name
+It is important to add comments in `.travis.yml` to identify the name
 of each environment variable encoded in a `:secure` section.
 
-After all of these steps, your .travis.yml should contain config of the
-form:
+After these steps, your `.travis.yml` should contain config of the form:
+
+```
+language: scala
+
+env:
+  global:
+    # PGP_PASSPHRASE
+    - secure: "XXXXXX"
+    # SONA_USER
+    - secure: "XXXXXX"
+    # SONA_PASS
+    - secure: "XXXXXX"
+
+script: admin/build.sh
 
-	language: scala
-	env:
-	  global:
-	    # PGP_PASSPHRASE
-	    - secure: "XXXXXX"
-	    # SONA_USER
-	    - secure: "XXXXXX"
-	    # SONA_PASS
-	    - secure: "XXXXXX"
-	script: admin/build.sh
+jdk:
+  - openjdk6
+  - oraclejdk8
+
+notifications:
+  email:
+    - [email protected]
+```
 
 If Sonatype credentials change in the future, step 3 can be repeated
 without generating a new key.
 
-Be sure to use SBT 0.13.7 or higher to avoid [#1430](https://github.com/sbt/sbt/issues/1430)!
-
 ### Testing
 
-  1. Follow the release process below to create a dummy release (e.g. 0.1.0-TEST1).
+  1. Follow the release process below to create a dummy release (e.g., `v0.1.0-TEST1`).
      Confirm that the release was staged to Sonatype but do not release it to Maven
      central. Instead, drop the staging repository.
 
 ### Performing a release
 
-  1. Create a GitHub "Release" (with a corresponding tag) via the GitHub
+  1. Create a GitHub "Release" with a corresponding tag (e.g., `v0.1.1`) via the GitHub
      web interface.
-  2. Travis CI will schedule a build for this release. Review the build logs.
-  3. Log into https://oss.sonatype.org/ and identify the staging repository.
-  4. Sanity check its contents
-  5. Release staging repository to Maven and send out release announcement.
-
+  1. The release will be published using the Scala and JVM version combinations specified
+     in `scalaVersionsByJvm` in `build.sbt`.
+     - If you need to release against a different Scala version, include the Scala version
+       and the JVM version to use in the tag name, separated by `#`s (e.g., `v0.1.1#2.13.0-M1#8`).
+       Note that the JVM version needs to be listed in `.travis.yml` for the build to run.
+  1. Travis CI will schedule a build for this release. Review the build logs.
+  1. Log into https://oss.sonatype.org/ and identify the staging repository.
+  1. Sanity check its contents.
+  1. Release staging repository to Maven and send out release announcement.

admin/build.sh

@@ -2,15 +2,43 @@
 
 set -e
 
-# prep environment for publish to sonatype staging if the HEAD commit is tagged
+# Builds of tagged revisions are published to sonatype staging.
 
-# git on travis does not fetch tags, but we have TRAVIS_TAG
-# headTag=$(git describe --exact-match ||:)
+# Travis runs a build on new revisions and on new tags, so a tagged revision is built twice.
+# Builds for a tag have TRAVIS_TAG defined, which we use for identifying tagged builds.
+# Checking the local git clone would not work because git on travis does not fetch tags.
+
+# The version number to be published is extracted from the tag, e.g., v1.2.3 publishes
+# version 1.2.3 using all Scala versions in build.sbt's `crossScalaVersions`.
+
+# When a new, binary incompatible Scala version becomes available, a previously released version
+# can be released using that new Scala version by creating a new tag containing the Scala and the
+# JVM version after hashes, e.g., v1.2.3#2.13.0-M1#8. The JVM version needs to be listed in
+# `.travis.yml`, otherwise the required build doesn't run.
+
+verPat="[0-9]+\.[0-9]+\.[0-9]+(-[A-Za-z0-9-]+)?"
+tagPat="^v$verPat(#$verPat#[0-9]+)?$"
+
+if [[ "$TRAVIS_TAG" =~ $tagPat ]]; then
+  currentJvmVer=$(java -version 2>&1 | awk -F '"' '/version/ {print $2}' | sed 's/^1\.//' | sed 's/[^0-9].*//')
+
+  tagVer=$(echo $TRAVIS_TAG | sed s/#.*// | sed s/^v//)
+  publishVersion='set every version := "'$tagVer'"'
+
+  scalaAndJvmVer=$(echo $TRAVIS_TAG | sed s/[^#]*// | sed s/^#//)
+  if [ "$scalaAndJvmVer" != "" ]; then
+    scalaVer=$(echo $scalaAndJvmVer | sed s/#.*//)
+    jvmVer=$(echo $scalaAndJvmVer | sed s/[^#]*// | sed s/^#//)
+    if [ "$jvmVer" != "$currentJvmVer" ]; then
+      echo "Not publishing $TRAVIS_TAG on Java version $currentJvmVer."
+      exit 0
+    fi
+    publishScalaVersion='set every ScalaModulePlugin.scalaVersionsByJvm := Map('$jvmVer' -> List("'$scalaVer'" -> true))'
+    echo "Releasing $tagVer using Scala $scalaVer on Java version $jvmVer."
+  else
+    echo "Releasing $tagVer on Java version $currentJvmVer according to 'scalaVersionsByJvm' in build.sbt."
+  fi
 
-if [[ "$TRAVIS_TAG" =~ ^v[0-9]+\.[0-9]+\.[0-9]+(-[A-Za-z0-9-]+)? ]]; then
-  echo "Going to release from tag $TRAVIS_TAG!"
-  myVer=$(echo $TRAVIS_TAG | sed -e s/^v//)
-  publishVersion='set every version := "'$myVer'"'
   extraTarget="+publish-signed"
   cat admin/gpg.sbt >> project/plugins.sbt
   cp admin/publish-settings.sbt .
@@ -22,4 +50,4 @@ if [[ "$TRAVIS_TAG" =~ ^v[0-9]+\.[0-9]+\.[0-9]+(-[A-Za-z0-9-]+)? ]]; then
   openssl aes-256-cbc -K $K -iv $IV -in admin/secring.asc.enc -out admin/secring.asc -d
 fi
 
-sbt "$publishVersion" clean update +test +publishLocal $extraTarget
+sbt "$publishVersion" "$publishScalaVersion" clean update +test +publishLocal $extraTarget

build.sbt

@@ -1,29 +1,39 @@
-scalaVersion in ThisBuild := crossScalaVersions.value.head
+import ScalaModulePlugin._
 
-crossScalaVersions in ThisBuild := {
-  val v211 = List("2.11.8")
-  val v212 = List("2.12.0-RC1")
+scalaVersionsByJvm in ThisBuild := {
+  val v211 = "2.11.11"
+  val v212 = "2.12.2"
+  val v213 = "2.13.0-M1"
 
-  val javaVersion = System.getProperty("java.version")
-  val isTravisPublishing = !util.Properties.envOrElse("TRAVIS_TAG", "").trim.isEmpty
-
-  if (isTravisPublishing) {
-    if (javaVersion.startsWith("1.6.")) v211
-    else if (javaVersion.startsWith("1.8.")) v212
-    else Nil
-  } else if (javaVersion.startsWith("1.6.") || javaVersion.startsWith("1.7.")) {
-    v211
-  } else if (javaVersion.startsWith("1.8.") || javaVersion.startsWith("9")) {
-    v211 ++ v212
-  } else {
-    sys.error(s"Unsupported java version: $javaVersion.")
-  }
+  Map(
+    6 -> List(v211 -> true),
+    7 -> List(v211 -> false),
+    8 -> List(v212 -> true, v213 -> true, v211 -> false),
+    9 -> List(v212 -> false, v213 -> false, v211 -> false)
+  )
 }
 
+lazy val root = project.in(file("."))
+  .aggregate(`scala-parser-combinatorsJS`, `scala-parser-combinatorsJVM`)
+  .settings(disablePublishing)
+
 lazy val `scala-parser-combinators` = crossProject.in(file(".")).
   settings(scalaModuleSettings: _*).
   settings(
-    name := "scala-parser-combinators-root"
+    name := "scala-parser-combinators-root",
+    apiMappings += (scalaInstance.value.libraryJar ->
+        url(s"https://www.scala-lang.org/api/${scalaVersion.value}/")),
+    scalacOptions in (Compile, doc) ++= Seq(
+      "-diagrams",
+      "-doc-source-url",
+      s"https://github.com/scala/scala-parser-combinators/tree/v${version.value}€{FILE_PATH}.scala",
+      "-sourcepath",
+      (baseDirectory in LocalRootProject).value.absolutePath,
+      "-doc-title",
+      "Scala Parser Combinators",
+      "-doc-version",
+      version.value
+    )
   ).
   jvmSettings(
     // Mima uses the name of the jvm project in the artifactId
@@ -38,14 +48,7 @@ lazy val `scala-parser-combinators` = crossProject.in(file(".")).
     version            := "1.1.0-SNAPSHOT"
   ).
   jvmSettings(
-    // important!! must come here (why?)
-    scalaModuleOsgiSettings: _*
-  ).
-  jvmSettings(
-    OsgiKeys.exportPackage := Seq(s"scala.util.parsing.*;version=${version.value}"),
-
-    // needed to fix classloader issues (see scala-xml#20)
-    fork in Test := true
+    OsgiKeys.exportPackage := Seq(s"scala.util.parsing.*;version=${version.value}")
   ).
   jsSettings(
     // Scala.js cannot run forked tests