diff --git a/.scalafmt.conf b/.scalafmt.conf index 106c0cc5..97595104 100644 --- a/.scalafmt.conf +++ b/.scalafmt.conf @@ -1,3 +1,4 @@ +version=2.4.2 style = defaultWithAlign maxColumn = 100 @@ -19,5 +20,4 @@ docstrings = JavaDoc rewrite { rules = [SortImports, RedundantBraces] redundantBraces.maxLines = 1 -} - \ No newline at end of file +} \ No newline at end of file diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 17cece84..00000000 --- a/.travis.yml +++ /dev/null @@ -1,14 +0,0 @@ -language: scala -scala: -- 2.13.1 -jdk: -- openjdk8 -script: -- sbt test -- if [ "$TRAVIS_BRANCH" = "master" -a "$TRAVIS_PULL_REQUEST" = "false" ]; then - openssl aes-256-cbc -K $encrypted_40545b9562dd_key -iv $encrypted_40545b9562dd_iv - -in secring.gpg.enc -out secring.gpg -d; - fi -after_success: -- if [ "$TRAVIS_BRANCH" = "master" -a "$TRAVIS_PULL_REQUEST" = "false" ]; then sbt - compile publishSigned; fi diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 00000000..fef1c3a0 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright (C) 2016-2020 47 Degrees + + 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. \ No newline at end of file diff --git a/build.sbt b/build.sbt index a03f1704..16ca3a8e 100644 --- a/build.sbt +++ b/build.sbt @@ -1,26 +1,16 @@ -import ProjectPlugin.autoImport._ +addCommandAlias("ci-test", "scalafmtCheckAll; scalafmtSbtCheck; test") +addCommandAlias("ci-docs", "github; project-docs/mdoc; headerCreateAll") -val scalaExercisesV = "0.6.0-SNAPSHOT" - -def dep(artifactId: String) = "org.scala-exercises" %% artifactId % scalaExercisesV - -lazy val `scala-tutorial` = (project in file(".")) +lazy val exercises = (project in file(".")) + .settings(moduleName := "exercises-scalatutorial") + .settings(exercisesSettings) .enablePlugins(ExerciseCompilerPlugin) - .settings( - name := "exercises-scalatutorial", - libraryDependencies ++= Seq( - dep("exercise-compiler"), - dep("definitions"), - %%("shapeless", V.shapeless), - %%("scalatest", V.scalatest), - %%("scalacheck", V.scalacheck), - "com.github.alexarchambault" %% "scalacheck-shapeless_1.14" % V.scalacheckShapeless, - "org.scalatestplus" %% "scalatestplus-scalacheck" % V.scalatestplusScheck - ) - ) - -// Distribution -pgpPassphrase := Some(getEnvVar("PGP_PASSPHRASE").getOrElse("").toCharArray) -pgpPublicRing := file(s"$gpgFolder/pubring.gpg") -pgpSecretRing := file(s"$gpgFolder/secring.gpg") +lazy val `project-docs` = (project in file(".docs")) + .aggregate(exercises) + .dependsOn(exercises) + .settings(moduleName := "exercises-project-docs") + .settings(mdocIn := file(".docs")) + .settings(mdocOut := file(".")) + .settings(skip in publish := true) + .enablePlugins(MdocPlugin) diff --git a/project/ProjectPlugin.scala b/project/ProjectPlugin.scala index 587e5922..50166c50 100644 --- a/project/ProjectPlugin.scala +++ b/project/ProjectPlugin.scala @@ -1,55 +1,49 @@ -import de.heikoseeberger.sbtheader.HeaderPlugin.autoImport._ -import de.heikoseeberger.sbtheader.License._ import sbt.Keys._ import sbt._ -import sbtorgpolicies._ -import sbtorgpolicies.model._ -import sbtorgpolicies.OrgPoliciesPlugin.autoImport._ +import com.alejandrohdezma.sbt.github.SbtGithubPlugin object ProjectPlugin extends AutoPlugin { override def trigger: PluginTrigger = allRequirements - override def requires: Plugins = plugins.JvmPlugin && OrgPoliciesPlugin + override def requires: Plugins = plugins.JvmPlugin && SbtGithubPlugin object autoImport { lazy val V = new { - val scala213: String = "2.13.1" val shapeless: String = "2.3.3" - val scalatest: String = "3.1.1" - val scalatestplusScheck: String = "3.1.0.0-RC2" + val scala: String = "2.13.2" + val scalaExercises: String = "0.6.0-SNAPSHOT" val scalacheck: String = "1.14.3" val scalacheckShapeless: String = "1.2.5" + val scalatest: String = "3.1.1" + val scalatestplusScheck: String = "3.1.1.1" } - } - import autoImport._ + def dep(artifactId: String) = "org.scala-exercises" %% artifactId % V.scalaExercises + + lazy val exercisesSettings = Seq( + libraryDependencies ++= Seq( + dep("exercise-compiler"), + dep("definitions"), + "com.chuusai" %% "shapeless" % V.shapeless, + "org.scalatest" %% "scalatest" % V.scalatest, + "org.scalacheck" %% "scalacheck" % V.scalacheck, + "org.scalatestplus" %% "scalacheck-1-14" % V.scalatestplusScheck, + "com.github.alexarchambault" %% "scalacheck-shapeless_1.14" % V.scalacheckShapeless + ) + ) + } override def projectSettings: Seq[Def.Setting[_]] = Seq( - description := "Scala Exercises: The path to enlightenment", - startYear := Option(2016), - orgGithubSetting := GitHubSettings( - organization = "scala-exercises", - project = name.value, - organizationName = "Scala Exercises", - groupId = "org.scala-exercises", - organizationHomePage = url("https://www.scala-exercises.org"), - organizationEmail = "hello@47deg.com" - ), - orgLicenseSetting := ApacheLicense, - scalaVersion := V.scala213, - scalaOrganization := "org.scala-lang", + organization := "org.scala-exercises", + organizationName := "47 Degrees", + organizationHomepage := Some(url("https://47deg.com")), + scalaVersion := autoImport.V.scala, resolvers ++= Seq( - Resolver.mavenLocal, Resolver.sonatypeRepo("snapshots"), Resolver.sonatypeRepo("releases") - ), - scalacOptions := sbtorgpolicies.model.scalacCommonOptions, - headerLicense := Some(Custom(s"""| scala-exercises - ${name.value} - | Copyright (C) 2015-2019 47 Degrees, LLC. - | - |""".stripMargin)) + ) ) } diff --git a/project/plugins.sbt b/project/plugins.sbt index 5be51237..c2d9942e 100644 --- a/project/plugins.sbt +++ b/project/plugins.sbt @@ -1,6 +1,10 @@ -resolvers ++= Seq( - Resolver.sonatypeRepo("snapshots") -) - -addSbtPlugin("org.scala-exercises" % "sbt-exercise" % "0.6.0-SNAPSHOT") -addSbtPlugin("com.47deg" % "sbt-org-policies" % "0.12.0-M3") \ No newline at end of file +resolvers += Resolver.sonatypeRepo("snapshots") +addSbtPlugin("org.scala-exercises" % "sbt-exercise" % "0.6.0-SNAPSHOT") +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") diff --git a/pubring.gpg b/pubring.gpg deleted file mode 100644 index c7e3925b..00000000 --- a/pubring.gpg +++ /dev/null @@ -1,18 +0,0 @@ ------BEGIN PGP PUBLIC KEY BLOCK----- -Version: BCPG v1.51 - -mQENBFgGJjoBCACkQzvPI+1VtMYz252a3i3wm1dKrsF5v/E//IsYLMsXx/4BICES -bjZchmCbaIqjaNrfBxRAR20KbWVXbUptDJgXA/WOyGEUfDvS6Kfm1F6A34qVyCIr -NPEIeDVM64nLpQFrNuIiFPlTj9eXbKPRbV0eUrtKH59iplB4DCboK4ysGX3Hk/A3 -nzmAf9+Lt9N8vuzO8ymYvdWfdzQsVPCSXkKhK2qpT+ORIPAPWGdXmZ6Rr1wAGwqY -+x0iVSL2IFs5MqDvBbDoyfnt14UVffJlI6O0C+flIY+kSCp86pYQrHHaCnWrnALU -L8Cb/DJ7DODpd99bDHtkuMHUn4BO4WmoI69zABEBAAG0JXNjYWxhLWV4ZXJjaXNl -cyA8ZGV2ZWxvcGVyQDQ3ZGVnLmNvbT6JARwEEwECAAYFAlgGJjoACgkQT9ktcdDT -ZI66CQgAkGDi0EOapqJbFMiNTH85IelGs2c04aNPnEGZh+dUHqpJvA785PduXtzT -XEP8DVP4zgjfGoDyiaJWBVXyg6Ch7XZ6gNodgOS7oQu5nFsA6ZBtwVy0qfRjfK2E -NEIvRuNjQuAlDTDHRfDtZmFIDSd4YR/smJL7BVrO5eT+qsbeluZGGi54TY/zwLbe -TefcUmTixDhm5LGyVPKiEdZwk6o385+9IAFycFozb9K/1NSTBM1GbZBMR/WuACbT -K+DDtqUnGk1cZmNbWzoVabNnubVhGnhMC9AW24pzHu+xEk13yXsPWVikB6NbVg50 -TBkuFf9IEXMEzanKMDDMOatih3a8bg== -=fR5S ------END PGP PUBLIC KEY BLOCK----- diff --git a/secring.gpg.enc b/secring.gpg.enc deleted file mode 100644 index 2f82f161..00000000 Binary files a/secring.gpg.enc and /dev/null differ diff --git a/src/test/scala/scalatutorial/sections/ClassesVsCaseClassesSpec.scala b/src/test/scala/scalatutorial/sections/ClassesVsCaseClassesSpec.scala index 0fa35d77..755a5f1d 100644 --- a/src/test/scala/scalatutorial/sections/ClassesVsCaseClassesSpec.scala +++ b/src/test/scala/scalatutorial/sections/ClassesVsCaseClassesSpec.scala @@ -24,6 +24,8 @@ class ClassesVsCaseClassesSpec extends RefSpec with Checkers { check( Test.testSuccess( ClassesVsCaseClasses.encoding _, - "Note(C,Quarter,3)" :: false :: "Note(C,Quarter,4)" :: HNil)) + "Note(C,Quarter,3)" :: false :: "Note(C,Quarter,4)" :: HNil + ) + ) } diff --git a/src/test/scala/scalatutorial/sections/StandardLibrarySpec.scala b/src/test/scala/scalatutorial/sections/StandardLibrarySpec.scala index 67df8e6c..286f9e7f 100644 --- a/src/test/scala/scalatutorial/sections/StandardLibrarySpec.scala +++ b/src/test/scala/scalatutorial/sections/StandardLibrarySpec.scala @@ -18,7 +18,9 @@ class StandardLibrarySpec extends RefSpec with Checkers { check( Test.testSuccess( StandardLibrary.insertionSort _, - ((_: Int) < (_: Int)) :: List.empty[Int] :: HNil)) + ((_: Int) < (_: Int)) :: List.empty[Int] :: HNil + ) + ) def `check either`(): Unit = check( @@ -26,6 +28,9 @@ class StandardLibrarySpec extends RefSpec with Checkers { StandardLibrary.either _, (Right[String, Int](3): Either[String, Int]) :: (Left[String, Int]("not a number"): Either[ String, - Int]) :: HNil)) + Int + ]) :: HNil + ) + ) } diff --git a/src/test/scala/scalatutorial/sections/SyntacticConveniencesSpec.scala b/src/test/scala/scalatutorial/sections/SyntacticConveniencesSpec.scala index fb1110d5..4fe2d1e9 100644 --- a/src/test/scala/scalatutorial/sections/SyntacticConveniencesSpec.scala +++ b/src/test/scala/scalatutorial/sections/SyntacticConveniencesSpec.scala @@ -18,7 +18,9 @@ class SyntacticConveniencesSpec extends RefSpec with Checkers { check( Test.testSuccess( SyntacticConveniences.stringInterpolation _, - "Hello, Functional Programming!" :: HNil)) + "Hello, Functional Programming!" :: HNil + ) + ) def `check string interpolation2`(): Unit = check(Test.testSuccess(SyntacticConveniences.stringInterpolation2 _, "Hello, SCALA!" :: HNil)) @@ -42,6 +44,8 @@ class SyntacticConveniencesSpec extends RefSpec with Checkers { check( Test.testSuccess( SyntacticConveniences.typeAlias _, - (Right((2, 0)): Either[String, (Int, Int)]) :: HNil)) + (Right((2, 0)): Either[String, (Int, Int)]) :: HNil + ) + ) } diff --git a/version.sbt b/version.sbt deleted file mode 100644 index 3f478e0c..00000000 --- a/version.sbt +++ /dev/null @@ -1 +0,0 @@ -version in ThisBuild := "0.6.0-SNAPSHOT"