some editing, update profiling, use Hspec

Author: m4lvin

.gitignore

@@ -26,3 +26,4 @@ cabal-dev
 cabal.sandbox.config
 dist
 dist-*
+report.cabal

Howto.tex

@@ -1,15 +1,9 @@
 
 \section{How to use this?}
 
-To generate the PDF, open the report.tex in your favorite LaTeX editor and
-hit compile, or manually do this:
-
-\begin{verbatim}
-  pdflatex report
-  bibtex report
-  pdflatex report
-  pdflatex report
-\end{verbatim}
+To generate the PDF, open \texttt{report.tex} in your favorite \LaTeX editor and compile.
+Alternatively, you can manually do
+\texttt{pdflatex report; bibtex report; pdflatex report; pdflatex report} in a terminal.
 
 You should have stack installed (see \url{https://haskellstack.org/}) and
 open a terminal in the same folder.

Profiling.tex

@@ -1,19 +1,17 @@
 
-\section{Profiling}
-\label{sec:Profiling}
+\section{Optional: Profiling}\label{sec:Profiling}
 
 The GHC compiler comes with a profiling system to keep track of which
-functions Are executed how often and how much time and memory they take.
+functions are executed how often and how much time and memory they take.
 To activate this RTS, we compile and execute our program as follows:
 
 \begin{verbatim}
 stack clean
-stack build --executable-profiling --library-profiling \
-  --ghc-options="-fprof-auto -rtsopts"
-stack exec -- myprogram +RTS -p -h
+stack build --profile
+stack exec --profile myprogram -- +RTS -p
 \end{verbatim}
 
-The results are saved in the file \texttt{myprogram.prof} which looks like this.
+Results are saved in the file \texttt{myprogram.prof} which looks as follows.
 Note for example, that funnyfunction was called on 14 entries.
 
 \begin{small}
@@ -32,7 +30,3 @@ \section{Profiling}
 
 For many more RTS options, see the GHC documentation online at
 \url{https://downloads.haskell.org/~ghc/latest/docs/html/users_guide/profiling.html}.
-
-To speed up our program, especially in GHCi, we can also add the
-parameter \texttt{-fobject-code} to the \texttt{ghc-options} field
-in the \texttt{.cabal} file.

report.pdf

@@ -1 +1 @@
-resolver: lts-18.18
+resolver: lts-18.21

stack.yaml

@@ -10,36 +10,29 @@ module Main where
 
 import Basics
 
-import Text.Printf (printf)
+import Test.Hspec
 import Test.QuickCheck
-import Test.QuickCheck.Test (isSuccess)
-import System.Exit (exitSuccess, exitFailure)
 \end{code}
 
-The tuples in the following list consist of a name for the test and a
-quickCheckResult applied to a property. For example, we check that the output
-of funnyfunction is one of three possibilities. The second test checks that
-reversing twice gives the same string back.
-
-% TODO: add tests using thenumbers, somenumbers, randomnumbers
+The following uses the HSpec library to define different tests.
+Note that the first test is a specific test with fixed inputs.
+The second and third test use QuickCheck.
 
 \begin{code}
-tests :: [(String, IO Result)]
-tests =
-  [ ("funnytest1", quickCheckResult (\n -> funnyfunction n `elem` [42, n*100, (n-1)*100]) )
-  , ("reversetest", quickCheckResult (\str -> myreverse (myreverse str) == (str::String)) )
-  ]
-
 main :: IO ()
-main  = do
-  results <- mapM (\(s,a) -> printf "\n%-20s: " s >> a) tests
-  if all isSuccess results
-    then exitSuccess
-    else exitFailure
+main = hspec $ do
+  describe "Basics" $ do
+    it "somenumbers should be the same as [1..10]" $
+      somenumbers `shouldBe` [1..10]
+    it "funnyfunction: result is within [1..100]" $
+      property (\n -> funnyfunction n `elem` [1..100])
+    it "myreverse: using it twice gives back the same list" $
+      property $ \str -> myreverse (myreverse str) == (str::String)
 \end{code}
 
-To run this, use \verb|stack clean && stack test --coverage|. In particular
-this will generate a nice report using hpc. Look for ``The coverage report
-for ... is available at ... .html'' and open this html file in your browser.
-See \url{https://wiki.haskell.org/Haskell_program_coverage} for more examples
-and information how to read the report.
+To run the tests, use \verb|stack test|.
+
+To also find out which part of your program is actually used for these tests,
+run \verb|stack clean && stack test --coverage|. Then look for ``The coverage
+report for ... is available at ... .html'' and open this file in your browser.
+See also: \url{https://wiki.haskell.org/Haskell_program_coverage}.