aqila-mapas 0.4.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +12 -0
- data/.rspec +3 -0
- data/.rubocop.yml +1223 -0
- data/.travis.yml +5 -0
- data/Gemfile +14 -0
- data/Gemfile.lock +49 -0
- data/README.md +31 -0
- data/Rakefile +8 -0
- data/aqila-mapas.gemspec +36 -0
- data/bin/console +15 -0
- data/bin/setup +8 -0
- data/lib/aqila/mapas/railtie.rb +13 -0
- data/lib/aqila/mapas/version.rb +7 -0
- data/lib/aqila/mapas.rb +57 -0
- data/lib/map/download_tiles_service.rb +74 -0
- data/lib/map/file_import_basic.rb +30 -0
- data/lib/map/float.rb +13 -0
- data/lib/map/gdal/base.rb +66 -0
- data/lib/map/gdal/colorize_service.rb +82 -0
- data/lib/map/gdal/contrast_stretch_service.rb +26 -0
- data/lib/map/gdal/crop_service.rb +36 -0
- data/lib/map/gdal/gdal_info_service.rb +32 -0
- data/lib/map/gdal/grid_service.rb +36 -0
- data/lib/map/gdal/merge_service.rb +22 -0
- data/lib/map/gdal/ndvi_service.rb +32 -0
- data/lib/map/gdal/ogr2ogr_service.rb +23 -0
- data/lib/map/gdal/ogri_info_service.rb +35 -0
- data/lib/map/gdal/polygonize_service.rb +36 -0
- data/lib/map/gdal/raster_service.rb +36 -0
- data/lib/map/gdal/rgb_service.rb +27 -0
- data/lib/map/gdal/table_colors.txt +52 -0
- data/lib/map/gdal/tiles_service.rb +21 -0
- data/lib/map/gdal/translate_service.rb +37 -0
- data/lib/map/gdal/warp_service.rb +22 -0
- data/lib/map/gleba_tiles_service.rb +29 -0
- data/lib/map/gpx_service.rb +34 -0
- data/lib/map/kml_creator_line_service.rb +31 -0
- data/lib/map/kml_creator_service.rb +31 -0
- data/lib/map/kml_edit_service.rb +122 -0
- data/lib/map/kml_offset_service.rb +59 -0
- data/lib/map/kml_service.rb +35 -0
- data/lib/map/lat_lon_service.rb +93 -0
- data/lib/map/polygon_service.rb +100 -0
- data/lib/map/rgeo_service.rb +42 -0
- data/lib/map/shape_to_tif_service.rb +89 -0
- data/lib/map/tile_service.rb +22 -0
- data/lib/map/tiles_base.rb +11 -0
- data/lib/map/tracking_cleaner_service.rb +78 -0
- data/lib/satellite/imagery_proccessor.rb +70 -0
- data/lib/satellite/landsat8/coordinate_converter_service.rb +40 -0
- data/lib/satellite/landsat8/imagery_service.rb +113 -0
- data/lib/satellite/sentinel2/coordinate_converter_service.rb +90 -0
- data/lib/satellite/sentinel2/imagery_service.rb +144 -0
- metadata +137 -0
data/.rubocop.yml
ADDED
@@ -0,0 +1,1223 @@
|
|
1
|
+
AllCops:
|
2
|
+
DisabledByDefault: true
|
3
|
+
TargetRubyVersion: 2.3.4
|
4
|
+
|
5
|
+
################################ Lint ################################
|
6
|
+
|
7
|
+
Lint/AmbiguousOperator:
|
8
|
+
Description: >-
|
9
|
+
Checks for ambiguous operators in the first argument of a
|
10
|
+
method invocation without parentheses.
|
11
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#parens-as-args'
|
12
|
+
Enabled: true
|
13
|
+
|
14
|
+
Lint/AmbiguousRegexpLiteral:
|
15
|
+
Description: >-
|
16
|
+
Checks for ambiguous regexp literals in the first argument of
|
17
|
+
a method invocation without parenthesis.
|
18
|
+
Enabled: true
|
19
|
+
|
20
|
+
Lint/AssignmentInCondition:
|
21
|
+
Description: "Don't use assignment in conditions."
|
22
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#safe-assignment-in-condition'
|
23
|
+
Enabled: true
|
24
|
+
|
25
|
+
Lint/BlockAlignment:
|
26
|
+
Description: 'Align block ends correctly.'
|
27
|
+
Enabled: true
|
28
|
+
|
29
|
+
Lint/CircularArgumentReference:
|
30
|
+
Description: "Don't refer to the keyword argument in the default value."
|
31
|
+
Enabled: true
|
32
|
+
|
33
|
+
Lint/ConditionPosition:
|
34
|
+
Description: >-
|
35
|
+
Checks for condition placed in a confusing position relative to
|
36
|
+
the keyword.
|
37
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#same-line-condition'
|
38
|
+
Enabled: true
|
39
|
+
|
40
|
+
Lint/Debugger:
|
41
|
+
Description: 'Check for debugger calls.'
|
42
|
+
Enabled: true
|
43
|
+
|
44
|
+
Lint/DefEndAlignment:
|
45
|
+
Description: 'Align ends corresponding to defs correctly.'
|
46
|
+
Enabled: true
|
47
|
+
|
48
|
+
Lint/DeprecatedClassMethods:
|
49
|
+
Description: 'Check for deprecated class method calls.'
|
50
|
+
Enabled: true
|
51
|
+
|
52
|
+
Lint/DuplicateMethods:
|
53
|
+
Description: 'Check for duplicate methods calls.'
|
54
|
+
Enabled: true
|
55
|
+
|
56
|
+
Lint/EachWithObjectArgument:
|
57
|
+
Description: 'Check for immutable argument given to each_with_object.'
|
58
|
+
Enabled: true
|
59
|
+
|
60
|
+
Lint/ElseLayout:
|
61
|
+
Description: 'Check for odd code arrangement in an else block.'
|
62
|
+
Enabled: true
|
63
|
+
|
64
|
+
Lint/EmptyEnsure:
|
65
|
+
Description: 'Checks for empty ensure block.'
|
66
|
+
Enabled: true
|
67
|
+
|
68
|
+
Lint/EmptyInterpolation:
|
69
|
+
Description: 'Checks for empty string interpolation.'
|
70
|
+
Enabled: true
|
71
|
+
|
72
|
+
Lint/EndAlignment:
|
73
|
+
Description: 'Align ends correctly.'
|
74
|
+
EnforcedStyleAlignWith: variable
|
75
|
+
Enabled: true
|
76
|
+
|
77
|
+
Lint/EndInMethod:
|
78
|
+
Description: 'END blocks should not be placed inside method definitions.'
|
79
|
+
Enabled: true
|
80
|
+
|
81
|
+
Lint/EnsureReturn:
|
82
|
+
Description: 'Do not use return in an ensure block.'
|
83
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-return-ensure'
|
84
|
+
Enabled: true
|
85
|
+
|
86
|
+
Lint/FormatParameterMismatch:
|
87
|
+
Description: 'The number of parameters to format/sprint must match the fields.'
|
88
|
+
Enabled: true
|
89
|
+
|
90
|
+
Lint/HandleExceptions:
|
91
|
+
Description: "Don't suppress exception."
|
92
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions'
|
93
|
+
Enabled: true
|
94
|
+
|
95
|
+
Lint/LiteralInInterpolation:
|
96
|
+
Description: 'Checks for literals used in interpolation.'
|
97
|
+
Enabled: true
|
98
|
+
|
99
|
+
Lint/Loop:
|
100
|
+
Description: >-
|
101
|
+
Use Kernel#loop with break rather than begin/end/until or
|
102
|
+
begin/end/while for post-loop tests.
|
103
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#loop-with-break'
|
104
|
+
Enabled: true
|
105
|
+
|
106
|
+
Lint/NestedMethodDefinition:
|
107
|
+
Description: 'Do not use nested method definitions.'
|
108
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-nested-methods'
|
109
|
+
Enabled: true
|
110
|
+
|
111
|
+
Lint/NonLocalExitFromIterator:
|
112
|
+
Description: 'Do not use return in iterator to cause non-local exit.'
|
113
|
+
Enabled: true
|
114
|
+
|
115
|
+
Lint/ParenthesesAsGroupedExpression:
|
116
|
+
Description: >-
|
117
|
+
Checks for method calls with a space before the opening
|
118
|
+
parenthesis.
|
119
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#parens-no-spaces'
|
120
|
+
Enabled: true
|
121
|
+
|
122
|
+
Lint/RequireParentheses:
|
123
|
+
Description: >-
|
124
|
+
Use parentheses in the method call to avoid confusion
|
125
|
+
about precedence.
|
126
|
+
Enabled: true
|
127
|
+
|
128
|
+
Lint/RescueException:
|
129
|
+
Description: 'Avoid rescuing the Exception class.'
|
130
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-blind-rescues'
|
131
|
+
Enabled: true
|
132
|
+
|
133
|
+
Lint/ShadowingOuterLocalVariable:
|
134
|
+
Description: >-
|
135
|
+
Do not use the same name as outer local variable
|
136
|
+
for block arguments or block local variables.
|
137
|
+
Enabled: true
|
138
|
+
|
139
|
+
Lint/StringConversionInInterpolation:
|
140
|
+
Description: 'Checks for Object#to_s usage in string interpolation.'
|
141
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-to-s'
|
142
|
+
Enabled: true
|
143
|
+
|
144
|
+
Lint/UnderscorePrefixedVariableName:
|
145
|
+
Description: 'Do not use prefix `_` for a variable that is used.'
|
146
|
+
Enabled: true
|
147
|
+
|
148
|
+
Lint/UnneededDisable:
|
149
|
+
Description: >-
|
150
|
+
Checks for rubocop:disable comments that can be removed.
|
151
|
+
Note: this cop is not disabled when disabling all cops.
|
152
|
+
It must be explicitly disabled.
|
153
|
+
Enabled: true
|
154
|
+
|
155
|
+
Lint/UnusedBlockArgument:
|
156
|
+
Description: 'Checks for unused block arguments.'
|
157
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#underscore-unused-vars'
|
158
|
+
Enabled: true
|
159
|
+
|
160
|
+
Lint/UnusedMethodArgument:
|
161
|
+
Description: 'Checks for unused method arguments.'
|
162
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#underscore-unused-vars'
|
163
|
+
Enabled: true
|
164
|
+
|
165
|
+
Lint/UnreachableCode:
|
166
|
+
Description: 'Unreachable code.'
|
167
|
+
Enabled: true
|
168
|
+
|
169
|
+
Lint/UselessAccessModifier:
|
170
|
+
Description: 'Checks for useless access modifiers.'
|
171
|
+
Enabled: true
|
172
|
+
|
173
|
+
Lint/UselessAssignment:
|
174
|
+
Description: 'Checks for useless assignment to a local variable.'
|
175
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#underscore-unused-vars'
|
176
|
+
Enabled: true
|
177
|
+
|
178
|
+
Lint/UselessComparison:
|
179
|
+
Description: 'Checks for comparison of something with itself.'
|
180
|
+
Enabled: true
|
181
|
+
|
182
|
+
Lint/UselessElseWithoutRescue:
|
183
|
+
Description: 'Checks for useless `else` in `begin..end` without `rescue`.'
|
184
|
+
Enabled: true
|
185
|
+
|
186
|
+
Lint/UselessSetterCall:
|
187
|
+
Description: 'Checks for useless setter call to a local variable.'
|
188
|
+
Enabled: true
|
189
|
+
|
190
|
+
Lint/Void:
|
191
|
+
Description: 'Possible use of operator/literal/variable in void context.'
|
192
|
+
Enabled: true
|
193
|
+
|
194
|
+
################################ Metrics ################################
|
195
|
+
|
196
|
+
Metrics/AbcSize:
|
197
|
+
Description: >-
|
198
|
+
A calculated magnitude based on number of assignments,
|
199
|
+
branches, and conditions.
|
200
|
+
Reference: 'http://c2.com/cgi/wiki?AbcMetric'
|
201
|
+
Enabled: false
|
202
|
+
Max: 20
|
203
|
+
|
204
|
+
Metrics/BlockNesting:
|
205
|
+
Description: 'Avoid excessive block nesting'
|
206
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#three-is-the-number-thou-shalt-count'
|
207
|
+
Enabled: true
|
208
|
+
Max: 4
|
209
|
+
|
210
|
+
Metrics/ClassLength:
|
211
|
+
Description: 'Avoid classes longer than 250 lines of code.'
|
212
|
+
Enabled: true
|
213
|
+
Max: 250
|
214
|
+
|
215
|
+
Metrics/CyclomaticComplexity:
|
216
|
+
Description: >-
|
217
|
+
A complexity metric that is strongly correlated to the number
|
218
|
+
of test cases needed to validate a method.
|
219
|
+
Enabled: true
|
220
|
+
|
221
|
+
Metrics/LineLength:
|
222
|
+
Description: 'Limit lines to 80 characters.'
|
223
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#80-character-limits'
|
224
|
+
Enabled: false
|
225
|
+
|
226
|
+
Metrics/MethodLength:
|
227
|
+
Description: 'Avoid methods longer than 30 lines of code.'
|
228
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#short-methods'
|
229
|
+
Enabled: true
|
230
|
+
Max: 30
|
231
|
+
|
232
|
+
Metrics/ModuleLength:
|
233
|
+
Description: 'Avoid modules longer than 250 lines of code.'
|
234
|
+
Enabled: true
|
235
|
+
Max: 250
|
236
|
+
|
237
|
+
Metrics/ParameterLists:
|
238
|
+
Description: 'Avoid parameter lists longer than three or four parameters.'
|
239
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#too-many-params'
|
240
|
+
Enabled: true
|
241
|
+
|
242
|
+
Metrics/PerceivedComplexity:
|
243
|
+
Description: >-
|
244
|
+
A complexity metric geared towards measuring complexity for a
|
245
|
+
human reader.
|
246
|
+
Enabled: false
|
247
|
+
|
248
|
+
################################ Performance ################################
|
249
|
+
|
250
|
+
Performance/Count:
|
251
|
+
Description: >-
|
252
|
+
Use `count` instead of `select...size`, `reject...size`,
|
253
|
+
`select...count`, `reject...count`, `select...length`,
|
254
|
+
and `reject...length`.
|
255
|
+
Enabled: true
|
256
|
+
|
257
|
+
Performance/Detect:
|
258
|
+
Description: >-
|
259
|
+
Use `detect` instead of `select.first`, `find_all.first`,
|
260
|
+
`select.last`, and `find_all.last`.
|
261
|
+
Reference: 'https://github.com/JuanitoFatas/fast-ruby#enumerabledetect-vs-enumerableselectfirst-code'
|
262
|
+
Enabled: true
|
263
|
+
|
264
|
+
Performance/FlatMap:
|
265
|
+
Description: >-
|
266
|
+
Use `Enumerable#flat_map`
|
267
|
+
instead of `Enumerable#map...Array#flatten(1)`
|
268
|
+
or `Enumberable#collect..Array#flatten(1)`
|
269
|
+
Reference: 'https://github.com/JuanitoFatas/fast-ruby#enumerablemaparrayflatten-vs-enumerableflat_map-code'
|
270
|
+
Enabled: true
|
271
|
+
EnabledForFlattenWithoutParams: false
|
272
|
+
# If enabled, this cop will warn about usages of
|
273
|
+
# `flatten` being called without any parameters.
|
274
|
+
# This can be dangerous since `flat_map` will only flatten 1 level, and
|
275
|
+
# `flatten` without any parameters can flatten multiple levels.
|
276
|
+
|
277
|
+
Performance/ReverseEach:
|
278
|
+
Description: 'Use `reverse_each` instead of `reverse.each`.'
|
279
|
+
Reference: 'https://github.com/JuanitoFatas/fast-ruby#enumerablereverseeach-vs-enumerablereverse_each-code'
|
280
|
+
Enabled: true
|
281
|
+
|
282
|
+
Performance/Sample:
|
283
|
+
Description: >-
|
284
|
+
Use `sample` instead of `shuffle.first`,
|
285
|
+
`shuffle.last`, and `shuffle[Fixnum]`.
|
286
|
+
Reference: 'https://github.com/JuanitoFatas/fast-ruby#arrayshufflefirst-vs-arraysample-code'
|
287
|
+
Enabled: true
|
288
|
+
|
289
|
+
Performance/Size:
|
290
|
+
Description: >-
|
291
|
+
Use `size` instead of `count` for counting
|
292
|
+
the number of elements in `Array` and `Hash`.
|
293
|
+
Reference: 'https://github.com/JuanitoFatas/fast-ruby#arraycount-vs-arraysize-code'
|
294
|
+
Enabled: true
|
295
|
+
|
296
|
+
Performance/StringReplacement:
|
297
|
+
Description: >-
|
298
|
+
Use `tr` instead of `gsub` when you are replacing the same
|
299
|
+
number of characters. Use `delete` instead of `gsub` when
|
300
|
+
you are deleting characters.
|
301
|
+
Reference: 'https://github.com/JuanitoFatas/fast-ruby#stringgsub-vs-stringtr-code'
|
302
|
+
Enabled: true
|
303
|
+
|
304
|
+
Performance/Casecmp:
|
305
|
+
Description: >-
|
306
|
+
This cop identifies places where a case-insensitive string
|
307
|
+
comparison can better be implemented using casecmp.
|
308
|
+
Enabled: true
|
309
|
+
|
310
|
+
Performance/CompareWithBlock:
|
311
|
+
Description: >-
|
312
|
+
This cop identifies places where sort { |a, b| a.foo <=> b.foo }
|
313
|
+
can be replaced by sort_by(&:foo).
|
314
|
+
This cop also checks max and min methods.
|
315
|
+
Enabled: true
|
316
|
+
|
317
|
+
Performance/RedundantMerge:
|
318
|
+
Description: >-
|
319
|
+
This cop identifies places where Hash#merge! can be replaced by Hash#[]=.
|
320
|
+
Enabled: true
|
321
|
+
|
322
|
+
Performance/HashEachMethods:
|
323
|
+
Description: >-
|
324
|
+
This cop checks for uses of `each_key` and `each_value` Hash methods.
|
325
|
+
Enabled: true
|
326
|
+
|
327
|
+
Performance/RedundantBlockCall:
|
328
|
+
Description: >-
|
329
|
+
This cop identifies the use of a `&block` parameter
|
330
|
+
and `block.call` where `yield` would do just as well.
|
331
|
+
Enabled: true
|
332
|
+
Performance/TimesMap:
|
333
|
+
Description: >-
|
334
|
+
This cop checks for .times.map calls. In most cases
|
335
|
+
such calls can be replaced with an explicit array creation.
|
336
|
+
Enabled: true
|
337
|
+
|
338
|
+
################################ Rails ################################
|
339
|
+
|
340
|
+
Rails/ActionFilter:
|
341
|
+
Description: 'Enforces consistent use of action filter methods.'
|
342
|
+
Enabled: false
|
343
|
+
|
344
|
+
Rails/Date:
|
345
|
+
Description: >-
|
346
|
+
Checks the correct usage of date aware methods,
|
347
|
+
such as Date.today, Date.current etc.
|
348
|
+
Enabled: false
|
349
|
+
|
350
|
+
Rails/Delegate:
|
351
|
+
Description: 'Prefer delegate method for delegations.'
|
352
|
+
Enabled: false
|
353
|
+
|
354
|
+
Rails/FindBy:
|
355
|
+
Description: 'Prefer find_by over where.first.'
|
356
|
+
Enabled: false
|
357
|
+
|
358
|
+
Rails/FindEach:
|
359
|
+
Description: 'Prefer all.find_each over all.find.'
|
360
|
+
Enabled: false
|
361
|
+
|
362
|
+
Rails/HasAndBelongsToMany:
|
363
|
+
Description: 'Prefer has_many :through to has_and_belongs_to_many.'
|
364
|
+
Enabled: false
|
365
|
+
|
366
|
+
Rails/Output:
|
367
|
+
Description: 'Checks for calls to puts, print, etc.'
|
368
|
+
Enabled: false
|
369
|
+
|
370
|
+
Rails/ReadWriteAttribute:
|
371
|
+
Description: >-
|
372
|
+
Checks for read_attribute(:attr) and
|
373
|
+
write_attribute(:attr, val).
|
374
|
+
Enabled: false
|
375
|
+
|
376
|
+
Rails/ScopeArgs:
|
377
|
+
Description: 'Checks the arguments of ActiveRecord scopes.'
|
378
|
+
Enabled: false
|
379
|
+
|
380
|
+
Rails/TimeZone:
|
381
|
+
Description: 'Checks the correct usage of time zone aware methods.'
|
382
|
+
StyleGuide: 'https://github.com/bbatsov/rails-style-guide#time'
|
383
|
+
Reference: 'http://danilenko.org/2012/7/6/rails_timezones'
|
384
|
+
Enabled: false
|
385
|
+
|
386
|
+
Rails/Validation:
|
387
|
+
Description: 'Use validates :attribute, hash of validations.'
|
388
|
+
Enabled: false
|
389
|
+
|
390
|
+
################################ Style ################################
|
391
|
+
|
392
|
+
Style/Alias:
|
393
|
+
Description: 'Use alias_method instead of alias.'
|
394
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#alias-method'
|
395
|
+
Enabled: false
|
396
|
+
|
397
|
+
Style/AndOr:
|
398
|
+
Description: 'Use &&/|| instead of and/or.'
|
399
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-and-or-or'
|
400
|
+
Enabled: false
|
401
|
+
|
402
|
+
Style/ArrayJoin:
|
403
|
+
Description: 'Use Array#join instead of Array#*.'
|
404
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#array-join'
|
405
|
+
Enabled: false
|
406
|
+
|
407
|
+
Style/AsciiComments:
|
408
|
+
Description: 'Use only ascii symbols in comments.'
|
409
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#english-comments'
|
410
|
+
Enabled: false
|
411
|
+
|
412
|
+
Style/Attr:
|
413
|
+
Description: 'Checks for uses of Module#attr.'
|
414
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#attr'
|
415
|
+
Enabled: false
|
416
|
+
|
417
|
+
Style/BeginBlock:
|
418
|
+
Description: 'Avoid the use of BEGIN blocks.'
|
419
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-BEGIN-blocks'
|
420
|
+
Enabled: false
|
421
|
+
|
422
|
+
Style/BarePercentLiterals:
|
423
|
+
Description: 'Checks if usage of %() or %Q() matches configuration.'
|
424
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#percent-q-shorthand'
|
425
|
+
Enabled: false
|
426
|
+
|
427
|
+
Style/BlockComments:
|
428
|
+
Description: 'Do not use block comments.'
|
429
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-block-comments'
|
430
|
+
Enabled: false
|
431
|
+
|
432
|
+
Style/BlockDelimiters:
|
433
|
+
Description: >-
|
434
|
+
Avoid using {...} for multi-line blocks (multiline chaining is
|
435
|
+
always ugly).
|
436
|
+
Prefer {...} over do...end for single-line blocks.
|
437
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#single-line-blocks'
|
438
|
+
Enabled: false
|
439
|
+
|
440
|
+
Style/BracesAroundHashParameters:
|
441
|
+
Description: 'Enforce braces style around hash parameters.'
|
442
|
+
Enabled: false
|
443
|
+
|
444
|
+
Style/CaseEquality:
|
445
|
+
Description: 'Avoid explicit use of the case equality operator(===).'
|
446
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-case-equality'
|
447
|
+
Enabled: false
|
448
|
+
|
449
|
+
Style/CharacterLiteral:
|
450
|
+
Description: 'Checks for uses of character literals.'
|
451
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-character-literals'
|
452
|
+
Enabled: false
|
453
|
+
|
454
|
+
Style/ClassAndModuleChildren:
|
455
|
+
Description: 'Checks style of children classes and modules.'
|
456
|
+
Enabled: false
|
457
|
+
|
458
|
+
Style/ClassCheck:
|
459
|
+
Description: 'Enforces consistent use of `Object#is_a?` or `Object#kind_of?`.'
|
460
|
+
Enabled: false
|
461
|
+
|
462
|
+
Style/ClassMethods:
|
463
|
+
Description: 'Use self when defining module/class methods.'
|
464
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#def-self-class-methods'
|
465
|
+
Enabled: false
|
466
|
+
|
467
|
+
Style/ClassVars:
|
468
|
+
Description: 'Avoid the use of class variables.'
|
469
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-class-vars'
|
470
|
+
Enabled: false
|
471
|
+
|
472
|
+
Style/ColonMethodCall:
|
473
|
+
Description: 'Do not use :: for method call.'
|
474
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#double-colons'
|
475
|
+
Enabled: false
|
476
|
+
|
477
|
+
Style/CommandLiteral:
|
478
|
+
Description: 'Use `` or %x around command literals.'
|
479
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#percent-x'
|
480
|
+
Enabled: false
|
481
|
+
|
482
|
+
Style/CommentAnnotation:
|
483
|
+
Description: 'Checks formatting of annotation comments.'
|
484
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#annotate-keywords'
|
485
|
+
Enabled: false
|
486
|
+
|
487
|
+
Style/DefWithParentheses:
|
488
|
+
Description: 'Use def with parentheses when there are arguments.'
|
489
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#method-parens'
|
490
|
+
Enabled: false
|
491
|
+
|
492
|
+
Style/PreferredHashMethods:
|
493
|
+
Description: 'Checks for use of deprecated Hash methods.'
|
494
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#hash-key'
|
495
|
+
Enabled: false
|
496
|
+
|
497
|
+
Style/Documentation:
|
498
|
+
Description: 'Document classes and non-namespace modules.'
|
499
|
+
Enabled: false
|
500
|
+
|
501
|
+
Style/DoubleNegation:
|
502
|
+
Description: 'Checks for uses of double negation (!!).'
|
503
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-bang-bang'
|
504
|
+
Enabled: false
|
505
|
+
|
506
|
+
Style/EachWithObject:
|
507
|
+
Description: 'Prefer `each_with_object` over `inject` or `reduce`.'
|
508
|
+
Enabled: false
|
509
|
+
|
510
|
+
Style/EmptyElse:
|
511
|
+
Description: 'Avoid empty else-clauses.'
|
512
|
+
Enabled: false
|
513
|
+
|
514
|
+
Style/EmptyLiteral:
|
515
|
+
Description: 'Prefer literals to Array.new/Hash.new/String.new.'
|
516
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#literal-array-hash'
|
517
|
+
Enabled: false
|
518
|
+
|
519
|
+
Style/EndBlock:
|
520
|
+
Description: 'Avoid the use of END blocks.'
|
521
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-END-blocks'
|
522
|
+
Enabled: false
|
523
|
+
|
524
|
+
Style/EvenOdd:
|
525
|
+
Description: 'Favor the use of Fixnum#even? && Fixnum#odd?'
|
526
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#predicate-methods'
|
527
|
+
Enabled: false
|
528
|
+
|
529
|
+
Style/FlipFlop:
|
530
|
+
Description: 'Checks for flip flops'
|
531
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-flip-flops'
|
532
|
+
Enabled: false
|
533
|
+
|
534
|
+
Style/For:
|
535
|
+
Description: 'Checks use of for or each in multiline loops.'
|
536
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-for-loops'
|
537
|
+
Enabled: false
|
538
|
+
|
539
|
+
Style/FormatString:
|
540
|
+
Description: 'Enforce the use of Kernel#sprintf, Kernel#format or String#%.'
|
541
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#sprintf'
|
542
|
+
Enabled: false
|
543
|
+
|
544
|
+
Style/GlobalVars:
|
545
|
+
Description: 'Do not introduce global variables.'
|
546
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#instance-vars'
|
547
|
+
Reference: 'http://www.zenspider.com/Languages/Ruby/QuickRef.html'
|
548
|
+
Enabled: false
|
549
|
+
|
550
|
+
Style/GuardClause:
|
551
|
+
Description: 'Check for conditionals that can be replaced with guard clauses'
|
552
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals'
|
553
|
+
Enabled: false
|
554
|
+
|
555
|
+
Style/HashSyntax:
|
556
|
+
Description: >-
|
557
|
+
Prefer Ruby 1.9 hash syntax { a: 1, b: 2 } over 1.8 syntax
|
558
|
+
{ :a => 1, :b => 2 }.
|
559
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#hash-literals'
|
560
|
+
Enabled: false
|
561
|
+
|
562
|
+
Style/IfUnlessModifier:
|
563
|
+
Description: >-
|
564
|
+
Favor modifier if/unless usage when you have a
|
565
|
+
single-line body.
|
566
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#if-as-a-modifier'
|
567
|
+
Enabled: false
|
568
|
+
|
569
|
+
Style/IfWithSemicolon:
|
570
|
+
Description: 'Do not use if x; .... Use the ternary operator instead.'
|
571
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-semicolon-ifs'
|
572
|
+
Enabled: false
|
573
|
+
|
574
|
+
Style/InfiniteLoop:
|
575
|
+
Description: 'Use Kernel#loop for infinite loops.'
|
576
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#infinite-loop'
|
577
|
+
Enabled: false
|
578
|
+
|
579
|
+
Style/Lambda:
|
580
|
+
Description: 'Use the new lambda literal syntax for single-line blocks.'
|
581
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#lambda-multi-line'
|
582
|
+
Enabled: false
|
583
|
+
|
584
|
+
Style/LambdaCall:
|
585
|
+
Description: 'Use lambda.call(...) instead of lambda.(...).'
|
586
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#proc-call'
|
587
|
+
Enabled: false
|
588
|
+
|
589
|
+
Style/LineEndConcatenation:
|
590
|
+
Description: >-
|
591
|
+
Use \ instead of + or << to concatenate two string literals at
|
592
|
+
line end.
|
593
|
+
Enabled: false
|
594
|
+
|
595
|
+
Style/MethodCallWithoutArgsParentheses:
|
596
|
+
Description: 'Do not use parentheses for method calls with no arguments.'
|
597
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-args-no-parens'
|
598
|
+
Enabled: false
|
599
|
+
|
600
|
+
Style/MethodDefParentheses:
|
601
|
+
Description: >-
|
602
|
+
Checks if the method definitions have or don't have
|
603
|
+
parentheses.
|
604
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#method-parens'
|
605
|
+
Enabled: false
|
606
|
+
|
607
|
+
Style/ModuleFunction:
|
608
|
+
Description: 'Checks for usage of `extend self` in modules.'
|
609
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#module-function'
|
610
|
+
Enabled: false
|
611
|
+
|
612
|
+
Style/MultilineBlockChain:
|
613
|
+
Description: 'Avoid multi-line chains of blocks.'
|
614
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#single-line-blocks'
|
615
|
+
Enabled: false
|
616
|
+
|
617
|
+
Style/MultilineIfThen:
|
618
|
+
Description: 'Do not use then for multi-line if/unless.'
|
619
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-then'
|
620
|
+
Enabled: false
|
621
|
+
|
622
|
+
Style/MultilineTernaryOperator:
|
623
|
+
Description: >-
|
624
|
+
Avoid multi-line ?: (the ternary operator);
|
625
|
+
use if/unless instead.
|
626
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-multiline-ternary'
|
627
|
+
Enabled: false
|
628
|
+
|
629
|
+
Style/NegatedIf:
|
630
|
+
Description: >-
|
631
|
+
Favor unless over if for negative conditions
|
632
|
+
(or control flow or).
|
633
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#unless-for-negatives'
|
634
|
+
Enabled: false
|
635
|
+
|
636
|
+
Style/NegatedWhile:
|
637
|
+
Description: 'Favor until over while for negative conditions.'
|
638
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#until-for-negatives'
|
639
|
+
Enabled: false
|
640
|
+
|
641
|
+
Style/NestedTernaryOperator:
|
642
|
+
Description: 'Use one expression per branch in a ternary operator.'
|
643
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-nested-ternary'
|
644
|
+
Enabled: false
|
645
|
+
|
646
|
+
Style/Next:
|
647
|
+
Description: 'Use `next` to skip iteration instead of a condition at the end.'
|
648
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals'
|
649
|
+
Enabled: false
|
650
|
+
|
651
|
+
Style/NilComparison:
|
652
|
+
Description: 'Prefer x.nil? to x == nil.'
|
653
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#predicate-methods'
|
654
|
+
Enabled: false
|
655
|
+
|
656
|
+
Style/NonNilCheck:
|
657
|
+
Description: 'Checks for redundant nil checks.'
|
658
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-non-nil-checks'
|
659
|
+
Enabled: false
|
660
|
+
|
661
|
+
Style/Not:
|
662
|
+
Description: 'Use ! instead of not.'
|
663
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#bang-not-not'
|
664
|
+
Enabled: false
|
665
|
+
|
666
|
+
Style/NumericLiterals:
|
667
|
+
Description: >-
|
668
|
+
Add underscores to large numeric literals to improve their
|
669
|
+
readability.
|
670
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#underscores-in-numerics'
|
671
|
+
Enabled: false
|
672
|
+
|
673
|
+
Style/OneLineConditional:
|
674
|
+
Description: >-
|
675
|
+
Favor the ternary operator(?:) over
|
676
|
+
if/then/else/end constructs.
|
677
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#ternary-operator'
|
678
|
+
Enabled: false
|
679
|
+
|
680
|
+
Style/OptionalArguments:
|
681
|
+
Description: >-
|
682
|
+
Checks for optional arguments that do not appear at the end
|
683
|
+
of the argument list
|
684
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#optional-arguments'
|
685
|
+
Enabled: false
|
686
|
+
|
687
|
+
Style/ParallelAssignment:
|
688
|
+
Description: >-
|
689
|
+
Check for simple usages of parallel assignment.
|
690
|
+
It will only warn when the number of variables
|
691
|
+
matches on both sides of the assignment.
|
692
|
+
This also provides performance benefits
|
693
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#parallel-assignment'
|
694
|
+
Enabled: false
|
695
|
+
|
696
|
+
Style/ParenthesesAroundCondition:
|
697
|
+
Description: >-
|
698
|
+
Don't use parentheses around the condition of an
|
699
|
+
if/unless/while.
|
700
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-parens-if'
|
701
|
+
Enabled: false
|
702
|
+
|
703
|
+
Style/PercentLiteralDelimiters:
|
704
|
+
Description: 'Use `%`-literal delimiters consistently'
|
705
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#percent-literal-braces'
|
706
|
+
Enabled: false
|
707
|
+
|
708
|
+
Style/PercentQLiterals:
|
709
|
+
Description: 'Checks if uses of %Q/%q match the configured preference.'
|
710
|
+
Enabled: false
|
711
|
+
|
712
|
+
Style/PerlBackrefs:
|
713
|
+
Description: 'Avoid Perl-style regex back references.'
|
714
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-perl-regexp-last-matchers'
|
715
|
+
Enabled: false
|
716
|
+
|
717
|
+
Style/Proc:
|
718
|
+
Description: 'Use proc instead of Proc.new.'
|
719
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#proc'
|
720
|
+
Enabled: false
|
721
|
+
|
722
|
+
Style/RaiseArgs:
|
723
|
+
Description: 'Checks the arguments passed to raise/fail.'
|
724
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#exception-class-messages'
|
725
|
+
Enabled: false
|
726
|
+
|
727
|
+
Style/RedundantBegin:
|
728
|
+
Description: "Don't use begin blocks when they are not needed."
|
729
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#begin-implicit'
|
730
|
+
Enabled: false
|
731
|
+
|
732
|
+
Style/RedundantException:
|
733
|
+
Description: "Checks for an obsolete RuntimeException argument in raise/fail."
|
734
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-explicit-runtimeerror'
|
735
|
+
Enabled: false
|
736
|
+
|
737
|
+
Style/RedundantReturn:
|
738
|
+
Description: "Don't use return where it's not required."
|
739
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-explicit-return'
|
740
|
+
Enabled: false
|
741
|
+
|
742
|
+
Style/RedundantSelf:
|
743
|
+
Description: "Don't use self where it's not needed."
|
744
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-self-unless-required'
|
745
|
+
Enabled: false
|
746
|
+
|
747
|
+
Style/RegexpLiteral:
|
748
|
+
Description: 'Use / or %r around regular expressions.'
|
749
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#percent-r'
|
750
|
+
Enabled: false
|
751
|
+
|
752
|
+
Style/RescueModifier:
|
753
|
+
Description: 'Avoid using rescue in its modifier form.'
|
754
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-rescue-modifiers'
|
755
|
+
Enabled: false
|
756
|
+
|
757
|
+
Style/SelfAssignment:
|
758
|
+
Description: >-
|
759
|
+
Checks for places where self-assignment shorthand should have
|
760
|
+
been used.
|
761
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#self-assignment'
|
762
|
+
Enabled: false
|
763
|
+
|
764
|
+
Style/Semicolon:
|
765
|
+
Description: "Don't use semicolons to terminate expressions."
|
766
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-semicolon'
|
767
|
+
Enabled: false
|
768
|
+
|
769
|
+
Style/SignalException:
|
770
|
+
Description: 'Checks for proper usage of fail and raise.'
|
771
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#fail-method'
|
772
|
+
Enabled: false
|
773
|
+
|
774
|
+
Style/SingleLineBlockParams:
|
775
|
+
Description: 'Enforces the names of some block params.'
|
776
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#reduce-blocks'
|
777
|
+
Enabled: false
|
778
|
+
|
779
|
+
Style/SingleLineMethods:
|
780
|
+
Description: 'Avoid single-line methods.'
|
781
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-single-line-methods'
|
782
|
+
Enabled: false
|
783
|
+
|
784
|
+
Style/SpecialGlobalVars:
|
785
|
+
Description: 'Avoid Perl-style global variables.'
|
786
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-cryptic-perlisms'
|
787
|
+
Enabled: false
|
788
|
+
|
789
|
+
Style/StringLiterals:
|
790
|
+
Description: 'Checks if uses of quotes match the configured preference.'
|
791
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#consistent-string-literals'
|
792
|
+
Enabled: false
|
793
|
+
|
794
|
+
Style/StringLiteralsInInterpolation:
|
795
|
+
Description: >-
|
796
|
+
Checks if uses of quotes inside expressions in interpolated
|
797
|
+
strings match the configured preference.
|
798
|
+
Enabled: false
|
799
|
+
|
800
|
+
Style/StructInheritance:
|
801
|
+
Description: 'Checks for inheritance from Struct.new.'
|
802
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-extend-struct-new'
|
803
|
+
Enabled: false
|
804
|
+
|
805
|
+
Style/SymbolLiteral:
|
806
|
+
Description: 'Use plain symbols instead of string symbols when possible.'
|
807
|
+
Enabled: false
|
808
|
+
|
809
|
+
Style/SymbolProc:
|
810
|
+
Description: 'Use symbols as procs instead of blocks when possible.'
|
811
|
+
Enabled: false
|
812
|
+
|
813
|
+
Style/TrailingCommaInArguments:
|
814
|
+
Description: 'Checks for trailing comma in parameter lists.'
|
815
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-params-comma'
|
816
|
+
Enabled: false
|
817
|
+
|
818
|
+
Style/TrailingCommaInLiteral:
|
819
|
+
Description: 'Checks for trailing comma in literals.'
|
820
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
|
821
|
+
Enabled: false
|
822
|
+
|
823
|
+
Style/TrivialAccessors:
|
824
|
+
Description: 'Prefer attr_* methods to trivial readers/writers.'
|
825
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#attr_family'
|
826
|
+
Enabled: false
|
827
|
+
|
828
|
+
Style/UnlessElse:
|
829
|
+
Description: >-
|
830
|
+
Do not use unless with else. Rewrite these with the positive
|
831
|
+
case first.
|
832
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-else-with-unless'
|
833
|
+
Enabled: false
|
834
|
+
|
835
|
+
Style/UnneededCapitalW:
|
836
|
+
Description: 'Checks for %W when interpolation is not needed.'
|
837
|
+
Enabled: false
|
838
|
+
|
839
|
+
Style/UnneededPercentQ:
|
840
|
+
Description: 'Checks for %q/%Q when single quotes or double quotes would do.'
|
841
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#percent-q'
|
842
|
+
Enabled: false
|
843
|
+
|
844
|
+
Style/TrailingUnderscoreVariable:
|
845
|
+
Description: >-
|
846
|
+
Checks for the usage of unneeded trailing underscores at the
|
847
|
+
end of parallel variable assignment.
|
848
|
+
Enabled: false
|
849
|
+
|
850
|
+
Style/VariableInterpolation:
|
851
|
+
Description: >-
|
852
|
+
Don't interpolate global, instance and class variables
|
853
|
+
directly in strings.
|
854
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#curlies-interpolate'
|
855
|
+
Enabled: false
|
856
|
+
|
857
|
+
Style/WhenThen:
|
858
|
+
Description: 'Use when x then ... for one-line cases.'
|
859
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#one-line-cases'
|
860
|
+
Enabled: false
|
861
|
+
|
862
|
+
Style/WhileUntilDo:
|
863
|
+
Description: 'Checks for redundant do after while or until.'
|
864
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-multiline-while-do'
|
865
|
+
Enabled: false
|
866
|
+
|
867
|
+
Style/WhileUntilModifier:
|
868
|
+
Description: >-
|
869
|
+
Favor modifier while/until usage when you have a
|
870
|
+
single-line body.
|
871
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#while-as-a-modifier'
|
872
|
+
Enabled: false
|
873
|
+
|
874
|
+
Style/WordArray:
|
875
|
+
Description: 'Use %w or %W for arrays of words.'
|
876
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#percent-w'
|
877
|
+
Enabled: false
|
878
|
+
|
879
|
+
Style/FrozenStringLiteralComment:
|
880
|
+
Description: >-
|
881
|
+
This cop is designed to help upgrade to Ruby 3.0.
|
882
|
+
It will add the comment `# frozen_string_literal: true`
|
883
|
+
to the top of files to enable frozen string literals.
|
884
|
+
Frozen string literals may be default in Ruby 3.0.
|
885
|
+
The comment will be added below a shebang and encoding comment.
|
886
|
+
The frozen string literal comment is only valid in Ruby 2.3+.
|
887
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#magic-comments'
|
888
|
+
Enabled: true
|
889
|
+
|
890
|
+
Style/MutableConstant:
|
891
|
+
Description: >-
|
892
|
+
This cop checks whether some constant value isn't a mutable literal (e.g. array or hash).
|
893
|
+
Enabled: true
|
894
|
+
|
895
|
+
################################ Layout ################################
|
896
|
+
|
897
|
+
Layout/MultilineMethodCallIndentation:
|
898
|
+
Description: >-
|
899
|
+
This cop checks the indentation of the method name part in method calls
|
900
|
+
that span more than one line.
|
901
|
+
EnforcedStyle: indented
|
902
|
+
Enabled: true
|
903
|
+
|
904
|
+
Layout/AccessModifierIndentation:
|
905
|
+
Description: Check indentation of private/protected visibility modifiers.
|
906
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#indent-public-private-protected'
|
907
|
+
Enabled: false
|
908
|
+
|
909
|
+
Layout/AlignArray:
|
910
|
+
Description: >-
|
911
|
+
Align the elements of an array literal if they span more than
|
912
|
+
one line.
|
913
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#align-multiline-arrays'
|
914
|
+
Enabled: false
|
915
|
+
|
916
|
+
Layout/AlignHash:
|
917
|
+
Description: >-
|
918
|
+
Align the elements of a hash literal if they span more than
|
919
|
+
one line.
|
920
|
+
Enabled: false
|
921
|
+
|
922
|
+
Layout/AlignParameters:
|
923
|
+
Description: >-
|
924
|
+
Align the parameters of a method call if they span more
|
925
|
+
than one line.
|
926
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-double-indent'
|
927
|
+
Enabled: false
|
928
|
+
|
929
|
+
Layout/BlockEndNewline:
|
930
|
+
Description: 'Put end statement of multiline block on its own line.'
|
931
|
+
Enabled: false
|
932
|
+
|
933
|
+
Layout/CaseIndentation:
|
934
|
+
Description: 'Indentation of when in a case/when/[else/]end.'
|
935
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#indent-when-to-case'
|
936
|
+
Enabled: false
|
937
|
+
|
938
|
+
Layout/ClosingParenthesisIndentation:
|
939
|
+
Description: 'Checks the indentation of hanging closing parentheses.'
|
940
|
+
Enabled: false
|
941
|
+
|
942
|
+
Layout/CommentIndentation:
|
943
|
+
Description: 'Indentation of comments.'
|
944
|
+
Enabled: false
|
945
|
+
|
946
|
+
Layout/DotPosition:
|
947
|
+
Description: 'Checks the position of the dot in multi-line method calls.'
|
948
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#consistent-multi-line-chains'
|
949
|
+
Enabled: false
|
950
|
+
|
951
|
+
Layout/ElseAlignment:
|
952
|
+
Description: 'Align elses and elsifs correctly.'
|
953
|
+
Enabled: false
|
954
|
+
|
955
|
+
Layout/EmptyLineBetweenDefs:
|
956
|
+
Description: 'Use empty lines between defs.'
|
957
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#empty-lines-between-methods'
|
958
|
+
Enabled: false
|
959
|
+
|
960
|
+
Layout/EmptyLines:
|
961
|
+
Description: "Don't use several empty lines in a row."
|
962
|
+
Enabled: false
|
963
|
+
|
964
|
+
Layout/EmptyLinesAroundAccessModifier:
|
965
|
+
Description: "Keep blank lines around access modifiers."
|
966
|
+
Enabled: false
|
967
|
+
|
968
|
+
Layout/EmptyLinesAroundBlockBody:
|
969
|
+
Description: "Keeps track of empty lines around block bodies."
|
970
|
+
Enabled: false
|
971
|
+
|
972
|
+
Layout/EmptyLinesAroundClassBody:
|
973
|
+
Description: "Keeps track of empty lines around class bodies."
|
974
|
+
Enabled: false
|
975
|
+
|
976
|
+
Layout/EmptyLinesAroundModuleBody:
|
977
|
+
Description: "Keeps track of empty lines around module bodies."
|
978
|
+
Enabled: false
|
979
|
+
|
980
|
+
Layout/EmptyLinesAroundMethodBody:
|
981
|
+
Description: "Keeps track of empty lines around method bodies."
|
982
|
+
Enabled: false
|
983
|
+
|
984
|
+
Layout/EndOfLine:
|
985
|
+
Description: 'Use Unix-style line endings.'
|
986
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#crlf'
|
987
|
+
Enabled: false
|
988
|
+
|
989
|
+
Layout/ExtraSpacing:
|
990
|
+
Description: 'Do not use unnecessary spacing.'
|
991
|
+
Enabled: false
|
992
|
+
|
993
|
+
Layout/InitialIndentation:
|
994
|
+
Description: >-
|
995
|
+
Checks the indentation of the first non-blank non-comment line in a file.
|
996
|
+
Enabled: false
|
997
|
+
|
998
|
+
Layout/FirstParameterIndentation:
|
999
|
+
Description: 'Checks the indentation of the first parameter in a method call.'
|
1000
|
+
Enabled: false
|
1001
|
+
|
1002
|
+
Layout/IndentationConsistency:
|
1003
|
+
Description: 'Keep indentation straight.'
|
1004
|
+
Enabled: false
|
1005
|
+
|
1006
|
+
Layout/IndentationWidth:
|
1007
|
+
Description: 'Use 2 spaces for indentation.'
|
1008
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#spaces-indentation'
|
1009
|
+
Enabled: true
|
1010
|
+
|
1011
|
+
Layout/IndentArray:
|
1012
|
+
Description: >-
|
1013
|
+
Checks the indentation of the first element in an array
|
1014
|
+
literal.
|
1015
|
+
Enabled: false
|
1016
|
+
|
1017
|
+
Layout/IndentHash:
|
1018
|
+
Description: 'Checks the indentation of the first key in a hash literal.'
|
1019
|
+
Enabled: false
|
1020
|
+
|
1021
|
+
Layout/LeadingCommentSpace:
|
1022
|
+
Description: 'Comments should start with a space.'
|
1023
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#hash-space'
|
1024
|
+
Enabled: false
|
1025
|
+
|
1026
|
+
Layout/MultilineBlockLayout:
|
1027
|
+
Description: 'Ensures newlines after multiline block do statements.'
|
1028
|
+
Enabled: false
|
1029
|
+
|
1030
|
+
Layout/MultilineOperationIndentation:
|
1031
|
+
Description: >-
|
1032
|
+
Checks indentation of binary operations that span more than
|
1033
|
+
one line.
|
1034
|
+
Enabled: false
|
1035
|
+
|
1036
|
+
Layout/RescueEnsureAlignment:
|
1037
|
+
Description: 'Align rescues and ensures correctly.'
|
1038
|
+
Enabled: false
|
1039
|
+
|
1040
|
+
Layout/SpaceBeforeFirstArg:
|
1041
|
+
Description: >-
|
1042
|
+
Checks that exactly one space is used between a method name
|
1043
|
+
and the first argument for method calls without parentheses.
|
1044
|
+
Enabled: true
|
1045
|
+
|
1046
|
+
Layout/SpaceAfterColon:
|
1047
|
+
Description: 'Use spaces after colons.'
|
1048
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#spaces-operators'
|
1049
|
+
Enabled: false
|
1050
|
+
|
1051
|
+
Layout/SpaceAfterComma:
|
1052
|
+
Description: 'Use spaces after commas.'
|
1053
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#spaces-operators'
|
1054
|
+
Enabled: false
|
1055
|
+
|
1056
|
+
Layout/SpaceAroundKeyword:
|
1057
|
+
Description: 'Use spaces around keywords.'
|
1058
|
+
Enabled: false
|
1059
|
+
|
1060
|
+
Layout/SpaceAfterMethodName:
|
1061
|
+
Description: >-
|
1062
|
+
Do not put a space between a method name and the opening
|
1063
|
+
parenthesis in a method definition.
|
1064
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#parens-no-spaces'
|
1065
|
+
Enabled: false
|
1066
|
+
|
1067
|
+
Layout/SpaceAfterNot:
|
1068
|
+
Description: Tracks redundant space after the ! operator.
|
1069
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-space-bang'
|
1070
|
+
Enabled: false
|
1071
|
+
|
1072
|
+
Layout/SpaceAfterSemicolon:
|
1073
|
+
Description: 'Use spaces after semicolons.'
|
1074
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#spaces-operators'
|
1075
|
+
Enabled: false
|
1076
|
+
|
1077
|
+
Layout/SpaceBeforeBlockBraces:
|
1078
|
+
Description: >-
|
1079
|
+
Checks that the left block brace has or doesn't have space
|
1080
|
+
before it.
|
1081
|
+
Enabled: false
|
1082
|
+
|
1083
|
+
Layout/SpaceBeforeComma:
|
1084
|
+
Description: 'No spaces before commas.'
|
1085
|
+
Enabled: false
|
1086
|
+
|
1087
|
+
Layout/SpaceBeforeComment:
|
1088
|
+
Description: >-
|
1089
|
+
Checks for missing space between code and a comment on the
|
1090
|
+
same line.
|
1091
|
+
Enabled: false
|
1092
|
+
|
1093
|
+
Layout/SpaceBeforeSemicolon:
|
1094
|
+
Description: 'No spaces before semicolons.'
|
1095
|
+
Enabled: false
|
1096
|
+
|
1097
|
+
Layout/SpaceInsideBlockBraces:
|
1098
|
+
Description: >-
|
1099
|
+
Checks that block braces have or don't have surrounding space.
|
1100
|
+
For blocks taking parameters, checks that the left brace has
|
1101
|
+
or doesn't have trailing space.
|
1102
|
+
Enabled: false
|
1103
|
+
|
1104
|
+
Layout/SpaceAroundBlockParameters:
|
1105
|
+
Description: 'Checks the spacing inside and after block parameters pipes.'
|
1106
|
+
Enabled: false
|
1107
|
+
|
1108
|
+
Layout/SpaceAroundEqualsInParameterDefault:
|
1109
|
+
Description: >-
|
1110
|
+
Checks that the equals signs in parameter default assignments
|
1111
|
+
have or don't have surrounding space depending on
|
1112
|
+
configuration.
|
1113
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#spaces-around-equals'
|
1114
|
+
Enabled: false
|
1115
|
+
|
1116
|
+
Layout/SpaceAroundOperators:
|
1117
|
+
Description: 'Use a single space around operators.'
|
1118
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#spaces-operators'
|
1119
|
+
Enabled: false
|
1120
|
+
|
1121
|
+
Layout/SpaceInsideHashLiteralBraces:
|
1122
|
+
Description: "Use spaces inside hash literal braces - or don't."
|
1123
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#spaces-operators'
|
1124
|
+
Enabled: false
|
1125
|
+
|
1126
|
+
Layout/SpaceInsideParens:
|
1127
|
+
Description: 'No spaces after ( or before ).'
|
1128
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-spaces-braces'
|
1129
|
+
Enabled: false
|
1130
|
+
|
1131
|
+
Layout/SpaceInsideRangeLiteral:
|
1132
|
+
Description: 'No spaces inside range literals.'
|
1133
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-space-inside-range-literals'
|
1134
|
+
Enabled: false
|
1135
|
+
|
1136
|
+
Layout/SpaceInsideStringInterpolation:
|
1137
|
+
Description: 'Checks for padding/surrounding spaces inside string interpolation.'
|
1138
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#string-interpolation'
|
1139
|
+
Enabled: false
|
1140
|
+
|
1141
|
+
Layout/Tab:
|
1142
|
+
Description: 'No hard tabs.'
|
1143
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#spaces-indentation'
|
1144
|
+
Enabled: false
|
1145
|
+
|
1146
|
+
Layout/TrailingBlankLines:
|
1147
|
+
Description: 'Checks trailing blank lines and final newline.'
|
1148
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#newline-eof'
|
1149
|
+
Enabled: false
|
1150
|
+
|
1151
|
+
Layout/TrailingWhitespace:
|
1152
|
+
Description: 'Avoid trailing whitespace.'
|
1153
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-whitespace'
|
1154
|
+
Enabled: false
|
1155
|
+
|
1156
|
+
################################ Security ################################
|
1157
|
+
|
1158
|
+
Security/Eval:
|
1159
|
+
Description: 'The use of eval represents a serious security risk.'
|
1160
|
+
Enabled: true
|
1161
|
+
|
1162
|
+
Security/JSONLoad:
|
1163
|
+
Description: >-
|
1164
|
+
This cop checks for the use of JSON class methods which have potential security issues.
|
1165
|
+
|
1166
|
+
Autocorrect is disabled by default because it's potentially dangerous.
|
1167
|
+
If using a stream, like JSON.load(open('file')), it will need to call #read manually,
|
1168
|
+
like JSON.parse(open('file').read). If reading single values (rather than proper JSON objects),
|
1169
|
+
like JSON.load('false'), it will need to pass the quirks_mode: true option,
|
1170
|
+
like JSON.parse('false', quirks_mode: true). Other similar issues may apply.
|
1171
|
+
Enabled: true
|
1172
|
+
|
1173
|
+
Security/YAMLLoad:
|
1174
|
+
Description: >-
|
1175
|
+
This cop checks for the use of YAML class methods which have potential security
|
1176
|
+
issues leading to remote code execution when loading from an untrusted source.
|
1177
|
+
Enabled: true
|
1178
|
+
|
1179
|
+
################################ Naming ################################
|
1180
|
+
|
1181
|
+
Naming/BinaryOperatorParameterName:
|
1182
|
+
Description: 'When defining binary operators, name the argument other.'
|
1183
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#other-arg'
|
1184
|
+
Enabled: false
|
1185
|
+
|
1186
|
+
Naming/AccessorMethodName:
|
1187
|
+
Description: Check the naming of accessor methods for get_/set_.
|
1188
|
+
Enabled: false
|
1189
|
+
|
1190
|
+
Naming/AsciiIdentifiers:
|
1191
|
+
Description: 'Use only ascii symbols in identifiers.'
|
1192
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#english-identifiers'
|
1193
|
+
Enabled: false
|
1194
|
+
|
1195
|
+
Naming/ClassAndModuleCamelCase:
|
1196
|
+
Description: 'Use CamelCase for classes and modules.'
|
1197
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#camelcase-classes'
|
1198
|
+
Enabled: false
|
1199
|
+
|
1200
|
+
Naming/ConstantName:
|
1201
|
+
Description: 'Constants should use SCREAMING_SNAKE_CASE.'
|
1202
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#screaming-snake-case'
|
1203
|
+
Enabled: false
|
1204
|
+
|
1205
|
+
Naming/FileName:
|
1206
|
+
Description: 'Use snake_case for source file names.'
|
1207
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#snake-case-files'
|
1208
|
+
Enabled: false
|
1209
|
+
|
1210
|
+
Naming/MethodName:
|
1211
|
+
Description: 'Use the configured style when naming methods.'
|
1212
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#snake-case-symbols-methods-vars'
|
1213
|
+
Enabled: false
|
1214
|
+
|
1215
|
+
Naming/PredicateName:
|
1216
|
+
Description: 'Check the names of predicate methods.'
|
1217
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#bool-methods-qmark'
|
1218
|
+
Enabled: false
|
1219
|
+
|
1220
|
+
Naming/VariableName:
|
1221
|
+
Description: 'Use the configured style when naming variables.'
|
1222
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#snake-case-symbols-methods-vars'
|
1223
|
+
Enabled: false
|