Merge pull request #55 from thomashoneyman/trh/strmap

Add strMap

Author: garyb

bower.json

@@ -20,7 +20,8 @@
     "purescript-codec": "^6.0.0",
     "purescript-variant": "^8.0.0",
     "purescript-ordered-collections": "^3.0.0",
-    "purescript-type-equality": "^4.0.1"
+    "purescript-type-equality": "^4.0.1",
+    "purescript-foreign-object": "^4.1.0"
   },
   "devDependencies": {
     "purescript-argonaut-codecs": "^9.1.0",

src/Data/Codec/Argonaut/Common.purs

@@ -1,19 +1,9 @@
 module Data.Codec.Argonaut.Common
-  ( nonEmptyString
-  , nonEmptyArray
-  , maybe
-  , tuple
-  , either
-  , list
-  , nonEmptyList
-  , map
-  , set
-  , nonEmptySet
-  , foreignObject
+  ( module Data.Codec.Argonaut.Common
   , module Data.Codec.Argonaut
   ) where
 
-import Prelude hiding (map, void, identity)
+import Prelude hiding (identity, map, void)
 
 import Data.Array as Array
 import Data.Array.NonEmpty as NEA
@@ -29,6 +19,7 @@ import Data.Profunctor (dimap)
 import Data.Set as Set
 import Data.Set.NonEmpty as NESet
 import Data.String.NonEmpty as NEString
+import Data.Traversable (traverse)
 import Data.Tuple (Tuple(..), fst, snd)
 import Foreign.Object as Object
 
@@ -110,6 +101,15 @@ nonEmptyList codec = prismaticCodec "NonEmptyList" NEL.fromFoldable Array.fromFo
 map ∷ ∀ a b. Ord a ⇒ JsonCodec a → JsonCodec b → JsonCodec (Map.Map a b)
 map codecA codecB = dimap Map.toUnfoldable (Map.fromFoldable) (named "Map" (array (tuple codecA codecB)))
 
+-- | A codec for `Map` values which have string keys.
+-- |
+-- | Encodes as an object in JSON.
+strMap ∷ ∀ a. JsonCodec a → JsonCodec (Map.Map String a)
+strMap codec =
+  codec'
+    (F.map Map.fromFoldableWithIndex <<< traverse (decode codec) <=< decode jobject)
+    (encode jobject <<< Object.fromFoldableWithIndex <<< F.map (encode codec))
+
 -- | A codec for `Set` values.
 -- |
 -- | Encodes as an array in JSON.
@@ -122,7 +122,7 @@ set codec = dimap Array.fromFoldable Set.fromFoldable (named "Set" (array codec)
 nonEmptySet ∷ ∀ a. Ord a ⇒ JsonCodec a → JsonCodec (NESet.NonEmptySet a)
 nonEmptySet codec = prismaticCodec "NonEmptySet" NESet.fromFoldable NESet.toUnfoldable (array codec)
 
--- | A codec for `StrMap` values.
+-- | A codec for `Object` values.
 -- |
 -- | Encodes as an array of two-element key/value arrays in JSON.
 foreignObject ∷ ∀ a. JsonCodec a → JsonCodec (Object.Object a)

src/Data/Codec/Argonaut/Compat.purs

@@ -9,7 +9,7 @@ import Prelude hiding (identity, map, void)
 import Data.Argonaut.Core as J
 import Data.Bifunctor as BF
 import Data.Codec as Codec
-import Data.Codec.Argonaut.Common (Codec(..), Codec', JIndexedCodec, JPropCodec, JsonCodec, JsonDecodeError(..), array, boolean, char, codePoint, codec, codec', coercible, decode, either, encode, fix, hoist, identity, index, indexedArray, int, jarray, jobject, json, list, map, named, nonEmptyArray, nonEmptyList, nonEmptySet, nonEmptyString, null, number, object, printJsonDecodeError, prismaticCodec, prop, record, recordProp, recordPropOptional, set, string, tuple, void, (<~<), (>~>), (~))
+import Data.Codec.Argonaut.Common (Codec(..), Codec', JIndexedCodec, JPropCodec, JsonCodec, JsonDecodeError(..), array, boolean, char, codePoint, codec, codec', coercible, decode, either, encode, fix, hoist, identity, index, indexedArray, int, jarray, jobject, json, list, map, named, nonEmptyArray, nonEmptyList, nonEmptySet, nonEmptyString, null, number, object, printJsonDecodeError, prismaticCodec, prop, record, recordProp, recordPropOptional, set, strMap, string, tuple, void, (<~<), (>~>), (~))
 import Data.Either (Either)
 import Data.Functor as Functor
 import Data.Maybe (Maybe(..))

test/Test/Common.purs

@@ -31,6 +31,9 @@ main = do
   log "Checking StrMap codec"
   quickCheck propStrMapCodec
 
+  log "Checking Object codec"
+  quickCheck propObjectCodec
+
 propMaybeCodec ∷ Gen Result
 propMaybeCodec =
   propCodec
@@ -57,6 +60,12 @@ propMapCodec =
 
 propStrMapCodec ∷ Gen Result
 propStrMapCodec =
+  propCodec
+    (genMap genAsciiString genInt)
+    (JA.strMap JA.int)
+
+propObjectCodec ∷ Gen Result
+propObjectCodec =
   propCodec
     (genForeignObject genAsciiString genInt)
     (JA.foreignObject JA.int)