Safe Haskell	None
Language	GHC2024

Napkin.Spec.Yaml.Interpret

Synopsis

newtype YamlParseError = YamlParseError Text
type LoadYamlConstraint backend = (SpecBackend backend, Default (DbBackendOptions backend), Show (DbBackendOptions backend), FromJSON (DbBackendOptions backend), Eq (BackendTableMeta backend), Show (BackendTableMeta backend), RunBackendEffect backend, RunBackendConn backend, DumpBackendRequirements backend, HasBackendQueryStats backend, WebBackendQueryStats backend, BackendMetaConstraints backend, SqlConcat backend, InterpreterBackendSupport backend, Typeable backend, NapkinParserDialect backend, BackendName backend, BackendPrograms backend, BackendPreprocessors backend)
data YamlLoadResult b = YamlLoadResult {
- sourceMaps :: YamlSourceMaps
- yamlSpec :: YamlSpec b
- rawYaml :: Value
}
type YamlLoadAction (m :: k -> Type) (a :: k) = forall b. LoadYamlConstraint b => YamlLoadResult b -> m a
loadYamlFile' :: MonadIO m => SpecFilesWithOverrides -> YamlSourceMaps -> YamlLoadAction m a -> m (Either NapkinError a)
loadYamlFile :: SpecFilesWithOverrides -> YamlLoadAction NapkinExceptM a -> NapkinExceptM a
data YamlBackend = LoadYamlConstraint b => YamlBackend (Proxy b)
loadYaml' :: Monad m => Value -> Maybe Patch -> YamlSourceMaps -> YamlLoadAction m a -> m (Either Text a)
loadHaskellModules :: forall bk m. MonadIO m => InterpreterInstance -> YamlSpec bk -> m (Either HaskellEvaluationError ())
interpretTables :: forall bk (m :: Type -> Type). (MonadIO m, Typeable bk) => StaticDictionaryLookup bk -> InterpreterInstance -> YamlSourceMaps -> YamlSpec bk -> ExceptT HaskellEvaluationError m (SpecProgramArguments, Spec bk ())
interpretHaskellSpec :: Typeable bk => StaticDictionaryLookup bk -> InterpreterInstance -> YamlSpec bk -> ExceptT HaskellEvaluationError (Spec bk) ()
interpretYamlToSpec :: Typeable b => StaticDictionaryLookup b -> RuntimeEnv -> YamlSourceMaps -> YamlSpec b -> SpecMetaArgs -> NapkinExceptM (RawInterpretedSpec b)
interpretYamlToSpec' :: Typeable b => StaticDictionaryLookup b -> RuntimeEnv -> YamlSourceMaps -> YamlSpec b -> SpecMetaArgs -> NapkinExceptM' YamlSpecInterpretError (RawInterpretedSpec b)
interpretTable :: forall bk (m :: Type -> Type). (MonadIO m, Typeable bk) => StaticDictionaryLookup bk -> InterpreterInstance -> YamlSourceMaps -> SpecTableName -> YamlTableSpec bk -> ExceptT HaskellEvaluationError m (SpecProgramArguments, Spec bk ())
interpretSpec :: Typeable b => LookupFunction (Spec b ()) -> InterpreterInstance -> Typed (Spec b ()) ModuleFunction -> ExceptT HaskellEvaluationError (Spec b) ()
evalHsFun :: forall (m :: Type -> Type) b. (MonadIO m, Typeable b) => LookupFunction b -> InterpreterInstance -> Typed b ModuleFunction -> ExceptT HaskellEvaluationError m b
specMerge :: Value -> Value -> Value

Documentation

newtype YamlParseError #

Constructors

YamlParseError Text

Instances

Instances details

Exception YamlParseError #
Instance details Defined in Napkin.Spec.Yaml.Interpret Methods toException :: YamlParseError -> SomeException # fromException :: SomeException -> Maybe YamlParseError # displayException :: YamlParseError -> String # backtraceDesired :: YamlParseError -> Bool #
Show YamlParseError #
Instance details Defined in Napkin.Spec.Yaml.Interpret Methods showsPrec :: Int -> YamlParseError -> ShowS # show :: YamlParseError -> String # showList :: [YamlParseError] -> ShowS #
Eq YamlParseError #
Instance details Defined in Napkin.Spec.Yaml.Interpret Methods (==) :: YamlParseError -> YamlParseError -> Bool # (/=) :: YamlParseError -> YamlParseError -> Bool #

type LoadYamlConstraint backend = (SpecBackend backend, Default (DbBackendOptions backend), Show (DbBackendOptions backend), FromJSON (DbBackendOptions backend), Eq (BackendTableMeta backend), Show (BackendTableMeta backend), RunBackendEffect backend, RunBackendConn backend, DumpBackendRequirements backend, HasBackendQueryStats backend, WebBackendQueryStats backend, BackendMetaConstraints backend, SqlConcat backend, InterpreterBackendSupport backend, Typeable backend, NapkinParserDialect backend, BackendName backend, BackendPrograms backend, BackendPreprocessors backend) #

data YamlLoadResult b #

Constructors

YamlLoadResult
Fields sourceMaps :: YamlSourceMaps yamlSpec :: YamlSpec b rawYaml :: Value

Instances

Instances details

Generic (YamlLoadResult b) #

Instance details

Defined in Napkin.Spec.Yaml.Interpret

Associated Types

type Rep (YamlLoadResult b)

Instance details

Defined in Napkin.Spec.Yaml.Interpret

type Rep (YamlLoadResult b) = D1 ('MetaData "YamlLoadResult" "Napkin.Spec.Yaml.Interpret" "napkin-runtime-2.0.0-Erk85iQPgMrCSpa03PiHz5" 'False) (C1 ('MetaCons "YamlLoadResult" 'PrefixI 'True) (S1 ('MetaSel ('Just "sourceMaps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 YamlSourceMaps) :*: (S1 ('MetaSel ('Just "yamlSpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (YamlSpec b)) :*: S1 ('MetaSel ('Just "rawYaml") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Value))))

Methods

from :: YamlLoadResult b -> Rep (YamlLoadResult b) x #

to :: Rep (YamlLoadResult b) x -> YamlLoadResult b #

type Rep (YamlLoadResult b) #

Instance details

Defined in Napkin.Spec.Yaml.Interpret

type Rep (YamlLoadResult b) = D1 ('MetaData "YamlLoadResult" "Napkin.Spec.Yaml.Interpret" "napkin-runtime-2.0.0-Erk85iQPgMrCSpa03PiHz5" 'False) (C1 ('MetaCons "YamlLoadResult" 'PrefixI 'True) (S1 ('MetaSel ('Just "sourceMaps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 YamlSourceMaps) :*: (S1 ('MetaSel ('Just "yamlSpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (YamlSpec b)) :*: S1 ('MetaSel ('Just "rawYaml") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Value))))

type YamlLoadAction (m :: k -> Type) (a :: k) = forall b. LoadYamlConstraint b => YamlLoadResult b -> m a #

loadYamlFile' :: MonadIO m => SpecFilesWithOverrides -> YamlSourceMaps -> YamlLoadAction m a -> m (Either NapkinError a) #

loadYamlFile :: SpecFilesWithOverrides -> YamlLoadAction NapkinExceptM a -> NapkinExceptM a #

data YamlBackend #

Constructors

LoadYamlConstraint b => YamlBackend (Proxy b)

Instances

Instances details

FromJSON YamlBackend #
Instance details Defined in Napkin.Spec.Yaml.Interpret Methods parseJSON :: Value -> Parser YamlBackend # parseJSONList :: Value -> Parser [YamlBackend] # omittedField :: Maybe YamlBackend #

loadYaml' :: Monad m => Value -> Maybe Patch -> YamlSourceMaps -> YamlLoadAction m a -> m (Either Text a) #

loadHaskellModules :: forall bk m. MonadIO m => InterpreterInstance -> YamlSpec bk -> m (Either HaskellEvaluationError ()) #

The main entry point interpreting a given YAML spec file as a Spec value ready to run via executeSpec

This function is intended to unroll/interpret as much as possible to get the spec in its final state ready to be actually run.

interpretTables :: forall bk (m :: Type -> Type). (MonadIO m, Typeable bk) => StaticDictionaryLookup bk -> InterpreterInstance -> YamlSourceMaps -> YamlSpec bk -> ExceptT HaskellEvaluationError m (SpecProgramArguments, Spec bk ()) #

interpretHaskellSpec :: Typeable bk => StaticDictionaryLookup bk -> InterpreterInstance -> YamlSpec bk -> ExceptT HaskellEvaluationError (Spec bk) () #

interpretYamlToSpec :: Typeable b => StaticDictionaryLookup b -> RuntimeEnv -> YamlSourceMaps -> YamlSpec b -> SpecMetaArgs -> NapkinExceptM (RawInterpretedSpec b) #

interpretYamlToSpec' :: Typeable b => StaticDictionaryLookup b -> RuntimeEnv -> YamlSourceMaps -> YamlSpec b -> SpecMetaArgs -> NapkinExceptM' YamlSpecInterpretError (RawInterpretedSpec b) #

interpretTable :: forall bk (m :: Type -> Type). (MonadIO m, Typeable bk) => StaticDictionaryLookup bk -> InterpreterInstance -> YamlSourceMaps -> SpecTableName -> YamlTableSpec bk -> ExceptT HaskellEvaluationError m (SpecProgramArguments, Spec bk ()) #

Main entry point for fully interpreting a given table's entry in the YAML file.

interpretSpec :: Typeable b => LookupFunction (Spec b ()) -> InterpreterInstance -> Typed (Spec b ()) ModuleFunction -> ExceptT HaskellEvaluationError (Spec b) () #

evalHsFun :: forall (m :: Type -> Type) b. (MonadIO m, Typeable b) => LookupFunction b -> InterpreterInstance -> Typed b ModuleFunction -> ExceptT HaskellEvaluationError m b #

specMerge :: Value -> Value -> Value #