Merge branch 'master' into addDocs

Author: hdgarrood

.travis.yml

@@ -5,7 +5,8 @@ node_js: stable
 env:
   - PATH=$HOME/purescript:$PATH
 install:
-  - TAG=$(basename $(curl --location --silent --output /dev/null -w %{url_effective} https://github.com/purescript/purescript/releases/latest))
+  - TAG=v0.14.0-rc2
+  # - TAG=$(basename $(curl --location --silent --output /dev/null -w %{url_effective} https://github.com/purescript/purescript/releases/latest))
   - curl --location --output $HOME/purescript.tar.gz https://github.com/purescript/purescript/releases/download/$TAG/linux64.tar.gz
   - tar -xvf $HOME/purescript.tar.gz -C $HOME/
   - chmod a+x $HOME/purescript

package.json

@@ -3,12 +3,12 @@
   "scripts": {
     "clean": "rimraf output && rimraf .pulp-cache",
     "build": "eslint src && pulp build -- --censor-lib --strict",
-    "test": "pulp test --no-check-main"
+    "test": "pulp test"
   },
   "devDependencies": {
     "eslint": "^4.19.1",
     "purescript-psa": "^0.6.0",
-    "pulp": "^12.2.0",
+    "pulp": "^15.0.0",
     "rimraf": "^2.6.2"
   }
 }

src/Control/Apply.purs

@@ -68,6 +68,12 @@ infixl 4 applySecond as *>
 
 -- | Lift a function of two arguments to a function which accepts and returns
 -- | values wrapped with the type constructor `f`.
+-- |
+-- | ```purescript
+-- | lift2 add (Just 1) (Just 2) == Just 3
+-- | lift2 add Nothing (Just 2) == Nothing
+-- |```
+-- |
 lift2 :: forall a b c f. Apply f => (a -> b -> c) -> f a -> f b -> f c
 lift2 f a b = f <$> a <*> b
 

src/Data/Bounded.purs

@@ -3,10 +3,17 @@ module Data.Bounded
   , bottom
   , top
   , module Data.Ord
+  , class BoundedRecord, bottomRecord, topRecord
   ) where
 
-import Data.Ord (class Ord, Ordering(..), compare, (<), (<=), (>), (>=))
+import Data.Ord (class Ord, class OrdRecord, Ordering(..), compare, (<), (<=), (>), (>=))
+import Data.Symbol (class IsSymbol, SProxy(..), reflectSymbol)
 import Data.Unit (Unit, unit)
+import Prim.Row as Row
+import Prim.RowList as RL
+import Record.Unsafe (unsafeSet)
+import Type.Data.Row (RProxy(..))
+import Type.Data.RowList (RLProxy(..))
 
 -- | The `Bounded` type class represents totally ordered types that have an
 -- | upper and lower boundary.
@@ -54,3 +61,41 @@ foreign import bottomNumber :: Number
 instance boundedNumber :: Bounded Number where
   top = topNumber
   bottom = bottomNumber
+
+class OrdRecord rowlist row <= BoundedRecord rowlist row subrow | rowlist -> subrow where
+  topRecord :: RLProxy rowlist -> RProxy row -> Record subrow
+  bottomRecord :: RLProxy rowlist -> RProxy row -> Record subrow
+
+instance boundedRecordNil :: BoundedRecord RL.Nil row () where
+  topRecord _ _ = {}
+  bottomRecord _ _ = {}
+
+instance boundedRecordCons
+    :: ( IsSymbol key
+       , Bounded focus
+       , Row.Cons key focus rowTail row
+       , Row.Cons key focus subrowTail subrow
+       , BoundedRecord rowlistTail row subrowTail
+       )
+    => BoundedRecord (RL.Cons key focus rowlistTail) row subrow where
+  topRecord _ rowProxy
+    = insert top tail
+    where
+      key = reflectSymbol (SProxy :: SProxy key)
+      insert = unsafeSet key :: focus -> Record subrowTail -> Record subrow
+      tail = topRecord (RLProxy :: RLProxy rowlistTail) rowProxy
+
+  bottomRecord _ rowProxy
+    = insert bottom tail
+    where
+      key = reflectSymbol (SProxy :: SProxy key)
+      insert = unsafeSet key :: focus -> Record subrowTail -> Record subrow
+      tail = bottomRecord (RLProxy :: RLProxy rowlistTail) rowProxy
+
+instance boundedRecord
+    :: ( RL.RowToList row list
+       , BoundedRecord list row row
+       )
+    => Bounded (Record row) where
+  top = topRecord (RLProxy :: RLProxy list) (RProxy :: RProxy row)
+  bottom = bottomRecord (RLProxy :: RLProxy list) (RProxy :: RProxy row)

src/Data/Function.purs

@@ -26,6 +26,12 @@ flip f b a = f a b
 -- | ```purescript
 -- | const 1 "hello" = 1
 -- | ```
+-- |
+-- | It can also be thought of as creating a function that ignores its argument:
+-- |
+-- | ```purescript
+-- | const 1 = \_ -> 1
+-- | ```
 const :: forall a b. a -> b -> a
 const a _ = a
 
@@ -56,7 +62,7 @@ apply f x = f x
 infixr 0 apply as $
 
 -- | Applies an argument to a function. This is primarily used as the `(#)`
--- | operator, which allows parentheses to be ommitted in some cases, or as a
+-- | operator, which allows parentheses to be omitted in some cases, or as a
 -- | natural way to apply a value to a chain of composed functions.
 applyFlipped :: forall a b. a -> (a -> b) -> b
 applyFlipped x f = f x

src/Data/Unit.purs

@@ -7,6 +7,9 @@ import Data.Show (class Show)
 -- |
 -- | `Unit` is often used, wrapped in a monadic type constructor, as the
 -- | return type of a computation where only the _effects_ are important.
+-- |
+-- | When returning a value of type `Unit` from an FFI function, it is
+-- | recommended to use `undefined`, or not return a value at all.
 foreign import data Unit :: Type
 
 -- | `unit` is the sole inhabitant of the `Unit` type.

src/Type/Data/Row.purs

@@ -16,5 +16,5 @@ module Type.Data.Row where
 -- | { x :: Int, y :: Int } -> { x :: Int, y :: Int }
 -- | ```
 -- | Here `row` has been specialised to `( x :: Int, y :: Int )`.
-data RProxy (row :: # Type)
+data RProxy (row :: Row Type)
   = RProxy

src/Type/Data/RowList.purs

@@ -2,8 +2,6 @@ module Type.Data.RowList where
 
 import Prim.RowList (kind RowList)
 
--- | A proxy data type whose type parameter is a type of kind `RowList`.
--- |
--- | Commonly used for specialising a function with a quantified type.
-data RLProxy (rowlist :: RowList)
+-- | A proxy to carry information about a rowlist.
+data RLProxy (rowlist :: RowList Type)
   = RLProxy

test/Test/Main.purs

@@ -149,4 +149,9 @@ testRecordInstances = do
   testOrd { a: 42, b: "hello" } { a: 42, b: "hello" } EQ
   testOrd { a: 42, b: "hell" } { a: 42, b: "hello" } LT
   testOrd { a: 42, b: "hello" } { a: 42, b: "hell" } GT
-
+  assert "Record bottom" $
+    (bottom :: { a :: Boolean }).a
+    == bottom
+  assert "Record top" $
+    (top :: { a :: Boolean }).a
+    == top