Salak

Configuration Loader for Production in Haskell.

How to use this library

| This library default a standard configuration load process. It can load properties from CommandLine, Environment, `JSON value` and Yaml files. They all load to the same format SourcePack. Earler property source has higher order to load property. For example:

CommandLine:  --package.a.enabled=true
Environment: PACKAGE_A_ENABLED: false

lookup "package.a.enabled" properties => Just True

CommandLine has higher order then Environment, for the former load properties earler then later.

Usage:

data Config = Config
  { name :: Text
  , dir  :: Maybe Text
  , ext  :: Int
  } deriving (Eq, Show)

instance FromProp Config where
  fromProp = Config
    <$> "user"
    <*> "pwd"
    <*> "ext" .?= 1

main = do
  c :: Config <- defaultLoadSalak def $ require ""
  print c

λ> c
Config {name = "daniel", dir = Nothing, ext = 1}

Source

data Selector

Instances

Eq Selector

Defined in Salak.Types

Methods

(==) :: Selector -> Selector -> Bool

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

Show Selector

Defined in Salak.Types

Methods

showsPrec :: Int -> Selector -> ShowS

show :: Selector -> String

showList :: [Selector] -> ShowS

data SourcePack

Instances

Show SourcePack

Defined in Salak.Types

Methods

showsPrec :: Int -> SourcePack -> ShowS

show :: SourcePack -> String

showList :: [SourcePack] -> ShowS

FromProp a => IsString (Prop a)

Defined in Salak.Prop

Methods

fromString :: String -> Prop a

Monad m => HasSourcePack (ReaderT SourcePack m)

Defined in Salak

Methods

askSourcePack :: ReaderT SourcePack m SourcePack

type SourcePackT = StateT SourcePack

data Reload

Constructors

Reload

Fields

• sourceName :: Text
• reload :: Priority -> IO Source

Instances

Show Reload

Defined in Salak.Types

Methods

showsPrec :: Int -> Reload -> ShowS

show :: Reload -> String

showList :: [Reload] -> ShowS

load :: (Functor f, Foldable f) => Reload -> f a -> (Priority -> a -> (Text, Value)) -> SourcePack -> SourcePack

loadJSON :: Reload -> Value -> SourcePack -> SourcePack

loadYaml :: MonadIO m => FilePath -> SourcePackT m ()

loadEnv :: MonadIO m => SourcePackT m ()

Salak

defaultLoadSalak :: MonadIO m => PropConfig -> ReaderT SourcePack m a -> m a

loadSalak :: Monad m => ReaderT SourcePack m a -> SourcePackT m () -> m a

data PropConfig

Constructors

PropConfig

Fields

• configFileKey :: Maybe String
• commandLine :: ParseCommandLine

Instances

Default PropConfig

Defined in Salak

Methods

def :: PropConfig

class Monad m => HasSourcePack m where

Methods

askSourcePack :: m SourcePack

Instances

Monad m => HasSourcePack (ReaderT SourcePack m)

Defined in Salak

Methods

askSourcePack :: ReaderT SourcePack m SourcePack

fetch :: (HasSourcePack m, FromProp a) => Text -> m (Either String a)

require :: (HasSourcePack m, FromProp a) => Text -> m a

Utilities

data ReloadableSourcePack

runReloadable :: MonadIO m => SourcePack -> ReloadableSourcePackT m a -> m (a, IO (Bool, [String]))

type Prop a = ReaderT SourcePack PResult a

class FromProp a where

Minimal complete definition

Nothing

Methods

fromProp :: Prop a

fromProp :: (Generic a, GFromProp (Rep a)) => Prop a

Instances

FromProp Bool

Defined in Salak.Prop

Methods

fromProp :: Prop Bool

FromProp Double

Defined in Salak.Prop

Methods

fromProp :: Prop Double

FromProp Float

Defined in Salak.Prop

Methods

fromProp :: Prop Float

FromProp Int

Defined in Salak.Prop

Methods

fromProp :: Prop Int

FromProp Int8

Defined in Salak.Prop

Methods

fromProp :: Prop Int8

FromProp Int16

Defined in Salak.Prop

Methods

fromProp :: Prop Int16

FromProp Int32

Defined in Salak.Prop

Methods

fromProp :: Prop Int32

FromProp Int64

Defined in Salak.Prop

Methods

fromProp :: Prop Int64

FromProp Word

Defined in Salak.Prop

Methods

fromProp :: Prop Word

FromProp Word8

Defined in Salak.Prop

Methods

fromProp :: Prop Word8

FromProp Word16

Defined in Salak.Prop

Methods

fromProp :: Prop Word16

FromProp Word32

Defined in Salak.Prop

Methods

fromProp :: Prop Word32

FromProp Word64

Defined in Salak.Prop

Methods

fromProp :: Prop Word64

FromProp Scientific

Defined in Salak.Prop

Methods

fromProp :: Prop Scientific

FromProp Text

Defined in Salak.Prop

Methods

fromProp :: Prop Text

FromProp Text

Defined in Salak.Prop

Methods

fromProp :: Prop Text

FromProp String

Defined in Salak.Prop

Methods

fromProp :: Prop String

FromProp a => FromProp [a]

Defined in Salak.Prop

Methods

fromProp :: Prop [a]

FromProp a => FromProp (Maybe a)

Defined in Salak.Prop

Methods

fromProp :: Prop (Maybe a)

data PResult a

Constructors

O [Selector] a

N [Selector]

F [Selector] String

Instances

Monad PResult

Defined in Salak.Prop

Methods

(>>=) :: PResult a -> (a -> PResult b) -> PResult b

(>>) :: PResult a -> PResult b -> PResult b

return :: a -> PResult a

fail :: String -> PResult a

Functor PResult

Defined in Salak.Prop

Methods

fmap :: (a -> b) -> PResult a -> PResult b

(<$) :: a -> PResult b -> PResult a

Applicative PResult

Defined in Salak.Prop

Methods

pure :: a -> PResult a

(<*>) :: PResult (a -> b) -> PResult a -> PResult b

liftA2 :: (a -> b -> c) -> PResult a -> PResult b -> PResult c

(*>) :: PResult a -> PResult b -> PResult b

(<*) :: PResult a -> PResult b -> PResult a

Alternative PResult

Defined in Salak.Prop

Methods

empty :: PResult a

(<|>) :: PResult a -> PResult a -> PResult a

some :: PResult a -> PResult [a]

many :: PResult a -> PResult [a]

Eq a => Eq (PResult a)

Defined in Salak.Prop

Methods

(==) :: PResult a -> PResult a -> Bool

(/=) :: PResult a -> PResult a -> Bool

Show a => Show (PResult a)

Defined in Salak.Prop

Methods

showsPrec :: Int -> PResult a -> ShowS

show :: PResult a -> String

showList :: [PResult a] -> ShowS

FromProp a => IsString (Prop a)

Defined in Salak.Prop

Methods

fromString :: String -> Prop a

readPrimitive :: ([Selector] -> Value -> PResult a) -> Prop a

ReadPrimitive value

readSelect :: FromProp a => Text -> Prop a

Parse value

err :: String -> Prop a