Integrate feedback from workshop session (#102)

* Duplicate all exercises for refactoring/rearrangement

* Revert exercise on toplevel definitions to no-indentation based syntax

* When switching to parameter untupling use parens instead of curly braces

* Revert to curly braces syntax

* Format code with scalafmt

* Format code using scalafmt

* Format all exercises with scalafmt

* Add a note about scalafmt configuration in the exercise instructions

* Add illustrations about markdown config & add instructions

* Add notes about code formatting & markdown previewing to instructions

* Rename exercise

* Add an exercise on indentation based syntax

* Add links in the exercise instruction to Scala documentation

- Links to:
  - Scala 3 Language Reference
  - Scala API docs
  - Scala 3 Book

* Add checking of formatting code to CI

* Remove comment that is no longer applicable

* Update readme/remove unused variable

* Update exercises/exercise_000_sudoku_solver_initial_state/README.md

Co-authored-by: gianick <[email protected]>

* Change variable name to Camel Case

* Bump scalafmt version & reformat all code

- Bump scalafmt version & scalafmt sbt plugin version
- Run scalafmt on all exercises

* Change variable name in build definition

* Change formatting of coonfiguration file

* Moved import around

* Update exercise instructions for the syntax rewrite exercise

* Remove alternative exercise series that uses Curly Braces syntax

* Add IDE set-up instructions

* Update exercises/exercise_000_sudoku_solver_initial_state/IDE_setup.md

Co-authored-by: gianick <[email protected]>

* Review comment updates

* Update Scala version to nightly build

- Scala 3.3.1-RC1 nightly build has fix for rewrite to curly
  braces syntax. This fix may still make it in 3.3.0

---------

Co-authored-by: gianick <[email protected]>

Author: eloots

.github/workflows/ci.yml

@@ -52,9 +52,14 @@ jobs:
         cache: 'sbt'
         distribution: 'temurin'
 
+    - name: Check code formatting
+      run: sbt scalafmtCheckAll
+      working-directory: ${{env.EXERCISES_DIRECTORY}}/${{matrix.exercise}}
+
     - name: Test with sbt
       run: sbt test
       working-directory: ${{env.EXERCISES_DIRECTORY}}/${{matrix.exercise}}
+
   validate_course_summary:
     if: ${{ always() }}
     runs-on: ubuntu-latest

.gitignore

@@ -48,7 +48,8 @@ project/plugins/project/
 *.sublime-workspace
 
 # OS specific
-.DS_Store
+**/.DS_Store
+**/__MACOSX
 
 # Other
 Preci*.pdf

exercises/exercise_000_sudoku_solver_initial_state/.scalafmt.conf

@@ -0,0 +1,51 @@
+version         = 3.7.2
+runner.dialect  = scala213
+
+style                               = defaultWithAlign
+indentOperator.preset               = akka
+maxColumn                           = 120
+rewrite.rules                       = [RedundantParens, AvoidInfix]
+align.tokens                        = [{code = "=>", owner = "Case"}]
+align.openParenDefnSite             = false
+align.openParenCallSite             = false
+optIn.breakChainOnFirstMethodDot    = false
+optIn.configStyleArguments          = false
+danglingParentheses.defnSite        = false
+danglingParentheses.callSite        = false
+rewrite.neverInfix.excludeFilters   = [
+  and
+  min
+  max
+  until
+  to
+  by
+  eq
+  ne
+  "should.*"
+  "contain.*"
+  "must.*"
+  in
+  ignore
+  be
+  taggedAs
+  thrownBy
+  synchronized
+  have
+  when
+  size
+  only
+  noneOf
+  oneElementOf
+  noElementsOf
+  atLeastOneElementOf
+  atMostOneElementOf
+  allElementsOf
+  inOrderElementsOf
+  theSameElementsAs
+  message
+]
+rewriteTokens = {
+  "⇒": "=>"
+  "→": "->"
+  "←": "<-"
+}

exercises/exercise_000_sudoku_solver_initial_state/IDE_setup.md

@@ -0,0 +1,19 @@
+# Setting up IntelliJ Idea or Visual Code Studio for Scala development
+
+## Setting up IntelliJ Idea for Scala development
+
+- If you haven't already installed the IntelliJ Idea, follow the [Getting started](https://www.jetbrains.com/help/idea/installation-guide.html) instructions on the JetBrains website. The Community Edition should be sufficient for this workshop.
+
+- After installing the IDE, install the Scala plugin for IntelliJ Idea by following [these instructions](https://www.jetbrains.com/help/idea/discover-intellij-idea-for-scala.html#scala_plugin).
+
+## Setting up Visual Code Studio for Scala development
+
+- Download the installation binary for your system (Windows, Mac, Linux) [here](https://code.visualstudio.com/download).
+
+- Follow the set-up instructions [here](https://code.visualstudio.com/docs/setup/setup-overview).
+
+- Install the Metals (a Scala language server with rich IDE features) plugin for Visual Code Studio by following the instructions [here](https://scalameta.org/metals/docs/editors/vscode/)
+
+## Other Scala source editors
+
+There are plenty of other options for Source Code editing. For example, Metals supports Vim, Sublime Text and Emacs. For more information, have a look at the [Text Editors section](https://scalameta.org/metals/docs) in the Metals Documentation

exercises/exercise_000_sudoku_solver_initial_state/README.md

@@ -1,5 +1,17 @@
 # Initial State
 
+## Documentation
+
+You may want to have look at the [Scala Language website](https://www3.scala-lang.org)
+and bookmark it in your favourite browser.
+
+It has a number of links among which:
+
+- The [Scala 3 Language Reference](https://docs3.scala-lang.org/scala3/reference).
+- The [Scala API documentation](https://docs3.scala-lang.org/api/all.html) for every version of Scala.
+- The [Scala 3 Book](https://docs3.scala-lang.org/scala3/book/introduction.html) which
+  gives you a concise introduction to all things Scala 3.
+
 ## An Akka Typed/Scala based Sudoku Solver
 
 ## Background
@@ -123,3 +135,30 @@ Hit RETURN to stop solver
 - You can control the rate at which the Sudoku problem generator sends
   problems by tweaking the setting `sudoku-solver.problem-sender.send-interval`
   in the `sudokusolver.conf` configuration file.
+
+## Source code formatting & Markdown viewer in IntelliJ
+
+
+### Source code formatting
+
+[scalafmt](https://github.com/scalameta/scalafmt) based source code formatting is
+in place in this project. scalafmt supports both Scala 2 and Scala 3. You can
+[re]format the code by running `scalafmtAll` from the sbt prompt. As we switch from
+Scala 2 to Scala 3, you need to make sure that a matching scalafmt configuration is
+in place. In any of the exercises, you can run `cmtc pull-template .scalafmt.conf`
+to "pull-in" the correct configuration file.
+
+### Markdown viewer in IntelliJ IDEA
+
+The font size can be a bit too small for the taste of some people. You can change the
+Markdown zoom setting in IntelliJ by pasting the following CSS snippet in the
+markdown setting in _" Settings" -> "Languages & Frameworks" -> "Custom CSS -> CSS rules"_ and adjust the font-size setting to your liking:
+
+```
+body {
+  font-size: 120% !important;
+}
+```
+
+![IntelliJ Markdown viewer settings](images/Markdown-viewer-IntelliJ.png)
+

exercises/exercise_000_sudoku_solver_initial_state/images/Markdown-viewer-IntelliJ.png

@@ -14,7 +14,7 @@ object CompileOptions {
   )
 }
 
-object Version {
+object Versions {
   lazy val akkaVer           = "2.6.20"
   lazy val logbackVer        = "1.2.3"
   lazy val mUnitVer          = "0.7.26"
@@ -26,18 +26,18 @@ object Dependencies {
     "com.typesafe.akka"             %% "akka-actor-typed",
     "com.typesafe.akka"             %% "akka-slf4j",
     "com.typesafe.akka"             %% "akka-stream",
-  ).map (_ % Version.akkaVer)
+  ).map (_ % Versions.akkaVer)
 
   private lazy val akkaTestkitDeps = Seq(
-    "com.typesafe.akka"             %% "akka-actor-testkit-typed" % Version.akkaVer % Test
+    "com.typesafe.akka"             %% "akka-actor-testkit-typed" % Versions.akkaVer % Test
   )
 
   private lazy val logbackDeps = Seq (
     "ch.qos.logback"                 %  "logback-classic",
-  ).map (_ % Version.logbackVer)
+  ).map (_ % Versions.logbackVer)
 
   private lazy val munitDeps = Seq(
-    "org.scalameta" %% "munit" % Version.mUnitVer % Test
+    "org.scalameta" %% "munit" % Versions.mUnitVer % Test
   )
 
   lazy val dependencies: Seq[ModuleID] =

exercises/exercise_000_sudoku_solver_initial_state/project/Build.scala

@@ -0,0 +1,4 @@
+addSbtPlugin("com.eed3si9n" % "sbt-buildinfo" % "0.11.0")
+addSbtPlugin("org.scalameta" % "sbt-mdoc" % "2.3.7")
+addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.5.0")
+addSbtPlugin("org.scalameta" % "sbt-native-image" % "0.3.1")

exercises/exercise_000_sudoku_solver_initial_state/project/plugins.sbt

@@ -1,19 +1,16 @@
 akka {
-
   log-dead-letters = on
   logger-startup-timeout = 30s
 
   actor {
     provider = local
-
     debug {
       lifecycle = on
       unhandled = on
     }
   }
 
   remote {
-
     artery {
       canonical {
         hostname = "127.0.0.1"

exercises/exercise_000_sudoku_solver_initial_state/src/main/resources/application.conf

@@ -1,32 +1,27 @@
-/**
-  * Copyright © 2020-2023 Lunatech Labs.
+/** Copyright © 2020-2023 Lunatech Labs.
   *
-  * 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
+  * 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.
+  * 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.
   *
-  * NO COMMERCIAL SUPPORT OR ANY OTHER FORM OF SUPPORT IS OFFERED ON
-  * THIS SOFTWARE BY Lunatech Labs.
+  * NO COMMERCIAL SUPPORT OR ANY OTHER FORM OF SUPPORT IS OFFERED ON THIS SOFTWARE BY Lunatech Labs.
   *
-  * See the License for the specific language governing permissions and
-  * limitations under the License.
+  * See the License for the specific language governing permissions and limitations under the License.
   */
 
 package org.lunatechlabs.dotty
 
 import akka.NotUsed
 import akka.actor.typed.scaladsl.adapter.TypedActorSystemOps
-import akka.actor.typed.scaladsl.{ Behaviors, Routers }
-import akka.actor.typed.{ ActorSystem, Behavior, Terminated }
-import org.lunatechlabs.dotty.sudoku.{ SudokuProblemSender, SudokuSolver, SudokuSolverSettings }
+import akka.actor.typed.scaladsl.{Behaviors, Routers}
+import akka.actor.typed.{ActorSystem, Behavior, Terminated}
+import org.lunatechlabs.dotty.sudoku.{SudokuProblemSender, SudokuSolver, SudokuSolverSettings}
 
-import scala.Console.{ GREEN, RESET }
+import scala.Console.{GREEN, RESET}
 import scala.io.StdIn
 
 object Main {
@@ -36,13 +31,10 @@ object Main {
       // Start a SudokuSolver
       val sudokuSolver = context.spawn(SudokuSolver(sudokuSolverSettings), s"sudoku-solver")
       // Start a Sudoku problem sender
-      context.spawn(SudokuProblemSender(sudokuSolver, sudokuSolverSettings),
-                    "sudoku-problem-sender"
-      )
+      context.spawn(SudokuProblemSender(sudokuSolver, sudokuSolverSettings), "sudoku-problem-sender")
 
-      Behaviors.receiveSignal {
-        case (_, Terminated(_)) =>
-          Behaviors.stopped
+      Behaviors.receiveSignal { case (_, Terminated(_)) =>
+        Behaviors.stopped
       }
     }
 }

exercises/exercise_000_sudoku_solver_initial_state/src/main/scala/org/lunatechlabs/dotty/SudokuSolverMain.scala

@@ -4,44 +4,39 @@ object ReductionRules {
 
   def reductionRuleOne(reductionSet: ReductionSet): ReductionSet = {
     val inputCellsGrouped = reductionSet.filter(_.size <= 7).groupBy(identity)
-    val completeInputCellGroups = inputCellsGrouped.filter {
-      case (set, setOccurrences) => set.size == setOccurrences.length
+    val completeInputCellGroups = inputCellsGrouped.filter { case (set, setOccurrences) =>
+      set.size == setOccurrences.length
     }
     val completeAndIsolatedValueSets = completeInputCellGroups.keys.toList
-    completeAndIsolatedValueSets.foldLeft(reductionSet) {
-      case (cells, caivSet) =>
-        cells.map { cell =>
-          if (cell != caivSet) cell &~ caivSet else cell
-        }
+    completeAndIsolatedValueSets.foldLeft(reductionSet) { case (cells, caivSet) =>
+      cells.map { cell =>
+        if (cell != caivSet) cell &~ caivSet else cell
+      }
     }
   }
 
   def reductionRuleTwo(reductionSet: ReductionSet): ReductionSet = {
-    val valueOccurrences = CELLPossibleValues.map { value =>
-      cellIndexesVector.zip(reductionSet).foldLeft(Vector.empty[Int]) {
-        case (acc, (index, cell)) =>
-          if (cell contains value) index +: acc else acc
+    val valueOccurrences = CellPossibleValues.map { value =>
+      cellIndexesVector.zip(reductionSet).foldLeft(Vector.empty[Int]) { case (acc, (index, cell)) =>
+        if (cell contains value) index +: acc else acc
       }
     }
 
     val cellIndexesToValues =
-      CELLPossibleValues
-        .zip(valueOccurrences)
-        .groupBy { case (value, occurrence) => occurrence }
-        .filter { case (loc, occ) => loc.length == occ.length && loc.length <= 6 }
+      CellPossibleValues.zip(valueOccurrences).groupBy { case (value, occurrence) => occurrence }.filter {
+        case (loc, occ) => loc.length == occ.length && loc.length <= 6
+      }
 
-    val cellIndexListToReducedValue = cellIndexesToValues.map {
-      case (index, seq) => (index, (seq.map { case (value, _) => value }).toSet)
+    val cellIndexListToReducedValue = cellIndexesToValues.map { case (index, seq) =>
+      (index, seq.map { case (value, _) => value }.toSet)
     }
 
-    val cellIndexToReducedValue = cellIndexListToReducedValue.flatMap {
-      case (cellIndexList, reducedValue) =>
-        cellIndexList.map(cellIndex => cellIndex -> reducedValue)
+    val cellIndexToReducedValue = cellIndexListToReducedValue.flatMap { case (cellIndexList, reducedValue) =>
+      cellIndexList.map(cellIndex => cellIndex -> reducedValue)
     }
 
-    reductionSet.zipWithIndex.foldRight(Vector.empty[CellContent]) {
-      case ((cellValue, cellIndex), acc) =>
-        cellIndexToReducedValue.getOrElse(cellIndex, cellValue) +: acc
+    reductionSet.zipWithIndex.foldRight(Vector.empty[CellContent]) { case ((cellValue, cellIndex), acc) =>
+      cellIndexToReducedValue.getOrElse(cellIndex, cellValue) +: acc
     }
   }
 }