puppet-lint-trailing_comma-check 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 38a1fd04aeaf11684d22adcb4306059667f41f3b
4
+ data.tar.gz: 8a8c5893f796a65d18dd266dd421aa42fad82dde
5
+ SHA512:
6
+ metadata.gz: 25749255ed6f56079cba85f26467768181c18716b8f3bc3583074f6f4c7f89f36ecee19cbf7373c054ca83d3fcc7ada2d2e785c3f78ad932498951c35973993e
7
+ data.tar.gz: d2930af4df68ea936200a1f7cc956bc95a28e48f986f107d0cd0466cc4f6ab04226d449aeb20c1b27207d74a4d1ce6254fae398834c7ef333454b45f18ac1024
data/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
data/README.md ADDED
@@ -0,0 +1,48 @@
1
+ puppet-lint-trailing_comma-check
2
+ =================================
3
+
4
+ [![Build Status](https://travis-ci.org/camptocamp/puppet-lint-trailing_comma-check.svg)](https://travis-ci.org/camptocamp/puppet-lint-trailing_comma-check)
5
+ [![Code Climate](https://codeclimate.com/github/camptocamp/puppet-lint-trailing_comma-check/badges/gpa.svg)](https://codeclimate.com/github/camptocamp/puppet-lint-trailing_comma-check)
6
+ [![Gem Version](https://badge.fury.io/rb/puppet-lint-trailing_comma-check.svg)](http://badge.fury.io/rb/puppet-lint-trailing_comma-check)
7
+ [![Coverage Status](https://img.shields.io/coveralls/camptocamp/puppet-lint-trailing_comma-check.svg)](https://coveralls.io/r/camptocamp/puppet-lint-trailing_comma-check?branch=master)
8
+
9
+ A puppet-lint plugin to check for missing trailing commas.
10
+
11
+
12
+ ## Checks
13
+
14
+ ### Missing trailing comma
15
+
16
+ As per style guide v2.0, there must be trailing commas after all resource attributes and
17
+ parameter definitions.
18
+
19
+ #### What you have done
20
+
21
+ ```puppet
22
+ file { '/etc/sudoers':
23
+ ensure => file
24
+ }
25
+ ```
26
+
27
+ #### What you should have done
28
+
29
+ ```puppet
30
+ file { '/etc/sudoers':
31
+ ensure => file,
32
+ }
33
+ ```
34
+
35
+
36
+ #### Disabling the check
37
+
38
+ To disable this check, you can add `--no-trailing_comma-check` to your puppet-lint command line.
39
+
40
+ ```shell
41
+ $ puppet-lint --no-trailing_comma-check path/to/file.pp
42
+ ```
43
+
44
+ Alternatively, if you’re calling puppet-lint via the Rake task, you should insert the following line to your `Rakefile`.
45
+
46
+ ```ruby
47
+ PuppetLint.configuration.send('disable_trailing_comma')
48
+ ```
@@ -0,0 +1,28 @@
1
+ PuppetLint.new_check(:trailing_comma) do
2
+ def check
3
+ # Resource and class declarations
4
+ resource_indexes.each do |resource|
5
+ lbo_token = resource[:tokens][-1].prev_code_token
6
+ if lbo_token && lbo_token.type != :COMMA
7
+ notify :warning, {
8
+ :message => 'missing trailing comma after last parameter',
9
+ :line => lbo_token.next_token.line,
10
+ :column => lbo_token.next_token.column,
11
+ :token => lbo_token.next_token,
12
+ }
13
+ end
14
+ end
15
+ end
16
+
17
+ def fix(problem)
18
+ comma = PuppetLint::Lexer::Token.new(
19
+ :COMMA,
20
+ ',',
21
+ problem[:token].line,
22
+ problem[:token].column
23
+ )
24
+
25
+ idx = tokens.index(problem[:token])
26
+ tokens.insert(idx, comma)
27
+ end
28
+ end
@@ -0,0 +1,127 @@
1
+ require 'spec_helper'
2
+
3
+ describe 'trailing_comma' do
4
+ let (:msg) { 'missing trailing comma after last parameter' }
5
+
6
+ context 'with fix disabled' do
7
+ context 'trailing comma present' do
8
+ let (:code) {
9
+ <<-EOS
10
+ class { '::apache':
11
+ timeout => '100',
12
+ docroot => '/var/www',
13
+ }
14
+
15
+ file { '/etc/fstab':
16
+ ensure => 'file',
17
+ content => 'foo',
18
+ }
19
+ EOS
20
+ }
21
+
22
+ it 'should not detect any problems' do
23
+ expect(problems).to have(0).problems
24
+ end
25
+ end
26
+
27
+ context 'trailing comma absent' do
28
+ let (:code) {
29
+ <<-EOS
30
+ class { '::apache':
31
+ timeout => '100',
32
+ docroot => '/var/www'
33
+ }
34
+
35
+ file { '/etc/fstab':
36
+ ensure => 'file',
37
+ content => 'foo'
38
+ }
39
+ EOS
40
+ }
41
+
42
+ it 'should detect a single problem' do
43
+ expect(problems).to have(2).problems
44
+ end
45
+
46
+ it 'should create a warning' do
47
+ expect(problems).to contain_warning(msg).on_line(3).in_column(32)
48
+ expect(problems).to contain_warning(msg).on_line(8).in_column(27)
49
+ end
50
+ end
51
+ end
52
+
53
+ context 'with fix enabled' do
54
+ before do
55
+ PuppetLint.configuration.fix = true
56
+ end
57
+
58
+ after do
59
+ PuppetLint.configuration.fix = false
60
+ end
61
+
62
+ context 'trailing comma present' do
63
+ let (:code) {
64
+ <<-EOS
65
+ class { '::apache':
66
+ timeout => '100',
67
+ docroot => '/var/www',
68
+ }
69
+
70
+ file { '/etc/fstab':
71
+ ensure => 'file',
72
+ content => 'foo',
73
+ }
74
+ EOS
75
+ }
76
+
77
+ it 'should not detect any problems' do
78
+ expect(problems).to have(0).problems
79
+ end
80
+
81
+ it 'should not modify the manifest' do
82
+ expect(manifest).to eq(code)
83
+ end
84
+ end
85
+
86
+ context 'trailing comma absent' do
87
+ let (:code) {
88
+ <<-EOS
89
+ class { '::apache':
90
+ timeout => '100',
91
+ docroot => '/var/www'
92
+ }
93
+
94
+ file { '/etc/fstab':
95
+ ensure => 'file',
96
+ content => 'foo'
97
+ }
98
+ EOS
99
+ }
100
+
101
+ it 'should detect a single problem' do
102
+ expect(problems).to have(2).problems
103
+ end
104
+
105
+ it 'should create a warning' do
106
+ expect(problems).to contain_fixed(msg).on_line(3).in_column(32)
107
+ expect(problems).to contain_fixed(msg).on_line(8).in_column(27)
108
+ end
109
+
110
+ it 'should add trailing commas' do
111
+ expect(manifest).to eq(
112
+ <<-EOS
113
+ class { '::apache':
114
+ timeout => '100',
115
+ docroot => '/var/www',
116
+ }
117
+
118
+ file { '/etc/fstab':
119
+ ensure => 'file',
120
+ content => 'foo',
121
+ }
122
+ EOS
123
+ )
124
+ end
125
+ end
126
+ end
127
+ end
@@ -0,0 +1,6 @@
1
+ require 'coveralls'
2
+ Coveralls.wear!
3
+
4
+ require 'puppet-lint'
5
+
6
+ PuppetLint::Plugins.load_spec_helper
metadata ADDED
@@ -0,0 +1,149 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: puppet-lint-trailing_comma-check
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Camptocamp
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2015-02-10 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: puppet-lint
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rspec
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '3.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '3.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec-its
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '1.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '1.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rspec-collection_matchers
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '1.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '1.0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: mime-types
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '1.0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '1.0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: coveralls
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: '0.7'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: '0.7'
97
+ - !ruby/object:Gem::Dependency
98
+ name: rake
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: '0'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ">="
109
+ - !ruby/object:Gem::Version
110
+ version: '0'
111
+ description: |2
112
+ A puppet-lint plugin to check for missing trailing commas.
113
+ email: raphael.pinson@camptocamp.com
114
+ executables: []
115
+ extensions: []
116
+ extra_rdoc_files: []
117
+ files:
118
+ - LICENSE
119
+ - README.md
120
+ - lib/puppet-lint/plugins/check_trailing_comma.rb
121
+ - spec/puppet-lint/plugins/check_trailing_comma/check_trailing_comma_spec.rb
122
+ - spec/spec_helper.rb
123
+ homepage: https://github.com/camptocamp/puppet-lint-trailing_comma-check
124
+ licenses:
125
+ - Apache-2.0
126
+ metadata: {}
127
+ post_install_message:
128
+ rdoc_options: []
129
+ require_paths:
130
+ - lib
131
+ required_ruby_version: !ruby/object:Gem::Requirement
132
+ requirements:
133
+ - - ">="
134
+ - !ruby/object:Gem::Version
135
+ version: '0'
136
+ required_rubygems_version: !ruby/object:Gem::Requirement
137
+ requirements:
138
+ - - ">="
139
+ - !ruby/object:Gem::Version
140
+ version: '0'
141
+ requirements: []
142
+ rubyforge_project:
143
+ rubygems_version: 2.2.2
144
+ signing_key:
145
+ specification_version: 4
146
+ summary: A puppet-lint plugin to check for missing trailing commas.
147
+ test_files:
148
+ - spec/spec_helper.rb
149
+ - spec/puppet-lint/plugins/check_trailing_comma/check_trailing_comma_spec.rb