Test the readme examples

Author: garyb

README.md

@@ -115,7 +115,11 @@ codec =
 Objects with optional properties can be defined using the [`CAR.optional`](https://pursuit.purescript.org/packages/purescript-codec-argonaut/docs/Data.Codec.Argonaut.Record#v:optional): 
 
 ```purescript
-type Person = 
+import Data.Codec.Argonaut as CA
+import Data.Codec.Argonaut.Record as CAR
+import Data.Maybe (Maybe)
+
+type Person =
   { name ∷ String
   , age ∷ Int
   , active ∷ Boolean
@@ -258,7 +262,7 @@ import Data.String.NonEmpty (NonEmptyString)
 import Data.String.NonEmpty as NES
 
 codec ∷ CA.JsonCodec NonEmptyString
-codec = CA.prismaticCodec NES.fromString NES.toString CA.string
+codec = CA.prismaticCodec "NonEmptyString" NES.fromString NES.toString CA.string
 ```
 
 See the documentation for [another example](https://pursuit.purescript.org/packages/purescript-codec-argonaut/docs/Data.Codec.Argonaut#v:prismaticCodec) of how [`CA.prismaticCodec`](https://pursuit.purescript.org/packages/purescript-codec-argonaut/docs/Data.Codec.Argonaut#v:prismaticCodec) might be used. The main downside to [`CA.prismaticCodec`](https://pursuit.purescript.org/packages/purescript-codec-argonaut/docs/Data.Codec.Argonaut#v:prismaticCodec) is the error reporting for the `Nothing` case might not be good as it otherwise could be, since [`UnexpectedValue`](https://pursuit.purescript.org/packages/purescript-codec-argonaut/docs/Data.Codec.Argonaut#t:JsonDecodeError) is the only information we have at that point.

test/Test/Example/Newtype.purs

@@ -0,0 +1,21 @@
+module Test.Example.Newtype where
+
+import Data.Codec.Argonaut as CA
+import Data.Codec.Argonaut.Record as CAR
+import Data.Newtype (class Newtype)
+import Data.Profunctor (wrapIso)
+
+type PersonRec = { "Name" ∷ String, age ∷ Int, "is active" ∷ Boolean }
+
+newtype Person = Person PersonRec
+
+derive instance newtypePerson ∷ Newtype Person _
+
+codec ∷ CA.JsonCodec Person
+codec =
+  CA.coercible "Person"
+    (CAR.record
+      { "Name": CA.string
+      , age: CA.int
+      , "is active": CA.boolean
+      })

test/Test/Example/Object1.purs

@@ -0,0 +1,15 @@
+module Test.Example.Object1 where
+
+import Data.Codec.Argonaut as CA
+import Data.Codec.Argonaut.Record as CAR
+
+type Person = { "Name" ∷ String, age ∷ Int, "is active" ∷ Boolean }
+
+codec ∷ CA.JsonCodec Person
+codec =
+  CA.object "Person"
+    (CAR.record
+      { "Name": CA.string
+      , age: CA.int
+      , "is active": CA.boolean
+      })

test/Test/Example/Object2.purs

@@ -0,0 +1,15 @@
+module Test.Example.Object2 where
+
+import Data.Codec.Argonaut as CA
+import Data.Codec.Argonaut.Record as CAR
+
+type Person = { name ∷ String, age ∷ Int, active ∷ Boolean }
+
+codec ∷ CA.JsonCodec Person
+codec =
+  CA.object "Person"
+    (CAR.record
+      { name: CA.string
+      , age: CA.int
+      , active: CA.boolean
+      })

test/Test/Example/Object3.purs

@@ -0,0 +1,23 @@
+module Test.Example.Object3 where
+
+import Data.Codec.Argonaut as CA
+import Data.Codec.Argonaut.Record as CAR
+import Data.Maybe (Maybe)
+
+type Person =
+  { name ∷ String
+  , age ∷ Int
+  , active ∷ Boolean
+  , email ∷ Maybe String
+  }
+
+codec ∷ CA.JsonCodec Person
+codec =
+  CA.object "Person"
+    ( CAR.record
+        { name: CA.string
+        , age: CA.int
+        , active: CA.boolean
+        , email: CAR.optional CA.string
+        }
+    )

test/Test/Example/Prismatic1.purs

@@ -0,0 +1,8 @@
+module Test.Example.Prismatic1 where
+
+import Data.Codec.Argonaut as CA
+import Data.String.NonEmpty (NonEmptyString)
+import Data.String.NonEmpty as NES
+
+codec ∷ CA.JsonCodec NonEmptyString
+codec = CA.prismaticCodec "NonEmptyString" NES.fromString NES.toString CA.string

test/Test/Example/Sum1.purs

@@ -0,0 +1,21 @@
+module Test.Example.Sum2 where
+
+import Prelude
+
+import Data.Codec.Argonaut as CA
+import Data.Codec.Argonaut.Variant as CAV
+import Data.Either (Either(..))
+import Data.Variant as V
+
+type SomeValue = V.Variant
+  ( str ∷ String
+  , int ∷ Int
+  , neither ∷ Unit
+  )
+
+codec ∷ CA.JsonCodec SomeValue
+codec = CAV.variantMatch
+  { str: Right CA.string
+  , int: Right CA.int
+  , neither: Left unit
+  }

test/Test/Example/Sum2.purs

@@ -0,0 +1,30 @@
+module Test.Example.Sum2 where
+
+import Prelude
+
+import Data.Codec.Argonaut as CA
+import Data.Codec.Argonaut.Variant as CAV
+import Data.Either (Either(..))
+import Data.Profunctor (dimap)
+import Data.Variant as V
+import Type.Proxy (Proxy(..))
+
+data SomeValue2 = Str String | Int Int | Neither
+
+codec ∷ CA.JsonCodec SomeValue2
+codec =
+  dimap toVariant fromVariant $ CAV.variantMatch
+    { str: Right CA.string
+    , int: Right CA.int
+    , neither: Left unit
+    }
+  where
+    toVariant = case _ of
+      Str s → V.inj (Proxy ∷ _ "str") s
+      Int i → V.inj (Proxy ∷ _ "int") i
+      Neither → V.inj (Proxy ∷ _ "neither") unit
+    fromVariant = V.match
+      { str: Str
+      , int: Int
+      , neither: \_ → Neither
+      }

test/Test/Prim.purs

@@ -12,7 +12,6 @@ import Data.Codec.Argonaut.Common as CA
 import Data.Either (Either(..), either, note)
 import Data.Generic.Rep (class Generic)
 import Data.Int as Int
-import Data.Maybe (Maybe(..))
 import Data.Maybe (Maybe(..), maybe)
 import Data.Newtype (class Newtype, unwrap, wrap)
 import Data.Profunctor (dimap)