Data.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 Properties. 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 FromProperties Config where
  fromProperties v = Config
        <$> v .?> "name"
        <*> v .?> "dir"
        <*> v .?> "ext" .?= 1

main = do
  p <- defaultPropertiesWithFile "salak.yml"
  let config  = p .>> "salak.config"  :: Config
      enabled = p .?> "salak.enabled" .|= True
  print config
  print enabled

Properties Loader

type LoadProperties = StateT Properties

Monad to Load Properties

Since: 0.2.2

runLoad :: Monad m => LoadProperties m a -> m Properties

Load Properties

Since: 0.2.2

askProperties :: Monad m => LoadProperties m Properties

Get current Properties

Since: 0.2.2

setValue :: Monad m => Text -> Property -> LoadProperties m ()

Set value to current properties

Since: 0.2.2

loadCommandLine :: MonadIO m => ParseCommandLine -> LoadProperties m ()

Load Properties from CommandLine

Since: 0.2.2

loadEnvironment :: MonadIO m => LoadProperties m ()

Load Properties from CommandLine

Since: 0.2.2

loadJSON :: MonadIO m => Value -> LoadProperties m ()

Load Properties from JSON Value

Since: 0.2.2

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

Load Properties from Yaml

Since: 0.2.2

loadYamlIfExists :: MonadIO m => Maybe FilePath -> LoadProperties m ()

Load Properties from Yaml if exists

Since: 0.2.2

Predefined Loaders

defaultProperties :: IO Properties

Initialize default properties from CommandLine and Environment. CommandLine use default parser.

defaultProperties' :: ParseCommandLine -> IO Properties

Initialize default properties from CommandLine and Environment.

defaultPropertiesWithFile

Arguments

:: FileName

specify default config file name, can reset by config "salak.config.name" from CommandLine or Environment.

-> IO Properties

Initialize default properties from CommandLine, Environment and Yaml files. All these configuration sources has orders, from highest order to lowest order:

1. CommandLine
2. Environment
3. Specified Yaml file(file in "salak.config.dir")
4. Yaml file in current directory
5. Yaml file in home directory

defaultPropertiesWithFile'

Arguments

:: FileName

specify default config file name, can reset by config "salak.config.name" from CommandLine or Environment.

-> ParseCommandLine

parser for command line

-> IO Properties

Initialize default properties from CommandLine, Environment and Yaml files. All these configuration sources has orders, from highest order to lowest order:

1. CommandLine
2. Environment
3. Specified Yaml file(file in "salak.config.dir")
4. Yaml file in current directory
5. Yaml file in home directory

empty :: Properties

The empty Properties

Lookup Properties

lookup :: FromProperties a => Text -> Properties -> Return a

Find Properties by key and convert to specific Haskell value.

toKeys :: Text -> [Key]

Split origin key by . to sub keys:

"salak.config.name" -> ["salak","config","name"]
"" -> []
"a..b" -> ["a","b"]

Types

data Property

A Property value represented as a Haskell value.

Constructors

PNum !Scientific

Numeric Property

PStr !Text

String Property

PBool !Bool

Bool Property

Instances

Eq Property

Defined in Data.Salak.Types

Methods

(==) :: Property -> Property -> Bool

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

Show Property

Defined in Data.Salak.Types

Methods

showsPrec :: Int -> Property -> ShowS

show :: Property -> String

showList :: [Property] -> ShowS

IsString Property

Defined in Data.Salak.Types

Methods

fromString :: String -> Property

FromProperties Property

Defined in Data.Salak.Types

Methods

fromProperties :: Properties -> Return Property

data Properties

A Property Container to hold all properties

Constructors

Properties [Property] [HashMap Key Properties]

Instances

Eq Properties

Defined in Data.Salak.Types

Methods

(==) :: Properties -> Properties -> Bool

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

Show Properties

Defined in Data.Salak.Types

Methods

showsPrec :: Int -> Properties -> ShowS

show :: Properties -> String

showList :: [Properties] -> ShowS

type Key = Text

Property key

class FromProperties a where

Convert Properties to Haskell value.

Methods

fromProperties :: Properties -> Return a

Instances

FromProperties Bool

Defined in Data.Salak.Types

Methods

fromProperties :: Properties -> Return Bool

FromProperties Char

Defined in Data.Salak.Types

Methods

fromProperties :: Properties -> Return Char

FromProperties Double

Defined in Data.Salak.Types

Methods

fromProperties :: Properties -> Return Double

FromProperties Float

Defined in Data.Salak.Types

Methods

fromProperties :: Properties -> Return Float

FromProperties Int

Defined in Data.Salak.Types

Methods

fromProperties :: Properties -> Return Int

FromProperties Int8

Defined in Data.Salak.Types

Methods

fromProperties :: Properties -> Return Int8

FromProperties Int16

Defined in Data.Salak.Types

Methods

fromProperties :: Properties -> Return Int16

FromProperties Int32

Defined in Data.Salak.Types

Methods

fromProperties :: Properties -> Return Int32

FromProperties Int64

Defined in Data.Salak.Types

Methods

fromProperties :: Properties -> Return Int64

FromProperties Word

Defined in Data.Salak.Types

Methods

fromProperties :: Properties -> Return Word

FromProperties Word8

Defined in Data.Salak.Types

Methods

fromProperties :: Properties -> Return Word8

FromProperties Word16

Defined in Data.Salak.Types

Methods

fromProperties :: Properties -> Return Word16

FromProperties Word32

Defined in Data.Salak.Types

Methods

fromProperties :: Properties -> Return Word32

FromProperties Word64

Defined in Data.Salak.Types

Methods

fromProperties :: Properties -> Return Word64

FromProperties Scientific

Defined in Data.Salak.Types

Methods

fromProperties :: Properties -> Return Scientific

FromProperties Text

Defined in Data.Salak.Types

Methods

fromProperties :: Properties -> Return Text

FromProperties String

Defined in Data.Salak.Types

Methods

fromProperties :: Properties -> Return String

FromProperties Property

Defined in Data.Salak.Types

Methods

fromProperties :: Properties -> Return Property

FromProperties a => FromProperties [a]

Defined in Data.Salak.Types

Methods

fromProperties :: Properties -> Return [a]

FromProperties a => FromProperties (Maybe a)

Defined in Data.Salak.Types

Methods

fromProperties :: Properties -> Return (Maybe a)

type Return = Either ErrResult

Return of FromProperties

Properties Loader Helper

insert :: [Key] -> Property -> Properties -> Properties

Insert simple Property into Properties by Key. If the key already have values then the new property will discard.

defaultParseCommandLine :: ParseCommandLine

Default command line parsers. Use format:

--KEY=VALUE

For example:

--salak.config.name=test.yml => ("salak.config.name", PStr "test.yml")

type ParseCommandLine = [String] -> IO [(String, Property)]

CommandLine parser. Parse command line into property key values.

type FileName = String

Yaml file name.

Operations

(.?>) :: FromProperties a => Properties -> Text -> Return a infixl 5

Find Properties by key and convert to specific Haskell value.

Since: 0.2.1

(.|=) :: Return a -> a -> a infixl 5

Get property or use default value if not found, but will throw exception if parse failed.

Since: 0.2.1

(.?=) :: Return a -> a -> Return a infixl 5

Use default value if Key not found

Since: 0.2.1

(.>>) :: FromProperties a => Properties -> Text -> a infixl 5

Find Properties by key and convert to specific Haskell value. Throw error if property not found or parse failed

Since: 0.2.1