mods/tests/template.test.lua at main · BlueLua/mods · 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
local mods = require "mods"

local stringify = mods.stringify

local args_repr = mods.utils.args_repr
local template = mods.template
local fmt = string.format

describe("mods.template", function()
  -- stylua: ignore start
  local function name_func() return "Ada" end
  local function table_func() return { x = 1 } end
  local function nil_func() return nil end
  -- stylua: ignore end

  local tests
  local view = {
    achievement = "a new badge",
    count = 3,
    prize = "A free trip",
    user = {
      active = false,
      admin = true,
      name = "Ada",
      meta = { role = "Engineer" },
      name_func = name_func,
    },
    name_func = name_func,
  }

  -- stylua: ignore
  tests = {
    ---------template-------------------------|------------expected-------------
    -- Basic values
    { "{{prize}} awaits you!"                 , "A free trip awaits you!"      },
    { "You’ve unlocked {{achievement}}!"      , "You’ve unlocked a new badge!" },
    { "{{missing}}"                           , ""                             },
    { "{{missing}} just arrived! {{missing}}" , " just arrived! "              },
    { "{{prize}}{{achievement}}"              , "A free tripa new badge"       },
    { "{{ prize }} is great"                  , "A free trip is great"         },

    -- Lookup
    { "{{.}}"                                 , stringify(view)                },
    { "{{user}}"                              , stringify(view.user)           },
    { "{{user.name}}"                         , "Ada"                          },
    { "{{user.meta.role}}"                    , "Engineer"                     },
    { "{{user.missing}}"                      , ""                             },
    { "{{user.name_func}}"                    , "Ada"                          },

    -- Function values
    { "Hi {{name_func}}"                      , "Hi Ada"                       },

    -- Non-string values
    { "Count: {{count}}"                      , "Count: 3"                     },
    { "active: {{user.active}}"               , "active: false"                },
    { "admin: {{user.admin}}"                 , "admin: true"                  },
  }
  -- stylua: ignore end

  for i = 1, #tests do
    local tmpl, expected = unpack(tests[i] --[[@as {[1]:string, [2]:string}]], 1, 2)
    it(fmt("template(%q, {...}) returns correct result", tmpl), function()
      local res = template(tmpl, view)
      assert.are_equal(expected, res)
    end)
  end

  ------------------
  --- Edge cases ---
  ------------------

  -- stylua: ignore
  tests = {
    ---------template----|--------view---------|------expected-------
    { ""                 , view                , ""                 },
    { "{{ x"             , view                , "{{ x"             },
    { "y }}"             , view                , "y }}"             },
    { "{{...}}"          , view                , ""                 },
    { "{{..}}"           , view                , ""                 },
    { "{{   }}"          , view                , ""                 },
    { "{{}}"             , view                , ""                 },
    { "{{fn}}"           , { fn = nil_func }   , ""                 },
    { "{{fn}}"           , { fn = table_func } , stringify({ x = 1 }) },
    { "{{.name}}"        , view                , ""                 },
    { "{{user.}}"        , view                , ""                 },
    { "{{.user}}"        , view                , ""                 },
    { "{{user...}}"      , view                , ""                 },
    { "{{user.name}}"    , { user = "x" }      , ""                 },
    { "{{user..name}}"   , { user = "x" }      , ""                 },
    { "Empty {{}} tag"   , view                , "Empty  tag"       },
    { "Unclosed {{prize" , view                , "Unclosed {{prize" },
  }

  for i = 1, #tests do
    local tmpl, v, expected = unpack(tests[i] --[[@as {[1]:string, [2]:table, [3]:string}]], 1, 3)
    it(fmt("template(%q, %s) handles edge case", tmpl, stringify(v, { newline = "" })), function()
      local res = template(tmpl, v)
      assert.are_equal(expected, res)
    end)
  end

  -- stylua: ignore
  tests = {
    ---------params-------|------------------------------errmsg------------------------------
    {{ "{{name}}", nil   }, "bad argument #2 (table expected, got no value)"  },
    {{ "{{name}}", 123   }, "bad argument #2 (table expected, got number)"    },
    {{ "{{name}}", false }, "bad argument #2 (table expected, got boolean)"   },
    {{ nil       , {}    }, "bad argument #1 (string expected, got no value)" },
    {{ 123       , {}    }, "bad argument #1 (string expected, got number)"   },
    {{ false     , {}    }, "bad argument #1 (string expected, got boolean)"  },
  }

  for i = 1, #tests do
    local params, errmsg = unpack(tests[i] --[[@as {[1]:any[], [3]:string}]], 1, 2)
    it(fmt("template(%s) errors", args_repr(params)), function()
      assert.has_error(function()
        _ = template(unpack(params, 1, 2))
      end, errmsg)
    end)
  end
end)