Skip to content

Add encoder for NonEmptyString #98

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 6, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Breaking changes (😱!!!):

New features:
- Added decoders for `NonEmptyString` and added a new `decodeNonempty` function (#94)
- Added encoder for `NonEmptyString` (d0liver, #98)

Bugfixes:

Expand Down
4 changes: 4 additions & 0 deletions src/Data/Argonaut/Encode/Class.purs
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import Data.Argonaut.Encode.Encoders

import Data.Argonaut.Core (Json, fromObject)
import Data.Array.NonEmpty (NonEmptyArray)
import Data.String.NonEmpty (NonEmptyString)
import Data.Either (Either)
import Data.Identity (Identity)
import Data.List (List)
Expand Down Expand Up @@ -58,6 +59,9 @@ instance encodeJsonJson :: EncodeJson Json where
instance encodeJsonCodePoint :: EncodeJson CodePoint where
encodeJson = encodeCodePoint

instance encodeNonEmptyString :: EncodeJson NonEmptyString where
encodeJson = encodeNonEmptyString

instance encodeJsonNonEmpty_Array :: (EncodeJson a) => EncodeJson (NonEmpty Array a) where
encodeJson = encodeNonEmpty_Array encodeJson

Expand Down
5 changes: 5 additions & 0 deletions src/Data/Argonaut/Encode/Encoders.purs
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ import Data.Int (toNumber)
import Data.List (List(..), (:), toUnfoldable)
import Data.List.NonEmpty as NEL
import Data.List.Types (NonEmptyList)
import Data.String.NonEmpty (NonEmptyString)
import Data.String.NonEmpty as NonEmptyString
import Data.Map as M
import Data.Maybe (Maybe(..))
import Data.NonEmpty (NonEmpty(..))
Expand Down Expand Up @@ -60,6 +62,9 @@ encodeString = fromString
encodeCodePoint :: CodePoint -> Json
encodeCodePoint = encodeString <<< CP.singleton

encodeNonEmptyString :: NonEmptyString -> Json
encodeNonEmptyString = fromString <<< NonEmptyString.toString

encodeNonEmpty_Array :: forall a. (a -> Json) -> NonEmpty Array a -> Json
encodeNonEmpty_Array encoder (NonEmpty h t) = encodeArray encoder (Arr.cons h t)

Expand Down
17 changes: 17 additions & 0 deletions test/Test/Main.purs
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ import Data.Argonaut.Encode (encodeJson, (:=), (:=?), (~>), (~>?))
import Data.Argonaut.Gen (genJson)
import Data.Argonaut.Parser (jsonParser)
import Data.Array.NonEmpty (NonEmptyArray)
import Data.String.NonEmpty (NonEmptyString)
import Data.String.NonEmpty as NonEmptyString
import Data.Bifunctor (rmap)
import Data.Either (Either(..), either)
import Data.Foldable (foldl)
Expand Down Expand Up @@ -314,6 +316,21 @@ nonEmptyCheck = do
Left err ->
false <?> printJsonDecodeError err


test "Test EncodeJson/DecodeJson on NonEmptyString" do
quickCheck \(x :: NonEmptyString) ->
case decodeJson (encodeJson x) of
Right decoded ->
decoded == x
<?>
( " x = "
<> NonEmptyString.toString x
<> ", decoded = "
<> NonEmptyString.toString decoded
)
Left err ->
false <?> printJsonDecodeError err

test "Test EncodeJson/DecodeJson on NonEmptyArray" do
quickCheck \(x :: NonEmptyArray String) ->
case decodeJson (encodeJson x) of
Expand Down