Add tests for Language.PureScript.Docs

hdgarrood · hdgarrood · commit c3b8b3642a3e · 2016-01-06T22:02:06.000Z
In particular, tests for documentation for re-exports.
diff --git a/.gitignore b/.gitignore
@@ -16,3 +16,5 @@ tmp/
 .stack-work/
 tests/support/flattened/
 output
+examples/docs/docs/
+core-tests/full-core-docs.md
diff --git a/.travis.yml b/.travis.yml
@@ -57,6 +57,8 @@ install:
   # Snapshot state of the sandbox now, so we don't need to make new one for test install
   - rm -rf ~/cabal-sandboxes/$GHCVER-${STACKAGE:-none}
   - cp -r .cabal-sandbox ~/cabal-sandboxes/$GHCVER-${STACKAGE:-none}
+  # Install bower globally (for psc-docs/psc-publish tests)
+  - npm install -g bower
 script:
   - ./travis/configure.sh
   - cabal build --ghc-options="-Werror"
diff --git a/core-tests/test-everything.sh b/core-tests/test-everything.sh
@@ -18,9 +18,7 @@ if [ "$force_reinstall" = "true" ] && [ -d "bower_components" ]; then
   rm -r bower_components
 fi
 
-npm install bower
-
-node_modules/.bin/bower i \
+bower i \
         purescript-prelude \
         purescript-eff \
         purescript-st \
@@ -75,3 +73,7 @@ fi
 ../dist/build/psc/psc tests/*/*.purs \
                       'bower_components/purescript-*/src/**/*.purs' \
                 --ffi 'bower_components/purescript-*/src/**/*.js'
+
+../dist/build/psc-docs/psc-docs tests/*/*.purs \
+                      'bower_components/purescript-*/src/**/*.purs' \
+                      > full-core-docs.md
diff --git a/examples/docs/bower.json b/examples/docs/bower.json
@@ -0,0 +1,19 @@
+{
+  "name": "docs-test-package",
+  "version": "1.0.0",
+  "moduleType": [
+    "node"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/not-real/not-a-real-repo.git"
+  },
+  "ignore": [
+    "**/.*",
+    "node_modules",
+    "bower_components",
+    "output"
+  ],
+  "dependencies": {
+  }
+}
diff --git a/examples/docs/bower_components/purescript-prelude/src/Prelude.purs b/examples/docs/bower_components/purescript-prelude/src/Prelude.purs
@@ -0,0 +1,8 @@
+module Prelude where
+
+newtype Unit = Unit {}
+
+unit :: Unit
+unit = Unit {}
+
+data Boolean2 = True | False
diff --git a/examples/docs/src/Clash.purs b/examples/docs/src/Clash.purs
@@ -0,0 +1,32 @@
+module Clash (module Clash1) where
+
+import Clash1 as Clash1
+import Clash2 as Clash2
+
+module Clash1 (module Clash1a) where
+
+import Clash1a
+
+module Clash1a where
+
+value :: Int
+value = 0
+
+type Type = Int
+
+class TypeClass a where
+  typeClassMember :: a
+
+module Clash2 (module Clash2a) where
+
+import Clash2a
+
+module Clash2a where
+
+value :: String
+value = "hello"
+
+type Type = String
+
+class TypeClass a b where
+  typeClassMember :: a -> b
diff --git a/examples/docs/src/DuplicateNames.purs b/examples/docs/src/DuplicateNames.purs
@@ -0,0 +1,9 @@
+module DuplicateNames
+  ( module DuplicateNames
+  , module Prelude
+  ) where
+
+import Prelude (Unit)
+
+unit :: Int
+unit = 0
diff --git a/examples/docs/src/Example.purs b/examples/docs/src/Example.purs
@@ -0,0 +1,7 @@
+module Example
+  ( module Prelude
+  , module Example2
+  ) where
+
+import Prelude (Unit())
+import Example2 (one)
diff --git a/examples/docs/src/Example2.purs b/examples/docs/src/Example2.purs
@@ -0,0 +1,7 @@
+module Example2 where
+
+one :: Int
+one = 1
+
+two :: Int
+two = 2
diff --git a/examples/docs/src/MultiVirtual.purs b/examples/docs/src/MultiVirtual.purs
@@ -0,0 +1,27 @@
+module MultiVirtual
+  ( module X )
+  where
+
+import MultiVirtual1 as X
+import MultiVirtual2 as X
+
+
+module MultiVirtual1 where
+
+foo :: Int
+foo = 1
+
+module MultiVirtual2 
+  ( module MultiVirtual2
+  , module MultiVirtual3
+  ) where
+
+import MultiVirtual3
+
+bar :: Int
+bar = 2
+
+module MultiVirtual3 where
+
+baz :: Int
+baz = 3
diff --git a/examples/docs/src/NewOperators.purs b/examples/docs/src/NewOperators.purs
@@ -0,0 +1,12 @@
+module NewOperators
+  ( module NewOperators2 )
+  where
+
+import NewOperators2
+
+module NewOperators2 where
+
+infixl 8 _compose as >>>
+
+_compose :: forall a b c. (b -> c) -> (a -> b) -> (a -> c)
+_compose f g x = f (g x)
diff --git a/examples/docs/src/NotAllCtors.purs b/examples/docs/src/NotAllCtors.purs
@@ -0,0 +1,5 @@
+module NotAllCtors
+  ( module Prelude )
+  where
+
+import Prelude (Boolean2(True))
diff --git a/examples/docs/src/OldOperators.purs b/examples/docs/src/OldOperators.purs
@@ -0,0 +1,10 @@
+
+-- Remove this after 0.9.
+module OldOperators (module OldOperators2) where
+
+import OldOperators2
+
+module OldOperators2 where
+
+(>>) :: forall a. a -> a -> a
+(>>) a b = b
diff --git a/examples/docs/src/ReExportedTypeClass.purs b/examples/docs/src/ReExportedTypeClass.purs
@@ -0,0 +1,5 @@
+module ReExportedTypeClass
+  ( module SomeTypeClass )
+  where
+
+import SomeTypeClass
diff --git a/examples/docs/src/SolitaryTypeClassMember.purs b/examples/docs/src/SolitaryTypeClassMember.purs
@@ -0,0 +1,6 @@
+module SolitaryTypeClassMember
+  ( module SomeTypeClass )
+  where
+
+import SomeTypeClass (member)
+
diff --git a/examples/docs/src/SomeTypeClass.purs b/examples/docs/src/SomeTypeClass.purs
@@ -0,0 +1,5 @@
+
+module SomeTypeClass where
+
+class SomeClass a where
+  member :: a
diff --git a/examples/docs/src/Transitive1.purs b/examples/docs/src/Transitive1.purs
@@ -0,0 +1,5 @@
+module Transitive1
+  ( module Transitive2 )
+  where
+
+import Transitive2
diff --git a/examples/docs/src/Transitive2.purs b/examples/docs/src/Transitive2.purs
@@ -0,0 +1,5 @@
+module Transitive2
+  ( module Transitive3 )
+  where
+
+import Transitive3
diff --git a/examples/docs/src/Transitive3.purs b/examples/docs/src/Transitive3.purs
@@ -0,0 +1,4 @@
+module Transitive3 where
+
+transitive3 :: Int
+transitive3 = 0
diff --git a/examples/docs/src/TypeClassWithoutMembers.purs b/examples/docs/src/TypeClassWithoutMembers.purs
@@ -0,0 +1,11 @@
+module TypeClassWithoutMembers
+  ( module Intermediate )
+  where
+
+import Intermediate
+
+module Intermediate
+  ( module SomeTypeClass )
+  where
+
+import SomeTypeClass (SomeClass)
diff --git a/examples/docs/src/UTF8.purs b/examples/docs/src/UTF8.purs
@@ -0,0 +1,7 @@
+module UTF8 where
+
+import Prelude (Unit, unit)
+
+-- | üÜäÄ 😰
+thing :: Unit
+thing = unit
diff --git a/examples/docs/src/Virtual.purs b/examples/docs/src/Virtual.purs
@@ -0,0 +1,5 @@
+module Virtual
+  ( module VirtualPrelude )
+  where
+
+import Prelude as VirtualPrelude
diff --git a/purescript.cabal b/purescript.cabal
@@ -20,6 +20,9 @@ tested-with: GHC==7.8
 
 extra-source-files: examples/passing/*.purs
                   , examples/failing/*.purs
+                  , examples/docs/bower_components/purescript-prelude/src/*.purs
+                  , examples/docs/bower.json
+                  , examples/docs/src/*.purs
                   , tests/support/setup.js
                   , tests/support/package.json
                   , tests/support/bower.json
@@ -273,6 +276,7 @@ test-suite tests
     main-is: Main.hs
     other-modules: TestsSetup
                    TestPscPublish
+                   TestDocs
     buildable: True
     hs-source-dirs: tests tests/common
 
diff --git a/tests/Main.hs b/tests/Main.hs
@@ -30,6 +30,7 @@
 --   -- @shouldFailWith TypesDoNotUnify
 --   -- @shouldFailWith TypesDoNotUnify
 --   -- @shouldFailWith TransitiveExportError
+--
 
 module Main (main) where
 
@@ -39,6 +40,7 @@ import Prelude.Compat
 import qualified Language.PureScript as P
 import qualified Language.PureScript.CodeGen.JS as J
 import qualified Language.PureScript.CoreFn as CF
+import qualified Language.PureScript.Docs as Docs
 
 import Data.Char (isSpace)
 import Data.Maybe (mapMaybe, fromMaybe)
@@ -69,6 +71,7 @@ import Text.Parsec (ParseError)
 
 import TestsSetup
 import TestPscPublish
+import qualified TestDocs
 
 modulesDir :: FilePath
 modulesDir = ".test_modules" </> "node_modules"
@@ -176,6 +179,8 @@ main = do
   testCompiler
   heading "psc-publish test suite"
   testPscPublish
+  heading "Documentation test suite"
+  TestDocs.main
 
   where
   heading msg = do
@@ -211,7 +216,7 @@ testCompiler = do
       assertDoesNotCompile (supportPurs ++ [failing </> inputFile]) foreigns
 
   if null failures
-    then exitSuccess
+    then pure ()
     else do
       putStrLn "Failures:"
       forM_ failures $ \(fp, err) ->
@@ -223,6 +228,7 @@ testPscPublish :: IO ()
 testPscPublish = do
   testPackage "tests/support/prelude"
 
+
 supportModules :: [String]
 supportModules =
   [ "Control.Monad.Eff.Class"
diff --git a/tests/TestDocs.hs b/tests/TestDocs.hs
