Merge pull request #114 from haskell-jp/grammar

英文の改善

Author: igrep

src/Education/MakeMistakesToLearnHaskell/Exercise/Core.hs

@@ -125,7 +125,7 @@ isInWords wd = any (Text.isInfixOf wd)
 
 detailsForgetToWriteDo :: Text -> Details
 detailsForgetToWriteDo funcNames =
-  "HINT: You seem to forget to write `do`. `do` must be put before listing " <> funcNames <> "."
+  "HINT: You seem to have forgotten to write `do`. `do` must be put before listing " <> funcNames <> "."
 
 detailsDoConsistentWidth :: Details
 detailsDoConsistentWidth = "HINT: instructions in a `do` must be in a consistent width."

src/Education/MakeMistakesToLearnHaskell/Exercise/Ex01.hs

@@ -17,12 +17,12 @@ diag1 :: Diagnosis
 diag1 code msg
   | "parse error on input" `Text.isInfixOf` msg
       && "'" `Text.isInfixOf` code =
-        "HINT: In Haskell, you must surround string literals with double-quote '\"'. Such as \"Hello, world\"."
+        "HINT: In Haskell, you must surround string literals with double-quotes '\"', like \"Hello, world\"."
   | ("parse error" `Text.isInfixOf` msg || "Parse error" `Text.isInfixOf` msg)
       && "top-level declaration expected." `Text.isInfixOf` msg =
-        "HINT: This error indicates you haven't defined main function."
+        "HINT: This error indicates that you haven't defined the main function."
   | "Variable not in scope: main :: IO" `Text.isInfixOf` msg =
-    "HINT: This error indicates you haven't defined main function."
+    "HINT: This error indicates that you haven't defined the main function."
   | "Variable not in scope:" `Text.isInfixOf` msg =
     "HINT: you might have misspelled 'putStrLn'."
   | otherwise = ""

src/Education/MakeMistakesToLearnHaskell/Exercise/Ex02.hs

@@ -17,21 +17,21 @@ diag2 code msg
   | "parse error" `Text.isInfixOf` msg || "Parse error" `Text.isInfixOf` msg =
     if "top-level declaration expected." `Text.isInfixOf` msg
       then
-        "HINT: This error indicates you haven't defined main function."
+        "HINT: This error indicates that you haven't defined the main function."
       else
         -- TODO: Use regex or ghc tokenizer
         case compare (Text.count "(" code) (Text.count ")" code) of
-            GT -> "HINT: you might have forgot to write close parenthesis"
-            LT -> "HINT: you might have forgot to write open parenthesis"
+            GT -> "HINT: you might have forgotten to write a close parenthesis"
+            LT -> "HINT: you might have forgotten to write an open parenthesis"
             EQ -> ""
   | "No instance for (Fractional (IO ()))" `Text.isInfixOf` msg || "No instance for (Num (IO ()))" `Text.isInfixOf` msg =
-    "HINT: you might have forgot to write parentheses"
+    "HINT: you might have forgotten to write parentheses"
   | "No instance for (Show (a0 -> a0))" `Text.isInfixOf` msg =
-    "HINT: you might have forgot to write some numbers between operators ('*', '/' etc.)."
+    "HINT: you might have forgotten to write some numbers between operators ('*', '/' etc.)."
   | "No instance for (Num (t0 -> a0))" `Text.isInfixOf` msg =
-    "HINT: you might have forgot to write multiplication operator '*'"
+    "HINT: you might have forgotten to write the multiplication operator '*'"
   | "No instance for (Fractional (t0 -> a0))" `Text.isInfixOf` msg =
-    "HINT: you might have forgot to write division operator '/'"
+    "HINT: you might have forgotten to write the division operator '/'"
   | "Variable not in scope: main :: IO" `Text.isInfixOf` msg =
-    "HINT: This error indicates you haven't defined main function."
+    "HINT: This error indicates that you haven't defined the main function."
   | otherwise = ""

src/Education/MakeMistakesToLearnHaskell/Exercise/Ex03.hs

@@ -25,12 +25,12 @@ diag3 code msg
   | code `isInconsistentlyIndentedAfter` "do" = detailsDoConsistentWidth
   | "parse error on input" `Text.isInfixOf` msg
       && "'" `Text.isInfixOf` code =
-        "HINT: In Haskell, you must surround string literals with double-quote '\"'. Such as \"Hello, world\"."
+        "HINT: In Haskell, you must surround string literals with double-quotes '\"', like \"Hello, world\"."
   | ("parse error" `Text.isInfixOf` msg || "Parse error" `Text.isInfixOf` msg)
       && "top-level declaration expected." `Text.isInfixOf` msg =
-        "HINT: This error indicates you haven't defined main function."
+        "HINT: This error indicates that you haven't defined the main function."
   | "Variable not in scope: main :: IO" `Text.isInfixOf` msg =
-    "HINT: This error indicates you haven't defined main function."
+    "HINT: This error indicates that you haven't defined the main function."
   | "Variable not in scope:" `Text.isInfixOf` msg =
     "HINT: you might have misspelled 'putStrLn'."
   | "Couldn't match expected type ‘(String -> IO ())" `Text.isInfixOf` msg =

src/Education/MakeMistakesToLearnHaskell/Exercise/Ex04.hs

@@ -35,7 +35,7 @@ diag4 code msg
       "HINT: Don't assign the result of `getContents` with `=`. Use `<-` instead."
   | "Couldn't match type ‘IO String’ with ‘[Char]’" `Text.isInfixOf` msg
     && "In the first argument of ‘lines’" `Text.isInfixOf` msg =
-      "HINT: Unfortunately, you have to assign the result of `getContents` with `<-` operator."
+      "HINT: You have to assign the result of `getContents` with `<-` operator."
   | otherwise =
     let mtoks = GHC.tokenizeHaskell (Text.toStrict code)
         tokPutStr = (GHC.VariableTok, "putStr")

test/Education/MakeMistakesToLearnHaskell/Exercise1Spec.hs

@@ -24,11 +24,11 @@ spec = do
   itShouldFailForCaseWithMessage
     "1"
     "single-quote"
-    ["HINT: In Haskell, you must surround string literals with double-quote '\"'. Such as \"Hello, world\"."]
+    ["HINT: In Haskell, you must surround string literals with double-quotes '\"', like \"Hello, world\"."]
 
   itShouldFailForCaseWithMessage
     "1"
     "no-main"
-    ["HINT: This error indicates you haven't defined main function."]
+    ["HINT: This error indicates that you haven't defined the main function."]
 
   itShouldFailForCaseWithMessage "1" "typo" []

test/Education/MakeMistakesToLearnHaskell/Exercise2Spec.hs

@@ -32,47 +32,47 @@ spec = do
   itShouldFailForCaseWithMessage
     "2"
     "no-number-1"
-    ["HINT: you might have forgot to write some numbers between operators ('*', '/' etc.)."]
+    ["HINT: you might have forgotten to write some numbers between operators ('*', '/' etc.)."]
 
   itShouldFailForCaseWithMessage
     "2"
     "no-number-2"
-    ["HINT: you might have forgot to write some numbers between operators ('*', '/' etc.)."]
+    ["HINT: you might have forgotten to write some numbers between operators ('*', '/' etc.)."]
 
   itShouldFailForCaseWithMessage
     "2"
     "no-number-3"
-    ["HINT: you might have forgot to write some numbers between operators ('*', '/' etc.)."]
+    ["HINT: you might have forgotten to write some numbers between operators ('*', '/' etc.)."]
 
   itShouldFailForCaseWithMessage
     "2"
     "no-paren"
-    ["HINT: you might have forgot to write parentheses"]
+    ["HINT: you might have forgotten to write parentheses"]
 
   itShouldFailForCaseWithMessage
     "2"
     "no-close-paren"
-    ["HINT: you might have forgot to write close parenthesis"]
+    ["HINT: you might have forgotten to write a close parenthesis"]
 
   itShouldFailForCaseWithMessage
     "2"
     "no-main"
-    ["HINT: This error indicates you haven't defined main function."]
+    ["HINT: This error indicates that you haven't defined the main function."]
 
   itShouldFailForCaseWithMessage
     "2"
     "no-open-paren"
-    ["HINT: you might have forgot to write open parenthesis"]
+    ["HINT: you might have forgotten to write an open parenthesis"]
 
   itShouldFailForCaseWithMessage
     "2"
     "no-slash"
-    ["HINT: you might have forgot to write division operator '/'"]
+    ["HINT: you might have forgotten to write the division operator '/'"]
 
   itShouldFailForCaseWithMessage
     "2"
     "no-star"
-    ["HINT: you might have forgot to write multiplication operator '*'"]
+    ["HINT: you might have forgotten to write the multiplication operator '*'"]
 
   itShouldFailForCaseWithMessage "2" "typo" []
 

test/Education/MakeMistakesToLearnHaskell/Exercise3Spec.hs

@@ -32,7 +32,7 @@ spec = do
   itShouldFailForCaseWithMessage
     "3"
     "no-main"
-    ["HINT: This error indicates you haven't defined main function."]
+    ["HINT: This error indicates that you haven't defined the main function."]
 
   itShouldFailForCaseWithMessage
     "3"
@@ -47,12 +47,12 @@ spec = do
   itShouldFailForCaseWithMessage
     "3"
     "no-do"
-    ["HINT: You seem to forget to write `do`. `do` must be put before listing `putStrLn`s."]
+    ["HINT: You seem to have forgotten to write `do`. `do` must be put before listing `putStrLn`s."]
 
   itShouldFailForCaseWithMessage
     "3"
     "single-quote"
-    ["HINT: In Haskell, you must surround string literals with double-quote '\"'. Such as \"Hello, world\"."]
+    ["HINT: In Haskell, you must surround string literals with double-quotes '\"', like \"Hello, world\"."]
 
   itShouldFailForCaseWithMessage "3" "typo" []
 

test/Education/MakeMistakesToLearnHaskell/Exercise4Spec.hs

@@ -28,7 +28,7 @@ spec = do
   itShouldFailForCaseWithMessage
     "4"
     "no-do"
-    ["HINT: You seem to forget to write `do`. `do` must be put before listing `putStr`s and `getContents`."]
+    ["HINT: You seem to have forgotten to write `do`. `do` must be put before listing `putStr`s and `getContents`."]
 
   let useLeftThinArrow = "HINT: Don't assign the result of `getContents` with `=`. Use `<-` instead."
   -- ^ TODO: Collect common error messages
@@ -61,7 +61,7 @@ spec = do
   itShouldFailForCaseWithMessage
     "4"
     "no-arrow"
-    ["HINT: Unfortunately, you have to assign the result of `getContents` with `<-` operator."]
+    ["HINT: You have to assign the result of `getContents` with `<-` operator."]
 
   itShouldFailForCaseWithMessage
     "4"

test/Education/MakeMistakesToLearnHaskell/SpecHelper.hs

@@ -7,7 +7,6 @@ module Education.MakeMistakesToLearnHaskell.SpecHelper where
 import qualified Education.MakeMistakesToLearnHaskell.Exercise as Exercise
 import           Education.MakeMistakesToLearnHaskell.SpecEnv (setRunHaskellFailureWithOutput, mkDefaultSpecEnv)
 
-
 shouldFail :: Exercise.Result -> IO Exercise.Details
 shouldFail (Exercise.Fail d) = return d
 shouldFail other = fail $ "Unexpected exercise result: " ++ show other
@@ -29,4 +28,4 @@ itShouldFailForCaseWithMessage ename tcid messages = do
     let e = setRunHaskellFailureWithOutput baseEnv err
     d <- shouldFail =<< Exercise.verify subject e ("test/assets/" ++ ename ++ "/" ++ tcid ++ ".hs")
 
-    for_ messages $ \message -> d `shouldSatisfy` Text.isInfixOf message
+    for_ messages $ \message -> (Text.unpack d `shouldContain` Text.unpack message)

test/Education/MakeMistakesToLearnHaskellSpec.hs

@@ -7,7 +7,6 @@ module Education.MakeMistakesToLearnHaskellSpec (main, spec) where
 import qualified Education.MakeMistakesToLearnHaskell
 import           Education.MakeMistakesToLearnHaskell.Env
 
-
 -- `main` is here so that this module can be run from GHCi on its own.  It is
 -- not needed for automatic spec discovery.
 main :: IO ()
@@ -25,7 +24,7 @@ spec =
     it "given an empty answer, show FAIL" $ do
       void $ runMmlh ["show", "--terminal", "1"]
       runMmlh ["verify", "test/assets/common/empty.hs"]
-        >>= shouldExitWithHints ["HINT: This error indicates you haven't defined main function."]
+        >>= shouldExitWithHints ["HINT: This error indicates that you haven't defined the main function."]
 
     it "given non-existing answer of exercise 2.5, show NOT VERIFIED" $ do
       void $ runMmlh ["show", "--terminal", "2.5"]
@@ -44,7 +43,7 @@ spec =
 
     it "given a not-compilable answer of exercise 4, show FAIL" $ do
       let msgs =
-            ["HINT: You seem to forget to write `do`. `do` must be put before listing `putStr`s and `getContents`."]
+            ["HINT: You seem to have forgotten to write `do`. `do` must be put before listing `putStr`s and `getContents`."]
       void $ runMmlh ["show", "--terminal", "4"]
       runMmlh ["verify", "test/assets/4/no-do.hs"]
         >>= shouldExitWithHints msgs
@@ -58,30 +57,30 @@ runMmlh args = do
     $ withEnv env
     $ captureProcessResult Education.MakeMistakesToLearnHaskell.main
 
-
-includes :: ByteString'.ByteString -> ByteString'.ByteString -> Bool
-includes = ByteString'.isInfixOf
-
+shouldContainBS :: ByteString'.ByteString -> ByteString'.ByteString -> Expectation
+shouldContainBS a b = if ByteString'.isInfixOf b a
+  then pure ()
+  else expectationFailure $ unwords [show a, "does not contain", show b]
 
 shouldExitWithHints :: [ByteString'.ByteString] -> ProcessResult -> IO ()
 shouldExitWithHints hintMsgs (ProcessResult out err code ex) = do
   fmap show ex `shouldBe` Nothing
-  err `shouldSatisfy` ByteString'.null
-  mapM_ ((out `shouldSatisfy`) . includes) hintMsgs
+  err `shouldBe` ByteString'.empty
+  mapM_ (out `shouldContainBS`) hintMsgs
   code `shouldBe` ExitFailure 1
 
 
 shouldVerifySuccess :: ProcessResult -> IO ()
 shouldVerifySuccess (ProcessResult out err code ex) = do
   fmap show ex `shouldBe` Nothing
-  err `shouldSatisfy` ByteString'.null
-  out `shouldSatisfy` includes "SUCCESS"
+  err `shouldBe` ByteString'.empty
+  out `shouldContainBS` "SUCCESS"
   code `shouldBe` ExitSuccess
 
 
 shouldPrintNotVerified :: ProcessResult -> IO ()
 shouldPrintNotVerified (ProcessResult out err code ex) = do
   fmap show ex `shouldBe` Nothing
-  err `shouldSatisfy` ByteString'.null
-  out `shouldSatisfy` includes "NOT VERIFIED"
+  err `shouldBe` ByteString'.empty
+  out `shouldContainBS` "NOT VERIFIED"
   code `shouldBe` ExitSuccess