sdktest/flags.lua at main · AshitaXI/sdktest · GitHub

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
--[[
 * Addons - Copyright (c) 2020 Ashita Development Team
 * Contact: https://www.ashitaxi.com/
 * Contact: https://discord.gg/Ashita
 *
 * This file is part of Ashita.
 *
 * Ashita is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Ashita is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Ashita.  If not, see <https://www.gnu.org/licenses/>.
--]]

--[[
Flags Helper Module

This is a simple module that helps with testing by holding flag state information.
Flags are used as simple true/false validations if a test has successfully done its purpose.

Registering flags should be done once, in a single block table in the format of:

    local flags = require('flags');

    local test_flags = {
        { name = 'some_flag_name_1', seen = false },
        { name = 'some_flag_name_2', seen = false },
        { name = 'some_flag_name_3', seen = false },
    };
    flags.register(test_flags);

While testing, a flag can be set to its true state by using:

    flags.set('some_flag_name_1');

You can also test if a flag is set via:

    local f = flags.is_set('some_flag_name_1');

Once all testing has completed, you can validate all your flags have been met/set via:

    flags.validate();

Note: Flag names are compared in a non-case sensitive manner!
--]]

require 'common';

local flags = T{};
flags.flags = T{};

--[[
* Registers a table of flags to be monitored.
*
* @param {table} tests - The table of tests to monitor.
--]]
function flags.register(tests)
    assert(type(tests) == 'table', 'invalid tests table');

    flags.flags = tests;
end

--[[
* Returns if the given flag exists in the current flags table.
*
* @param {string} name - The name of the flag to check.
* @return {bool} True if exists, false otherwise.
--]]
function flags.has(name)
    return flags.flags:any(function (v) return v.name:ieq(name); end);
end

--[[
* Returns if the given flag is set or not.
*
* @param {string} name - The name of the flag to check.
* @return {bool} True if set, false otherwise.
--]]
function flags.is_set(name)
    local flag = flags.flags:filteri(function (v) return v.name:ieq(name); end);
    if (#flag == 0) then
        error(('is_set requested an unregistered flag: %s'):fmt(name));
    end
    return flag:first().seen;
end

--[[
* Sets a flag to its true state.
*
* @param {string} name - The name of the flag to set.
--]]
function flags.set(name)
    if (not flags.flags:any(function (v) return v.name:ieq(name); end)) then
        error(('set requested an unregistered flag: %s'):fmt(name));
    end

    flags.flags:each(function (v)
        if (v.name:ieq(name)) then
            v.seen = true;
        end
    end);
end

--[[
* Asserts that all flags have met their true condition.
--]]
function flags.validate()
    local failed = T{};

    flags.flags:each(function (v)
        if (not v.seen) then
            failed:append(v.name);
        end
    end);

    assert(#failed == 0, ('failed to validate all flag conditions were met: %s'):fmt(failed:join(', ')));
end

-- Return the flags module table..
return flags;