Safe Haskell	None
Language	Haskell2010

Data.Interpolation

Synopsis

newtype TemplateKey = TemplateKey {
- unTemplateKey :: Text
}
newtype TemplateValue = TemplateValue {
- unTemplateValue :: Text
}
data Template a = Template {
- _templateKey :: TemplateKey
- _templateDefault :: Maybe a
}
data Uninterpolated a
- = Templated (Template a)
- | Literal a
data InterpolationFailure
- = InterpolationFailureKeyNotFound TemplateKey
- | InterpolationFailureValueNotReadable TemplateKey TemplateValue
newtype InterpolationContext = InterpolationContext {
- unInterpolationContext :: Map TemplateKey TemplateValue
}
class FromTemplateValue a where
- parseTemplateValue :: TemplateValue -> Maybe a
class ToTemplateValue a where
- toTemplateValue :: a -> TemplateValue
newtype Interpolator templates identities = Interpolator {
- runInterpolator :: templates -> Reader InterpolationContext (Validation [InterpolationFailure] identities)
}
runTemplate :: FromTemplateValue a => Interpolator (Uninterpolated a) a
mkInterpolationContext :: MonadIO m => m InterpolationContext
interpolateWithContext :: (Default Interpolator templates identities, MonadIO m) => templates -> m (Either [InterpolationFailure] identities)
interpolateWithContextExplicit :: MonadIO m => Interpolator templates identities -> templates -> m (Either [InterpolationFailure] identities)
maybeGen :: Gen a -> Gen (Maybe a)
noEnv :: Gen Text
varNameAllowed :: Gen Text

Documentation

newtype TemplateKey Source #

Newtype wrapper for an environment variable key.

Constructors

TemplateKey
Fields unTemplateKey :: Text

Instances

Eq TemplateKey Source #
Instance details Defined in Data.Interpolation Methods (==) :: TemplateKey -> TemplateKey -> Bool # (/=) :: TemplateKey -> TemplateKey -> Bool #
Ord TemplateKey Source #
Instance details Defined in Data.Interpolation Methods compare :: TemplateKey -> TemplateKey -> Ordering # (<) :: TemplateKey -> TemplateKey -> Bool # (<=) :: TemplateKey -> TemplateKey -> Bool # (>) :: TemplateKey -> TemplateKey -> Bool # (>=) :: TemplateKey -> TemplateKey -> Bool # max :: TemplateKey -> TemplateKey -> TemplateKey # min :: TemplateKey -> TemplateKey -> TemplateKey #
Show TemplateKey Source #
Instance details Defined in Data.Interpolation Methods showsPrec :: Int -> TemplateKey -> ShowS # show :: TemplateKey -> String # showList :: [TemplateKey] -> ShowS #
Arbitrary TemplateKey Source #
Instance details Defined in Data.Interpolation Methods arbitrary :: Gen TemplateKey # shrink :: TemplateKey -> [TemplateKey] #
ToJSON TemplateKey Source #
Instance details Defined in Data.Interpolation Methods toJSON :: TemplateKey -> Value # toEncoding :: TemplateKey -> Encoding # toJSONList :: [TemplateKey] -> Value # toEncodingList :: [TemplateKey] -> Encoding #
FromJSON TemplateKey Source #
Instance details Defined in Data.Interpolation Methods parseJSON :: Value -> Parser TemplateKey # parseJSONList :: Value -> Parser [TemplateKey] #

newtype TemplateValue Source #

Newtype wrapper for an environment variable value.

Constructors

TemplateValue
Fields unTemplateValue :: Text

Instances

Eq TemplateValue Source #
Instance details Defined in Data.Interpolation Methods (==) :: TemplateValue -> TemplateValue -> Bool # (/=) :: TemplateValue -> TemplateValue -> Bool #
Ord TemplateValue Source #
Instance details Defined in Data.Interpolation Methods compare :: TemplateValue -> TemplateValue -> Ordering # (<) :: TemplateValue -> TemplateValue -> Bool # (<=) :: TemplateValue -> TemplateValue -> Bool # (>) :: TemplateValue -> TemplateValue -> Bool # (>=) :: TemplateValue -> TemplateValue -> Bool # max :: TemplateValue -> TemplateValue -> TemplateValue # min :: TemplateValue -> TemplateValue -> TemplateValue #
Show TemplateValue Source #
Instance details Defined in Data.Interpolation Methods showsPrec :: Int -> TemplateValue -> ShowS # show :: TemplateValue -> String # showList :: [TemplateValue] -> ShowS #
ToJSON TemplateValue Source #
Instance details Defined in Data.Interpolation Methods toJSON :: TemplateValue -> Value # toEncoding :: TemplateValue -> Encoding # toJSONList :: [TemplateValue] -> Value # toEncodingList :: [TemplateValue] -> Encoding #
FromJSON TemplateValue Source #
Instance details Defined in Data.Interpolation Methods parseJSON :: Value -> Parser TemplateValue # parseJSONList :: Value -> Parser [TemplateValue] #

data Template a Source #

Type for a value that is described by '_env:ENVIRONMENT_VARIABLE:default' in JSON.

Constructors

Template
Fields _templateKey :: TemplateKey _templateDefault :: Maybe a

Instances

Eq a => Eq (Template a) Source #
Instance details Defined in Data.Interpolation Methods (==) :: Template a -> Template a -> Bool # (/=) :: Template a -> Template a -> Bool #
Ord a => Ord (Template a) Source #
Instance details Defined in Data.Interpolation Methods compare :: Template a -> Template a -> Ordering # (<) :: Template a -> Template a -> Bool # (<=) :: Template a -> Template a -> Bool # (>) :: Template a -> Template a -> Bool # (>=) :: Template a -> Template a -> Bool # max :: Template a -> Template a -> Template a # min :: Template a -> Template a -> Template a #
Show a => Show (Template a) Source #
Instance details Defined in Data.Interpolation Methods showsPrec :: Int -> Template a -> ShowS # show :: Template a -> String # showList :: [Template a] -> ShowS #
ToTemplateValue a => ToJSON (Template a) Source #
Instance details Defined in Data.Interpolation Methods toJSON :: Template a -> Value # toEncoding :: Template a -> Encoding # toJSONList :: [Template a] -> Value # toEncodingList :: [Template a] -> Encoding #
FromTemplateValue a => FromJSON (Template a) Source #
Instance details Defined in Data.Interpolation Methods parseJSON :: Value -> Parser (Template a) # parseJSONList :: Value -> Parser [Template a] #

data Uninterpolated a Source #

Type for a value that can be described either with '_env...' or as just a literal value in JSON.

Constructors

Templated (Template a)
Literal a

Instances

FromTemplateValue a => Default Interpolator (Uninterpolated a) a Source #	When we can parse template values, we can interpolate from the template.
Instance details Defined in Data.Interpolation Methods def :: Interpolator (Uninterpolated a) a #
Eq a => Eq (Uninterpolated a) Source #
Instance details Defined in Data.Interpolation Methods (==) :: Uninterpolated a -> Uninterpolated a -> Bool # (/=) :: Uninterpolated a -> Uninterpolated a -> Bool #
Ord a => Ord (Uninterpolated a) Source #
Instance details Defined in Data.Interpolation Methods compare :: Uninterpolated a -> Uninterpolated a -> Ordering # (<) :: Uninterpolated a -> Uninterpolated a -> Bool # (<=) :: Uninterpolated a -> Uninterpolated a -> Bool # (>) :: Uninterpolated a -> Uninterpolated a -> Bool # (>=) :: Uninterpolated a -> Uninterpolated a -> Bool # max :: Uninterpolated a -> Uninterpolated a -> Uninterpolated a # min :: Uninterpolated a -> Uninterpolated a -> Uninterpolated a #
Show a => Show (Uninterpolated a) Source #
Instance details Defined in Data.Interpolation Methods showsPrec :: Int -> Uninterpolated a -> ShowS # show :: Uninterpolated a -> String # showList :: [Uninterpolated a] -> ShowS #
Arbitrary a => Arbitrary (Uninterpolated a) Source #
Instance details Defined in Data.Interpolation Methods arbitrary :: Gen (Uninterpolated a) # shrink :: Uninterpolated a -> [Uninterpolated a] #
Arbitrary (Uninterpolated Text) Source #
Instance details Defined in Data.Interpolation Methods arbitrary :: Gen (Uninterpolated Text) # shrink :: Uninterpolated Text -> [Uninterpolated Text] #
(ToTemplateValue a, ToJSON a) => ToJSON (Uninterpolated a) Source #
Instance details Defined in Data.Interpolation Methods toJSON :: Uninterpolated a -> Value # toEncoding :: Uninterpolated a -> Encoding # toJSONList :: [Uninterpolated a] -> Value # toEncodingList :: [Uninterpolated a] -> Encoding #
(FromTemplateValue a, FromJSON a) => FromJSON (Uninterpolated a) Source #
Instance details Defined in Data.Interpolation Methods parseJSON :: Value -> Parser (Uninterpolated a) # parseJSONList :: Value -> Parser [Uninterpolated a] #

data InterpolationFailure Source #

Constructors

InterpolationFailureKeyNotFound TemplateKey
InterpolationFailureValueNotReadable TemplateKey TemplateValue

Instances

Eq InterpolationFailure Source #
Instance details Defined in Data.Interpolation Methods (==) :: InterpolationFailure -> InterpolationFailure -> Bool # (/=) :: InterpolationFailure -> InterpolationFailure -> Bool #
Ord InterpolationFailure Source #
Instance details Defined in Data.Interpolation Methods compare :: InterpolationFailure -> InterpolationFailure -> Ordering # (<) :: InterpolationFailure -> InterpolationFailure -> Bool # (<=) :: InterpolationFailure -> InterpolationFailure -> Bool # (>) :: InterpolationFailure -> InterpolationFailure -> Bool # (>=) :: InterpolationFailure -> InterpolationFailure -> Bool # max :: InterpolationFailure -> InterpolationFailure -> InterpolationFailure # min :: InterpolationFailure -> InterpolationFailure -> InterpolationFailure #
Show InterpolationFailure Source #
Instance details Defined in Data.Interpolation Methods showsPrec :: Int -> InterpolationFailure -> ShowS # show :: InterpolationFailure -> String # showList :: [InterpolationFailure] -> ShowS #

newtype InterpolationContext Source #

Constructors

InterpolationContext
Fields unInterpolationContext :: Map TemplateKey TemplateValue

class FromTemplateValue a where Source #

A class for parsing environment variable values, which should only be defined on primitives. Similar to Read except that for text-type values it should parse using identity.

Methods

parseTemplateValue :: TemplateValue -> Maybe a Source #

Instances

FromTemplateValue Bool Source #
Instance details Defined in Data.Interpolation Methods parseTemplateValue :: TemplateValue -> Maybe Bool Source #
FromTemplateValue Int Source #
Instance details Defined in Data.Interpolation Methods parseTemplateValue :: TemplateValue -> Maybe Int Source #
FromTemplateValue String Source #
Instance details Defined in Data.Interpolation Methods parseTemplateValue :: TemplateValue -> Maybe String Source #
FromTemplateValue Text Source #
Instance details Defined in Data.Interpolation Methods parseTemplateValue :: TemplateValue -> Maybe Text Source #

class ToTemplateValue a where Source #

A class for showing environment variable values, which should only be defined on primitives. Similar to Show except that for text-type values it should use identity.

Methods

toTemplateValue :: a -> TemplateValue Source #

Instances

ToTemplateValue Bool Source #
Instance details Defined in Data.Interpolation Methods toTemplateValue :: Bool -> TemplateValue Source #
ToTemplateValue Int Source #
Instance details Defined in Data.Interpolation Methods toTemplateValue :: Int -> TemplateValue Source #
ToTemplateValue String Source #
Instance details Defined in Data.Interpolation Methods toTemplateValue :: String -> TemplateValue Source #
ToTemplateValue Text Source #
Instance details Defined in Data.Interpolation Methods toTemplateValue :: Text -> TemplateValue Source #

newtype Interpolator templates identities Source #

Constructors

Interpolator
Fields runInterpolator :: templates -> Reader InterpolationContext (Validation [InterpolationFailure] identities)

Instances

Profunctor Interpolator Source #
Instance details Defined in Data.Interpolation Methods dimap :: (a -> b) -> (c -> d) -> Interpolator b c -> Interpolator a d # lmap :: (a -> b) -> Interpolator b c -> Interpolator a c # rmap :: (b -> c) -> Interpolator a b -> Interpolator a c # (#.) :: Coercible c b => q b c -> Interpolator a b -> Interpolator a c # (.#) :: Coercible b a => Interpolator b c -> q a b -> Interpolator a c #
ProductProfunctor Interpolator Source #
Instance details Defined in Data.Interpolation Methods purePP :: b -> Interpolator a b # (**) :: Interpolator a (b -> c) -> Interpolator a b -> Interpolator a c # empty :: Interpolator () () # (*!) :: Interpolator a b -> Interpolator a' b' -> Interpolator (a, a') (b, b') #
SumProfunctor Interpolator Source #
Instance details Defined in Data.Interpolation Methods (+++!) :: Interpolator a b -> Interpolator a' b' -> Interpolator (Either a a') (Either b b') #
Default Interpolator a a Source #	Pure transformation for the identity interpolation. FIXME this is too clunky for overlapping instances, define an auxiliary class (or type) for IdentityInterpolation.
Instance details Defined in Data.Interpolation Methods def :: Interpolator a a #
FromTemplateValue a => Default Interpolator (Uninterpolated a) a Source #	When we can parse template values, we can interpolate from the template.
Instance details Defined in Data.Interpolation Methods def :: Interpolator (Uninterpolated a) a #
Default Interpolator a b => Default Interpolator [a] [b] Source #
Instance details Defined in Data.Interpolation Methods def :: Interpolator [a] [b] #
Default Interpolator a b => Default Interpolator (Maybe a) (Maybe b) Source #
Instance details Defined in Data.Interpolation Methods def :: Interpolator (Maybe a) (Maybe b) #
(Default Interpolator a b, Ord a, Ord b) => Default Interpolator (Set a) (Set b) Source #
Instance details Defined in Data.Interpolation Methods def :: Interpolator (Set a) (Set b) #
Default Interpolator a b => Default Interpolator (Map k a) (Map k b) Source #
Instance details Defined in Data.Interpolation Methods def :: Interpolator (Map k a) (Map k b) #
Functor (Interpolator templates) Source #
Instance details Defined in Data.Interpolation Methods fmap :: (a -> b) -> Interpolator templates a -> Interpolator templates b # (<$) :: a -> Interpolator templates b -> Interpolator templates a #
Applicative (Interpolator templates) Source #
Instance details Defined in Data.Interpolation Methods pure :: a -> Interpolator templates a # (<>) :: Interpolator templates (a -> b) -> Interpolator templates a -> Interpolator templates b # liftA2 :: (a -> b -> c) -> Interpolator templates a -> Interpolator templates b -> Interpolator templates c # (>) :: Interpolator templates a -> Interpolator templates b -> Interpolator templates b # (<*) :: Interpolator templates a -> Interpolator templates b -> Interpolator templates a #

runTemplate :: FromTemplateValue a => Interpolator (Uninterpolated a) a Source #

Run a template using the interpolation context and failing if the value is not found or not readable.

mkInterpolationContext :: MonadIO m => m InterpolationContext Source #

interpolateWithContext :: (Default Interpolator templates identities, MonadIO m) => templates -> m (Either [InterpolationFailure] identities) Source #

interpolateWithContextExplicit :: MonadIO m => Interpolator templates identities -> templates -> m (Either [InterpolationFailure] identities) Source #

maybeGen :: Gen a -> Gen (Maybe a) Source #

noEnv :: Gen Text Source #

varNameAllowed :: Gen Text Source #

Key	Shortcut
s	Open this search box
esc	Close this search box
↓,ctrl + j	Move down in search results
↑,ctrl + k	Move up in search results
↵	Go to active search result