Copyright	(c) 2019-2021 Vaclav Svejcar
License	BSD-3-Clause
Maintainer	vaclav.svejcar@gmail.com
Stability	experimental
Portability	POSIX
Safe Haskell	None
Language	Haskell2010

Headroom.Configuration.Enrich

Contents

Data Types
Field Generators
Field Manipulation

Description

This module contains mini-DSL for enrichment of generated YAML configurations, i.e. replacing default values with real ones, etc. This is intentionally done without the Data.Yaml and parsing, because that way all comments inside YAML file would be lost.

Synopsis

newtype Enrich = Enrich {
- enrich :: Text -> Text
}
data ValueType
- = Array
- | String
withArray :: ToJSON a => [a] -> Text -> (ValueType, Text)
withText :: Text -> Text -> (ValueType, Text)
replaceEmptyValue :: Text -> (Text -> (ValueType, Text)) -> Enrich

Data Types

newtype Enrich Source #

Simple wrapper representing single step of enrichment.

Constructors

Enrich
Fields enrich :: Text -> Text takes input text and does enrichment

Instances

Instances details

Semigroup Enrich Source #
Instance details Defined in Headroom.Configuration.Enrich Methods (<>) :: Enrich -> Enrich -> Enrich # sconcat :: NonEmpty Enrich -> Enrich # stimes :: Integral b => b -> Enrich -> Enrich #
Monoid Enrich Source #
Instance details Defined in Headroom.Configuration.Enrich Methods mempty :: Enrich # mappend :: Enrich -> Enrich -> Enrich # mconcat :: [Enrich] -> Enrich #

data ValueType Source #

Represents type of the field value.

Constructors

Array	type of YAML array
String	type of YAML string

Instances

Instances details

Eq ValueType Source #
Instance details Defined in Headroom.Configuration.Enrich Methods (==) :: ValueType -> ValueType -> Bool # (/=) :: ValueType -> ValueType -> Bool #
Show ValueType Source #
Instance details Defined in Headroom.Configuration.Enrich Methods showsPrec :: Int -> ValueType -> ShowS # show :: ValueType -> String # showList :: [ValueType] -> ShowS #

Field Generators

withArray Source #

Arguments

:: ToJSON a
=> [a]	input list used as value
-> Text	field name
-> (ValueType, Text)	generated fields as `(valueType, generatedField)`

Generates YAML array field from given list and field name.

withText Source #

Arguments

:: Text	input text value
-> Text	field name
-> (ValueType, Text)	generated fields as `(valueType, generatedField)`

Generates YAML string from given text value and field name.

Field Manipulation

replaceEmptyValue Source #

Arguments

:: Text	field name
-> (Text -> (ValueType, Text))	field value generator function
-> Enrich	resulting enrichment step

Replaces empty value of given field with actual generated value.