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
|
--!A cross-platform build utility based on Lua
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
-- http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
--
-- Copyright (C) 2015-present, TBOOX Open Source Group.
--
-- @author ruki
-- @file api_checker.lua
--
-- imports
import("core.base.option")
import("core.base.hashset")
import("core.project.project")
import("..checker")
-- get the most probable value
function _get_most_probable_value(value, valueset)
local result
local mindist
for v in valueset:keys() do
local dist = value:levenshtein(v)
if not mindist or dist < mindist then
mindist = dist
result = v
end
end
return result
end
-- show result
function _show(apiname, value, target, opt)
opt = opt or {}
-- match level? verbose: note/warning/error, default: warning/error
local level = opt.level
if not option.get("verbose") and level == "note" then
return
end
-- get source information
local sourceinfo = target:sourceinfo(apiname, value) or {}
local sourcetips = sourceinfo.file or ""
if sourceinfo.line then
sourcetips = sourcetips .. ":" .. sourceinfo.line .. ": "
end
if #sourcetips == 0 then
sourcetips = string.format("target(%s)", target:name())
end
-- do show
local level_tips = "note"
if level == "warning" then
level_tips = "${color.warning}${text.warning}${clear}"
elseif level == "error" then
level_tips = "${color.error}${text.error}${clear}"
end
if apiname:endswith("s") then
apiname = apiname:sub(1, #apiname - 1)
end
_g.showed = _g.showed or {}
local showed = _g.showed
local infostr
if opt.showstr then
infostr = string.format("%s%s: %s", sourcetips, level_tips, opt.showstr)
else
infostr = string.format("%s%s: unknown %s value '%s'", sourcetips, level_tips, apiname, value)
end
if opt.valueset then
local probable_value = _get_most_probable_value(value, opt.valueset)
if probable_value then
infostr = string.format("%s, it may be '%s'", infostr, probable_value)
end
end
if not showed[infostr] then
cprint(infostr)
showed[infostr] = true
return true
end
end
-- check api configuration in targets
function check_targets(apiname, opt)
opt = opt or {}
local level = opt.level or "warning"
local valueset
if opt.values and type(opt.values) ~= "function" then
valueset = hashset.from(opt.values)
else
valueset = hashset.new()
end
for _, target in pairs(project.targets()) do
local target_valueset = valueset
if type(opt.values) == "function" then
local target_values = opt.values(target)
if target_values then
target_valueset = hashset.from(target_values)
end
end
local values = target:get(apiname)
for _, value in ipairs(values) do
if opt.check then
local ok, errors = opt.check(target, value)
if not ok then
local reported = _show(apiname, value, target, {showstr = errors, level = level})
if reported then
checker.update_stats(level)
end
end
elseif not target_valueset:has(value) then
local reported = _show(apiname, value, target, {valueset = target_valueset, level = level})
if reported then
checker.update_stats(level)
end
end
end
end
end
|
