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
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a3f8cb06cac386264652e1005a6b23e975308fbd1887b469f20f528bdbb88563
4
- data.tar.gz: 24503e8b29b8f1876682f39c07e0e53080b03be08a295c885e8c49485f8137ba
3
+ metadata.gz: 6a10b0d0e49d2184cf0d39a8bbad38dfe5080419679a0c27cc7b4d2d79a2b8af
4
+ data.tar.gz: 036ca77c943772b0244b8274ca387a0b1c8195dada9f4881aceeefb99d09c734
5
5
  SHA512:
6
- metadata.gz: 40a105f93aa52b6ce4b36d972bf24750150e2c0ee3399483f4ec1675f94573c4df821a61ee6fa10a4fcd161fa4a87d0efdb73084aafe424f32813cc56dd67ba3
7
- data.tar.gz: 59288f41742905617e98f76f53290110636bc05c9b7c328bad78c12f07f5b059a28769ab9a30f56986e92cca9b5d6248cb3cd790ddcc7655f86f72a53fe79f47
6
+ metadata.gz: f1eadb21266f0d8b8f534ef50efd8ad12c9deb6349ce5c7e6f6f6561472c651880e28f7ca1c5ad6c6daa3b01809277742b88be127237a4f874b76a8dbbad9df8
7
+ data.tar.gz: 6410d357bfdc98444d6aa8bcc34e0678c81053adf760cba5f59e0ebb313d771242e8ccfa175540e829043af0eac0444f478662b0578a539d86fd2a8b70b6ad59
@@ -1,13 +1,13 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- inspecstyle (0.1.2)
4
+ inspecstyle (0.2.0)
5
5
  rubocop
6
6
 
7
7
  GEM
8
8
  remote: https://rubygems.org/
9
9
  specs:
10
- ast (2.4.0)
10
+ ast (2.4.1)
11
11
  diff-lcs (1.3)
12
12
  minitest (5.14.1)
13
13
  parallel (1.19.1)
data/README.md CHANGED
@@ -1,3 +1,6 @@
1
+ # WIP: This gem is __not__ live, but we would love your help and input! Core issue here: https://github.com/inspec/inspec/issues/5095
2
+
3
+
1
4
  # InSpecStyle
2
5
 
3
6
  Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rubocop/inspecstyle`. To experiment with that code, run `bin/console` for an interactive prompt.
@@ -40,6 +43,40 @@ To only run these cops on your local rubocop run, execute:
40
43
  ## TODO:
41
44
 
42
45
  - Instead of referencing issues in the cops, point to a general `inspecstyle.guide`
46
+ - Known issue, resources that work on manual runs but not in `atom` package: [
47
+ - AzureGenericResource
48
+ ]
49
+ - Cop ideas:
50
+ ```
51
+ its('minimum_days_between_password_change') { should eq 0 } becomes 'mindays'
52
+ its('maximum_days_between_password_change') { should eq 0 } becomes 'maxdays'
53
+ Inspec.deprecate(:resource_user_serverspec_compat, "The user resource `has_home_directory?` matcher is deprecated. Please use `its('home')`.")
54
+ Inspec.deprecate(:resource_user_serverspec_compat, "The user resource `has_authorized_key?` matcher is deprecated. There is no currently implemented alternative")
55
+
56
+
57
+ shadow resource deprecations
58
+ (e.g.)
59
+ describe shadow('/etc/my-custom-place/shadow') do
60
+ its('count') { should eq 32 }
61
+ end
62
+
63
+ property deprecations:
64
+
65
+ user -> users
66
+ password -> passwords
67
+ last_change -> last_changes
68
+ expiry_date -> expiry_dates
69
+ lines (no replacement)
70
+
71
+ e.g.
72
+
73
+ sql = oracledb_session(user: 'my_user', pass: 'password')
74
+ describe sql.query(\"SELECT UPPER(VALUE) AS VALUE FROM V$PARAMETER WHERE UPPER(NAME)='AUDIT_SYS_OPERATIONS'\").row(0).column('value') do
75
+ its('value') { should eq 'TRUE' }
76
+ end
77
+
78
+ oracledb_session deprecated `pass`, use `password` instead
79
+ ```
43
80
 
44
81
  ## Development
45
82
 
@@ -1,9 +1,27 @@
1
+ InSpecStyle/Apache:
2
+ Description: 'Use apache_conf instead of apache'
3
+ Enabled: true
4
+ VersionAdded: '0.82'
5
+ PreferredReplacement: 'apache_conf'
6
+
7
+ InSpecStyle/AwsIamUserProperty:
8
+ Description: 'For the aws_iam_users resource name and user properties are deprecated. Use username and aws_user_struct instead'
9
+ Enabled: true
10
+ VersionAdded: '0.82'
11
+
1
12
  InSpecStyle/AzureGenericResource:
2
13
  Description: 'Do not use azure_generic_resource'
3
14
  Enabled: true
4
15
  VersionAdded: '0.82'
5
16
  StyleGuide: 'https://github.com/inspec/inspec/issues/3131'
6
17
 
18
+ InSpecStyle/DeprecatedAttributes1:
19
+ Description: 'Attributes are deprecated in favor of inputs'
20
+ Enabled: true
21
+ VersionAdded: '0.82'
22
+ StyleGuide: 'https://github.com/inspec/inspec/issues/3802'
23
+ PreferredReplacement: 'input'
24
+
7
25
  InSpecStyle/DeprecatedAttributes:
8
26
  Description: 'Attributes are deprecated in favor of inputs'
9
27
  Enabled: true
@@ -11,7 +29,82 @@ InSpecStyle/DeprecatedAttributes:
11
29
  StyleGuide: 'https://github.com/inspec/inspec/issues/3802'
12
30
  PreferredReplacement: 'input'
13
31
 
14
- InspecStyle/FirstCop:
15
- Description: 'This first cop is a sandbox for exploring new InspecStyle cops.'
32
+ InSpecStyle/FileBeMounted:
33
+ Description: 'aws_iam_users resource name and user properties are deprecated for username and aws_user_struct'
34
+ Enabled: true
35
+ VersionAdded: '0.82'
36
+
37
+ InSpecStyle/FileSize:
38
+ Description: '`size` property for `file` resource is deprecated for `size_kb` and will be removed in InSpec5'
39
+ Enabled: true
40
+ VersionAdded: '0.82'
41
+ PreferredReplacement: 'size_kb'
42
+
43
+ InSpecStyle/HostProto:
44
+ Description: 'Proto property for host has been deprecated for protocol'
45
+ Enabled: true
46
+ VersionAdded: '0.82'
47
+ PreferredReplacement: 'protocol'
48
+
49
+ InSpecStyle/IisWebsite:
50
+ Description: 'iis_website resource has been deprecated for iis_site'
51
+ Enabled: true
52
+ VersionAdded: '0.82'
53
+ PreferredReplacement: 'iis_site'
54
+
55
+ InSpecStyle/LinuxKernelParameter:
56
+ Description: 'linux_kernel_parameter resource has been deprecated for kernel_parameter'
57
+ Enabled: true
58
+ VersionAdded: '0.82'
59
+ PreferredReplacement: 'kernel_parameter'
60
+
61
+ InSpecStyle/MSSQLSessionPass:
62
+ Description: 'mssql_session resource parameter pass is deprecated for password'
63
+ Enabled: true
64
+ VersionAdded: '0.82'
65
+
66
+ InSpecStyle/OracleDbSessionPass:
67
+ Description: 'Use `password` instead of `pass`'
68
+ Enabled: true
69
+ VersionAdded: '0.82'
70
+ PreferredReplacement: 'password'
71
+
72
+ InSpecStyle/PPAResource:
73
+ Description: 'The ppa resource is deprecated in favor of the apt resource'
74
+ Enabled: true
75
+ VersionAdded: '0.82'
76
+ PreferredReplacement: 'apt'
77
+
78
+ InSpecStyle/ProcessesList:
79
+ Description: 'list property on processes resource is deprecated for entries'
80
+ Enabled: true
81
+ VersionAdded: '0.82'
82
+ PreferredReplacement: 'entries'
83
+
84
+ InSpecStyle/ScriptResource:
85
+ Description: 'Use powershell instead of script'
86
+ Enabled: true
87
+ VersionAdded: '0.82'
88
+ PreferredReplacement: 'powershell'
89
+
90
+ InSpecStyle/ShadowProperties:
91
+ Description: 'Deprecated properties for the shadow resource'
92
+ Enabled: true
93
+ VersionAdded: '0.82'
94
+
95
+ InSpecStyle/UsersResourceMatchers:
96
+ Description: 'Deprecated matchers for the users resource'
97
+ Enabled: true
98
+ VersionAdded: '0.82'
99
+
100
+ InSpecStyle/WindowsRegistryKey:
101
+ Description: 'The windows_registry_key resource is deprecated for registry_key'
102
+ Enabled: true
103
+ VersionAdded: '0.82'
104
+ PreferredReplacement: 'registry_key'
105
+
106
+ InSpecStyle/WmiWmisClass:
107
+ Description: "wmi('wmisclass') is deprecated for wmi({class: wmisclass})"
16
108
  Enabled: true
17
109
  VersionAdded: '0.82'
110
+ PreferredReplacement: "wmi({class: 'wmisclass'})"
@@ -79,7 +79,7 @@
79
79
  <dl>
80
80
  <dt>Defined in:</dt>
81
81
  <dd>lib/rubocop/inspecstyle/inject.rb<span class="defines">,<br />
82
- lib/rubocop/inspecstyle.rb,<br /> lib/rubocop/inspecstyle/version.rb,<br /> lib/rubocop/cop/inspecstyle/first_cop.rb,<br /> lib/rubocop/cop/inspecstyle/deprecated_attributes.rb,<br /> lib/rubocop/cop/inspecstyle/azure_generic_resource.rb</span>
82
+ lib/rubocop/inspecstyle.rb,<br /> lib/rubocop/inspecstyle/version.rb,<br /> lib/rubocop/cop/inspecstyle/apache.rb,<br /> lib/rubocop/cop/inspecstyle/file_size.rb,<br /> lib/rubocop/cop/inspecstyle/host_proto.rb,<br /> lib/rubocop/cop/inspecstyle/iis_website.rb,<br /> lib/rubocop/cop/inspecstyle/ppa_resource.rb,<br /> lib/rubocop/cop/inspecstyle/processes_list.rb,<br /> lib/rubocop/cop/inspecstyle/wmi_wmis_class.rb,<br /> lib/rubocop/cop/inspecstyle/file_be_mounted.rb,<br /> lib/rubocop/cop/inspecstyle/script_resource.rb,<br /> lib/rubocop/cop/inspecstyle/shadow_properties.rb,<br /> lib/rubocop/cop/inspecstyle/mssql_session_pass.rb,<br /> lib/rubocop/cop/inspecstyle/windows_registry_key.rb,<br /> lib/rubocop/cop/inspecstyle/aws_iam_user_property.rb,<br /> lib/rubocop/cop/inspecstyle/deprecated_attributes.rb,<br /> lib/rubocop/cop/inspecstyle/azure_generic_resource.rb,<br /> lib/rubocop/cop/inspecstyle/deprecated_attributes1.rb,<br /> lib/rubocop/cop/inspecstyle/linux_kernel_parameter.rb,<br /> lib/rubocop/cop/inspecstyle/oracle_db_session_pass.rb,<br /> lib/rubocop/cop/inspecstyle/users_resource_matchers.rb</span>
83
83
  </dd>
84
84
  </dl>
85
85
 
@@ -88,7 +88,7 @@
88
88
  <h2>Overview</h2><div class="docstring">
89
89
  <div class="discussion">
90
90
 
91
- <p>TODO: when finished, run `rake generate_cops_documentation` to update the docs</p>
91
+ <p>NOTE TO SELF - this one works BUT not if other its statements are defined. Needs to work in any arrangement. This is a powerful one to crack as this pattern will be used in a LOT of other cops.</p>
92
92
 
93
93
 
94
94
  </div>
@@ -118,7 +118,7 @@
118
118
  </div>
119
119
 
120
120
  <div id="footer">
121
- Generated on Thu Jun 11 11:57:48 2020 by
121
+ Generated on Thu Jul 2 15:33:00 2020 by
122
122
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
123
123
  0.9.25 (ruby-2.6.6).
124
124
  </div>
@@ -78,8 +78,8 @@
78
78
 
79
79
  <dl>
80
80
  <dt>Defined in:</dt>
81
- <dd>lib/rubocop/cop/inspecstyle/first_cop.rb<span class="defines">,<br />
82
- lib/rubocop/cop/inspecstyle/deprecated_attributes.rb,<br /> lib/rubocop/cop/inspecstyle/azure_generic_resource.rb</span>
81
+ <dd>lib/rubocop/cop/inspecstyle/apache.rb<span class="defines">,<br />
82
+ lib/rubocop/cop/inspecstyle/file_size.rb,<br /> lib/rubocop/cop/inspecstyle/host_proto.rb,<br /> lib/rubocop/cop/inspecstyle/iis_website.rb,<br /> lib/rubocop/cop/inspecstyle/ppa_resource.rb,<br /> lib/rubocop/cop/inspecstyle/processes_list.rb,<br /> lib/rubocop/cop/inspecstyle/wmi_wmis_class.rb,<br /> lib/rubocop/cop/inspecstyle/file_be_mounted.rb,<br /> lib/rubocop/cop/inspecstyle/script_resource.rb,<br /> lib/rubocop/cop/inspecstyle/shadow_properties.rb,<br /> lib/rubocop/cop/inspecstyle/mssql_session_pass.rb,<br /> lib/rubocop/cop/inspecstyle/windows_registry_key.rb,<br /> lib/rubocop/cop/inspecstyle/aws_iam_user_property.rb,<br /> lib/rubocop/cop/inspecstyle/deprecated_attributes.rb,<br /> lib/rubocop/cop/inspecstyle/azure_generic_resource.rb,<br /> lib/rubocop/cop/inspecstyle/deprecated_attributes1.rb,<br /> lib/rubocop/cop/inspecstyle/linux_kernel_parameter.rb,<br /> lib/rubocop/cop/inspecstyle/oracle_db_session_pass.rb,<br /> lib/rubocop/cop/inspecstyle/users_resource_matchers.rb</span>
83
83
  </dd>
84
84
  </dl>
85
85
 
@@ -107,7 +107,7 @@
107
107
  </div>
108
108
 
109
109
  <div id="footer">
110
- Generated on Thu Jun 11 11:57:48 2020 by
110
+ Generated on Thu Jul 2 15:33:00 2020 by
111
111
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
112
112
  0.9.25 (ruby-2.6.6).
113
113
  </div>
@@ -78,8 +78,8 @@
78
78
 
79
79
  <dl>
80
80
  <dt>Defined in:</dt>
81
- <dd>lib/rubocop/cop/inspecstyle/first_cop.rb<span class="defines">,<br />
82
- lib/rubocop/cop/inspecstyle/deprecated_attributes.rb,<br /> lib/rubocop/cop/inspecstyle/azure_generic_resource.rb</span>
81
+ <dd>lib/rubocop/cop/inspecstyle/apache.rb<span class="defines">,<br />
82
+ lib/rubocop/cop/inspecstyle/file_size.rb,<br /> lib/rubocop/cop/inspecstyle/host_proto.rb,<br /> lib/rubocop/cop/inspecstyle/iis_website.rb,<br /> lib/rubocop/cop/inspecstyle/ppa_resource.rb,<br /> lib/rubocop/cop/inspecstyle/processes_list.rb,<br /> lib/rubocop/cop/inspecstyle/wmi_wmis_class.rb,<br /> lib/rubocop/cop/inspecstyle/file_be_mounted.rb,<br /> lib/rubocop/cop/inspecstyle/script_resource.rb,<br /> lib/rubocop/cop/inspecstyle/shadow_properties.rb,<br /> lib/rubocop/cop/inspecstyle/mssql_session_pass.rb,<br /> lib/rubocop/cop/inspecstyle/windows_registry_key.rb,<br /> lib/rubocop/cop/inspecstyle/aws_iam_user_property.rb,<br /> lib/rubocop/cop/inspecstyle/deprecated_attributes.rb,<br /> lib/rubocop/cop/inspecstyle/azure_generic_resource.rb,<br /> lib/rubocop/cop/inspecstyle/deprecated_attributes1.rb,<br /> lib/rubocop/cop/inspecstyle/linux_kernel_parameter.rb,<br /> lib/rubocop/cop/inspecstyle/oracle_db_session_pass.rb,<br /> lib/rubocop/cop/inspecstyle/users_resource_matchers.rb</span>
83
83
  </dd>
84
84
  </dl>
85
85
 
@@ -91,7 +91,7 @@
91
91
 
92
92
 
93
93
 
94
- <strong class="classes">Classes:</strong> <span class='object_link'><a href="InSpecStyle/AzureGenericResource.html" title="RuboCop::Cop::InSpecStyle::AzureGenericResource (class)">AzureGenericResource</a></span>, <span class='object_link'><a href="InSpecStyle/DeprecatedAttributes.html" title="RuboCop::Cop::InSpecStyle::DeprecatedAttributes (class)">DeprecatedAttributes</a></span>, <span class='object_link'><a href="InSpecStyle/FirstCop.html" title="RuboCop::Cop::InSpecStyle::FirstCop (class)">FirstCop</a></span>
94
+ <strong class="classes">Classes:</strong> <span class='object_link'><a href="InSpecStyle/Apache.html" title="RuboCop::Cop::InSpecStyle::Apache (class)">Apache</a></span>, <span class='object_link'><a href="InSpecStyle/AwsIamUserProperty.html" title="RuboCop::Cop::InSpecStyle::AwsIamUserProperty (class)">AwsIamUserProperty</a></span>, <span class='object_link'><a href="InSpecStyle/AzureGenericResource.html" title="RuboCop::Cop::InSpecStyle::AzureGenericResource (class)">AzureGenericResource</a></span>, <span class='object_link'><a href="InSpecStyle/DeprecatedAttributes.html" title="RuboCop::Cop::InSpecStyle::DeprecatedAttributes (class)">DeprecatedAttributes</a></span>, <span class='object_link'><a href="InSpecStyle/DeprecatedAttributes1.html" title="RuboCop::Cop::InSpecStyle::DeprecatedAttributes1 (class)">DeprecatedAttributes1</a></span>, <span class='object_link'><a href="InSpecStyle/FileBeMounted.html" title="RuboCop::Cop::InSpecStyle::FileBeMounted (class)">FileBeMounted</a></span>, <span class='object_link'><a href="InSpecStyle/FileSize.html" title="RuboCop::Cop::InSpecStyle::FileSize (class)">FileSize</a></span>, <span class='object_link'><a href="InSpecStyle/HostProto.html" title="RuboCop::Cop::InSpecStyle::HostProto (class)">HostProto</a></span>, <span class='object_link'><a href="InSpecStyle/IisWebsite.html" title="RuboCop::Cop::InSpecStyle::IisWebsite (class)">IisWebsite</a></span>, <span class='object_link'><a href="InSpecStyle/LinuxKernelParameter.html" title="RuboCop::Cop::InSpecStyle::LinuxKernelParameter (class)">LinuxKernelParameter</a></span>, <span class='object_link'><a href="InSpecStyle/MSSQLSessionPass.html" title="RuboCop::Cop::InSpecStyle::MSSQLSessionPass (class)">MSSQLSessionPass</a></span>, <span class='object_link'><a href="InSpecStyle/OracleDbSessionPass.html" title="RuboCop::Cop::InSpecStyle::OracleDbSessionPass (class)">OracleDbSessionPass</a></span>, <span class='object_link'><a href="InSpecStyle/PPAResource.html" title="RuboCop::Cop::InSpecStyle::PPAResource (class)">PPAResource</a></span>, <span class='object_link'><a href="InSpecStyle/ProcessesList.html" title="RuboCop::Cop::InSpecStyle::ProcessesList (class)">ProcessesList</a></span>, <span class='object_link'><a href="InSpecStyle/ScriptResource.html" title="RuboCop::Cop::InSpecStyle::ScriptResource (class)">ScriptResource</a></span>, <span class='object_link'><a href="InSpecStyle/ShadowProperties.html" title="RuboCop::Cop::InSpecStyle::ShadowProperties (class)">ShadowProperties</a></span>, <span class='object_link'><a href="InSpecStyle/UsersResourceMatchers.html" title="RuboCop::Cop::InSpecStyle::UsersResourceMatchers (class)">UsersResourceMatchers</a></span>, <span class='object_link'><a href="InSpecStyle/WindowsRegistryKey.html" title="RuboCop::Cop::InSpecStyle::WindowsRegistryKey (class)">WindowsRegistryKey</a></span>, <span class='object_link'><a href="InSpecStyle/WmiWmisClass.html" title="RuboCop::Cop::InSpecStyle::WmiWmisClass (class)">WmiWmisClass</a></span>
95
95
 
96
96
 
97
97
  </p>
@@ -107,7 +107,7 @@
107
107
  </div>
108
108
 
109
109
  <div id="footer">
110
- Generated on Thu Jun 11 11:57:48 2020 by
110
+ Generated on Thu Jul 2 15:33:00 2020 by
111
111
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
112
112
  0.9.25 (ruby-2.6.6).
113
113
  </div>
@@ -0,0 +1,306 @@
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::Apache
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::Apache";
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 (A)</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">Apache</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::Apache
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::Apache</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/apache.rb</dd>
100
+ </dl>
101
+
102
+ </div>
103
+
104
+ <h2>Overview</h2><div class="docstring">
105
+ <div class="discussion">
106
+
107
+ <p>Do not use apache</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><span class='comment'># apache has been deprecated
123
+ </span><span class='comment'># &#39;https://github.com/inspec/inspec/issues/3131&#39;
124
+ </span><span class='comment'># Since there are multiples replacements autocorrect is not supported.
125
+ </span>
126
+ <span class='comment'># bad
127
+ </span><span class='id identifier rubyid_apache'>apache</span>
128
+
129
+ <span class='comment'># good
130
+ </span><span class='id identifier rubyid_azurerm_virtual_machine'>azurerm_virtual_machine</span> <span class='comment'># use a specific resource pack resource</span></code></pre>
131
+
132
+ </div>
133
+
134
+
135
+ </div>
136
+
137
+ <h2>
138
+ Constant Summary
139
+ <small><a href="#" class="constants_summary_toggle">collapse</a></small>
140
+ </h2>
141
+
142
+ <dl class="constants">
143
+
144
+ <dt id="MSG-constant" class="">MSG =
145
+
146
+ </dt>
147
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Use a `apache_conf` instead of `#apache`. </span><span class='tstring_end'>&#39;</span></span>\
148
+ <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>This resource will be removed in InSpec 5.</span><span class='tstring_end'>&#39;</span></span></pre></dd>
149
+
150
+ </dl>
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+
159
+
160
+ <h2>
161
+ Instance Method Summary
162
+ <small><a href="#" class="summary_toggle">collapse</a></small>
163
+ </h2>
164
+
165
+ <ul class="summary">
166
+
167
+ <li class="public ">
168
+ <span class="summary_signature">
169
+
170
+ <a href="#autocorrect-instance_method" title="#autocorrect (instance method)">#<strong>autocorrect</strong>(node) &#x21d2; Object </a>
171
+
172
+
173
+
174
+ </span>
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+
184
+ <span class="summary_desc"><div class='inline'></div></span>
185
+
186
+ </li>
187
+
188
+
189
+ <li class="public ">
190
+ <span class="summary_signature">
191
+
192
+ <a href="#on_send-instance_method" title="#on_send (instance method)">#<strong>on_send</strong>(node) &#x21d2; Object </a>
193
+
194
+
195
+
196
+ </span>
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+
206
+ <span class="summary_desc"><div class='inline'></div></span>
207
+
208
+ </li>
209
+
210
+
211
+ </ul>
212
+
213
+
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+ <div id="instance_method_details" class="method_details_list">
223
+ <h2>Instance Method Details</h2>
224
+
225
+
226
+ <div class="method_details first">
227
+ <h3 class="signature first" id="autocorrect-instance_method">
228
+
229
+ #<strong>autocorrect</strong>(node) &#x21d2; <tt>Object</tt>
230
+
231
+
232
+
233
+
234
+
235
+ </h3><table class="source_code">
236
+ <tr>
237
+ <td>
238
+ <pre class="lines">
239
+
240
+
241
+ 39
242
+ 40
243
+ 41
244
+ 42
245
+ 43</pre>
246
+ </td>
247
+ <td>
248
+ <pre class="code"><span class="info file"># File 'lib/rubocop/cop/inspecstyle/apache.rb', line 39</span>
249
+
250
+ <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>
251
+ <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>
252
+ <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='id identifier rubyid_preferred_replacement'>preferred_replacement</span><span class='rparen'>)</span>
253
+ <span class='kw'>end</span>
254
+ <span class='kw'>end</span></pre>
255
+ </td>
256
+ </tr>
257
+ </table>
258
+ </div>
259
+
260
+ <div class="method_details ">
261
+ <h3 class="signature " id="on_send-instance_method">
262
+
263
+ #<strong>on_send</strong>(node) &#x21d2; <tt>Object</tt>
264
+
265
+
266
+
267
+
268
+
269
+ </h3><table class="source_code">
270
+ <tr>
271
+ <td>
272
+ <pre class="lines">
273
+
274
+
275
+ 33
276
+ 34
277
+ 35
278
+ 36
279
+ 37</pre>
280
+ </td>
281
+ <td>
282
+ <pre class="code"><span class="info file"># File 'lib/rubocop/cop/inspecstyle/apache.rb', line 33</span>
283
+
284
+ <span class='kw'>def</span> <span class='id identifier rubyid_on_send'>on_send</span><span class='lparen'>(</span><span class='id identifier rubyid_node'>node</span><span class='rparen'>)</span>
285
+ <span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_apache?'>apache?</span><span class='lparen'>(</span><span class='id identifier rubyid_node'>node</span><span class='rparen'>)</span>
286
+
287
+ <span class='id identifier rubyid_add_offense'>add_offense</span><span class='lparen'>(</span><span class='id identifier rubyid_node'>node</span><span class='comma'>,</span> <span class='label'>location:</span> <span class='symbol'>:selector</span><span class='rparen'>)</span>
288
+ <span class='kw'>end</span></pre>
289
+ </td>
290
+ </tr>
291
+ </table>
292
+ </div>
293
+
294
+ </div>
295
+
296
+ </div>
297
+
298
+ <div id="footer">
299
+ Generated on Thu Jul 2 15:33:00 2020 by
300
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
301
+ 0.9.25 (ruby-2.6.6).
302
+ </div>
303
+
304
+ </div>
305
+ </body>
306
+ </html>