Safe Haskell	None

Snap.Snaplet.Redson.Snapless.Metamodel

Description

Model definition parser, served model routines.

Synopsis

Documentation

type ModelName = ByteString Source

type FieldName = ByteString Source

type FieldValue = ByteString Source

type FieldIndex = (FieldName, Bool)Source

Name of indexed field and collation flag.

type Commit = Map FieldName FieldValue Source

List of field key-value pairs.

Suitable for using with hmset.

data Permissions Source

Field permissions property.

Constructors

Roles [ByteString]
Everyone
Nobody

Instances

Show Permissions
ToJSON Permissions
FromJSON Permissions

data FieldTargets Source

Constructors

Fields [FieldName]
AllFields
NoneFields

Instances

Show FieldTargets
FromJSON FieldTargets

type FieldMeta = Map FieldName Value Source

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

data Field Source

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 Source

canRead :: Lens Field Permissions Source

data Application Source

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)Source

apRead :: Lens Application (Maybe Permissions)Source

data Model Source

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 Source

canUpdateM :: Lens Model Permissions Source

canReadM :: Lens Model Permissions Source

canCreateM :: Lens Model Permissions Source

defaultFieldType :: ByteString Source

Used when field type is not specified in model description.

type Groups = Map ByteString [Field]Source

A named group of fields.

groupFieldName Source

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 Source

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

doApplications :: Model -> Model Source

Perform all applications in model.

cacheIndices :: Model -> Model Source

Set indices field of model to list of FieldIndexes