inspecstyle 0.1.3 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (59) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +2 -2
  3. data/README.md +37 -0
  4. data/config/default.yml +95 -2
  5. data/doc/RuboCop.html +3 -3
  6. data/doc/RuboCop/Cop.html +3 -3
  7. data/doc/RuboCop/Cop/InSpecStyle.html +4 -4
  8. data/doc/RuboCop/Cop/InSpecStyle/Apache.html +306 -0
  9. data/doc/RuboCop/Cop/InSpecStyle/AwsIamUserProperty.html +358 -0
  10. data/doc/RuboCop/Cop/InSpecStyle/AzureGenericResource.html +6 -5
  11. data/doc/RuboCop/Cop/InSpecStyle/DeprecatedAttributes.html +3 -2
  12. data/doc/RuboCop/Cop/InSpecStyle/DeprecatedAttributes1.html +311 -0
  13. data/doc/RuboCop/Cop/InSpecStyle/FileBeMounted.html +250 -0
  14. data/doc/RuboCop/Cop/InSpecStyle/FileSize.html +315 -0
  15. data/doc/RuboCop/Cop/InSpecStyle/HostProto.html +315 -0
  16. data/doc/RuboCop/Cop/InSpecStyle/IisWebsite.html +294 -0
  17. data/doc/RuboCop/Cop/InSpecStyle/LinuxKernelParameter.html +296 -0
  18. data/doc/RuboCop/Cop/InSpecStyle/MSSQLSessionPass.html +319 -0
  19. data/doc/RuboCop/Cop/InSpecStyle/OracleDbSessionPass.html +319 -0
  20. data/doc/RuboCop/Cop/InSpecStyle/PPAResource.html +294 -0
  21. data/doc/RuboCop/Cop/InSpecStyle/ProcessesList.html +315 -0
  22. data/doc/RuboCop/Cop/InSpecStyle/ScriptResource.html +298 -0
  23. data/doc/RuboCop/Cop/InSpecStyle/ShadowProperties.html +334 -0
  24. data/doc/RuboCop/Cop/InSpecStyle/UsersResourceMatchers.html +357 -0
  25. data/doc/RuboCop/Cop/InSpecStyle/WindowsRegistryKey.html +294 -0
  26. data/doc/RuboCop/Cop/InSpecStyle/WmiWmisClass.html +294 -0
  27. data/doc/RuboCop/InSpecStyle.html +2 -2
  28. data/doc/RuboCop/InSpecStyle/Error.html +1 -1
  29. data/doc/RuboCop/InSpecStyle/Inject.html +1 -1
  30. data/doc/_index.html +181 -2
  31. data/doc/class_list.html +1 -1
  32. data/doc/file.README.html +24 -2
  33. data/doc/index.html +24 -2
  34. data/doc/method_list.html +254 -6
  35. data/doc/top-level-namespace.html +1 -1
  36. data/lib/rubocop/cop/inspecstyle/apache.rb +57 -0
  37. data/lib/rubocop/cop/inspecstyle/aws_iam_user_property.rb +96 -0
  38. data/lib/rubocop/cop/inspecstyle/azure_generic_resource.rb +2 -1
  39. data/lib/rubocop/cop/inspecstyle/deprecated_attributes.rb +2 -2
  40. data/lib/rubocop/cop/inspecstyle/deprecated_attributes1.rb +52 -0
  41. data/lib/rubocop/cop/inspecstyle/file_be_mounted.rb +65 -0
  42. data/lib/rubocop/cop/inspecstyle/file_size.rb +77 -0
  43. data/lib/rubocop/cop/inspecstyle/host_proto.rb +71 -0
  44. data/lib/rubocop/cop/inspecstyle/iis_website.rb +36 -0
  45. data/lib/rubocop/cop/inspecstyle/linux_kernel_parameter.rb +41 -0
  46. data/lib/rubocop/cop/inspecstyle/mssql_session_pass.rb +59 -0
  47. data/lib/rubocop/cop/inspecstyle/oracle_db_session_pass.rb +59 -0
  48. data/lib/rubocop/cop/inspecstyle/ppa_resource.rb +36 -0
  49. data/lib/rubocop/cop/inspecstyle/processes_list.rb +77 -0
  50. data/lib/rubocop/cop/inspecstyle/script_resource.rb +48 -0
  51. data/lib/rubocop/cop/inspecstyle/shadow_properties.rb +83 -0
  52. data/lib/rubocop/cop/inspecstyle/users_resource_matchers.rb +98 -0
  53. data/lib/rubocop/cop/inspecstyle/windows_registry_key.rb +36 -0
  54. data/lib/rubocop/cop/inspecstyle/wmi_wmis_class.rb +37 -0
  55. data/lib/rubocop/cop/inspecstyle_cops.rb +18 -2
  56. data/lib/rubocop/inspecstyle/version.rb +1 -1
  57. data/notes-for-development.md +10 -0
  58. metadata +36 -3
  59. data/lib/rubocop/cop/inspecstyle/first_cop.rb +0 -69
data/doc/RuboCop/Cop/InSpecStyle/ShadowProperties.html ADDED
@@ -0,0 +1,334 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: RuboCop::Cop::InSpecStyle::ShadowProperties
8
+
9
+ &mdash; Documentation by YARD 0.9.25
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../../css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="../../../css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "RuboCop::Cop::InSpecStyle::ShadowProperties";
19
+ relpath = '../../../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../../../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../../../_index.html">Index (S)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../../RuboCop.html" title="RuboCop (module)">RuboCop</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Cop.html" title="RuboCop::Cop (module)">Cop</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../InSpecStyle.html" title="RuboCop::Cop::InSpecStyle (module)">InSpecStyle</a></span></span>
41
+ &raquo;
42
+ <span class="title">ShadowProperties</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: RuboCop::Cop::InSpecStyle::ShadowProperties
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName"><span class='object_link'><a href="../../Cop.html" title="RuboCop::Cop (module)">RuboCop::Cop</a></span></span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next"><span class='object_link'><a href="../../Cop.html" title="RuboCop::Cop (module)">RuboCop::Cop</a></span></li>
78
+
79
+ <li class="next">RuboCop::Cop::InSpecStyle::ShadowProperties</li>
80
+
81
+ </ul>
82
+ <a href="#" class="inheritanceTree">show all</a>
83
+
84
+ </dd>
85
+ </dl>
86
+
87
+
88
+
89
+
90
+
91
+
92
+ <dl>
93
+ <dt>Includes:</dt>
94
+ <dd>RangeHelp</dd>
95
+ </dl>
96
+
97
+
98
+
99
+
100
+
101
+
102
+ <dl>
103
+ <dt>Defined in:</dt>
104
+ <dd>lib/rubocop/cop/inspecstyle/shadow_properties.rb</dd>
105
+ </dl>
106
+
107
+ </div>
108
+
109
+ <h2>Overview</h2><div class="docstring">
110
+ <div class="discussion">
111
+
112
+ <p>Shadow resource properties `user|password|last_change|expiry_date|line` is deprecated in favor of `users|passwords|last_changes|expiry_dates|lines`</p>
113
+
114
+
115
+ </div>
116
+ </div>
117
+ <div class="tags">
118
+
119
+ <div class="examples">
120
+ <p class="tag_title">Examples:</p>
121
+
122
+
123
+ <p class="example_title"><div class='inline'>
124
+ <p>EnforcedStyle: InSpecStyle (default)</p>
125
+ </div></p>
126
+
127
+ <pre class="example code"><code><span class='comment'># Use users instead
128
+ </span>
129
+ <span class='comment'># bad
130
+ </span><span class='id identifier rubyid_describe'>describe</span> <span class='id identifier rubyid_shadow'>shadow</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/etc/my-custom-place/shadow</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='kw'>do</span>
131
+ <span class='id identifier rubyid_its'>its</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>user</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_should'>should</span> <span class='id identifier rubyid_eq'>eq</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>user</span><span class='tstring_end'>&#39;</span></span> <span class='rbrace'>}</span>
132
+ <span class='kw'>end</span>
133
+
134
+ <span class='comment'># good
135
+ </span><span class='id identifier rubyid_describe'>describe</span> <span class='id identifier rubyid_shadow'>shadow</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/etc/my-custom-place/shadow</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='kw'>do</span>
136
+ <span class='id identifier rubyid_its'>its</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>users</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_should'>should</span> <span class='id identifier rubyid_eq'>eq</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>user</span><span class='tstring_end'>&#39;</span></span> <span class='rbrace'>}</span>
137
+ <span class='kw'>end</span></code></pre>
138
+
139
+ </div>
140
+
141
+
142
+ </div>
143
+
144
+ <h2>
145
+ Constant Summary
146
+ <small><a href="#" class="constants_summary_toggle">collapse</a></small>
147
+ </h2>
148
+
149
+ <dl class="constants">
150
+
151
+ <dt id="MSG-constant" class="">MSG =
152
+
153
+ </dt>
154
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Use `:%&lt;violation&gt;ss` instead of `:%&lt;violation&gt;s` as a property </span><span class='tstring_end'>&#39;</span></span> \
155
+ <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>for the `shadow` resource. This property will be removed in InSpec 5</span><span class='tstring_end'>&#39;</span></span></pre></dd>
156
+
157
+ </dl>
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+ <h2>
168
+ Instance Method Summary
169
+ <small><a href="#" class="summary_toggle">collapse</a></small>
170
+ </h2>
171
+
172
+ <ul class="summary">
173
+
174
+ <li class="public ">
175
+ <span class="summary_signature">
176
+
177
+ <a href="#autocorrect-instance_method" title="#autocorrect (instance method)">#<strong>autocorrect</strong>(node) &#x21d2; Object </a>
178
+
179
+
180
+
181
+ </span>
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+
190
+
191
+ <span class="summary_desc"><div class='inline'></div></span>
192
+
193
+ </li>
194
+
195
+
196
+ <li class="public ">
197
+ <span class="summary_signature">
198
+
199
+ <a href="#on_block-instance_method" title="#on_block (instance method)">#<strong>on_block</strong>(node) &#x21d2; Object </a>
200
+
201
+
202
+
203
+ </span>
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+
212
+
213
+ <span class="summary_desc"><div class='inline'></div></span>
214
+
215
+ </li>
216
+
217
+
218
+ </ul>
219
+
220
+
221
+
222
+
223
+
224
+
225
+
226
+
227
+
228
+
229
+
230
+ <div id="instance_method_details" class="method_details_list">
231
+ <h2>Instance Method Details</h2>
232
+
233
+
234
+ <div class="method_details first">
235
+ <h3 class="signature first" id="autocorrect-instance_method">
236
+
237
+ #<strong>autocorrect</strong>(node) &#x21d2; <tt>Object</tt>
238
+
239
+
240
+
241
+
242
+
243
+ </h3><table class="source_code">
244
+ <tr>
245
+ <td>
246
+ <pre class="lines">
247
+
248
+
249
+ 64
250
+ 65
251
+ 66
252
+ 67
253
+ 68</pre>
254
+ </td>
255
+ <td>
256
+ <pre class="code"><span class="info file"># File 'lib/rubocop/cop/inspecstyle/shadow_properties.rb', line 64</span>
257
+
258
+ <span class='kw'>def</span> <span class='id identifier rubyid_autocorrect'>autocorrect</span><span class='lparen'>(</span><span class='id identifier rubyid_node'>node</span><span class='rparen'>)</span>
259
+ <span class='id identifier rubyid_lambda'>lambda</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_corrector'>corrector</span><span class='op'>|</span>
260
+ <span class='id identifier rubyid_corrector'>corrector</span><span class='period'>.</span><span class='id identifier rubyid_insert_after'>insert_after</span><span class='lparen'>(</span><span class='id identifier rubyid_offense_range'>offense_range</span><span class='lparen'>(</span><span class='id identifier rubyid_node'>node</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>s</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
261
+ <span class='kw'>end</span>
262
+ <span class='kw'>end</span></pre>
263
+ </td>
264
+ </tr>
265
+ </table>
266
+ </div>
267
+
268
+ <div class="method_details ">
269
+ <h3 class="signature " id="on_block-instance_method">
270
+
271
+ #<strong>on_block</strong>(node) &#x21d2; <tt>Object</tt>
272
+
273
+
274
+
275
+
276
+
277
+ </h3><table class="source_code">
278
+ <tr>
279
+ <td>
280
+ <pre class="lines">
281
+
282
+
283
+ 48
284
+ 49
285
+ 50
286
+ 51
287
+ 52
288
+ 53
289
+ 54
290
+ 55
291
+ 56
292
+ 57
293
+ 58
294
+ 59
295
+ 60
296
+ 61
297
+ 62</pre>
298
+ </td>
299
+ <td>
300
+ <pre class="code"><span class="info file"># File 'lib/rubocop/cop/inspecstyle/shadow_properties.rb', line 48</span>
301
+
302
+ <span class='kw'>def</span> <span class='id identifier rubyid_on_block'>on_block</span><span class='lparen'>(</span><span class='id identifier rubyid_node'>node</span><span class='rparen'>)</span>
303
+ <span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_inside_shadow_spec?'>inside_shadow_spec?</span><span class='lparen'>(</span><span class='id identifier rubyid_node'>node</span><span class='rparen'>)</span>
304
+ <span class='id identifier rubyid_node'>node</span><span class='period'>.</span><span class='id identifier rubyid_descendants'>descendants</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_descendant'>descendant</span><span class='op'>|</span>
305
+ <span class='id identifier rubyid_deprecated_shadow_property?'>deprecated_shadow_property?</span><span class='lparen'>(</span><span class='id identifier rubyid_descendant'>descendant</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_violation'>violation</span><span class='op'>|</span>
306
+ <span class='id identifier rubyid_add_offense'>add_offense</span><span class='lparen'>(</span>
307
+ <span class='id identifier rubyid_descendant'>descendant</span><span class='comma'>,</span>
308
+ <span class='label'>location:</span> <span class='id identifier rubyid_offense_range'>offense_range</span><span class='lparen'>(</span><span class='id identifier rubyid_descendant'>descendant</span><span class='rparen'>)</span><span class='comma'>,</span>
309
+ <span class='label'>message:</span> <span class='id identifier rubyid_format'>format</span><span class='lparen'>(</span>
310
+ <span class='const'><span class='object_link'><a href="#MSG-constant" title="RuboCop::Cop::InSpecStyle::ShadowProperties::MSG (constant)">MSG</a></span></span><span class='comma'>,</span>
311
+ <span class='label'>violation:</span> <span class='id identifier rubyid_violation'>violation</span>
312
+ <span class='rparen'>)</span>
313
+ <span class='rparen'>)</span>
314
+ <span class='kw'>end</span>
315
+ <span class='kw'>end</span>
316
+ <span class='kw'>end</span></pre>
317
+ </td>
318
+ </tr>
319
+ </table>
320
+ </div>
321
+
322
+ </div>
323
+
324
+ </div>
325
+
326
+ <div id="footer">
327
+ Generated on Thu Jul 2 15:33:00 2020 by
328
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
329
+ 0.9.25 (ruby-2.6.6).
330
+ </div>
331
+
332
+ </div>
333
+ </body>
334
+ </html>
data/doc/RuboCop/Cop/InSpecStyle/UsersResourceMatchers.html ADDED
@@ -0,0 +1,357 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: RuboCop::Cop::InSpecStyle::UsersResourceMatchers
8
+
9
+ &mdash; Documentation by YARD 0.9.25
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../../css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="../../../css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "RuboCop::Cop::InSpecStyle::UsersResourceMatchers";
19
+ relpath = '../../../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../../../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../../../_index.html">Index (U)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../../RuboCop.html" title="RuboCop (module)">RuboCop</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Cop.html" title="RuboCop::Cop (module)">Cop</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../InSpecStyle.html" title="RuboCop::Cop::InSpecStyle (module)">InSpecStyle</a></span></span>
41
+ &raquo;
42
+ <span class="title">UsersResourceMatchers</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: RuboCop::Cop::InSpecStyle::UsersResourceMatchers
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName"><span class='object_link'><a href="../../Cop.html" title="RuboCop::Cop (module)">RuboCop::Cop</a></span></span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next"><span class='object_link'><a href="../../Cop.html" title="RuboCop::Cop (module)">RuboCop::Cop</a></span></li>
78
+
79
+ <li class="next">RuboCop::Cop::InSpecStyle::UsersResourceMatchers</li>
80
+
81
+ </ul>
82
+ <a href="#" class="inheritanceTree">show all</a>
83
+
84
+ </dd>
85
+ </dl>
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+ <dl>
98
+ <dt>Defined in:</dt>
99
+ <dd>lib/rubocop/cop/inspecstyle/users_resource_matchers.rb</dd>
100
+ </dl>
101
+
102
+ </div>
103
+
104
+ <h2>Overview</h2><div class="docstring">
105
+ <div class="discussion">
106
+
107
+ <p>Users resource deprecated matchers</p>
108
+
109
+
110
+ </div>
111
+ </div>
112
+ <div class="tags">
113
+
114
+ <div class="examples">
115
+ <p class="tag_title">Examples:</p>
116
+
117
+
118
+ <p class="example_title"><div class='inline'>
119
+ <p>EnforcedStyle: InSpecStyle (default)</p>
120
+ </div></p>
121
+
122
+ <pre class="example code"><code>
123
+ <span class='comment'># bad
124
+ </span><span class='id identifier rubyid_describe'>describe</span> <span class='id identifier rubyid_users'>users</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/etc/my-custom-place/users</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='kw'>do</span>
125
+ <span class='id identifier rubyid_its'>its</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>has_home_directory?</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_should'>should</span> <span class='id identifier rubyid_eq'>eq</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>foo</span><span class='tstring_end'>&#39;</span></span> <span class='rbrace'>}</span>
126
+ <span class='kw'>end</span>
127
+
128
+ <span class='comment'># good
129
+ </span><span class='id identifier rubyid_describe'>describe</span> <span class='id identifier rubyid_users'>users</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/etc/my-custom-place/users</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='kw'>do</span>
130
+ <span class='id identifier rubyid_its'>its</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>users</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_should'>should</span> <span class='id identifier rubyid_eq'>eq</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>foo</span><span class='tstring_end'>&#39;</span></span> <span class='rbrace'>}</span>
131
+ <span class='kw'>end</span></code></pre>
132
+
133
+ </div>
134
+
135
+
136
+ </div>
137
+
138
+ <h2>
139
+ Constant Summary
140
+ <small><a href="#" class="constants_summary_toggle">collapse</a></small>
141
+ </h2>
142
+
143
+ <dl class="constants">
144
+
145
+ <dt id="MSG-constant" class="">MSG =
146
+
147
+ </dt>
148
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Use `%&lt;solution&gt;s` instead of `%&lt;violation&gt;s` as a matcher </span><span class='tstring_end'>&#39;</span></span> \
149
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>for the `users` resource. \nThis matcher will be removed in InSpec 5</span><span class='tstring_end'>&quot;</span></span></pre></dd>
150
+
151
+ <dt id="MAP-constant" class="">MAP =
152
+
153
+ </dt>
154
+ <dd><pre class="code"><span class='lbrace'>{</span>
155
+ <span class='label'>has_home_directory?:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>its(&#39;home&#39;)</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
156
+ <span class='label'>has_login_shell?:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>its(&#39;shell&#39;)</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
157
+ <span class='label'>has_authorized_key?:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>another matcher</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
158
+ <span class='label'>maximum_days_between_password_change:</span> <span class='symbol'>:maxdays</span><span class='comma'>,</span>
159
+ <span class='label'>has_uid?:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>another matcher</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
160
+ <span class='label'>minimum_days_between_password_change:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>mindays</span><span class='tstring_end'>&quot;</span></span>
161
+ <span class='rbrace'>}</span></pre></dd>
162
+
163
+ </dl>
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+ <h2>
174
+ Instance Method Summary
175
+ <small><a href="#" class="summary_toggle">collapse</a></small>
176
+ </h2>
177
+
178
+ <ul class="summary">
179
+
180
+ <li class="public ">
181
+ <span class="summary_signature">
182
+
183
+ <a href="#autocorrect-instance_method" title="#autocorrect (instance method)">#<strong>autocorrect</strong>(node) &#x21d2; Object </a>
184
+
185
+
186
+
187
+ </span>
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+
196
+
197
+ <span class="summary_desc"><div class='inline'></div></span>
198
+
199
+ </li>
200
+
201
+
202
+ <li class="public ">
203
+ <span class="summary_signature">
204
+
205
+ <a href="#on_block-instance_method" title="#on_block (instance method)">#<strong>on_block</strong>(node) &#x21d2; Object </a>
206
+
207
+
208
+
209
+ </span>
210
+
211
+
212
+
213
+
214
+
215
+
216
+
217
+
218
+
219
+ <span class="summary_desc"><div class='inline'></div></span>
220
+
221
+ </li>
222
+
223
+
224
+ </ul>
225
+
226
+
227
+
228
+
229
+
230
+
231
+
232
+
233
+
234
+
235
+ <div id="instance_method_details" class="method_details_list">
236
+ <h2>Instance Method Details</h2>
237
+
238
+
239
+ <div class="method_details first">
240
+ <h3 class="signature first" id="autocorrect-instance_method">
241
+
242
+ #<strong>autocorrect</strong>(node) &#x21d2; <tt>Object</tt>
243
+
244
+
245
+
246
+
247
+
248
+ </h3><table class="source_code">
249
+ <tr>
250
+ <td>
251
+ <pre class="lines">
252
+
253
+
254
+ 72
255
+ 73
256
+ 74
257
+ 75
258
+ 76
259
+ 77
260
+ 78
261
+ 79
262
+ 80
263
+ 81
264
+ 82
265
+ 83
266
+ 84</pre>
267
+ </td>
268
+ <td>
269
+ <pre class="code"><span class="info file"># File 'lib/rubocop/cop/inspecstyle/users_resource_matchers.rb', line 72</span>
270
+
271
+ <span class='kw'>def</span> <span class='id identifier rubyid_autocorrect'>autocorrect</span><span class='lparen'>(</span><span class='id identifier rubyid_node'>node</span><span class='rparen'>)</span>
272
+ <span class='id identifier rubyid_lambda'>lambda</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_corrector'>corrector</span><span class='op'>|</span>
273
+ <span class='comment'># Only these two matchers are autocorrectable
274
+ </span> <span class='lbracket'>[</span>
275
+ <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>maximum_days_between_password_change</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
276
+ <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>minimum_days_between_password_change</span><span class='tstring_end'>&#39;</span></span>
277
+ <span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_violation'>violation</span><span class='op'>|</span>
278
+ <span class='kw'>if</span> <span class='id identifier rubyid_node'>node</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_violation'>violation</span><span class='rparen'>)</span>
279
+ <span class='id identifier rubyid_corrector'>corrector</span><span class='period'>.</span><span class='id identifier rubyid_replace'>replace</span><span class='lparen'>(</span><span class='id identifier rubyid_node'>node</span><span class='period'>.</span><span class='id identifier rubyid_loc'>loc</span><span class='period'>.</span><span class='id identifier rubyid_selector'>selector</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="#MAP-constant" title="RuboCop::Cop::InSpecStyle::UsersResourceMatchers::MAP (constant)">MAP</a></span></span><span class='lbracket'>[</span><span class='id identifier rubyid_violation'>violation</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rbracket'>]</span><span class='rparen'>)</span>
280
+ <span class='kw'>end</span>
281
+ <span class='kw'>end</span>
282
+ <span class='kw'>end</span>
283
+ <span class='kw'>end</span></pre>
284
+ </td>
285
+ </tr>
286
+ </table>
287
+ </div>
288
+
289
+ <div class="method_details ">
290
+ <h3 class="signature " id="on_block-instance_method">
291
+
292
+ #<strong>on_block</strong>(node) &#x21d2; <tt>Object</tt>
293
+
294
+
295
+
296
+
297
+
298
+ </h3><table class="source_code">
299
+ <tr>
300
+ <td>
301
+ <pre class="lines">
302
+
303
+
304
+ 55
305
+ 56
306
+ 57
307
+ 58
308
+ 59
309
+ 60
310
+ 61
311
+ 62
312
+ 63
313
+ 64
314
+ 65
315
+ 66
316
+ 67
317
+ 68
318
+ 69
319
+ 70</pre>
320
+ </td>
321
+ <td>
322
+ <pre class="code"><span class="info file"># File 'lib/rubocop/cop/inspecstyle/users_resource_matchers.rb', line 55</span>
323
+
324
+ <span class='kw'>def</span> <span class='id identifier rubyid_on_block'>on_block</span><span class='lparen'>(</span><span class='id identifier rubyid_node'>node</span><span class='rparen'>)</span>
325
+ <span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_inside_users_spec?'>inside_users_spec?</span><span class='lparen'>(</span><span class='id identifier rubyid_node'>node</span><span class='rparen'>)</span>
326
+ <span class='id identifier rubyid_node'>node</span><span class='period'>.</span><span class='id identifier rubyid_descendants'>descendants</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_descendant'>descendant</span><span class='op'>|</span>
327
+ <span class='id identifier rubyid_deprecated_users_matcher?'>deprecated_users_matcher?</span><span class='lparen'>(</span><span class='id identifier rubyid_descendant'>descendant</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_violation'>violation</span><span class='op'>|</span>
328
+ <span class='id identifier rubyid_add_offense'>add_offense</span><span class='lparen'>(</span>
329
+ <span class='id identifier rubyid_descendant'>descendant</span><span class='comma'>,</span>
330
+ <span class='label'>location:</span> <span class='id identifier rubyid_offense_range'>offense_range</span><span class='lparen'>(</span><span class='id identifier rubyid_descendant'>descendant</span><span class='rparen'>)</span><span class='comma'>,</span>
331
+ <span class='label'>message:</span> <span class='id identifier rubyid_format'>format</span><span class='lparen'>(</span>
332
+ <span class='const'><span class='object_link'><a href="#MSG-constant" title="RuboCop::Cop::InSpecStyle::UsersResourceMatchers::MSG (constant)">MSG</a></span></span><span class='comma'>,</span>
333
+ <span class='label'>violation:</span> <span class='id identifier rubyid_violation'>violation</span><span class='comma'>,</span>
334
+ <span class='label'>solution:</span> <span class='const'><span class='object_link'><a href="#MAP-constant" title="RuboCop::Cop::InSpecStyle::UsersResourceMatchers::MAP (constant)">MAP</a></span></span><span class='lbracket'>[</span><span class='id identifier rubyid_violation'>violation</span><span class='rbracket'>]</span>
335
+ <span class='rparen'>)</span>
336
+ <span class='rparen'>)</span>
337
+ <span class='kw'>end</span>
338
+ <span class='kw'>end</span>
339
+ <span class='kw'>end</span></pre>
340
+ </td>
341
+ </tr>
342
+ </table>
343
+ </div>
344
+
345
+ </div>
346
+
347
+ </div>
348
+
349
+ <div id="footer">
350
+ Generated on Thu Jul 2 15:33:01 2020 by
351
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
352
+ 0.9.25 (ruby-2.6.6).
353
+ </div>
354
+
355
+ </div>
356
+ </body>
357
+ </html>