-- Hoogle documentation, generated by Haddock -- See Hoogle, http://www.haskell.org/hoogle/ -- | Tools for specifying and parsing configurations -- -- Tools for specifying and parsing configurations -- -- This package provides a collection of utils on top of the packages -- optparse-applicative, aeson, and yaml for -- configuring libraries and applications in a convenient and composable -- way. -- -- The main features are -- --
    --
  1. configuration management through integration of command line -- option parsing and configuration files and
    2. --
  2. a Setup.hs file that generates a PkgInfo module -- for each component of a package that provides information about the -- package and the build.
    3. --
-- -- Documentation on how to use this package can be found in the -- README and in the API documentation of the modules -- Configuration.Utils and Configuration.Utils.Setup. @package configuration-tools @version 0.2.2 -- | This module contains a Setup.hs script that hooks into the -- cabal build process at the end of the configuration phase and -- generates a module with package information for each component of the -- cabal package. -- -- The modules are created in the autogen build directory where -- also the Path_ module is created by cabal's simple build -- setup. This is usually the directory ./dist/build/autogen. -- -- For a library component the module is named just PkgInfo. For -- all other components the module is named -- PkgInfo_COMPONENT_NAME where COMPONENT_NAME is the -- name of the component with - characters replaced by -- _. -- -- For instance, if a cabal package contains a library and an executable -- that is called my-app, the following modules are created: -- PkgInfo and PkgInfo_my_app. -- -- = Usage as Setup Script -- -- There are two ways how this module can be used: -- --
    --
  1. Copy the code of this module into a file called Setup.hs -- in the root directory of your package.
    2. --
  2. If the configuration-tools package is already installed in -- the system where the build is done, following code can be used as -- Setup.hs script:
    3. --
-- -- 
--   module Main (main) where
--   
--   import Configuration.Utils.Setup
--
-- -- With both methods the field Build-Type in the package -- description (cabal) file must be set to Custom: -- -- 
--   Build-Type: Custom
--
-- -- = Integration With Configuration.Utils -- -- You can integrate the information provided by the PkgInfo -- modules with the command line interface of an application by importing -- the respective module for the component and using the -- runWithPkgInfoConfiguration function from the module -- Configuration.Utils as show in the following example: -- -- 
--   {-# LANGUAGE OverloadedStrings #-}
--   {-# LANGUAGE FlexibleInstances #-}
--   
--   module Main
--   ( main
--   ) where
--   
--   import Configuration.Utils
--   import PkgInfo
--   
--   instance FromJSON (() -> ()) where parseJSON _ = pure id
--   
--   mainInfo :: ProgramInfo ()
--   mainInfo = programInfo "Hello World" (pure id) ()
--   
--   main :: IO ()
--   main = runWithPkgInfoConfiguration mainInfo pkgInfo . const $ putStrLn "hello world"
--
-- -- With that the resulting application supports the following additional -- command line options: -- -- module Configuration.Utils.Setup main :: IO () -- | This module provides a collection of utils on top of the packages -- optparse-applicative, aeson, and yaml, for configuring libraries and -- applications in a composable way. -- -- The main feature is the integration of command line option parsing and -- configuration files. -- -- The purpose is to make management of configurations easy by providing -- an idiomatic style of defining and deploying configurations. -- -- For each data type that is used as a configuration type the following -- must be provided: -- --
    --
  1. a default value,
    2. --
  2. a FromJSON instance that yields a function that takes a -- value and updates that value with the parsed values,
    3. --
  3. a ToJSON instance, and
    4. --
  4. an options parser that yields a function that takes a value and -- updates that value with the values provided as command line -- options.
    5. --
-- -- The module provides operators and functions that make the -- implmentation of these entities easy for the common case that the -- configurations are encoded mainly as nested records. -- -- The operators assume that lenses for the configuration record types -- are provided. -- -- An complete usage example can be found in the file -- example/Example.hs of the cabal package. module Configuration.Utils data ProgramInfo α -- | Smart constructor for ProgramInfo. -- -- piHelpHeader and piHelpFooter are set to Nothing. programInfo :: String -> MParser α -> α -> ProgramInfo α -- | Program Description piDescription :: Lens' (ProgramInfo α) String -- | Help header piHelpHeader :: Lens' (ProgramInfo α) (Maybe String) -- | Help footer piHelpFooter :: Lens' (ProgramInfo α) (Maybe String) -- | options parser for configuration (TODO consider using a typeclass for -- this) piOptionParser :: Lens' (ProgramInfo α) (MParser α) -- | default configuration piDefaultConfiguration :: Lens' (ProgramInfo α) α -- | Lens for simultaneous query and update of piOptionParser -- and piDefaultConfiguration. This supports to change the type of -- ProgramInfo with over and set. piOptionParserAndDefaultConfiguration :: Lens (ProgramInfo α) (ProgramInfo β) (MParser α, α) (MParser β, β) -- | Run an IO action with a configuration that is obtained by updating the -- given default configuration the values defined via command line -- arguments. -- -- In addition to the options defined by the given options parser the -- following options are recognized: -- -- runWithConfiguration :: (FromJSON (α -> α), ToJSON α) => ProgramInfo α -> (α -> IO ()) -> IO () -- | Information about the cabal package. The format is: -- -- 
--   (info message, detailed info message, version string, license text)
--
-- -- See the documentation of Configuration.Utils.Setup for a way -- how to generate this information automatically from the package -- description during the build process. type PkgInfo = (String, String, String, String) -- | Run an IO action with a configuration that is obtained by updating the -- given default configuration the values defined via command line -- arguments. -- -- In addition to the options defined by the given options parser the -- following options are recognized: -- -- runWithPkgInfoConfiguration :: (FromJSON (α -> α), ToJSON α) => ProgramInfo α -> PkgInfo -> (α -> IO ()) -> IO () -- | Type of option parsers that yield a modification function. type MParser α = Parser (α -> α) -- | An operator for applying a setter to an option parser that yields a -- value. -- -- Example usage: -- -- 
--   data Auth = Auth
--       { _user ∷ !String
--       , _pwd ∷ !String
--       }
--   
--   user ∷ Functor φ ⇒ (String → φ String) → Auth → φ Au user f s = (\u → s { _user = u }) <$> f (_user s)
--   pwd ∷ Functor φ ⇒ (String → φ String) → Auth → φ Au pwd f s = (\p → s { _pwd = p }) <$> f (_pwd s)
--   -- or with lenses and TemplateHaskell just:
--   -- $(makeLenses ''Auth)
--   
--   pAuth ∷ MParser Auth
--   pAuth = id
--      <$< user .:: strOption
--          × long "user"
--          ⊕ short 'u'        ⊕ help "user name"    <*< pwd .:: strOption
--          × long "pwd"
--          ⊕ help "password for user"
--
(.::) :: (Alternative φ, Applicative φ) => Lens' α β -> φ β -> φ (α -> α) -- | An operator for applying a setter to an option parser that yields a -- modification function. -- -- Example usage: -- -- 
--   data HttpURL = HttpURL
--       { _auth ∷ !Auth
--       , _domain ∷ !String
--       }
--   
--   auth ∷ Functor φ ⇒ (Auth → φ Auth) → HttpURL → φ HttpU auth f s = (\u → s { _auth = u }) <$> f (_auth s)
--   domain ∷ Functor φ ⇒ (String → φ String) → HttpURL → φ HttpU domain f s = (\u → s { _domain = u }) <$> f (_domain s)
--   path ∷ Functor φ ⇒ (String → φ String) → HttpURL → φ HttpU path f s = (\u → s { _path = u }) <$> f (_path s)
--   -- or with lenses and TemplateHaskell just:
--   -- $(makeLenses ''HttpURL)
--   
--   pHttpURL ∷ MParser HttpURL
--   pHttpURL = id
--       <$< auth %:: pAuth
--       <*< domain .:: strOption
--           × long "domain"
--           ⊕ short 'd'         ⊕ help "HTTP domain"
--
(%::) :: (Alternative φ, Applicative φ) => Lens' α β -> φ (β -> β) -> φ (α -> α) -- | A JSON Value parser for a property of a given Object -- that updates a setter with the parsed value. -- -- 
--   data Auth = Auth
--       { _userId ∷ !Int
--       , _pwd ∷ !String
--       }
--   
--   userId ∷ Functor φ ⇒ (Int → φ Int) → Auth → φ Au userId f s = (\u → s { _userId = u }) <$> f (_userId s)
--   pwd ∷ Functor φ ⇒ (String → φ String) → Auth → φ Au pwd f s = (\p → s { _pwd = p }) <$> f (_pwd s)
--   -- or with lenses and TemplateHaskell just:
--   -- $(makeLenses ''Auth)
--   
--   instance FromJSON (Auth → Auth) where     parseJSON = withObject "Auth" $ \o → id         <$< setProperty user "user" p o
--           <*< setProperty pwd "pwd" parseJSON o
--         where
--           p = withText "user" $ \case
--               "alice" → pure (0 ∷ Int)             "bob" → pure 1             e → faile $ "unrecognized user " ⊕ 
--
setProperty :: Lens' α β -> Text -> (Value -> Parser β) -> Object -> Parser (α -> α) -- | A variant of the setProperty that uses the default -- parseJSON method from the FromJSON instance to parse the -- value of the property. Its usage pattern mimics the usage pattern of -- the .: operator from the aeson library. -- -- 
--   data Auth = Auth
--       { _user ∷ !String
--       , _pwd ∷ !String
--       }
--   
--   user ∷ Functor φ ⇒ (String → φ String) → Auth → φ Au user f s = (\u → s { _user = u }) <$> f (_user s)
--   pwd ∷ Functor φ ⇒ (String → φ String) → Auth → φ Au pwd f s = (\p → s { _pwd = p }) <$> f (_pwd s)
--   -- or with lenses and TemplateHaskell just:
--   -- $(makeLenses ''Auth)
--   
--   instance FromJSON (Auth → Auth) where     parseJSON = withObject "Auth" $ \o → id         <$< user ..: "user" × o
--           <*< pwd ..: "pwd" × o
--
(..:) :: FromJSON β => Lens' α β -> Text -> Object -> Parser (α -> α) -- | A variant of the aeson operator .: that creates a parser that -- modifies a setter with a parsed function. -- -- 
--   data HttpURL = HttpURL
--       { _auth ∷ !Auth
--       , _domain ∷ !String
--       }
--   
--   auth ∷ Functor φ ⇒ (Auth → φ Auth) → HttpURL → φ HttpU auth f s = (\u → s { _auth = u }) <$> f (_auth s)
--   domain ∷ Functor φ ⇒ (String → φ String) → HttpURL → φ HttpU domain f s = (\u → s { _domain = u }) <$> f (_domain s)
--   path ∷ Functor φ ⇒ (String → φ String) → HttpURL → φ HttpU path f s = (\u → s { _path = u }) <$> f (_path s)
--   -- or with lenses and TemplateHaskell just:
--   -- $(makeLenses ''HttpURL)
--   
--   instance FromJSON (HttpURL → HttpURL) where     parseJSON = withObject "HttpURL" $ \o → id         <$< auth %.: "auth" × o
--           <*< domain ..: "domain" × o
--
(%.:) :: FromJSON (β -> β) => Lens' α β -> Text -> Object -> Parser (α -> α) -- | This operator is an alternative for $ with a higher precedence -- which makes it suitable for usage within Applicative style funtors -- without the need to add parenthesis. (%) :: (α -> β) -> α -> β -- | This operator is a UTF-8 version of % which is an alternative -- for $ with a higher precedence which makes it suitable for -- usage within Applicative style funtors without the need to add -- parenthesis. -- -- The hex value of the UTF-8 character × is 0x00d7. -- -- In VIM type: Ctrl-V u 00d7 -- -- You may also define a key binding by adding something like the -- following line to your vim configuration file: -- -- 
--   iabbrev <buffer> >< ×
--
(×) :: (α -> β) -> α -> β -- | Functional composition for applicative functors. (<*<) :: Applicative φ => φ (β -> γ) -> φ (α -> β) -> φ (α -> γ) -- | Functional composition for applicative functors with its arguments -- flipped. (>*>) :: Applicative φ => φ (α -> β) -> φ (β -> γ) -> φ (α -> γ) -- | Applicative functional composition between a pure function and an -- applicative function. (<$<) :: Functor φ => (β -> γ) -> φ (α -> β) -> φ (α -> γ) -- | Applicative functional composition between a pure function and an -- applicative function with its arguments flipped. (>$>) :: Functor φ => φ (α -> β) -> (β -> γ) -> φ (α -> γ) -- | Functional composition for applicative functors. -- -- This is a rather popular operator. Due to conflicts (for instance with -- the lens package) it may have to be imported qualified. -- | Deprecated: use <*< instead (<.>) :: Applicative φ => φ (β -> γ) -> φ (α -> β) -> φ (α -> γ) -- | For people who like nicely aligned code and do not mind messing with -- editor key-maps: here a version of <.> that uses a -- unicode symbol -- -- The hex value of the UTF-8 character ⊙ is 0x2299. -- -- A convenient VIM key-map is: -- -- 
--   iabbrev <buffer> ../ ⊙
--
-- | Deprecated: use <*< instead (⊙) :: Applicative φ => φ (β -> γ) -> φ (α -> β) -> φ (α -> γ) dropAndUncaml :: Int -> String -> String -- | This is the same type as the type from the lens library with the same -- name. type Lens' σ α = Lens σ σ α α -- | This is the same type as the type from the lens library with the same -- name. type Lens σ τ α β = Functor φ => (α -> φ β) -> σ -> φ τ instance (FromJSON (a -> a), FromJSON a) => FromJSON (Maybe a -> Maybe a) module Configuration.Utils.Http -- | In order to make TLS optional this type should be used wrapped into a -- Maybe. data HttpServiceTLSConfiguration hstcCertFile :: Lens' HttpServiceTLSConfiguration FilePath hstcKeyFile :: Lens' HttpServiceTLSConfiguration FilePath -- | We restrict services to use either HTTP or HTTPS but not both. -- -- TLS can be turned off explicitely in the configuration file by setting -- the respective section to null. It can not be turned on or -- off via command line options. But once it is turned on the values for -- the certificate and key file can be changed by command line options. data HttpServiceConfiguration hscHost :: Lens' HttpServiceConfiguration ByteString hscPort :: Lens' HttpServiceConfiguration Int hscUseTLS :: Lens' HttpServiceConfiguration (Maybe HttpServiceTLSConfiguration) defaultHttpServiceConfiguration :: HttpServiceConfiguration pHttpServiceConfiguration :: String -> MParser HttpServiceConfiguration data HttpClientConfiguration hccHost :: Lens' HttpClientConfiguration ByteString hccPort :: Lens' HttpClientConfiguration Int hccUseTLS :: Lens' HttpClientConfiguration Bool defaultHttpClientConfiguration :: HttpClientConfiguration pHttpClientConfiguration :: String -> MParser HttpClientConfiguration httpService2clientConfiguration :: HttpServiceConfiguration -> HttpClientConfiguration instance Show HttpServiceTLSConfiguration instance Read HttpServiceTLSConfiguration instance Eq HttpServiceTLSConfiguration instance Ord HttpServiceTLSConfiguration instance Show HttpServiceConfiguration instance Read HttpServiceConfiguration instance Eq HttpServiceConfiguration instance Ord HttpServiceConfiguration instance Show HttpClientConfiguration instance Read HttpClientConfiguration instance Eq HttpClientConfiguration instance Ord HttpClientConfiguration instance ToJSON HttpClientConfiguration instance FromJSON (HttpClientConfiguration -> HttpClientConfiguration) instance ToJSON HttpServiceConfiguration instance FromJSON (HttpServiceConfiguration -> HttpServiceConfiguration) instance ToJSON HttpServiceTLSConfiguration instance FromJSON HttpServiceTLSConfiguration instance FromJSON (HttpServiceTLSConfiguration -> HttpServiceTLSConfiguration)