/
module.ex
263 lines (212 loc) · 6.29 KB
/
module.ex
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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
defmodule Credo.Code.Module do
@moduledoc """
This module provides helper functions to analyse modules, return the defined
funcions or module attributes.
"""
alias Credo.Code
alias Credo.Code.Block
alias Credo.Code.Name
@def_ops [:def, :defp, :defmacro]
@doc "Returns the list of aliases defined in a given module source code."
def aliases({:defmodule, _, _arguments} = ast) do
ast
|> Credo.Code.postwalk(&find_aliases/2)
|> Enum.uniq()
end
defp find_aliases({:alias, _, [{:__aliases__, _, mod_list}]} = ast, aliases) do
module_names =
mod_list
|> Name.full()
|> List.wrap()
{ast, aliases ++ module_names}
end
# Multi alias
defp find_aliases(
{:alias, _,
[
{{:., _, [{:__aliases__, _, mod_list}, :{}]}, _, multi_mod_list}
]} = ast,
aliases
) do
module_names =
Enum.map(multi_mod_list, fn tuple ->
Name.full([Name.full(mod_list), Name.full(tuple)])
end)
{ast, aliases ++ module_names}
end
defp find_aliases(ast, aliases) do
{ast, aliases}
end
@doc "Reads an attribute from a module's `ast`"
def attribute(ast, attr_name) do
case Code.postwalk(ast, &find_attribute(&1, &2, attr_name), {:error, nil}) do
{:ok, value} ->
value
error ->
error
end
end
defp find_attribute({:@, _meta, arguments} = ast, tuple, attribute_name) do
case List.first(arguments) do
{^attribute_name, _meta, [value]} ->
{:ok, value}
_ ->
{ast, tuple}
end
end
defp find_attribute(ast, tuple, _name) do
{ast, tuple}
end
@doc "Returns the function/macro count for the given module's AST"
def def_count(nil), do: 0
def def_count({:defmodule, _, _arguments} = ast) do
ast
|> Code.postwalk(&collect_defs/2)
|> Enum.count()
end
def defs(nil), do: []
def defs({:defmodule, _, _arguments} = ast) do
Code.postwalk(ast, &collect_defs/2)
end
@doc "Returns the arity of the given function definition `ast`"
for op <- @def_ops do
def def_arity({unquote(op) = op, _, [{:when, _, fun_ast}, _]}) do
def_arity({op, nil, fun_ast})
end
def def_arity({unquote(op), _, [{_fun_name, _, arguments}, _]})
when is_list(arguments) do
Enum.count(arguments)
end
def def_arity({unquote(op), _, [{_fun_name, _, _}, _]}), do: 0
end
def def_arity(_), do: nil
@doc "Returns the name of the function/macro defined in the given `ast`"
for op <- @def_ops do
def def_name({unquote(op) = op, _, [{:when, _, fun_ast}, _]}) do
def_name({op, nil, fun_ast})
end
def def_name({unquote(op), _, [{fun_name, _, _arguments}, _]})
when is_atom(fun_name) do
fun_name
end
end
def def_name(_), do: nil
@doc "Returns the {fun_name, op} tuple of the function/macro defined in the given `ast`"
for op <- @def_ops do
def def_name_with_op({unquote(op) = op, _, _} = ast) do
{def_name(ast), op}
end
def def_name_with_op({unquote(op) = op, _, _} = ast, arity) do
if def_arity(ast) == arity do
{def_name(ast), op}
else
nil
end
end
end
def def_name_with_op(_), do: nil
@doc "Returns the name of the functions/macros for the given module's `ast`"
def def_names(nil), do: []
def def_names({:defmodule, _, _arguments} = ast) do
ast
|> Code.postwalk(&collect_defs/2)
|> Enum.map(&def_name/1)
|> Enum.uniq()
end
@doc "Returns the name of the functions/macros for the given module's `ast`"
def def_names_with_op(nil), do: []
def def_names_with_op({:defmodule, _, _arguments} = ast) do
ast
|> Code.postwalk(&collect_defs/2)
|> Enum.map(&def_name_with_op/1)
|> Enum.uniq()
end
@doc "Returns the name of the functions/macros for the given module's `ast` if it has the given `arity`."
def def_names_with_op(nil, _arity), do: []
def def_names_with_op({:defmodule, _, _arguments} = ast, arity) do
ast
|> Code.postwalk(&collect_defs/2)
|> Enum.map(&def_name_with_op(&1, arity))
|> Enum.reject(&is_nil/1)
|> Enum.uniq()
end
for op <- @def_ops do
defp collect_defs({:@, _, [{unquote(op), _, arguments} = ast]}, defs)
when is_list(arguments) do
{ast, defs -- [ast]}
end
defp collect_defs({unquote(op), _, arguments} = ast, defs)
when is_list(arguments) do
{ast, defs ++ [ast]}
end
end
defp collect_defs(ast, defs) do
{ast, defs}
end
@doc "Returns the list of modules used in a given module source code."
def modules({:defmodule, _, _arguments} = ast) do
ast
|> Code.postwalk(&find_dependent_modules/2)
|> Enum.uniq()
end
# exclude module name
defp find_dependent_modules(
{:defmodule, _, [{:__aliases__, _, mod_list}, _do_block]} = ast,
modules
) do
module_names =
mod_list
|> Name.full()
|> List.wrap()
{ast, modules -- module_names}
end
# single alias
defp find_dependent_modules(
{:alias, _, [{:__aliases__, _, mod_list}]} = ast,
aliases
) do
module_names =
mod_list
|> Name.full()
|> List.wrap()
{ast, aliases -- module_names}
end
# multi alias
defp find_dependent_modules(
{:alias, _,
[
{{:., _, [{:__aliases__, _, mod_list}, :{}]}, _, multi_mod_list}
]} = ast,
modules
) do
module_names =
Enum.flat_map(multi_mod_list, fn tuple ->
[Name.full(mod_list), Name.full(tuple)]
end)
{ast, modules -- module_names}
end
defp find_dependent_modules({:__aliases__, _, mod_list} = ast, modules) do
module_names =
mod_list
|> Name.full()
|> List.wrap()
{ast, modules ++ module_names}
end
defp find_dependent_modules(ast, modules) do
{ast, modules}
end
@doc "Returns the name of a module's given ast node."
def name({:defmodule, _, [{:__aliases__, _, name_list}, _]}) do
Enum.join(name_list, ".")
end
def name(_), do: "<Unknown Module Name>"
# TODO: write unit test
def exception?({:defmodule, _, [{:__aliases__, _, _name_list}, arguments]}) do
arguments
|> Block.calls_in_do_block()
|> Enum.any?(&defexception?/1)
end
def exception?(_), do: nil
defp defexception?({:defexception, _, _}), do: true
defp defexception?(_), do: false
end