Conferer.Source.Aeson

Source for json config files using Aeson

Documentation

data JsonSource

Source that read a config file as json and uses that value in a way that makes sense for Conferer but doesn't respect json perfectly.

Constructors

JsonSource

Fields

• value :: Value

Instances

Eq JsonSource

Defined in Conferer.Source.Aeson

Methods

(==) :: JsonSource -> JsonSource -> Bool

(/=) :: JsonSource -> JsonSource -> Bool

Show JsonSource

Defined in Conferer.Source.Aeson

Methods

showsPrec :: Int -> JsonSource -> ShowS

show :: JsonSource -> String

showList :: [JsonSource] -> ShowS

IsSource JsonSource

Defined in Conferer.Source.Aeson

Methods

getKeyInSource :: JsonSource -> Key -> IO (Maybe Text)

getSubkeysInSource :: JsonSource -> Key -> IO [Key]

fromConfig :: Key -> SourceCreator

Create a SourceCreator which uses files with config/{env}.json template and then uses fromFilePath

fromFilePath :: FilePath -> SourceCreator

Create a SourceCreator from a filepath

If the file is not present it will behave as if it had no keys.

If the file doesn't have valid json it will throw an error.

fromFilePath' :: FilePath -> IO Source

Create a Source from a filepath

If the file is not present it will behave as if it had no keys.

If the file doesn't have valid json it will throw an error.

data JsonHasInvalidKeysError

Exception thrown from fromFilePath when the json in the parsed file has incorrect keys

Constructors

JsonHasInvalidKeysError FilePath [RawKey]

Instances

Eq JsonHasInvalidKeysError

Defined in Conferer.Source.Aeson

Methods

(==) :: JsonHasInvalidKeysError -> JsonHasInvalidKeysError -> Bool

(/=) :: JsonHasInvalidKeysError -> JsonHasInvalidKeysError -> Bool

Show JsonHasInvalidKeysError

Defined in Conferer.Source.Aeson

Methods

showsPrec :: Int -> JsonHasInvalidKeysError -> ShowS

show :: JsonHasInvalidKeysError -> String

showList :: [JsonHasInvalidKeysError] -> ShowS

Exception JsonHasInvalidKeysError

Defined in Conferer.Source.Aeson

Methods

toException :: JsonHasInvalidKeysError -> SomeException

fromException :: SomeException -> Maybe JsonHasInvalidKeysError

displayException :: JsonHasInvalidKeysError -> String

fromValue :: Value -> Source

Create a Source from a json value, never fails.

traverseJSON :: Key -> Value -> Maybe Value

Traverse a Value using a Key to get a Value.

This function can nest objects and arrays when keys are nested

traverseJSON "a.b" {a: {b: 12}} == Just "12"
traverseJSON "a.b" {a: {b: false}} == Just "false"
traverseJSON "a" {a: {b: false}} == Nothing
traverseJSON "1" [false, true] == Just "true"
traverseJSON "0.a" [{a: "hi"}] == Just "hi"
traverseJSON "0" [] == Nothing

listKeysInJSON :: Value -> [Key]

Get the list of available keys inside a json value

valueToText :: Value -> Maybe Text

Turn json Value into Text to return that key

boolToString :: Bool -> Text

Turn a Bool into a Text

resultToMaybe :: Result a -> Maybe a

Because we use an old version of aeson

type RawKey = [Text]

invalidJsonKeys :: Value -> [RawKey]

Validates that a json has the correct format for keys, since Conferer Keys are pretty restricted.

The Source will work with incorrect keys but they will be ignored.

allKeys :: Value -> [RawKey]

Returns all keys in a json object