quality 8.1.1 → 9.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +16 -6
- data/lib/quality/rake/config.rb +13 -4
- data/lib/quality/runner.rb +2 -1
- data/lib/quality/version.rb +1 -1
- metadata +36 -36
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d0eeb8e8200a8489066c3555899760038353c7ff
|
4
|
+
data.tar.gz: 3e81796940c32d493adf9a4d7dc62bf748ae5963
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2377e676f03c114b1295d46d778071b43c7f25760272a1096009a8ff3418b25d7732fd6bf86799ab5e887835ff48ecde18bf5bc515ac3d50439b80c2b370a2a2
|
7
|
+
data.tar.gz: d8dd06d0ca7ad5034466a9014ee38dc3fa14273f9e797dca91e364f249e3f6df94076d30278cd089aa1641a37c3fc492221ce748a577d3798eaaea347fd79fd3
|
data/README.md
CHANGED
@@ -10,6 +10,12 @@ Quality is a tool that runs quality checks on Ruby code using cane,
|
|
10
10
|
reek, flog, flay and rubocop and makes sure your numbers don't get any
|
11
11
|
worse over time.
|
12
12
|
|
13
|
+
## Why
|
14
|
+
|
15
|
+
See [this post](http://blog.apiology.cc/2014/06/scalable-quality-part-1.html) or [these slides](https://docs.google.com/presentation/d/1Op4FH34-enm8luEIuAAVLkuAJ-sB4LKaMm57RJzvfeI/edit#slide) for more information on the problem the quality gem solves.
|
16
|
+
|
17
|
+
##How to use
|
18
|
+
|
13
19
|
```bash
|
14
20
|
$ gem install quality
|
15
21
|
```
|
@@ -81,9 +87,17 @@ Quality::Rake::Task.new { |t|
|
|
81
87
|
t.source_dirs.concat(%w(MyProject MyProjectTests))
|
82
88
|
|
83
89
|
# Pick any extra files that are source files, but may not have
|
84
|
-
# extensions--defaults to
|
90
|
+
# extensions--defaults to %w(Rakefile Dockerfile)
|
85
91
|
t.extra_files = ['tools/check-script', 'Rakefile']
|
86
92
|
|
93
|
+
# Extensions for Ruby language files--defaults to 'rb,rake'
|
94
|
+
t.ruby_file_extensions = 'rb,rake'
|
95
|
+
|
96
|
+
# Extensions for all source files--defaults to
|
97
|
+
# 'rb,rake,swift,cpp,c,java,py,clj,cljs,scala,js,yml,sh,json'
|
98
|
+
t.source_file_extensions =
|
99
|
+
'rb,rake,swift,cpp,c,java,py,clj,cljs,scala,js,yml,sh,json'
|
100
|
+
|
87
101
|
# Relative path to output directory where *_high_water_mark
|
88
102
|
# files will be read/written
|
89
103
|
#
|
@@ -98,10 +112,6 @@ Quality::Rake::Task.new { |t|
|
|
98
112
|
}
|
99
113
|
```
|
100
114
|
|
101
|
-
## Why
|
102
|
-
|
103
|
-
See [this post for more information](http://blog.apiology.cc/2014/06/scalable-quality-part-1.html) on the problem the quality gem solves.
|
104
|
-
|
105
115
|
## Code coverage
|
106
116
|
|
107
117
|
You can pull a similar trick with code coverage using SimpleCov in Ruby--put 'simplecov' in your Gemfile, and add the code below into your test_helper.rb or spec_helper.rb.
|
@@ -120,7 +130,7 @@ Quality uses [semantic versioning](http://semver.org/)--any incompatible changes
|
|
120
130
|
|
121
131
|
## Supported Ruby Versions
|
122
132
|
|
123
|
-
Tested against Ruby
|
133
|
+
Tested against Ruby >=2.0--does not support Ruby 1.9.x.
|
124
134
|
|
125
135
|
## Contributing
|
126
136
|
|
data/lib/quality/rake/config.rb
CHANGED
@@ -37,9 +37,16 @@ module Quality
|
|
37
37
|
attr_writer :source_dirs
|
38
38
|
|
39
39
|
# Pick any extra files that are source files, but may not have
|
40
|
-
# extensions--defaults to
|
40
|
+
# extensions--defaults to %w(Rakefile Dockerfile)
|
41
41
|
attr_accessor :extra_files
|
42
42
|
|
43
|
+
# Extensions for Ruby language files--defaults to 'rb,rake'
|
44
|
+
attr_accessor :ruby_file_extensions
|
45
|
+
|
46
|
+
# Extensions for all source files--defaults to
|
47
|
+
# 'rb,rake,swift,cpp,c,java,py,clj,cljs,scala,js,yml,sh,json'
|
48
|
+
attr_accessor :source_file_extensions
|
49
|
+
|
43
50
|
# Pipe-separated regexp string describing what to look for in
|
44
51
|
# files as 'todo'-like 'punchlist' comments.
|
45
52
|
#
|
@@ -61,11 +68,13 @@ module Quality
|
|
61
68
|
end
|
62
69
|
|
63
70
|
def extra_files
|
64
|
-
@extra_files ||=
|
71
|
+
@extra_files ||= %w(Rakefile Dockerfile)
|
65
72
|
end
|
66
73
|
|
67
74
|
def source_file_extensions
|
68
|
-
|
75
|
+
@source_file_extensions ||=
|
76
|
+
"#{ruby_file_extensions},swift,cpp,c,java,py,clj,cljs,scala,js," \
|
77
|
+
'yml,sh,json'
|
69
78
|
end
|
70
79
|
|
71
80
|
def source_files_glob(dirs = source_dirs,
|
@@ -78,7 +87,7 @@ module Quality
|
|
78
87
|
end
|
79
88
|
|
80
89
|
def ruby_file_extensions
|
81
|
-
'rb,rake'
|
90
|
+
@ruby_file_extensions ||= 'rb,rake'
|
82
91
|
end
|
83
92
|
|
84
93
|
def ruby_files_glob
|
data/lib/quality/runner.rb
CHANGED
@@ -1,3 +1,4 @@
|
|
1
|
+
require 'forwardable'
|
1
2
|
require_relative 'tools/cane'
|
2
3
|
require_relative 'tools/flay'
|
3
4
|
require_relative 'tools/flog'
|
@@ -20,7 +21,7 @@ module Quality
|
|
20
21
|
include Tools::BigFiles
|
21
22
|
include Tools::Punchlist
|
22
23
|
|
23
|
-
extend Forwardable
|
24
|
+
extend ::Forwardable
|
24
25
|
|
25
26
|
def initialize(config,
|
26
27
|
gem_spec: Gem::Specification,
|
data/lib/quality/version.rb
CHANGED
metadata
CHANGED
@@ -1,221 +1,221 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: quality
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version:
|
4
|
+
version: 9.0.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Vince Broz
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2015-
|
11
|
+
date: 2015-07-20 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: cane
|
15
15
|
requirement: !ruby/object:Gem::Requirement
|
16
16
|
requirements:
|
17
|
-
- -
|
17
|
+
- - ">="
|
18
18
|
- !ruby/object:Gem::Version
|
19
19
|
version: '2.6'
|
20
20
|
type: :runtime
|
21
21
|
prerelease: false
|
22
22
|
version_requirements: !ruby/object:Gem::Requirement
|
23
23
|
requirements:
|
24
|
-
- -
|
24
|
+
- - ">="
|
25
25
|
- !ruby/object:Gem::Version
|
26
26
|
version: '2.6'
|
27
27
|
- !ruby/object:Gem::Dependency
|
28
28
|
name: reek
|
29
29
|
requirement: !ruby/object:Gem::Requirement
|
30
30
|
requirements:
|
31
|
-
- -
|
31
|
+
- - ">="
|
32
32
|
- !ruby/object:Gem::Version
|
33
33
|
version: 1.3.4
|
34
34
|
type: :runtime
|
35
35
|
prerelease: false
|
36
36
|
version_requirements: !ruby/object:Gem::Requirement
|
37
37
|
requirements:
|
38
|
-
- -
|
38
|
+
- - ">="
|
39
39
|
- !ruby/object:Gem::Version
|
40
40
|
version: 1.3.4
|
41
41
|
- !ruby/object:Gem::Dependency
|
42
42
|
name: flog
|
43
43
|
requirement: !ruby/object:Gem::Requirement
|
44
44
|
requirements:
|
45
|
-
- -
|
45
|
+
- - ">="
|
46
46
|
- !ruby/object:Gem::Version
|
47
47
|
version: 4.1.1
|
48
48
|
type: :runtime
|
49
49
|
prerelease: false
|
50
50
|
version_requirements: !ruby/object:Gem::Requirement
|
51
51
|
requirements:
|
52
|
-
- -
|
52
|
+
- - ">="
|
53
53
|
- !ruby/object:Gem::Version
|
54
54
|
version: 4.1.1
|
55
55
|
- !ruby/object:Gem::Dependency
|
56
56
|
name: flay
|
57
57
|
requirement: !ruby/object:Gem::Requirement
|
58
58
|
requirements:
|
59
|
-
- -
|
59
|
+
- - ">="
|
60
60
|
- !ruby/object:Gem::Version
|
61
61
|
version: '2.4'
|
62
|
-
- -
|
62
|
+
- - "!="
|
63
63
|
- !ruby/object:Gem::Version
|
64
64
|
version: 2.6.0
|
65
65
|
type: :runtime
|
66
66
|
prerelease: false
|
67
67
|
version_requirements: !ruby/object:Gem::Requirement
|
68
68
|
requirements:
|
69
|
-
- -
|
69
|
+
- - ">="
|
70
70
|
- !ruby/object:Gem::Version
|
71
71
|
version: '2.4'
|
72
|
-
- -
|
72
|
+
- - "!="
|
73
73
|
- !ruby/object:Gem::Version
|
74
74
|
version: 2.6.0
|
75
75
|
- !ruby/object:Gem::Dependency
|
76
76
|
name: rubocop
|
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: :runtime
|
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
|
- !ruby/object:Gem::Dependency
|
90
90
|
name: bigfiles
|
91
91
|
requirement: !ruby/object:Gem::Requirement
|
92
92
|
requirements:
|
93
|
-
- -
|
93
|
+
- - ">="
|
94
94
|
- !ruby/object:Gem::Version
|
95
95
|
version: '0'
|
96
96
|
type: :runtime
|
97
97
|
prerelease: false
|
98
98
|
version_requirements: !ruby/object:Gem::Requirement
|
99
99
|
requirements:
|
100
|
-
- -
|
100
|
+
- - ">="
|
101
101
|
- !ruby/object:Gem::Version
|
102
102
|
version: '0'
|
103
103
|
- !ruby/object:Gem::Dependency
|
104
104
|
name: punchlist
|
105
105
|
requirement: !ruby/object:Gem::Requirement
|
106
106
|
requirements:
|
107
|
-
- -
|
107
|
+
- - ">="
|
108
108
|
- !ruby/object:Gem::Version
|
109
109
|
version: '0'
|
110
110
|
type: :runtime
|
111
111
|
prerelease: false
|
112
112
|
version_requirements: !ruby/object:Gem::Requirement
|
113
113
|
requirements:
|
114
|
-
- -
|
114
|
+
- - ">="
|
115
115
|
- !ruby/object:Gem::Version
|
116
116
|
version: '0'
|
117
117
|
- !ruby/object:Gem::Dependency
|
118
118
|
name: ruby_parser
|
119
119
|
requirement: !ruby/object:Gem::Requirement
|
120
120
|
requirements:
|
121
|
-
- -
|
121
|
+
- - ">="
|
122
122
|
- !ruby/object:Gem::Version
|
123
123
|
version: 3.2.2
|
124
|
-
- -
|
124
|
+
- - "!="
|
125
125
|
- !ruby/object:Gem::Version
|
126
126
|
version: 3.6.6
|
127
127
|
type: :runtime
|
128
128
|
prerelease: false
|
129
129
|
version_requirements: !ruby/object:Gem::Requirement
|
130
130
|
requirements:
|
131
|
-
- -
|
131
|
+
- - ">="
|
132
132
|
- !ruby/object:Gem::Version
|
133
133
|
version: 3.2.2
|
134
|
-
- -
|
134
|
+
- - "!="
|
135
135
|
- !ruby/object:Gem::Version
|
136
136
|
version: 3.6.6
|
137
137
|
- !ruby/object:Gem::Dependency
|
138
138
|
name: json
|
139
139
|
requirement: !ruby/object:Gem::Requirement
|
140
140
|
requirements:
|
141
|
-
- -
|
141
|
+
- - ">="
|
142
142
|
- !ruby/object:Gem::Version
|
143
143
|
version: '0'
|
144
144
|
type: :runtime
|
145
145
|
prerelease: false
|
146
146
|
version_requirements: !ruby/object:Gem::Requirement
|
147
147
|
requirements:
|
148
|
-
- -
|
148
|
+
- - ">="
|
149
149
|
- !ruby/object:Gem::Version
|
150
150
|
version: '0'
|
151
151
|
- !ruby/object:Gem::Dependency
|
152
152
|
name: bundler
|
153
153
|
requirement: !ruby/object:Gem::Requirement
|
154
154
|
requirements:
|
155
|
-
- -
|
155
|
+
- - ">="
|
156
156
|
- !ruby/object:Gem::Version
|
157
157
|
version: '1.1'
|
158
158
|
type: :development
|
159
159
|
prerelease: false
|
160
160
|
version_requirements: !ruby/object:Gem::Requirement
|
161
161
|
requirements:
|
162
|
-
- -
|
162
|
+
- - ">="
|
163
163
|
- !ruby/object:Gem::Version
|
164
164
|
version: '1.1'
|
165
165
|
- !ruby/object:Gem::Dependency
|
166
166
|
name: rake
|
167
167
|
requirement: !ruby/object:Gem::Requirement
|
168
168
|
requirements:
|
169
|
-
- -
|
169
|
+
- - "!="
|
170
170
|
- !ruby/object:Gem::Version
|
171
171
|
version: 10.4.2
|
172
172
|
type: :development
|
173
173
|
prerelease: false
|
174
174
|
version_requirements: !ruby/object:Gem::Requirement
|
175
175
|
requirements:
|
176
|
-
- -
|
176
|
+
- - "!="
|
177
177
|
- !ruby/object:Gem::Version
|
178
178
|
version: 10.4.2
|
179
179
|
- !ruby/object:Gem::Dependency
|
180
180
|
name: simplecov
|
181
181
|
requirement: !ruby/object:Gem::Requirement
|
182
182
|
requirements:
|
183
|
-
- -
|
183
|
+
- - ">="
|
184
184
|
- !ruby/object:Gem::Version
|
185
185
|
version: '0'
|
186
186
|
type: :development
|
187
187
|
prerelease: false
|
188
188
|
version_requirements: !ruby/object:Gem::Requirement
|
189
189
|
requirements:
|
190
|
-
- -
|
190
|
+
- - ">="
|
191
191
|
- !ruby/object:Gem::Version
|
192
192
|
version: '0'
|
193
193
|
- !ruby/object:Gem::Dependency
|
194
194
|
name: mocha
|
195
195
|
requirement: !ruby/object:Gem::Requirement
|
196
196
|
requirements:
|
197
|
-
- -
|
197
|
+
- - ">="
|
198
198
|
- !ruby/object:Gem::Version
|
199
199
|
version: '0'
|
200
200
|
type: :development
|
201
201
|
prerelease: false
|
202
202
|
version_requirements: !ruby/object:Gem::Requirement
|
203
203
|
requirements:
|
204
|
-
- -
|
204
|
+
- - ">="
|
205
205
|
- !ruby/object:Gem::Version
|
206
206
|
version: '0'
|
207
207
|
- !ruby/object:Gem::Dependency
|
208
208
|
name: minitest
|
209
209
|
requirement: !ruby/object:Gem::Requirement
|
210
210
|
requirements:
|
211
|
-
- - ~>
|
211
|
+
- - "~>"
|
212
212
|
- !ruby/object:Gem::Version
|
213
213
|
version: '5'
|
214
214
|
type: :development
|
215
215
|
prerelease: false
|
216
216
|
version_requirements: !ruby/object:Gem::Requirement
|
217
217
|
requirements:
|
218
|
-
- - ~>
|
218
|
+
- - "~>"
|
219
219
|
- !ruby/object:Gem::Version
|
220
220
|
version: '5'
|
221
221
|
description: |+
|
@@ -258,12 +258,12 @@ require_paths:
|
|
258
258
|
- lib
|
259
259
|
required_ruby_version: !ruby/object:Gem::Requirement
|
260
260
|
requirements:
|
261
|
-
- -
|
261
|
+
- - ">="
|
262
262
|
- !ruby/object:Gem::Version
|
263
263
|
version: '0'
|
264
264
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
265
265
|
requirements:
|
266
|
-
- -
|
266
|
+
- - ">="
|
267
267
|
- !ruby/object:Gem::Version
|
268
268
|
version: '0'
|
269
269
|
requirements: []
|