Minor tweaks

Author: garyb

package.json

@@ -2,14 +2,14 @@
   "private": true,
   "scripts": {
     "clean": "rimraf output && rimraf .pulp-cache",
-    "build": "jshint src && jscs src && psa \"src/**/*.purs\" \"bower_components/purescript-*/src/**/*.purs\" --censor-lib --strict",
-    "test": "psa \"src/**/*.purs\" \"bower_components/purescript-*/src/**/*.purs\" \"examples/**/*.purs\" --censor-lib --strict"
+    "build": "jshint src && jscs src && pulp build --censor-lib --strict",
+    "test": "pulp build -I examples --censor-lib --strict"
   },
   "devDependencies": {
-    "jscs": "^2.8.0",
-    "jshint": "^2.9.1",
-    "pulp": "^8.2.0",
-    "purescript-psa": "^0.3.8",
-    "rimraf": "^2.5.0"
+    "jscs": "^3.0.7",
+    "jshint": "^2.9.2",
+    "pulp": "^9.0.1",
+    "purescript-psa": "^0.3.9",
+    "rimraf": "^2.5.4"
   }
 }

src/Data/Foreign.js

@@ -1,8 +1,6 @@
 /* global exports */
 "use strict";
 
-// module Data.Foreign
-
 // jshint maxparams: 3
 exports.parseJSONImpl = function (left, right, str) {
   try {
@@ -11,8 +9,8 @@ exports.parseJSONImpl = function (left, right, str) {
     return left(e.toString());
   }
 };
-
 // jshint maxparams: 1
+
 exports.toForeign = function (value) {
   return value;
 };

src/Data/Foreign.purs

@@ -2,10 +2,10 @@
 -- | data.
 
 module Data.Foreign
-  ( Foreign()
+  ( Foreign
   , ForeignError(..)
   , Prop(..)
-  , F()
+  , F
   , parseJSON
   , toForeign
   , unsafeFromForeign
@@ -57,12 +57,8 @@ instance showForeignError :: Show ForeignError where
   show (ErrorAtProperty prop e) = "Error at property " <> show prop <> ": " <> show e
   show (JSONError s) = "JSON error: " <> s
 
-instance eqForeignError :: Eq ForeignError where
-  eq (TypeMismatch a b) (TypeMismatch a' b') = a == a' && b == b'
-  eq (ErrorAtIndex i e) (ErrorAtIndex i' e') = i == i' && e == e'
-  eq (ErrorAtProperty p e) (ErrorAtProperty p' e') = p == p' && e == e'
-  eq (JSONError s) (JSONError s') = s == s'
-  eq _ _ = false
+derive instance eqForeignError :: Eq ForeignError
+derive instance ordForeignError :: Ord ForeignError
 
 -- | An error monad, used in this library to encode possible failure when
 -- | dealing with foreign data.
@@ -140,6 +136,9 @@ readArray :: Foreign -> F (Array Foreign)
 readArray value | isArray value = pure $ unsafeFromForeign value
 readArray value = Left (TypeMismatch "array" (tagOf value))
 
+-- | A key/value pair for an object to be written as a `Foreign` value.
 newtype Prop = Prop { key :: String, value :: Foreign }
 
+-- | Constructs a JavaScript `Object` value (typed as `Foreign`) from an array
+-- | of `Prop`s.
 foreign import writeObject :: Array Prop -> Foreign

src/Data/Foreign/Class.purs

@@ -2,14 +2,13 @@
 
 module Data.Foreign.Class
   ( class IsForeign
-  , class AsForeign
-  , (.=)
   , read
   , readJSON
   , readWith
   , readProp
+  , class AsForeign
   , write
-  , writeProp
+  , writeProp, (.=)
   ) where
 
 import Prelude
@@ -51,7 +50,7 @@ instance numberIsForeign :: IsForeign Number where
 instance intIsForeign :: IsForeign Int where
   read = readInt
 
-instance arrayIsForeign :: (IsForeign a) => IsForeign (Array a) where
+instance arrayIsForeign :: IsForeign a => IsForeign (Array a) where
   read value = readArray value >>= readElements
     where
     readElements :: Array Foreign -> F (Array a)
@@ -60,21 +59,21 @@ instance arrayIsForeign :: (IsForeign a) => IsForeign (Array a) where
     readElement :: Int -> Foreign -> F a
     readElement i value = readWith (ErrorAtIndex i) value
 
-instance nullIsForeign :: (IsForeign a) => IsForeign (Null a) where
+instance nullIsForeign :: IsForeign a => IsForeign (Null a) where
   read = readNull read
 
-instance undefinedIsForeign :: (IsForeign a) => IsForeign (Undefined a) where
+instance undefinedIsForeign :: IsForeign a => IsForeign (Undefined a) where
   read = readUndefined read
 
-instance nullOrUndefinedIsForeign :: (IsForeign a) => IsForeign (NullOrUndefined a) where
+instance nullOrUndefinedIsForeign :: IsForeign a => IsForeign (NullOrUndefined a) where
   read = readNullOrUndefined read
 
 -- | Attempt to read a data structure from a JSON string
-readJSON :: forall a. (IsForeign a) => String -> F a
+readJSON :: forall a. IsForeign a => String -> F a
 readJSON json = parseJSON json >>= read
 
 -- | Attempt to read a foreign value, handling errors using the specified function
-readWith :: forall a e. (IsForeign a) => (ForeignError -> e) -> Foreign -> Either e a
+readWith :: forall a e. IsForeign a => (ForeignError -> e) -> Foreign -> Either e a
 readWith f value = either (Left <<< f) Right (read value)
 
 -- | Attempt to read a property of a foreign value at the specified index
@@ -105,19 +104,19 @@ instance numberAsForeign :: AsForeign Number where
 instance intAsForeign :: AsForeign Int where
   write = toForeign
 
-instance arrayAsForeign :: (AsForeign a) => AsForeign (Array a) where
+instance arrayAsForeign :: AsForeign a => AsForeign (Array a) where
   write = toForeign <<< map write
 
-instance nullAsForeign :: (AsForeign a) => AsForeign (Null a) where
+instance nullAsForeign :: AsForeign a => AsForeign (Null a) where
   write (Null a) = maybe writeNull write a
 
-instance undefinedAsForeign :: (AsForeign a) => AsForeign (Undefined a) where
+instance undefinedAsForeign :: AsForeign a => AsForeign (Undefined a) where
   write (Undefined a) = maybe writeUndefined write a
 
-instance nullOrUndefinedAsForeign :: (AsForeign a) => AsForeign (NullOrUndefined a) where
+instance nullOrUndefinedAsForeign :: AsForeign a => AsForeign (NullOrUndefined a) where
   write (NullOrUndefined a) = write (Null a)
 
 infixl 8 writeProp as .=
 
-writeProp :: forall a. (AsForeign a) => String -> a -> Prop
+writeProp :: forall a. AsForeign a => String -> a -> Prop
 writeProp k v = Prop { key: k, value: write v }

src/Data/Foreign/Index.js

@@ -1,8 +1,6 @@
 /* global exports */
 "use strict";
 
-// module Data.Foreign.Index
-
 // jshint maxparams: 4
 exports.unsafeReadPropImpl = function (f, s, key, value) {
   return value == null ? f : s(value[key]);

src/Data/Foreign/Index.purs

@@ -17,9 +17,9 @@ import Data.Either (Either(..))
 import Data.Foreign (Foreign, F, ForeignError(..), typeOf, isUndefined, isNull)
 import Data.Function.Uncurried (Fn2, runFn2, Fn4, runFn4)
 
--- | This type class identifies types wich act like _property indices_.
+-- | This type class identifies types that act like _property indices_.
 -- |
--- | The canonical instances are for `String`s and `Number`s.
+-- | The canonical instances are for `String`s and `Int`s.
 class Index i where
   ix :: Foreign -> i -> F Foreign
   hasProperty :: i -> Foreign -> Boolean

src/Data/Foreign/Keys.js

@@ -1,8 +1,6 @@
 /* global exports */
 "use strict";
 
-// module Data.Foreign.Keys
-
 exports.unsafeKeys = Object.keys || function (value) {
   var keys = [];
   for (var prop in value) {

src/Data/Foreign/Null.js

@@ -1,6 +1,4 @@
 /* global exports */
 "use strict";
 
-// module Data.Foreign.Null
-
 exports.writeNull = null;

src/Data/Foreign/Undefined.js

@@ -1,6 +1,4 @@
 /* global exports */
 "use strict";
 
-// module Data.Foreign.Undefined
-
 exports.writeUndefined = undefined;