Snap.Snaplet.Redson.Snapless.Metamodel

Model definition parser, served model routines.

Documentation

type ModelName = ByteString

type FieldName = ByteString

type FieldValue = ByteString

type FieldIndex = (FieldName, Bool)

Name of indexed field and collation flag.

type Commit = Map FieldName FieldValue

List of field key-value pairs.

Suitable for using with hmset.

data Permissions

Field permissions property.

Constructors

Roles [ByteString]

Everyone

Nobody

Instances

Show Permissions

ToJSON Permissions

FromJSON Permissions

data FieldTargets

Constructors

Fields [FieldName]

AllFields

NoneFields

Instances

Show FieldTargets

FromJSON FieldTargets

type FieldMeta = Map FieldName Value

Map of field annotations which are transparently handled by server without any logic.

data Field

Form field object.

Constructors

Field

Fields

name :: FieldName

fieldType :: ByteString

index :: Bool

indexCollate :: Bool

groupName :: Maybe ByteString

meta :: Maybe FieldMeta

_canRead :: Permissions

_canWrite :: Permissions

Instances

Show Field

ToJSON Field

FromJSON Field

canWrite :: Lens Field Permissions

canRead :: Lens Field Permissions

data Application

A list of properties to be applied to named fields.

Constructors

Application

Fields

targets :: FieldTargets

apMeta :: Maybe FieldMeta

_apRead :: Maybe Permissions

_apWrite :: Maybe Permissions

Instances

Show Application

FromJSON Application

apWrite :: Lens Application (Maybe Permissions)

apRead :: Lens Application (Maybe Permissions)

data Model

Model describes fields and permissions.

Models are built from JSON definitions (using FromJSON instance for Model) with further group splicing (spliceGroups), applications (doApplications) and index caching (cacheIndices).

Constructors

Model

Fields

modelName :: ModelName

title :: ByteString

fields :: [Field]

applications :: [Application]

_canCreateM :: Permissions

_canReadM :: Permissions

_canUpdateM :: Permissions

_canDeleteM :: Permissions

indices :: [FieldIndex]

Cached list of index fields.

Instances

Show Model

ToJSON Model

FromJSON Model

canDeleteM :: Lens Model Permissions

canUpdateM :: Lens Model Permissions

canReadM :: Lens Model Permissions

canCreateM :: Lens Model Permissions

defaultFieldType :: ByteString

Used when field type is not specified in model description.

type Groups = Map ByteString [Field]

A named group of fields.

groupFieldName

Arguments

:: FieldName

Name of field which is spliced into group

-> FieldName

Name of group field

-> FieldName

Build new name f_gK for every field of group g to which field f is spliced into.

spliceGroups :: Groups -> Model -> Model

Replace all model fields having groupName annotation with actual group fields.

doApplications :: Model -> Model

Perform all applications in model.

cacheIndices :: Model -> Model

Set indices field of model to list of FieldIndexes