op-foodcritic-rules 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +2 -0
- data/.rspec +1 -0
- data/.rubocop.yml +2 -0
- data/.ruby-gemset +1 -0
- data/.ruby-version +1 -0
- data/.travis.yml +5 -0
- data/Gemfile +8 -0
- data/Gemfile.lock +72 -0
- data/LICENSE +201 -0
- data/README.md +54 -0
- data/Rakefile +19 -0
- data/lib/foodcritic/rules/op001.rb +53 -0
- data/op-foodcritic-rules.gemspec +27 -0
- data/sample_cookbooks/op001/.kitchen.yml +9 -0
- data/sample_cookbooks/op001/recipes/test_includes.rb +6 -0
- data/sample_cookbooks/op001/recipes/tested.rb +2 -0
- data/sample_cookbooks/op001/recipes/tested_by_include_double_quotes.rb +2 -0
- data/sample_cookbooks/op001/recipes/tested_by_include_single_quotes.rb +2 -0
- data/sample_cookbooks/op001/recipes/untested.rb +2 -0
- data/spec/rules/op001_spec.rb +25 -0
- data/spec/spec_helper.rb +21 -0
- metadata +123 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 9da7686e765624a8ecb73a0a267884ac21aa8b8e
|
4
|
+
data.tar.gz: f758df6659dc25351a9222cd8f406c5a0002f6a4
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: d874c340cc14293503f2b82cb631e1ba96b7c525207aa1653ddd2f31a2345da693eeb4ae0cc90de3f0b846bc3b13ab0bb0a757b57f4a4a17a30e8d0361e5f4a6
|
7
|
+
data.tar.gz: 21a96b72144117f2262fe04334ef66d7fc179f0975747a13caf640fb0b3605fc16956e6c084cbe844577b7264b438cf5e66407b89b6ea759de36de4977f88c21
|
data/.gitignore
ADDED
data/.rspec
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
-c -b -fd --order rand
|
data/.rubocop.yml
ADDED
data/.ruby-gemset
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
op-foodcritic-rules
|
data/.ruby-version
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
2.3.1
|
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,72 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
op-foodcritic-rules (0.0.1)
|
5
|
+
foodcritic
|
6
|
+
|
7
|
+
GEM
|
8
|
+
remote: https://rubygems.org/
|
9
|
+
specs:
|
10
|
+
ast (2.3.0)
|
11
|
+
cucumber-core (1.5.0)
|
12
|
+
gherkin (~> 4.0)
|
13
|
+
diff-lcs (1.2.5)
|
14
|
+
erubis (2.7.0)
|
15
|
+
foodcritic (7.0.1)
|
16
|
+
cucumber-core (>= 1.3)
|
17
|
+
erubis
|
18
|
+
nokogiri (>= 1.5, < 2.0)
|
19
|
+
rake
|
20
|
+
rufus-lru (~> 1.0)
|
21
|
+
treetop (~> 1.4)
|
22
|
+
yajl-ruby (~> 1.1)
|
23
|
+
gherkin (4.0.0)
|
24
|
+
mini_portile2 (2.1.0)
|
25
|
+
nokogiri (1.6.8)
|
26
|
+
mini_portile2 (~> 2.1.0)
|
27
|
+
pkg-config (~> 1.1.7)
|
28
|
+
parser (2.3.1.2)
|
29
|
+
ast (~> 2.2)
|
30
|
+
pkg-config (1.1.7)
|
31
|
+
polyglot (0.3.5)
|
32
|
+
powerpack (0.1.1)
|
33
|
+
rainbow (2.1.0)
|
34
|
+
rake (11.2.2)
|
35
|
+
rspec (3.5.0)
|
36
|
+
rspec-core (~> 3.5.0)
|
37
|
+
rspec-expectations (~> 3.5.0)
|
38
|
+
rspec-mocks (~> 3.5.0)
|
39
|
+
rspec-core (3.5.2)
|
40
|
+
rspec-support (~> 3.5.0)
|
41
|
+
rspec-expectations (3.5.0)
|
42
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
43
|
+
rspec-support (~> 3.5.0)
|
44
|
+
rspec-mocks (3.5.0)
|
45
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
46
|
+
rspec-support (~> 3.5.0)
|
47
|
+
rspec-support (3.5.0)
|
48
|
+
rubocop (0.42.0)
|
49
|
+
parser (>= 2.3.1.1, < 3.0)
|
50
|
+
powerpack (~> 0.1)
|
51
|
+
rainbow (>= 1.99.1, < 3.0)
|
52
|
+
ruby-progressbar (~> 1.7)
|
53
|
+
unicode-display_width (~> 1.0, >= 1.0.1)
|
54
|
+
ruby-progressbar (1.8.1)
|
55
|
+
rufus-lru (1.1.0)
|
56
|
+
treetop (1.6.8)
|
57
|
+
polyglot (~> 0.3)
|
58
|
+
unicode-display_width (1.1.0)
|
59
|
+
yajl-ruby (1.2.1)
|
60
|
+
|
61
|
+
PLATFORMS
|
62
|
+
ruby
|
63
|
+
|
64
|
+
DEPENDENCIES
|
65
|
+
bundler
|
66
|
+
op-foodcritic-rules!
|
67
|
+
rake
|
68
|
+
rspec
|
69
|
+
rubocop
|
70
|
+
|
71
|
+
BUNDLED WITH
|
72
|
+
1.12.5
|
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,54 @@
|
|
1
|
+
# op-foodcritic-rules
|
2
|
+
|
3
|
+
[![Build Status](https://travis-ci.org/ofir-petrushka/op-foodcritic-rules.png?branch=master)](https://travis-ci.org/ofir-petrushka/op-foodcritic-rules)
|
4
|
+
|
5
|
+
Custom foodcritic rules.
|
6
|
+
Should be generic for everyone working with Chef.
|
7
|
+
Current focus is on automated testing.
|
8
|
+
|
9
|
+
## Installation
|
10
|
+
|
11
|
+
Add this line to your Gemfile in chef-repo:
|
12
|
+
|
13
|
+
gem 'op-foodcritic-rules', git: 'git@github.com:ofir-petrushka/op-foodcritic-rules.git'
|
14
|
+
|
15
|
+
And then execute `bundle` to install the gem.
|
16
|
+
|
17
|
+
## Usage
|
18
|
+
|
19
|
+
Once you have installed the gem, simply run foodcritic with the `-G` option:
|
20
|
+
|
21
|
+
bundle exec foodcritic -G .
|
22
|
+
|
23
|
+
# Rules
|
24
|
+
|
25
|
+
## <a id="OP001"></a>OP001: Include a kitchen test suite for every recipe not included by another
|
26
|
+
|
27
|
+
[Kitchen tests](https://docs.chef.io/kitchen.html) are the recommended way for automated chef recipe testing.
|
28
|
+
Generally speaking every recipe should have be in at least one test suite.
|
29
|
+
This is a laxed rule not requiring recipes included by other recipes to have test suites.
|
30
|
+
|
31
|
+
This rules looks for entries in .kitchen.yml under runlists to have every recipe under your recipe directory.
|
32
|
+
|
33
|
+
For example:
|
34
|
+
|
35
|
+
# Good
|
36
|
+
$ ls cookbooks/my_cookbook/recipes/tested.rb
|
37
|
+
cookbooks/my_cookbook/recipes/tested.rb
|
38
|
+
$ grep tested cookbooks/my_cookbook/.kitchen.yml
|
39
|
+
- recipe[tested]
|
40
|
+
|
41
|
+
# Bad
|
42
|
+
$ ls cookbooks/my_cookbook/recipes/not_tested.rb
|
43
|
+
cookbooks/my_cookbook/recipes/not_tested.rb
|
44
|
+
$ grep tested cookbooks/my_cookbook/.kitchen.yml
|
45
|
+
|
46
|
+
(empty result)
|
47
|
+
|
48
|
+
# License
|
49
|
+
|
50
|
+
OP Foodcritic Rules
|
51
|
+
|
52
|
+
* Author: Ofir Petrushka <ofir.petrushka AT gmail DOT com>
|
53
|
+
* Copyright: Copyright (c) Ofir Petrushka.
|
54
|
+
* License: Apache License, Version 2.0
|
data/Rakefile
ADDED
@@ -0,0 +1,19 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
require 'bundler/gem_tasks'
|
3
|
+
require 'rspec/core/rake_task'
|
4
|
+
|
5
|
+
task default: [:spec, :rubocop]
|
6
|
+
|
7
|
+
RSpec::Core::RakeTask.new do |t|
|
8
|
+
t.pattern = 'spec/rules/*_spec.rb'
|
9
|
+
end
|
10
|
+
|
11
|
+
begin
|
12
|
+
require 'rubocop/rake_task'
|
13
|
+
desc 'Run Chefstyle (rubocop)'
|
14
|
+
RuboCop::RakeTask.new do |task|
|
15
|
+
task.options << '--display-cop-names'
|
16
|
+
end
|
17
|
+
rescue LoadError
|
18
|
+
puts 'rubocop gem is not available. `bundle install` to get rake rubocop to work'
|
19
|
+
end
|
@@ -0,0 +1,53 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
# custom foodcritic rule OP001
|
3
|
+
require 'yaml'
|
4
|
+
|
5
|
+
rule 'OP001', 'Include a kitchen test suit for every recipe not included by another' do
|
6
|
+
tags %w(testing op coverage kitchen)
|
7
|
+
cookbook do |cookbook_path|
|
8
|
+
matches = []
|
9
|
+
recipes = Dir.glob(File.join(cookbook_path, 'recipes/*.rb'))
|
10
|
+
|
11
|
+
# Preload and parse Kitchen
|
12
|
+
kitchen = File.read(File.join(cookbook_path, '.kitchen.yml'))
|
13
|
+
kitchen = ERB.new(kitchen).result # Kitchen file is commenly an erb.
|
14
|
+
kitchen = YAML.load(kitchen)
|
15
|
+
|
16
|
+
recipes.each do |recipe|
|
17
|
+
recipe_name = File.basename(recipe, '.rb')
|
18
|
+
|
19
|
+
included_in_another_recipe = false
|
20
|
+
recipes.each do |recipe_include|
|
21
|
+
File.foreach(recipe_include) do |line|
|
22
|
+
if line.include?('include_recipe') &&
|
23
|
+
(line.include?('::' + recipe_name << '\'') ||
|
24
|
+
line.include?('::' + recipe_name << '"'))
|
25
|
+
included_in_another_recipe = true
|
26
|
+
break
|
27
|
+
end
|
28
|
+
end
|
29
|
+
break if included_in_another_recipe
|
30
|
+
end
|
31
|
+
|
32
|
+
# rubocop:disable Style/Next
|
33
|
+
unless included_in_another_recipe
|
34
|
+
# rubocop:enable Style/Next
|
35
|
+
recipe_in_kitchen = false
|
36
|
+
# Verify it's in kitchen test suite
|
37
|
+
kitchen['suites'].each do |suite|
|
38
|
+
suite['run_list'].each do |run_line|
|
39
|
+
if run_line.include?(recipe_name + ']')
|
40
|
+
recipe_in_kitchen = true
|
41
|
+
next
|
42
|
+
end
|
43
|
+
next if recipe_in_kitchen
|
44
|
+
end
|
45
|
+
next if recipe_in_kitchen
|
46
|
+
end
|
47
|
+
matches << file_match(recipe) unless recipe_in_kitchen
|
48
|
+
end
|
49
|
+
end
|
50
|
+
|
51
|
+
matches
|
52
|
+
end
|
53
|
+
end
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
# frozen_string_literal: true
|
3
|
+
lib = File.expand_path('../lib', __FILE__)
|
4
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = 'op-foodcritic-rules'
|
8
|
+
spec.version = '0.0.1'
|
9
|
+
spec.authors = ['Ofir Petrushka']
|
10
|
+
spec.email = ['ofir.petrushka@gmail.com']
|
11
|
+
spec.description = 'Recommendation foodcritic rules.'
|
12
|
+
spec.summary = 'Currently focused on testing.'
|
13
|
+
spec.homepage = 'https://github.com/ofir-petrushka/op-foodcritic-rules'
|
14
|
+
spec.license = 'Apache-2.0'
|
15
|
+
|
16
|
+
spec.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
|
17
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
18
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
19
|
+
spec.require_paths = ['lib']
|
20
|
+
spec.required_ruby_version = '>= 1.9.2'
|
21
|
+
|
22
|
+
spec.add_dependency 'foodcritic', '~> 7'
|
23
|
+
|
24
|
+
spec.add_development_dependency 'bundler', '~> 1'
|
25
|
+
spec.add_development_dependency 'rake', '~> 11'
|
26
|
+
spec.add_development_dependency 'rspec', '~> 3'
|
27
|
+
end
|
@@ -0,0 +1,6 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
# A sample recipe, which will be in .kitchen.yml
|
3
|
+
include_recipe '::tested_by_include_single_quotes'
|
4
|
+
# rubocop:disable Style/StringLiterals - sometimes this style would be in use for various reasons
|
5
|
+
include_recipe "::tested_by_include_double_quotes"
|
6
|
+
# rubocop:enable Style/StringLiterals
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
require 'spec_helper'
|
3
|
+
|
4
|
+
describe 'OP001' do
|
5
|
+
let(:fc_run) do
|
6
|
+
foodcritic_run('OP001')
|
7
|
+
end
|
8
|
+
|
9
|
+
it 'generates a warning against untested recipe' do
|
10
|
+
expect(warnings(fc_run)).to include('untested.rb')
|
11
|
+
end
|
12
|
+
|
13
|
+
it 'doesn\'t generate a warning against tested recipe' do
|
14
|
+
expect(warnings(fc_run)).to_not include('tested.rb')
|
15
|
+
end
|
16
|
+
|
17
|
+
it 'doesn\'t generate a warning against test_includes recipe' do
|
18
|
+
expect(warnings(fc_run)).to_not include('test_includes.rb')
|
19
|
+
end
|
20
|
+
|
21
|
+
it 'doesn\'t generate a warning against tested_by_include recipes' do
|
22
|
+
expect(warnings(fc_run)).to_not include('tested_by_include_single_quotes.rb')
|
23
|
+
expect(warnings(fc_run)).to_not include('tested_by_include_double_quotes.rb')
|
24
|
+
end
|
25
|
+
end
|
data/spec/spec_helper.rb
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
require 'rspec'
|
3
|
+
require 'foodcritic'
|
4
|
+
|
5
|
+
PROJECT_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '../'))
|
6
|
+
|
7
|
+
def foodcritic_run(rule_name)
|
8
|
+
fc = FoodCritic::Linter.new
|
9
|
+
|
10
|
+
opts = {
|
11
|
+
include_rules: [File.join(PROJECT_ROOT, 'lib/foodcritic/rules')],
|
12
|
+
tags: [rule_name.upcase],
|
13
|
+
cookbook_paths: File.join(PROJECT_ROOT, 'sample_cookbooks', rule_name.downcase)
|
14
|
+
}
|
15
|
+
|
16
|
+
fc.check(opts)
|
17
|
+
end
|
18
|
+
|
19
|
+
def warnings(fc_run)
|
20
|
+
fc_run.warnings.collect { |w| File.basename(w.match[:filename]) }.uniq
|
21
|
+
end
|
metadata
ADDED
@@ -0,0 +1,123 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: op-foodcritic-rules
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Ofir Petrushka
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2016-08-15 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: foodcritic
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '7'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '7'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: bundler
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '1'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '1'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rake
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '11'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '11'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: rspec
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '3'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '3'
|
69
|
+
description: Recommendation foodcritic rules.
|
70
|
+
email:
|
71
|
+
- ofir.petrushka@gmail.com
|
72
|
+
executables: []
|
73
|
+
extensions: []
|
74
|
+
extra_rdoc_files: []
|
75
|
+
files:
|
76
|
+
- ".gitignore"
|
77
|
+
- ".rspec"
|
78
|
+
- ".rubocop.yml"
|
79
|
+
- ".ruby-gemset"
|
80
|
+
- ".ruby-version"
|
81
|
+
- ".travis.yml"
|
82
|
+
- Gemfile
|
83
|
+
- Gemfile.lock
|
84
|
+
- LICENSE
|
85
|
+
- README.md
|
86
|
+
- Rakefile
|
87
|
+
- lib/foodcritic/rules/op001.rb
|
88
|
+
- op-foodcritic-rules.gemspec
|
89
|
+
- sample_cookbooks/op001/.kitchen.yml
|
90
|
+
- sample_cookbooks/op001/recipes/test_includes.rb
|
91
|
+
- sample_cookbooks/op001/recipes/tested.rb
|
92
|
+
- sample_cookbooks/op001/recipes/tested_by_include_double_quotes.rb
|
93
|
+
- sample_cookbooks/op001/recipes/tested_by_include_single_quotes.rb
|
94
|
+
- sample_cookbooks/op001/recipes/untested.rb
|
95
|
+
- spec/rules/op001_spec.rb
|
96
|
+
- spec/spec_helper.rb
|
97
|
+
homepage: https://github.com/ofir-petrushka/op-foodcritic-rules
|
98
|
+
licenses:
|
99
|
+
- Apache-2.0
|
100
|
+
metadata: {}
|
101
|
+
post_install_message:
|
102
|
+
rdoc_options: []
|
103
|
+
require_paths:
|
104
|
+
- lib
|
105
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
106
|
+
requirements:
|
107
|
+
- - ">="
|
108
|
+
- !ruby/object:Gem::Version
|
109
|
+
version: 1.9.2
|
110
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
111
|
+
requirements:
|
112
|
+
- - ">="
|
113
|
+
- !ruby/object:Gem::Version
|
114
|
+
version: '0'
|
115
|
+
requirements: []
|
116
|
+
rubyforge_project:
|
117
|
+
rubygems_version: 2.5.1
|
118
|
+
signing_key:
|
119
|
+
specification_version: 4
|
120
|
+
summary: Currently focused on testing.
|
121
|
+
test_files:
|
122
|
+
- spec/rules/op001_spec.rb
|
123
|
+
- spec/spec_helper.rb
|