summaryrefslogtreecommitdiff
path: root/support/digestif/digestif/Schema.lua
blob: 0ce26199a5b42f6c16f2a693beafe2e02c64bd03 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
--- A simple validation library, loosely inspired by JSON Schema

local Schema = {}
Schema.__index = Schema

local function is_schema(tbl)
  return getmetatable(tbl) == Schema
end
Schema.is_schema = is_schema

local validators, initializers = {}, {}

local function to_schema(tbl)
  if is_schema(tbl) then return tbl end
  for i = 1, #tbl do
    tbl[i] = to_schema(tbl[i])
  end
  -- local fields, items = tbl.fields, tbl.items
  -- if fields then
  --   for k, v in pairs(fields) do
  --     fields[k] = to_schema(v)
  --   end
  -- end
  -- if items then
  --   tbl.items = to_schema(items)
  -- end
  for k, fun in pairs(initializers) do
    if tbl[k] then tbl[k] = fun(tbl[k]) end
  end
  return setmetatable(tbl, Schema)
end
setmetatable(Schema, {__call = function(_, tbl) return to_schema(tbl) end})

local function msg_type(expect, got)
  return ("Type: expected %q, got %q"):format(expect, got)
end

local function msg_where(msg, loc_type, loc_name)
  return ("%s in %s %q"):format(msg, loc_type, loc_name)
end

initializers.items = to_schema
initializers.keys = to_schema
initializers.values = to_schema

function initializers.enum(tbl)
  local set = {}
  for i = 1, #tbl do
    set[tbl[i]] = true
  end
  return set
end

function initializers.fields(fields)
  for k, v in pairs(fields) do
    fields[k] = to_schema(v)
  end
  return fields
end

function validators.type(s, obj)
  local ok = (type(obj) == s)
  return ok, ok or msg_type(s, type(obj))
end

function validators.predicate(f, obj)
  return f(obj)
end

function validators.keys(schema, obj)
  if type(obj) ~= "table" then
    return false, msg_type("table", type(obj))
  end
  for k in pairs(obj) do
    local ok, msg = schema:validate(k)
    if not ok then
      return false, msg_where(msg, "key", k)
    end
  end
  return true
end

function validators.values(schema, obj)
  if type(obj) ~= "table" then
    return false, msg_type("table", type(obj))
  end
  for k, v in pairs(obj) do
    local ok, msg = schema:validate(v)
    if not ok then
      return false, msg_where(msg, "field", k)
    end
  end
  return true
end

function validators.fields(fields, obj)
  if type(obj) ~= "table" then
    return false, msg_type("table", type(obj))
  end
  for k, schema in pairs(fields) do
    local ok, msg = schema:validate(obj[k])
    if not ok then
      return false, msg_where(msg, "field", k)
    end
  end
  return true
end

function validators.items(schema, obj)
  if type(obj) ~= "table" then
    return false, msg_type("table", type(obj))
  end
  for i, item in ipairs(obj) do
    local ok, msg = schema:validate(item)
    if not ok then
      return false, msg_where(msg, "item", i)
    end
  end
  return true
end

function validators.enum(set, obj)
  local ok = set[obj]
  return ok, ok or ('Enum: %q not allowed'):format(obj)
end

function Schema:validate(obj)
  if self.optional and obj == nil then return true end
  for k, v in pairs(self) do
    local fun = validators[k]
    if fun then
      local ok, msg = fun(v, obj)
      if not ok then return false, msg end
    end
  end
  local len = #self
  if len > 0 then
    for i = 1, len do
      if self[i]:validate(obj) then break end
      if i == len then return false, "Alternatives: no match" end
    end
  end
  return true
end

function Schema:assert(obj)
  return assert(self:validate(obj))
end

function Schema:assert_fail(obj)
  assert(not self:validate(obj))
end

local schema_of_schema = Schema { -- luacheck: ignore schema_of_schema
  fields = {
    description = {
      type = "string",
      optional = true,
      description = "A docstring for the schema"
    },
    fields = {
      type = "table",
      values = {predicate = is_schema}
    },
    enum = {
      type = "table"
    },
    items = {
      predicate = is_schema
    },
    optional = {
      type = "boolean",
      optional = true,
      description = "Whether nil values are accepted"
    },
    predicate = {
      type = "function",
      optional = true,
      description = "A function to test on the object"
    },
    type = {
      type = "string",
      optional = true,
      description = "Check if the object is of a given type"
    },
  }
}

return Schema