Prepare repository for next release and SBT build improvements (#36)

juanpedromoreno · web-flow · commit 3e3b369522d1 · 2020-06-17T12:08:09.000+02:00
* Prepare repository for next  release and SBT build improvements

* Bumps scalafmt
diff --git a/.scalafmt.conf b/.scalafmt.conf
@@ -1,4 +1,4 @@
-version=2.4.2
+version=2.6.0
 style = defaultWithAlign
 maxColumn = 100
 
diff --git a/AUTHORS.md b/AUTHORS.md
@@ -27,8 +27,8 @@ These are the people that have contributed to the _exercises-monocle_ project:
 - [![AdrianRaFo](https://avatars0.githubusercontent.com/u/15971742?v=4&s=20) **AdrianRaFo**](https://github.com/AdrianRaFo)
 - [![juanpedromoreno](https://avatars2.githubusercontent.com/u/4879373?v=4&s=20) **juanpedromoreno**](https://github.com/juanpedromoreno)
 - [![kiroco12](https://avatars1.githubusercontent.com/u/48894338?v=4&s=20) **kiroco12**](https://github.com/kiroco12)
-- [![valydia](https://avatars1.githubusercontent.com/u/2129101?v=4&s=20) **valydia**](https://github.com/valydia)
 - [![47erbot](https://avatars1.githubusercontent.com/u/24799081?v=4&s=20) **47erbot**](https://github.com/47erbot)
+- [![valydia](https://avatars1.githubusercontent.com/u/2129101?v=4&s=20) **valydia**](https://github.com/valydia)
 - [![dominv](https://avatars1.githubusercontent.com/u/3943031?v=4&s=20) **dominv**](https://github.com/dominv)
 - [![angoglez](https://avatars0.githubusercontent.com/u/10107285?v=4&s=20) **angoglez**](https://github.com/angoglez)
 - [![BenFradet](https://avatars2.githubusercontent.com/u/1737211?v=4&s=20) **BenFradet**](https://github.com/BenFradet)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -11,7 +11,7 @@ the code. Pull requests are also welcome.
 
 People are expected to follow the [Code of Conduct](CODE_OF_CONDUCT.md) when discussing _exercises-monocle_ on the Github page or other venues.
 
-If you are being harassed, please contact one of [us](AUTHORS.md#maintainers) immediately so that we can support you. In case you cannot get in touch with us please write an email to [47 Degrees](mailto:scala-exercises@47deg.com).
+If you are being harassed, please contact one of [us](AUTHORS.md#maintainers) immediately so that we can support you. In case you cannot get in touch with us please write an email to [47 Degrees Open Source](mailto:hello@47deg.com).
 
 ## How can I help?
 
diff --git a/LICENSE.md b/LICENSE.md
@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright (C)  2017-2020 47 Degrees <https://47deg.com>
+   Copyright (C)  2017-2020 47 Degrees Open Source <https://www.47deg.com>
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
diff --git a/NOTICE.md b/NOTICE.md
@@ -4,6 +4,6 @@
 
 exercises-monocle
 
-Copyright (c) 2017-2020 47 Degrees. All rights reserved.
+Copyright (c) 2017-2020 47 Degrees Open Source. All rights reserved.
 
 Licensed under Apache-2.0. See [LICENSE](LICENSE.md) for terms.
diff --git a/build.sbt b/build.sbt
@@ -1,21 +1,41 @@
 import com.jsuereth.sbtpgp.PgpKeys.publishSigned
 
+ThisBuild / organization := "org.scala-exercises"
+ThisBuild / githubOrganization := "47degrees"
+ThisBuild / scalaVersion := "2.13.2"
+
+publish / skip := true
+
+// This is required by the exercises compiler:
 publishLocal := (publishLocal dependsOn compile).value
 publishSigned := (publishSigned dependsOn compile).value
 
 addCommandAlias("ci-test", "scalafmtCheckAll; scalafmtSbtCheck; test")
-addCommandAlias("ci-docs", "github; project-docs/mdoc; headerCreateAll")
+addCommandAlias("ci-docs", "github; documentation/mdoc; headerCreateAll")
+addCommandAlias("ci-publish", "github; ci-release")
 
 lazy val exercises = (project in file("."))
-  .settings(moduleName := "exercises-monocle")
-  .settings(exercisesSettings)
+  .settings(name := "exercises-monocle")
+  .settings(
+    libraryDependencies ++= Seq(
+      "org.scala-exercises"        %% "exercise-compiler"         % "0.6.1",
+      "org.scala-exercises"        %% "definitions"               % "0.6.1",
+      "org.typelevel"              %% "alleycats-core"            % "2.1.1",
+      "org.typelevel"              %% "cats-core"                 % "2.1.1",
+      "com.github.julien-truffaut" %% "monocle-core"              % "2.0.5",
+      "com.github.julien-truffaut" %% "monocle-macro"             % "2.0.5",
+      "com.chuusai"                %% "shapeless"                 % "2.3.3",
+      "org.scalatest"              %% "scalatest"                 % "3.1.2",
+      "org.scalacheck"             %% "scalacheck"                % "1.14.3",
+      "org.scalatestplus"          %% "scalacheck-1-14"           % "3.1.2.0",
+      "com.github.alexarchambault" %% "scalacheck-shapeless_1.14" % "1.2.5"
+    ),
+    scalacOptions += "-Ymacro-annotations",
+    addCompilerPlugin("org.typelevel" %% "kind-projector" % "0.11.0" cross CrossVersion.full)
+  )
   .enablePlugins(ExerciseCompilerPlugin)
 
-lazy val `project-docs` = (project in file(".docs"))
-  .aggregate(exercises)
-  .dependsOn(exercises)
-  .settings(moduleName := "exercises-project-docs")
-  .settings(mdocIn := file(".docs"))
+lazy val documentation = project
   .settings(mdocOut := file("."))
-  .settings(skip in publish := true)
+  .settings(publish / skip := true)
   .enablePlugins(MdocPlugin)
diff --git a/docs/AUTHORS.md b/docs/AUTHORS.md
diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
diff --git a/docs/LICENSE.md b/docs/LICENSE.md
diff --git a/docs/NOTICE.md b/docs/NOTICE.md
diff --git a/project/ProjectPlugin.scala b/project/ProjectPlugin.scala
diff --git a/project/build.properties b/project/build.properties
@@ -1 +1 @@
-sbt.version = 1.3.11
+sbt.version = 1.3.12
diff --git a/project/plugins.sbt b/project/plugins.sbt
@@ -1,9 +1,9 @@
-addSbtPlugin("org.scala-exercises" % "sbt-exercise"      % "0.6.0")
-addSbtPlugin("com.geirsson"        % "sbt-ci-release"    % "1.5.3")
-addSbtPlugin("org.scalameta"       % "sbt-mdoc"          % "2.1.5")
-addSbtPlugin("org.scalameta"       % "sbt-scalafmt"      % "2.3.4")
-addSbtPlugin("de.heikoseeberger"   % "sbt-header"        % "5.6.0")
-addSbtPlugin("com.alejandrohdezma" %% "sbt-github"       % "0.8.0")
-addSbtPlugin("com.alejandrohdezma" % "sbt-github-header" % "0.8.0")
-addSbtPlugin("com.alejandrohdezma" % "sbt-github-mdoc"   % "0.8.0")
-addSbtPlugin("com.alejandrohdezma" % "sbt-mdoc-toc"      % "0.2")
+addSbtPlugin("org.scala-exercises" % "sbt-exercise"             % "0.6.1")
+addSbtPlugin("com.geirsson"        % "sbt-ci-release"           % "1.5.3")
+addSbtPlugin("org.scalameta"       % "sbt-mdoc"                 % "2.1.5")
+addSbtPlugin("org.scalameta"       % "sbt-scalafmt"             % "2.4.0")
+addSbtPlugin("de.heikoseeberger"   % "sbt-header"               % "5.6.0")
+addSbtPlugin("com.alejandrohdezma" % "sbt-github"               % "0.8.2")
+addSbtPlugin("com.alejandrohdezma" % "sbt-github-header"        % "0.8.2")
+addSbtPlugin("com.alejandrohdezma" % "sbt-github-mdoc"          % "0.8.2")
+addSbtPlugin("com.alejandrohdezma" % "sbt-remove-test-from-pom" % "0.1.0")
diff --git a/src/main/scala/monocle/IsoExercises.scala b/src/main/scala/monocle/IsoExercises.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2020 47 Degrees <https://47deg.com>
+ * Copyright 2017-2020 47 Degrees Open Source <https://www.47deg.com>
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -41,7 +41,8 @@ object IsoHelper {
 
 }
 
-/** == Iso ==
+/**
+ * == Iso ==
  *
  * An [[http://julien-truffaut.github.io/Monocle/optics/iso.html `Iso`]] is an optic which converts elements of type `S` into elements of type `A` without loss.
  *
@@ -148,7 +149,6 @@ object IsoExercises extends AnyFlatSpec with Matchers with Section {
    * An `Iso` must satisfy all properties defined in `IsoLaws` from the core module. You can check the validity of your own `Iso` using `IsoTests` from the law module.
    *
    * In particular, an Iso must verify that `get` and `reverseGet` are inverse. This is done via `roundTripOneWay` and `roundTripOtherWay` laws:
-   *
    */
   def exerciseLaws(res0: Boolean, res1: Boolean) = {
     personToTuple.get(Person("Zoe", 25))
diff --git a/src/main/scala/monocle/LensExercises.scala b/src/main/scala/monocle/LensExercises.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2020 47 Degrees <https://47deg.com>
+ * Copyright 2017-2020 47 Degrees Open Source <https://www.47deg.com>
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -47,7 +47,8 @@ object LensHelper {
 
 }
 
-/** == Lens ==
+/**
+ * == Lens ==
  *
  * A [[http://julien-truffaut.github.io/Monocle/optics/lens.html Lens]] is an optic used to zoom inside a `Product`, e.g. `case class`, `Tuple`, `HList` or even `Map`.
  *
@@ -230,7 +231,6 @@ object LensExercises extends AnyFlatSpec with Matchers with Section {
    * In particular, a `Lens` must respect the `getSet` law which states that if you get a value `A` from `S` and `set` it back in, the result is an object identical to the original one. A side effect of this law is that `set` must only update the `A` it points to, for example it cannot increment a counter or modify another value.
    *
    * On the other hand, the `setGet` law states that if you `set` a `value`, you always `get` the same value back. This law guarantees that `set` is actually updating a value `A` inside of `S`.
-   *
    */
   def exerciseLaws(res0: Boolean, res1: Boolean) = {
     val streetNumber = Lens[Address, Int](_.streetNumber)(n => a => a.copy(streetNumber = n))
diff --git a/src/main/scala/monocle/MonocleLib.scala b/src/main/scala/monocle/MonocleLib.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2020 47 Degrees <https://47deg.com>
+ * Copyright 2017-2020 47 Degrees Open Source <https://www.47deg.com>
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,7 +18,8 @@ package monoclelib
 
 import org.scalaexercises.definitions._
 
-/** Monocle is an optics library for Scala (and Scala.js) strongly inspired by Haskell Lens.
+/**
+ * Monocle is an optics library for Scala (and Scala.js) strongly inspired by Haskell Lens.
  *
  * @param name monocle
  */
@@ -29,12 +30,13 @@ object MonocleLib extends Library {
 
   override def color = Some("#5B5988")
 
-  override def sections = List(
-    IsoExercises,
-    LensExercises,
-    PrismExercises,
-    OptionalExercises,
-    TraversalExercises
-  )
+  override def sections =
+    List(
+      IsoExercises,
+      LensExercises,
+      PrismExercises,
+      OptionalExercises,
+      TraversalExercises
+    )
   override def logoPath = "monocle"
 }
diff --git a/src/main/scala/monocle/OptionalExercises.scala b/src/main/scala/monocle/OptionalExercises.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2020 47 Degrees <https://47deg.com>
+ * Copyright 2017-2020 47 Degrees Open Source <https://www.47deg.com>
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -38,7 +38,8 @@ object OptionalHelper {
 
 }
 
-/** == Optional ==
+/**
+ * == Optional ==
  *
  * An [[http://julien-truffaut.github.io/Monocle/optics/optional.html `Optional`]]  is an Optic used to zoom inside a `Product`, e.g. `case class`, `Tuple`, `HList` or even Map. Unlike the `Lens`, the element that the `Optional` focuses on may not exist.
  *
diff --git a/src/main/scala/monocle/PrismExercises.scala b/src/main/scala/monocle/PrismExercises.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2020 47 Degrees <https://47deg.com>
+ * Copyright 2017-2020 47 Degrees Open Source <https://www.47deg.com>
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -40,7 +40,8 @@ object PrismHelper {
   val rawJNum: Prism[Json, JNum] = GenPrism[Json, JNum]
 }
 
-/** == Prism ==
+/**
+ * == Prism ==
  *
  * A [[http://julien-truffaut.github.io/Monocle/optics/prism.html `Prism`]] is an optic used to select part of a `Sum` type (also known as `Coproduct`), e.g. `sealed trait` or `Enum`.
  *
@@ -157,7 +158,8 @@ object PrismExercises extends AnyFlatSpec with Matchers with Section {
 
   }
 
-  /**  == Prism Generation ==
+  /**
+   *  == Prism Generation ==
    *
    * Generating `Prisms` for subclasses is fairly common, so we added a macro to simplify the process. All macros are defined in a separate module (see [[http://julien-truffaut.github.io/Monocle/modules.html modules]]).
    *
@@ -192,8 +194,6 @@ object PrismExercises extends AnyFlatSpec with Matchers with Section {
    * A `Prism` must satisfy all properties defined in `PrismLaws` from the core module. You can check the validity of your own `Prisms` using `PrismTests` from the `law` module.
    *
    * In particular, a `Prism` must verify that `getOption` and `reverseGet` allow a full round trip if the Prism matches i.e. if `getOption` returns a `Some`.
-   *
-   *
    */
   def exerciseLaws(res0: Boolean, res1: Boolean) = {
     val jStr = Prism.partial[Json, String] { case JStr(v) => v }(JStr)
diff --git a/src/main/scala/monocle/TraversalExercises.scala b/src/main/scala/monocle/TraversalExercises.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2020 47 Degrees <https://47deg.com>
+ * Copyright 2017-2020 47 Degrees Open Source <https://www.47deg.com>
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -48,7 +48,8 @@ object TraversalHelper {
 
 }
 
-/** == Traversal ==
+/**
+ * == Traversal ==
  *
  * A [[http://julien-truffaut.github.io/Monocle/optics/traversal.html `Traversal`]]  is the generalisation of an `Optional` to several targets. In other word, a `Traversal` allows to focus from a type `S` into 0 to n values of type `A`.
  *
@@ -135,14 +136,14 @@ object TraversalExercises extends AnyFlatSpec with Matchers with Section {
 
   }
 
-  /** == Law ==
+  /**
+   * == Law ==
    *
    * A `Traversal` must satisfy all properties defined in `TraversalLaws` from the `core` module. You can check the validity of your own `Traversal` using `TraversalTests` from the `law` module.
    *
    * In particular, a `Traversal` must respect the `modifyGetAll` law which checks that you can modify all elements targeted by a `Traversal`
    *
    * Another important `law` is `composeModify` also known as fusion law:
-   *
    */
   def exerciseLaws(res0: Boolean, res1: Boolean) = {
 
diff --git a/src/test/scala/monocle/IsoSpec.scala b/src/test/scala/monocle/IsoSpec.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2020 47 Degrees <https://47deg.com>
+ * Copyright 2017-2020 47 Degrees Open Source <https://www.47deg.com>
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/test/scala/monocle/LensSpec.scala b/src/test/scala/monocle/LensSpec.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2020 47 Degrees <https://47deg.com>
+ * Copyright 2017-2020 47 Degrees Open Source <https://www.47deg.com>
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/test/scala/monocle/OptionalSpec.scala b/src/test/scala/monocle/OptionalSpec.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2020 47 Degrees <https://47deg.com>
+ * Copyright 2017-2020 47 Degrees Open Source <https://www.47deg.com>
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/test/scala/monocle/PrismSpec.scala b/src/test/scala/monocle/PrismSpec.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2020 47 Degrees <https://47deg.com>
+ * Copyright 2017-2020 47 Degrees Open Source <https://www.47deg.com>
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/test/scala/monocle/TraversalSpec.scala b/src/test/scala/monocle/TraversalSpec.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2020 47 Degrees <https://47deg.com>
+ * Copyright 2017-2020 47 Degrees Open Source <https://www.47deg.com>
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-version=2.4.2`
	`1`	`+version=2.6.0`
`2`	`2`	`style = defaultWithAlign`
`3`	`3`	`maxColumn = 100`
`4`	`4`