puppet-lint-param-docs 1.4.1 → 1.4.2

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 (4) hide show
  1. checksums.yaml +4 -4
  2. data/lib/puppet-lint/plugins/check_parameter_documentation.rb +1 -1
  3. data/spec/puppet-lint/plugins/check_parameter_documentation_spec.rb +46 -0
  4. metadata +20 -20
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: e9c071b35fbded596e9cc62dbd7c632eb5ef0e55
4
- data.tar.gz: c8cc121248dd81d35397897d22bec9813f3085f0
3
+ metadata.gz: 97c4532b41c68c3cce6c7566a28900e66e90dc70
4
+ data.tar.gz: c5ee842a8e1f28935b51a9ab6ce5bcf0ec007f41
5
5
  SHA512:
6
- metadata.gz: 8d69ff35bfbf3523499a5f2ff00daedd515c9552fe746f39e72d40e42ad804b2067bf40f60a2aedeeabfca15c49bf3c9359b858e15387a8ebd15d0cd61ca5261
7
- data.tar.gz: fb201326d0298f9b8e4193b0754d1a362273ea59da66d92f21fffbc9441d9c0c38fbae17d0bb3b9031de6345f77dccf4b369abe016e71dea238ff837453ffe3c
6
+ metadata.gz: cb9ae66d054669c78ff450c5efb0856e40238dca4335274069d4a3d70f078e7839d5a095cda3640a5abd0762180cacdcf6c87b7f21e3c36b57136796cab75981
7
+ data.tar.gz: 6dc412254ab70459f4ee0cb49b71f128f76e7710b154bb4930525bf8e36a47e8177211aabdcf091d5389ec9e697f268e9cc70641c99ac11ccf3e02a8ed27f83f
data/lib/puppet-lint/plugins/check_parameter_documentation.rb CHANGED
@@ -9,7 +9,7 @@ PuppetLint.new_check(:parameter_documentation) do
9
9
  if [:COMMENT, :MLCOMMENT, :SLASH_COMMENT].include?(dtok.type)
10
10
  if dtok.value =~ /\A\s*\[\*([a-zA-Z0-9_]+)\*\]/ or
11
11
  dtok.value =~ /\A\s*\$([a-zA-Z0-9_]+):: +/ or
12
- dtok.value =~ /\A\s*@param ([a-zA-Z0-9_]+) +/
12
+ dtok.value =~ /\A\s*@param (?:\[.+\] )?([a-zA-Z0-9_]+)(?: +|$)/
13
13
  doc_params << $1
14
14
  end
15
15
  else
data/spec/puppet-lint/plugins/check_parameter_documentation_spec.rb CHANGED
@@ -376,6 +376,52 @@ define foreman (
376
376
  end
377
377
  end
378
378
 
379
+ context 'class with all parameters documented (@param)' do
380
+ let(:code) do
381
+ <<-EOS
382
+ # Example class
383
+ #
384
+ # === Parameters:
385
+ #
386
+ # @param foo example
387
+ # @param [Integer] bar example
388
+ # @param baz
389
+ # example
390
+ # @param [Integer] qux
391
+ # example
392
+ #
393
+ class example($foo, $bar, $baz, $qux) { }
394
+ EOS
395
+ end
396
+
397
+ it 'should not detect any problems' do
398
+ expect(problems).to have(0).problems
399
+ end
400
+ end
401
+
402
+ context 'define with all parameters documented (@param)' do
403
+ let(:code) do
404
+ <<-EOS
405
+ # Example define
406
+ #
407
+ # === Parameters:
408
+ #
409
+ # @param foo example
410
+ # @param [Integer] bar example
411
+ # @param baz
412
+ # example
413
+ # @param [Integer] qux
414
+ # example
415
+ #
416
+ define example($foo, $bar, $baz, $qux) { }
417
+ EOS
418
+ end
419
+
420
+ it 'should not detect any problems' do
421
+ expect(problems).to have(0).problems
422
+ end
423
+ end
424
+
379
425
  context 'class without parameters' do
380
426
  let(:code) { 'class example { }' }
381
427
 
metadata CHANGED
@@ -1,94 +1,94 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: puppet-lint-param-docs
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.4.1
4
+ version: 1.4.2
5
5
  platform: ruby
6
6
  authors:
7
- - Dominic Cleal
7
+ - Vox Pupuli
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2016-06-22 00:00:00.000000000 Z
11
+ date: 2017-03-29 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: puppet-lint
15
15
  requirement: !ruby/object:Gem::Requirement
16
16
  requirements:
17
- - - '>='
17
+ - - ">="
18
18
  - !ruby/object:Gem::Version
19
19
  version: '1.1'
20
- - - <
20
+ - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: '3.0'
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
26
26
  requirements:
27
- - - '>='
27
+ - - ">="
28
28
  - !ruby/object:Gem::Version
29
29
  version: '1.1'
30
- - - <
30
+ - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: '3.0'
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: rspec
35
35
  requirement: !ruby/object:Gem::Requirement
36
36
  requirements:
37
- - - ~>
37
+ - - "~>"
38
38
  - !ruby/object:Gem::Version
39
39
  version: '3.0'
40
40
  type: :development
41
41
  prerelease: false
42
42
  version_requirements: !ruby/object:Gem::Requirement
43
43
  requirements:
44
- - - ~>
44
+ - - "~>"
45
45
  - !ruby/object:Gem::Version
46
46
  version: '3.0'
47
47
  - !ruby/object:Gem::Dependency
48
48
  name: rspec-its
49
49
  requirement: !ruby/object:Gem::Requirement
50
50
  requirements:
51
- - - ~>
51
+ - - "~>"
52
52
  - !ruby/object:Gem::Version
53
53
  version: '1.0'
54
54
  type: :development
55
55
  prerelease: false
56
56
  version_requirements: !ruby/object:Gem::Requirement
57
57
  requirements:
58
- - - ~>
58
+ - - "~>"
59
59
  - !ruby/object:Gem::Version
60
60
  version: '1.0'
61
61
  - !ruby/object:Gem::Dependency
62
62
  name: rspec-collection_matchers
63
63
  requirement: !ruby/object:Gem::Requirement
64
64
  requirements:
65
- - - ~>
65
+ - - "~>"
66
66
  - !ruby/object:Gem::Version
67
67
  version: '1.0'
68
68
  type: :development
69
69
  prerelease: false
70
70
  version_requirements: !ruby/object:Gem::Requirement
71
71
  requirements:
72
- - - ~>
72
+ - - "~>"
73
73
  - !ruby/object:Gem::Version
74
74
  version: '1.0'
75
75
  - !ruby/object:Gem::Dependency
76
76
  name: rake
77
77
  requirement: !ruby/object:Gem::Requirement
78
78
  requirements:
79
- - - '>='
79
+ - - ">="
80
80
  - !ruby/object:Gem::Version
81
81
  version: '0'
82
82
  type: :development
83
83
  prerelease: false
84
84
  version_requirements: !ruby/object:Gem::Requirement
85
85
  requirements:
86
- - - '>='
86
+ - - ">="
87
87
  - !ruby/object:Gem::Version
88
88
  version: '0'
89
89
  description: |2
90
90
  A new check for puppet-lint that validates all parameters are documented.
91
- email: dcleal@redhat.com
91
+ email: voxpupuli@groups.io
92
92
  executables: []
93
93
  extensions: []
94
94
  extra_rdoc_files: []
@@ -100,7 +100,7 @@ files:
100
100
  - lib/puppet-lint/plugins/check_parameter_documentation.rb
101
101
  - spec/puppet-lint/plugins/check_parameter_documentation_spec.rb
102
102
  - spec/spec_helper.rb
103
- homepage: https://github.com/domcleal/puppet-lint-param-docs
103
+ homepage: https://github.com/voxpupuli/puppet-lint-param-docs
104
104
  licenses:
105
105
  - MIT
106
106
  metadata: {}
@@ -110,17 +110,17 @@ require_paths:
110
110
  - lib
111
111
  required_ruby_version: !ruby/object:Gem::Requirement
112
112
  requirements:
113
- - - '>='
113
+ - - ">="
114
114
  - !ruby/object:Gem::Version
115
115
  version: '0'
116
116
  required_rubygems_version: !ruby/object:Gem::Requirement
117
117
  requirements:
118
- - - '>='
118
+ - - ">="
119
119
  - !ruby/object:Gem::Version
120
120
  version: '0'
121
121
  requirements: []
122
122
  rubyforge_project:
123
- rubygems_version: 2.4.4
123
+ rubygems_version: 2.4.5
124
124
  signing_key:
125
125
  specification_version: 4
126
126
  summary: puppet-lint check to validate all parameters are documented