Merge pull request #22 from 2m/wip-write-authors-to-file-2m

New task that writes authors summary to file

Author: 2m

plugin/src/main/scala/AuthorsKeys.scala

@@ -3,5 +3,6 @@ package lt.dvim.authors
 import sbt._
 
 trait AuthorsKeys {
-  val authors = inputKey[Unit]("Generate authors report.")
+  val authors = inputKey[Unit]("Generate authors report to clipboard.")
+  val authorsFile = inputKey[File]("Generate authors report to a file.")
 }

plugin/src/main/scala/AuthorsPlugin.scala

@@ -2,38 +2,24 @@ package lt.dvim.authors
 
 import sbt._
 import sbt.Keys._
-import complete.DefaultParsers._
+import sbt.complete.DefaultParsers._
 
-import scala.concurrent.Await
+import scala.concurrent.{Await, Future}
 import scala.concurrent.duration._
 
 object AuthorsPlugin extends AutoPlugin {
   object autoImport extends AuthorsKeys
   import autoImport._
 
   override def trigger = AllRequirements
-  override def projectSettings: Seq[Setting[_]] = authorsSettings(Compile)
+  override def buildSettings: Seq[Setting[_]] = authorsBuildSettings
 
-  def authorsSettings(config: Configuration): Seq[Setting[_]] = authorsGlobalSettings ++ inConfig(config)(Seq())
+  private final val ArgsParser = spaceDelimited("<from> <to>")
 
-  def authorsGlobalSettings: Seq[Setting[_]] = Seq(
+  def authorsBuildSettings: Seq[Setting[_]] = Seq(
     authors := {
-      val (from, to) = spaceDelimited("<from> <to>").parsed match {
-        case Seq(from, to) => (from, to)
-        case _ =>
-          sys.error("Please specify the <from> and <to> tags as the arguments to the task.")
-      }
-
-      // get the org/repo name from the scm info
-      val repo = scmInfo.value.map(_.browseUrl.getPath.drop(1)).getOrElse {
-        sys.error("Please set the scmInfo setting.")
-      }
-
-      streams.value.log.info(s"Fetching authors summary for $repo between $from and $to")
-
       import scala.concurrent.ExecutionContext.Implicits.global
-      val summary = Authors
-        .summary(repo, from, to, baseDirectory.value.getAbsolutePath)
+      val summary = authorsSummary(ArgsParser.parsed, scmInfo.value, baseDirectory.value, streams.value)
         .map { s =>
           import java.awt.Toolkit
           import java.awt.datatransfer._
@@ -46,6 +32,41 @@ object AuthorsPlugin extends AutoPlugin {
 
       Await.result(summary, 30.seconds)
     },
-    aggregate in authors := false
+    authors / aggregate := false,
+    authorsFile := {
+      import scala.concurrent.ExecutionContext.Implicits.global
+      val summary = authorsSummary(ArgsParser.parsed, scmInfo.value, baseDirectory.value, streams.value)
+        .map { s =>
+          val file = baseDirectory.value / "target" / "authors.md"
+          IO.write(file, s)
+          streams.value.log.info(s"Authors summary written to ${file.getAbsoluteFile}")
+          file
+        }
+
+      Await.result(summary, 30.seconds)
+    },
+    authorsFile / aggregate := false
   )
+
+  private def authorsSummary(
+      args: Seq[String],
+      scmInfo: Option[ScmInfo],
+      baseDirectory: File,
+      streams: TaskStreams
+  ): Future[String] = {
+    val (from, to) = args match {
+      case Seq(from, to) => (from, to)
+      case _ =>
+        sys.error("Please specify the <from> and <to> tags as the arguments to the task.")
+    }
+
+    // get the org/repo name from the scm info
+    val repo = scmInfo.map(_.browseUrl.getPath.drop(1)).getOrElse {
+      sys.error("Please set the scmInfo setting.")
+    }
+
+    streams.log.info(s"Fetching authors summary for $repo between $from and $to")
+
+    Authors.summary(repo, from, to, baseDirectory.getAbsolutePath)
+  }
 }

plugin/src/sbt-test/authors/summary/build.sbt

@@ -1,3 +1,5 @@
-scmInfo := Some(ScmInfo(
+ThisBuild / scmInfo := Some(ScmInfo(
   url("https://github.com/2m/authors"),
-  "git@github.com:2m/authors.git"))
+  "git@github.com:2m/authors.git"))
+
+ThisBuild / baseDirectory := baseDirectory.value / "target" / "authors"

plugin/src/sbt-test/authors/summary/expected-authors.md

@@ -0,0 +1,4 @@
+
+| Author | Commits | Lines added | Lines removed |
+| ------ | ------- | ----------- | ------------- |
+| [<img width="20" alt="2m" src="https://avatars3.githubusercontent.com/u/422086?v=4&amp;s=40"/> **2m**](https://github.com/2m) | 11 | 130 | 94 |

plugin/src/sbt-test/authors/summary/test

@@ -1 +1,7 @@
-> authors v0.1 v0.2
+# Will be using local clone of the repo to test against
+$ exec git clone https://github.com/2m/authors.git target/authors
+
+> authors v1.0.0 v1.0.1
+
+> authorsFile v1.0.0 v1.0.1
+$ must-mirror target/authors/target/authors.md expected-authors.md